Files
lancedb/docs/src/js/classes/BooleanQuery.md
BubbleCal fec8d58f06 feat: support a bunch or FTS features in JS SDK (#2431)
- operator for match query
- slop for phrase query
- boolean query

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Introduced support for boolean full-text search queries with AND/OR
logic and occurrence conditions.
- Added operator options for match and multi-match queries to control
term combination logic.
- Enabled phrase queries to specify proximity (slop) for flexible phrase
matching.
- Added new enumerations (`Operator`, `Occur`) and the `BooleanQuery`
class for enhanced query expressiveness.

- **Bug Fixes**
- Improved validation and error handling for invalid operator and
occurrence inputs in full-text queries.

- **Tests**
- Expanded test coverage with new cases for boolean queries and
operator-based full-text searches.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: BubbleCal <bubble-cal@outlook.com>
2025-06-12 17:04:19 +08:00

1.1 KiB

@lancedb/lancedbDocs


@lancedb/lancedb / BooleanQuery

Class: BooleanQuery

Represents a full-text query interface. This interface defines the structure and behavior for full-text queries, including methods to retrieve the query type and convert the query to a dictionary format.

Implements

Constructors

new BooleanQuery()

new BooleanQuery(queries): BooleanQuery

Creates an instance of BooleanQuery.

Parameters

  • queries: [Occur, FullTextQuery][] An array of (Occur, FullTextQuery objects) to combine. Occur specifies whether the query must match, or should match.

Returns

BooleanQuery

Methods

queryType()

queryType(): FullTextQueryType

The type of the full-text query.

Returns

FullTextQueryType

Implementation of

FullTextQuery.queryType