Skip to content

PrepareQueryInput

Defined in: packages/client/src/index.ts:1271

Inputs to the read-path safety seam SyncClient.prepareQuery. The lazy relations a query reads are detected by scanning the compiled sql (union with the optional explicit use), then activated. Shared by the live React hooks and the non-live facade.

TRegistry extends SyncTableRegistry

sql: string

Defined in: packages/client/src/index.ts:1273

The compiled (parameterised) Drizzle SQL the query will run — the scan’s ground-truth target.


optional use?: readonly SyncTableName<TRegistry>[]

Defined in: packages/client/src/index.ts:1275

Lazy relations to also activate, beyond those scanned from sql — a pre-activation hint, not required.