std/build/collection

Interfaces

CollectionApprovalOperations

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:204

Properties

findMany

readonly findMany: (approvalRequestId) => RemoteQuery<readonly CollectionApprovalRequest[]>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:205

Parameters

Parameter	Type
approvalRequestId	string

Returns

RemoteQuery<readonly CollectionApprovalRequest[]>

process

readonly process: (input) => Promise<void>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:206

Parameters

Parameter	Type
input	{ action: "APPROVED" | "REJECTED" | "REQUEST_FOR_CHANGE" | "SUPERSEDED"; approvalRequestId: string; comments?: string; }
input.action	"APPROVED" | "REJECTED" | "REQUEST_FOR_CHANGE" | "SUPERSEDED"
input.approvalRequestId	string
input.comments?	string

Returns

Promise<void>

withdraw

readonly withdraw: (approvalRequestId) => Promise<void>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:211

Parameters

Parameter	Type
approvalRequestId	string

Returns

Promise<void>

---

CollectionApprovalRequest

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:194

Properties

canDecide

readonly canDecide: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:198

Whether this principal may decide the request's current step.

canSupersede

readonly canSupersede: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:200

Whether this principal may explicitly finish every remaining step.

canWithdraw

readonly canWithdraw: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:202

Whether this principal is the requestor and may withdraw the open request.

id

readonly id: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:195

status

readonly status: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:196

---

CollectionBaseQuery

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:119

Extended by

• CollectionQuery
• CollectionGroupedQuery

Type Parameters

Type Parameter
TRow extends object

Properties

bypass_secret?

readonly optional bypass_secret?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:126

columns?

readonly optional columns?: Record<string, boolean>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:124

orderBy?

readonly optional orderBy?: Partial<Record<Extract<keyof TRow, string>, "asc" | "desc">>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:125

search?

readonly optional search?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:123

Typo-tolerant search across text/phone/enum fields and direct relationship text labels.

where?

readonly optional where?: Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:121

with?

readonly optional with?: Record<string, unknown>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:120

---

CollectionClient

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:227

Type Parameters

Type Parameter
TCollections extends CollectionRegistry

Properties

[collectionRegistryType]?

readonly optional [collectionRegistryType]?: TCollections;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:228

approvals?

readonly optional approvals?: CollectionApprovalOperations;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:237

collections

readonly collections: { readonly [TName in string | number | symbol]: CollectionDefinition<TCollections[TName]> };

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:232

db

readonly db: { readonly [TName in string | number | symbol]: CollectionOperations<TCollections[TName]> };

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:229

history?

readonly optional history?: CollectionHistoryOperations;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:236

records

readonly records: CollectionRecordOperations;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:235

---

CollectionDbClient

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:240

Tenant-authored collection surfaces receive only the typed database vocabulary.

Type Parameters

Type Parameter
TCollections extends CollectionRegistry

Properties

[collectionRegistryType]?

readonly optional [collectionRegistryType]?: TCollections;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:241

db

readonly db: { readonly [TName in string | number | symbol]: CollectionOperations<TCollections[TName]> };

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:242

---

CollectionDefinition

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:111

Type Parameters

Type Parameter	Default type
TCollection extends CollectionType<object, object, object>	CollectionType

Properties

fields

readonly fields: readonly CollectionField<Extract<keyof CollectionRow<TCollection>, string>>[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:115

name

readonly name: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:112

recordLabel?

readonly optional recordLabel?: string | null;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:113

relationships?

readonly optional relationships?: readonly CollectionRelationship[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:116

system?

readonly optional system?: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:114

---

CollectionField

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:61

Type Parameters

Type Parameter	Default type
TName extends string	string

Properties

array?

readonly optional array?: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:66

currencies?

readonly optional currencies?: readonly string[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:72

kind

readonly kind: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:63

label?

readonly optional label?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:65

mimeTypes?

readonly optional mimeTypes?: readonly string[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:73

name

readonly name: TName;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:62

nullable

readonly nullable: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:64

options?

readonly optional options?: Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:71

precision?

readonly optional precision?: "day" | "minute";

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:70

How precisely an instant range is picked: calendar days, or date-times.

readOnly?

readonly optional readOnly?: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:67

relation?

readonly optional relation?: object;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:88

Carries no label: how a related record reads is a view decision, declared where the relation is rendered (a table column's relation.label), not inherited from the target collection.

name

readonly name: string;

target

readonly target: string;

search?

readonly optional search?: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:83

Explicit search opt-in, authored as text({ search: true }).

Search is opt-in: only a non-array text/phone/enum field carrying search: true gets a trigram search index and participates in any search path — the collection search box, the omni finder and @ mentions, relation pickers. Absent means the field is never searched and never indexed, however text-like its kind.

values?

readonly optional values?: readonly string[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:68

variant?

readonly optional variant?: NumericRendererVariant;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:74

---

CollectionFilter

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:175

One filter condition as the wire carries it.

Stated structurally, because the schema needs a transport and the vocabulary does not — a table rendering filter chips has no business importing a wire validator to learn what a filter is.

operator stays an inline union rather than an exported alias: the filter builder already extends it as CollectionFilter['operator'] | 'contains', and a second exported name for the same set is how the two drift.

Properties

operand?

readonly optional operand?: unknown;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:180

Omitted for the operators that take none (isNull, isNotNull).

operator

readonly operator:
  | "eq"
  | "ne"
  | "gt"
  | "gte"
  | "lt"
  | "lte"
  | "ilike"
  | "isNull"
  | "isNotNull"
  | "arrayContains"
  | "arrayOverlaps"
  | "contains_date"
  | "overlaps";

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:178

path

readonly path: readonly string[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:177

One or two segments: status, or agreement_employment.employee_number split in two.

---

CollectionFilterOptions

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:182

Properties

filters?

readonly optional filters?: readonly CollectionFilter[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:183

---

CollectionGroupedQuery

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:133

Extends

• CollectionBaseQuery<TRow>

Type Parameters

Type Parameter
TRow extends object

Properties

bypass_secret?

readonly optional bypass_secret?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:126

Inherited from

CollectionBaseQuery.bypass_secret

columns?

readonly optional columns?: Record<string, boolean>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:124

Inherited from

CollectionBaseQuery.columns

group

readonly group: object;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:135

by

readonly by: Extract<keyof TRow, string>;

lanes?

readonly optional lanes?: unknown[];

limit?

readonly optional limit?: number;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:134

orderBy?

readonly optional orderBy?: Partial<Record<Extract<keyof TRow, string>, "asc" | "desc">>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:125

Inherited from

CollectionBaseQuery.orderBy

search?

readonly optional search?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:123

Typo-tolerant search across text/phone/enum fields and direct relationship text labels.

Inherited from

CollectionBaseQuery.search

where?

readonly optional where?: Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:121

Inherited from

CollectionBaseQuery.where

with?

readonly optional with?: Record<string, unknown>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:120

Inherited from

CollectionBaseQuery.with

---

CollectionHistoryOperations

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:222

Methods

findMany()

findMany(
   collectionName,
   recordId,
limit?): RemoteQuery<readonly CollectionRecordHistoryEntry[]>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:223

Parameters

Parameter	Type
collectionName	string
recordId	string
limit?	number

Returns

RemoteQuery<readonly CollectionRecordHistoryEntry[]>

---

CollectionOperations

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:185

Type Parameters

Type Parameter
TCollection extends CollectionType<object, object, object>

Properties

count

readonly count: (query?, options?) => RemoteQuery<number>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:189

Parameters

Parameter	Type
query?	CollectionBaseQuery<CollectionRow<TCollection>>
options?	CollectionFilterOptions

Returns

RemoteQuery<number>

findFirst

readonly findFirst: (query?) => RemoteQuery<
  | CollectionRow<TCollection>
| undefined>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:187

Parameters

Parameter	Type
query?	CollectionBaseQuery<CollectionRow<TCollection>>

Returns

RemoteQuery< | CollectionRow<TCollection> | undefined>

findGrouped

readonly findGrouped: (query, options?) => RemoteQuery<Readonly<Record<string, CollectionRow<TCollection>[]>>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:188

Parameters

Parameter	Type
query	CollectionGroupedQuery<CollectionRow<TCollection>>
options?	CollectionFilterOptions

Returns

RemoteQuery<Readonly<Record<string, CollectionRow<TCollection>[]>>>

findMany

readonly findMany: (query?, options?) => CollectionPageQuery<CollectionRow<TCollection>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:186

Parameters

Parameter	Type
query?	CollectionQuery<CollectionRow<TCollection>>
options?	CollectionFilterOptions

Returns

CollectionPageQuery<CollectionRow<TCollection>>

mutate

readonly mutate: (values) => Promise<void>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:190

Parameters

Parameter	Type
values	CollectionMutationInput<TCollection>

Returns

Promise<void>

pending

readonly pending: number;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:192

Number of in-flight writes for this collection.

---

CollectionPage

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:30

Type Parameters

Type Parameter	Default type
TRow extends object	CollectionRecord

Properties

nextCursor

readonly nextCursor: string | null;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:32

rows

readonly rows: TRow[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:31

---

CollectionPageQuery

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:35

A collection page keeps the familiar row result while exposing its opaque continuation.

Extends

• RemoteQuery<TRow[]>

Type Parameters

Type Parameter
TRow extends object

Properties

current

readonly current: TRow[] | undefined;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:26

Inherited from

RemoteQuery.current

error

readonly error: Error | undefined;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:28

Inherited from

RemoteQuery.error

loading

readonly loading: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:27

Inherited from

RemoteQuery.loading

nextCursor

readonly nextCursor: string | null | undefined;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:36

---

CollectionQuery

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:128

Extends

• CollectionBaseQuery<TRow>

Type Parameters

Type Parameter
TRow extends object

Properties

after?

readonly optional after?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:131

Opaque continuation returned by the previous page.

bypass_secret?

readonly optional bypass_secret?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:126

Inherited from

CollectionBaseQuery.bypass_secret

columns?

readonly optional columns?: Record<string, boolean>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:124

Inherited from

CollectionBaseQuery.columns

limit?

readonly optional limit?: number;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:129

orderBy?

readonly optional orderBy?: Partial<Record<Extract<keyof TRow, string>, "asc" | "desc">>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:125

Inherited from

CollectionBaseQuery.orderBy

search?

readonly optional search?: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:123

Typo-tolerant search across text/phone/enum fields and direct relationship text labels.

Inherited from

CollectionBaseQuery.search

where?

readonly optional where?: Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:121

Inherited from

CollectionBaseQuery.where

with?

readonly optional with?: Record<string, unknown>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:120

Inherited from

CollectionBaseQuery.with

---

CollectionRecord

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:22

Indexable

[field: string]: unknown

---

CollectionRecordHistoryEntry

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:216

Properties

validFrom

readonly validFrom: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:218

validTo

readonly validTo: string | null;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:219

values

readonly values: CollectionRecord;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:217

version

readonly version: number;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:220

---

CollectionRecordOperations

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:213

Methods

findMany()

findMany(collectionName, query?): CollectionPageQuery<CollectionRecord>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:214

Parameters

Parameter	Type
collectionName	string
query?	CollectionQuery<CollectionRecord>

Returns

CollectionPageQuery<CollectionRecord>

---

CollectionRelationOptions

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:153

How a relationship presents its option set, declared inline wherever the relationship is rendered — a table column, a form field, a matrix cell.

A relationship is a picker: the stored value is only the key that selects one option, so what a surface needs is the option set, not a property of the target collection. The same target reads differently in different places (an employment might be an employee number here and a name plus department there), which is why this is declared per use and not inherited from the model.

TRow is the target collection's row, so label and the field lists are checked against the records actually being picked from.

Type Parameters

Type Parameter	Default type
TRow extends object	CollectionRecord

Properties

filters?

readonly optional filters?: readonly Extract<keyof TRow, string>[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:163

Fields the picker offers as filter controls, so a long option list stays navigable.

label

readonly label: (record) => string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:155

How one option reads. Required — nothing is inferred, and without it a value shows as its id.

Parameters

Parameter	Type
record	TRow

Returns

string

limit?

readonly optional limit?: number;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:159

orderBy?

readonly optional orderBy?: Partial<Record<Extract<keyof TRow, string>, "asc" | "desc">>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:158

searchFields?

readonly optional searchFields?: readonly Extract<keyof TRow, string>[];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:161

Fields the picker's search box matches. Defaults to the server's search behaviour.

where?

readonly optional where?: Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:157

Narrows which records are offered.

---

CollectionRelationship

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:106

Properties

cardinality

readonly cardinality: "one" | "many";

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:109

name

readonly name: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:107

target

readonly target: string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:108

---

CollectionType

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:38

Type Parameters

Type Parameter	Default type
TRow extends object	CollectionRecord
TCreate extends object	CollectionRecord
TUpdate extends object	CollectionRecord
TMutation extends object	CollectionRecord

Properties

create

readonly create: TCreate;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:40

mutation?

readonly optional mutation?: TMutation;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:43

Exact recursively generated graph accepted by the declarative browser mutation.

row

readonly row: TRow;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:39

update

readonly update: TUpdate;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:41

---

RemoteQuery

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:25

Extends

• PromiseLike<T>

Extended by

• CollectionPageQuery

Type Parameters

Type Parameter
T

Properties

current

readonly current: T | undefined;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:26

error

readonly error: Error | undefined;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:28

loading

readonly loading: boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:27

Type Aliases

CollectionCreateInput

type CollectionCreateInput<TCollection> = TCollection["create"];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:48

Type Parameters

Type Parameter
TCollection extends CollectionType<object, object, object>

---

CollectionFieldName

type CollectionFieldName<TCollection> = Extract<keyof CollectionRow<TCollection>, string>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:51

Type Parameters

Type Parameter
TCollection extends CollectionType<object, object, object>

---

CollectionGroupedResult

type CollectionGroupedResult<TRow> = Readonly<Record<string, TRow[]>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:140

Type Parameters

Type Parameter
TRow extends object

---

CollectionMutationInput

type CollectionMutationInput<TCollection> = NonNullable<TCollection["mutation"]>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:50

Type Parameters

Type Parameter
TCollection extends CollectionType<object, object, object>

---

CollectionRegistry

type CollectionRegistry = Readonly<Record<string, CollectionType<object, object, object>>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:45

---

CollectionRow

type CollectionRow<TCollection> = TCollection["row"];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:47

Type Parameters

Type Parameter
TCollection extends CollectionType<object, object, object>

---

CollectionUpdateInput

type CollectionUpdateInput<TCollection> = TCollection["update"];

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:49

Type Parameters

Type Parameter
TCollection extends CollectionType<object, object, object>

---

CollectionWhere

type CollectionWhere<_TRow> = Readonly<Record<string, unknown>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:118

Type Parameters

Type Parameter
_TRow extends object

---

ErasedCollectionRegistry

type ErasedCollectionRegistry = Readonly<Record<string, CollectionType>>;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:46

---

NumericRendererVariant

type NumericRendererVariant =
  | {
  type: "number";
}
  | {
  max: number;
  type: "star-rating";
}
  | {
  denominator: number;
  type: "progress";
};

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:52

Variables

COLLECTION_SEARCH_MAX_LENGTH

const COLLECTION_SEARCH_MAX_LENGTH: 200 = 200;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:93

Functions

collectionSearchTrigramIndexName()

function collectionSearchTrigramIndexName(tableName, columnName): string;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:105

Parameters

Parameter	Type
tableName	string
columnName	string

Returns

string

---

isSearchableCollectionField()

function isSearchableCollectionField(field): boolean;

Defined in: apps/website/.api-docs-entry/std/build/collection/index.d.ts:104

Whether a field is searchable — the predicate every search path and the trigram index creation agree on. Search runs over exactly the fields that got a trigram index, and both are explicit opt-ins: a non-array text/phone/enum field is only searchable when the author wrote text({ search: true }) (or the equivalent on phone()/enums()).

The trigram index itself is language-agnostic: gin_trgm_ops indexes character trigrams, not words, so the same index serves substring search in any script — CJK, accented Latin, RTL — without dictionaries or tokenizers. The index and the search must never assume a language.

Parameters

Parameter	Type
field	CollectionField

Returns

boolean

References

isSystemCollectionField

Re-exports isSystemCollectionField

---

labelTermText

Re-exports labelTermText

---

resolveRecordLabel

Re-exports resolveRecordLabel

---

SYSTEM_COLLECTION_FIELD_NAMES

Re-exports SYSTEM_COLLECTION_FIELD_NAMES