DomainQuerySpec<TColumn, TExpandKey>
Defined in: js-api/src/domains.ts:317
Query options for domain table query/queryDf.
Type Parameters
| Type Parameter | Default type |
|---|---|
TColumn extends string | string |
TExpandKey extends string | string |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
columns? | TColumn[] | Columns to return; omit for all viewable columns. | js-api/src/domains.ts:325 |
expand? | TExpandKey[] | Expansions (same-schema, depth 1): '<fk_column>' returns the master row's declared columns prefixed '<fk_column>.<name>'; 'details:<table>[.<fk_column>]' returns capped child-row arrays under the child-table name (JSON queries only — not supported by queryDf); '<relation>' (a declared many-to-many) returns the link array — see DomainRelationLink. | js-api/src/domains.ts:331 |
filter? | DomainFilter<TColumn> | Smart-filter string (same grammar as entity search, e.g. barcode starts "P-1"), a single condition, or the canonical condition tree — values are bound server-side. Row caps: JSON query 10k, d42 queryDf 10M. | js-api/src/domains.ts:321 |
limit? | number | - | js-api/src/domains.ts:332 |
offset? | number | - | js-api/src/domains.ts:333 |
sort? | string | Comma-separated column list; ! prefix for descending, e.g. 'name,!created_on'. | js-api/src/domains.ts:323 |