I was testing this module out in production and within 24h someone entered a term like this 😅

-"keyword"*

…which produces the invalid syntax:

!("keyword"):*

…perhaps a wildcard after a phrase should just be dropped?

If use 'abs as input and pass it to pg-tsquery, the output will be the same 'abs, then pass it to to_tsquery() and postgres 13 will complain ERROR: syntax error in tsquery: "'abs". Queries as ', 'b, abs&'s and maybe some others will also throw an error.

An input is just some serial number.

pg-tsquery produces the same result whether there is space character in front of negation or not:

parse('TS01-H-18011-005')
// TS01&!H&!18011&!005

parse('TS01 -H -18011 -005')
// TS01&!H&!18011&!005

Postgres has different result depending on the presence of a space character in front of negation:

select websearch_to_tsquery('TS01-H-18011-005');
--> 'ts01-h' <-> 'ts01' <-> 'h' <-> '18011' <-> '-005'

select websearch_to_tsquery('TS01 -H -18011 -005');
--> 'ts01' & !'h' & !'18011' & !'005'

This is useful in cases like SN inventory, slugs, and so on.

Right now this library doesn't seem to support searching for phrases. For example, "sad cat" translates to "sad&cat", while Postgres's websearch_to_tsquery translates it to 'sad' <-> 'cat'.

It'd be great to have TypeScript definitions for this module.

With the { singleQuoteReplacement: "&" } option the search term one' or 'one

…produces the invalid syntax:

one&

…I think the rule is too simplistic here?

Ran into a weird issue with this module after switching typescript to the 'node16' module format.
It boils down to the code is exporting a function as a cjs module, but the index.d.ts definitions are written as if it's esm.

error TS2349: This expression is not callable.
Type 'typeof import(".../node_modules/pg-tsquery/index")' has no call signatures.

I think the fix would be something like this in index.d.ts instead of the export default:

declare function tsquery(options?: TsqueryOptions): (str: string) => string;
export = tsquery

For now a work around is this goofy thing:

import { default as Tsquery } from 'pg-tsquery'

type TsQueryFunc = (options?: Tsquery.TsqueryOptions) => (str: string) => string
const tsqueryParser = (Tsquery as unknown as TsQueryFunc)()

The typescript guys built this little tool that seems to agree with my analysis:
https://arethetypeswrong.github.io/?p=pg-tsquery%408.4.1

In https://www.postgresql.org/docs/13/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES websearch_to_tsquery 4th example:

SELECT websearch_to_tsquery('english', 'signal -"segmentation fault"');
         websearch_to_tsquery
---------------------------------------
 'signal' & !( 'segment' <-> 'fault' )

currently

await pool.query(`select to_tsquery($1)`, [tsquery.parse('signal -"segmentation fault"')+'']);

gives "'signal' & !'segment' <-> 'fault'" which is different

For example, I want to find an id: 1234-4332, but get 1234&!4332, where I'd expect 1234-4332 (I think that's correct)

Error raised with this input Some query (*, we always adds * for our autocomplete system.

I have product SKU numbers like "G1-ABC", and search simply not found it with this library. The same with international phone numbers like "+37544:*" because + interpreted as modificators.

There seems to be small issue with the documentation:

const tsquery = require('pg-tsquery')(/* options can be passed to override the defaults */);

pool.query('SELECT * FROM tabby WHERE to_tsvector(col) @@ to_tsquery($1)', [tsquery(str)]);

Seeing as the exported tsquery function returns a function, I believe this should be:

tsquery()(str)

Would it be possible to attach an explicit license to this repo? I'm interested in using in a project but without knowing the licensing it's tricky to do so.

Thanks for your efforts!

Hi,

Parsing it's returns its.

Is there any way to make it return it&s instead?

select to_tsquery('tomato<->banana') @@ to_tsvector('tomato banana'); -- true
select to_tsquery('cherry<2>banana') @@ to_tsvector('cherry lol banana'); -- true

precedences are:

1.| (OR)
2. & (AND)
3. <-> (FOLLOWED BY)
4. ! (NOT)

Hi there. I am getting this error with the default settings. Any ideas?

SyntaxError: Invalid regular expression: /^[\s*&+<:,|]*(?<negated>[\s!-]*)[\s*&+<:,|]*(?:(?<quote>["'])(?<phrase>.*?)\k<quote>|(?<word>[^\s,|&+<>:*()[\]!-]+))/: Invalid group
    at Object.<anonymous> (/home/ec2-user/environment/dartmoorarchive/node_modules/pg-tsquery/index.js:6:21)
    at Module._compile (module.js:653:30)