DomainQueryParams
Defined in: js-api/src/domains.ts:294
Parameter values of the DomainQuery function — the serializable representation of
what a domain view is showing (filter elements, ordering, cap), as
DomainView.query reports it. Feeding it back to the function
(DomainQuery.run) reproduces the subset as a DataFrame, with the creation
script recorded.
This is the ONLY parameter shape of the function — DomainQuery is its
mutable, URL-serializable counterpart. Grammar strings, not condition trees: each
element is one DomainQuery filter expression ('status = "open"') with the
per-element JSON escape hatch. Use DomainQuerySpec for the REST surface
instead.
Aggregate mode (non-empty aggregations/groupBy) REJECTS columns and offset
with a 400 — they are select-mode parameters, not ignored ones.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
aggregations? | string[] | Measures ('count', 'avg(amount) as avg_amount') — non-empty means aggregate mode. | js-api/src/domains.ts:306 |
columns? | string[] | Projection; omit for all viewable columns (select mode only). | js-api/src/domains.ts:298 |
filters? | string[] | Filter elements, AND-combined. OMITTED, not [], when there are none — these are the function's parameter values, and it takes no empty lists (DomainView.query on an unfiltered view has no filters key). | js-api/src/domains.ts:302 |
groupBy? | string[] | Grouping columns — non-empty means aggregate mode. | js-api/src/domains.ts:308 |
joins? | string[] | Master-FK expands ('<fk_column>'); 'details:' child arrays are not supported. | js-api/src/domains.ts:304 |
limit? | number | - | js-api/src/domains.ts:311 |
offset? | number | Row offset (select mode only). | js-api/src/domains.ts:313 |
orderBy? | string[] | Sort elements; a '!' prefix means descending. | js-api/src/domains.ts:310 |
schema | string | - | js-api/src/domains.ts:295 |
table | string | - | js-api/src/domains.ts:296 |