Basic Usage
Tantivy comes with its own string-based query language.paradedb.parse
accepts Tantivy query strings, which is useful for concisely expressing complex queries or directly executing queries provided
by the end user. For instance, the following two queries are equivalent:
Lenient Query Parsing
By default,paradedb.parse
uses strict syntax parsing. This means that if any part of the query does not conform to Tantivyβs query string syntax, the query fails.
For instance, a valid field name must be provided before every query (i.e. category:footwear
).
By setting lenient
to true
, the query is executed on a best-effort basis. For example, if no field names are provided, the query is executed over all fields in the index:
Conjunction Mode
By default, queries in the query string areOR
ed together. For instance, the following two queries are equivalent:
AND
ed together. This means that the following two queries are equivalent:
Parse with Field
paradedb.parse_with_field
takes a field name and a query string without field names. Itβs useful for executing user-provided query
strings over specific fields. Like paradedb.parse
, lenient
and conjunction_mode
can be passed to this function.
Enumerated Types
To query a custom enum withparadedb.parse
, the
underlying ordinal value must be used.