Skip to main content

@terascope/types / sql-interfaces / xLuceneSQLOptions

Interface: xLuceneSQLOptions

Defined in: packages/types/src/sql-interfaces.ts:134

Options for translating an xLucene query to SQL.

Mirrors ElasticsearchDSLOptions. Engine-specific behavior lives on the dialect, and the geo sort options work as they do for the Elasticsearch DSL.

Properties​

PropertyTypeDescriptionDefined in
dialect?SQLDialectName | SQLDialectThe SQL engine to generate SQL for, as a name or a dialect object. Passing an object lets a caller override methods of a built-in dialect. Default SQLDialectName.duckdbpackages/types/src/sql-interfaces.ts:142
geo_sort_order?SortOrder-packages/types/src/sql-interfaces.ts:147
geo_sort_point?GeoPointIf a default_geo_field is set, this is required to enable sortingpackages/types/src/sql-interfaces.ts:146
geo_sort_unit?GeoDistanceUnit-packages/types/src/sql-interfaces.ts:148