DomainReadScope<TColumn>
Defined in: js-api/src/domains.ts:443
The part of a read that selects ROWS rather than shapes the page: what
DomainTableClient.count, DomainTableClient.exists,
DomainTableClient.aggregate and DomainTableClient.query all narrow by.
One object, so a caller cannot pass filter and forget deleted — a total that disagrees
with the rows it counts is the bug this shape removes.
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
TColumn extends string | string |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
deleted? | "exclude" | "include" | "only" | Soft-deleted rows: 'exclude' (the default — only live rows), 'include' (both) or 'only' (the trash). Anything but 'exclude' also projects ~is_deleted (DOMAIN_SERVICE_COLUMNS); a deleted row is read-only until DomainTableClient.restore brings it back. Needs DomainSupport.deleted. | js-api/src/domains.ts:456 |
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:447 |
search? | string | Case-insensitive substring over the table's searchable columns — those declared searchable: true, else the name column (DomainTableInfo.searchableColumns); a table with neither rejects with a filter error. ANDed with filter. | js-api/src/domains.ts:451 |