@noim/pg-tsquery
    TypeScript icon, indicating that this package has built-in type declarations

    8.2.0 • Public • Published

    Text-Search parser for PostgreSQL

    npm version build status coverage status

    Why?

    Using pg's to_tsquery directly with user input can throw errors. plainto_tsquery sanitizes the user input, but it's very limited (it just puts an and between words), websearch_to_tsquery extends this behavior a little further only between double-quotes, with followedBy operator and negations.

    This module allows customizable text-search operators: and, or, followedBy, not, prefix, parentheses, quoted text (same behavior than websearch_to_tsquery).

    See the options defaults values

    usage

    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)]);
    
    // or get a reusable instance
    const {Tsquery} = require('pg-tsquery');
    
    const parser = new Tsquery(/* options can be passed to override the defaults */);
    
    // then one of those equivalent ways to process your input:
    parse.parseAndStringify(str);
    `${parser.parse(str) || ''}`;
    inputs output
    foo bar foo&bar
    foo -bar, foo !bar, foo + !bar foo&!bar
    foo bar,bip, foo+bar | bip foo&bar|bip
    foo (bar,bip), foo+(bar|bip) foo&(bar|bip)
    foo>bar>bip foo<->bar<->bip
    foo*,bar* bana:* foo:*|bar:*&bana:*

    Demo

    Install

    npm i @noim/pg-tsquery

    DownloadsWeekly Downloads

    2

    Version

    8.2.0

    License

    ISC

    Unpacked Size

    10.4 kB

    Total Files

    4

    Last publish

    Collaborators

    • dunklestoast
    • thenoim