Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.31 KB

README.md

File metadata and controls

61 lines (35 loc) · 2.31 KB
Raw

Search Query Parser

This package allows you to create PostgreSQL 9.6 compatible ts_query expressions from simple-to-use "query language".

See for reference:

Also, Ruby version of this library is available: https://github.com/EugZol/search_query_parser

Example:

(TODO: add examples)

You can use &, |, ! operators in the source query, which are transformed into corresponding PostgreSQL operators. Spaces are transformed into <-> ("follows") PostgreSQL operator.

.to_ts_query accepts 3 arguments, only first is required:

  • Search string
  • Language ('enlgish' by default, will be given as first argument to Postgres' to_tsquery)
  • Whether to use prefix (true by default, :* will be added to each word)

What's the problem

When you use PostgreSQL full-text search you want your users to be able to utilize full power of expressions in a convinient manner. Let's say, you want your users to be able to issue a request to find all documents with cats but without dogs.

Unfortunately, you can't use Postgres' plain_tosquery (link) function for that, which would be the closest match to our goal. If you give the string cates & !dogs to plainto_tsquery, the result will be:

=> select plainto_tsquery('cats & !dogs');
 plainto_tsquery
-----------------
 'cat' & 'dog'

...so, it just drops all the punctuation and concatenate words with logical AND (&), just as the documentation says.

The solution

Use SearchQueryParser.to_ts_query(q) to produce PostgreSQL-compatible expression. All non-alphanumeric and non-operator symbols will be dropped from the q.

How can I use it?

Use it in your Ecto models with tsdata columns like that:

(TODO: add how to use)

Installation

Add this line to your application's Gemfile:

(TODO: add installation)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/EugZol/search_query_parser_ex.

License

The gem is available as open source under the terms of the MIT License.