Interface: QueryOptions

Defined in: packages/core/src/api/session.ts:59

Per-statement options.

Properties

Property	Type	Description	Defined in
blobReadAhead?	BlobReadAheadOption	Lazy-blob read-ahead for queryStream (see BlobReadAheadOption). Overrides the connection-level default; false disables it.	packages/core/src/api/session.ts:82
blobs?	BlobsOption	Blob handling override for this statement: 'eager' (default) materializes; 'lazy' returns Blob handles; 'lazy-binary' / 'lazy-text' lazify only that subtype; {default?, eager?: [cols], lazy?: [cols]} names specific columns on top of a base mode.	packages/core/src/api/session.ts:66
exclude?	string[]	Column names (alias/field, case-insensitive) to omit from rows.	packages/core/src/api/session.ts:68
expandStar?	boolean	Rewrite top-level * / alias.* / table.* into an explicit column list (minus exclude, filtered by only) BEFORE preparing — excluded columns are then genuinely never sent by the server, scalars included (decode-time exclude only saves blob reads). Costs one extra prepare per unique (sql, only, exclude); cached, invalidated by DDL. Emitted column names are double-quoted (dialect 3). Top-level UNION is not supported.	packages/core/src/api/session.ts:98
fetchSize?	number	Max rows per fetch round trip for THIS statement, overriding the connection-level fetchSize (adaptive batch sizing still applies — this is the ceiling, clamped to 1–65535). Lower it to smooth memory/ latency on huge rows; raise it for bulk scans of narrow ones.	packages/core/src/api/session.ts:89
only?	string[]	If set, keep ONLY these columns (applied before exclude).	packages/core/src/api/session.ts:70
rowMode?	"object" | "array"	Row shape: 'object' (default, keyed by column name) or 'array' (positional, preserving duplicate/aliased columns). Array mode is intended for ORM adapters; exclude/only are ignored. In array mode QueryResult.rows holds unknown[] per row.	packages/core/src/api/session.ts:77