Skip to main content

@terascope/types / sql-interfaces

sql-interfaces

Enumerations​

EnumerationDescription
SQLDialectNameThe SQL engines an xLucene query can be translated for.

Interfaces​

InterfaceDescription
SQLDialectThe SQL that differs between engines.
SQLGeoPointColumnSQL expressions that read the latitude and longitude out of a geo-point column.
SQLIPRangeBoundOne end of a queried address range.
SQLResultThe result of translating an xLucene query to SQL.
SQLSearchParamsThe SQL counterpart of ClientParams.SearchParams: everything a complete statement needs besides the query itself.
SQLSortA SQL ORDER BY entry.
xLuceneSQLOptionsOptions for translating an xLucene query to SQL.

Type Aliases​

SQLNullOrder​

SQLNullOrder = "first" | "last"

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

Where nulls are placed within a sorted column.

It is written on every ORDER BY term, because engine defaults differ and none match DataFrame. See defaultNullOrder in @terascope/sql-builder.