Interface: SQLSearchParams

The SQL counterpart of ClientParams.SearchParams: everything a complete statement needs besides the query itself.

Elasticsearch	here
`index`	`table`, or `relation` for an expression
`size`	`LIMIT`
`from`	`OFFSET`
`sort`	extra `ORDER BY` entries
`_source_includes` / `_source_excludes`	`includes` / `excludes`, into the `SELECT` list

Properties

Property	Type	Description	Defined in
`excludes?`	`string`[]	Fields the caller wants left out, combined with the configured excludes.	packages/types/src/sql-interfaces.ts:109
`from?`	`number`	Rows to skip. Must be a non-negative integer.	packages/types/src/sql-interfaces.ts:97
`includes?`	`string`[]	Fields the caller wants, filtered by what the configuration permits.	packages/types/src/sql-interfaces.ts:107
`relation?`	`string`	A SQL source expression used as-is, for sources that are not a plain table name, such as `read_parquet(['s3://bucket/a.parquet'])`, a subquery or a join. It is not escaped, so never build it from untrusted input. Use `table` for a name.	packages/types/src/sql-interfaces.ts:93
`size?`	`number`	Row limit. Must be a non-negative integer.	packages/types/src/sql-interfaces.ts:95
`sort?`	`SQLSort`[]	Ordering, appended to whatever the query itself asked for. A `geoDistance` query produces its own sort; when it does, it comes first. Each entry's `expression` is used as-is; see SQLSort.expression.	packages/types/src/sql-interfaces.ts:105
`table?`	`string`	The table to select from, quoted as an identifier. A dot separates catalog, schema and table - `main.public.events` becomes `"main"."public"."events"` - so a name is never taken as raw SQL.	packages/types/src/sql-interfaces.ts:86