Phrase search query for Postgres full text search

[Ilya Semenov]

Postgres 9.6 now supports phrase search with ... @@ phraseto_tsquery('hello world'). It would be great if Django supported it natively.

Currently, django.contrib.postgres.search.SearchQuery hard-codes SQL lookup formatting:

class SearchQuery(SearchQueryCombinable, Value):
    def as_sql(self, compiler, connection):
        ...
            template = 'plainto_tsquery({}::regconfig, %s)'.format(config_sql)

I believe the lookup function should be taken from a class level variable instead, and two more classes should be introduced: PhraseSearchQuery using phraseto_tsquery, and RawSearchQuery using to_tsquery.

[Andrii Soldatenko]

I need also this feature in my project, I'm going to start working on PR.

[Andrii Soldatenko]

​PR

[Mads Jensen]

Release notes and documentation needed.

[Andrii Soldatenko]

Added docs and tests.

[Tim Graham]

"Ready for checkin" is set by a patch reviewer, not the patch author (see ​Triaging tickets).

[Andrii Soldatenko]

Sorry for that. Thanks for the link!

[Greg Allensworth]

Hello. I wanted to check in on the status of this patch, to support phraseto_tsquery()

I ask because this one has been idle for about 14 months, in a "needs improvement" state.

I have come up with a much simpler approach to allowing phrase searching, which is smaller code changes and less code -- a simple phrase=True flag to the SearchVector

[Andrii Soldatenko]

Sorry I don't have a free time for a long time, yes sure you can reuse my PR or create you own, if you need any help please let me know.

[Greg Allensworth]

My own internal note: I have a copy of the patched version here. ​https://github.com/GreenInfo-Network/Django-PostgreSQL-SearchVector

[Andrii Soldatenko]

You need to adopt your patch to django style and create docs and tests.

[Greg Allensworth]

Thanks, Andrii. Do you want to go ahead and close PR 8491 ​https://github.com/django/django/pull/8491 ?

I will open a new one later today, or tomorrow.

[Greg Allensworth]

Pull Request is up: ​https://github.com/django/django/pull/10102

[Claude Paroz]

Unchecking Patch needs improvement so your patch is back in the review queue.

[Claude Paroz]

However tests are missing.

[Claude Paroz]

I added a test to Greg's patch ​in this PR.

[Tim Graham]

The patch may need a small change to support "to_tsquery" which is a part of ​PR 8491. Maybe a multivalued argument called something like search_type with values like "raw", "phrase", "plain" would be appropriate.

[Tim Graham <timograham@…>]

In f5e347a:

Fixed #27899 -- Added support for phrase/raw searching in SearchQuery.

Thanks Tim Graham, Nick Pope, and Claude Paroz for contribution and review.