RelationField
Defined in: packages/schema/src/relation-field.ts:4
f.relation(resource): a field holding the key of a record of another resource.
Extends
Section titled “Extends”Field<V>
Type Parameters
Section titled “Type Parameters”V
Properties
Section titled “Properties”
readonlydef:FieldTypeDef
Defined in: packages/schema/src/field.ts:91
Its field type.
Inherited from
Section titled “Inherited from”
readonlymeta:FieldMeta
Defined in: packages/schema/src/field.ts:93
What its builder methods have set.
Inherited from
Section titled “Inherited from”schema
Section titled “schema”
readonlyschema:ZodType<V>
Defined in: packages/schema/src/field.ts:87
The Zod schema a value is checked with on every create and update: the type’s, nullable and defaulted as set.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”access()
Section titled “access()”access(
rules):Field<V>
Defined in: packages/schema/src/field.ts:126
Role-based rules for reading and writing this column. They never see a record, so the set of readable columns is fixed per request. A field without a rule follows its resource.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”ai(
o):Field<V>
Defined in: packages/schema/src/field.ts:177
A job fills the field from prompt, {field} replaced by the record’s values, after a create, and after an update
that changes a field the prompt names, as the user who wrote; see AI fields and actions.
Parameters
Section titled “Parameters”prompt
Section titled “prompt”string
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”alias()
Section titled “alias()”alias(…
names):Field<V>
Defined in: packages/schema/src/field.ts:144
Other names filters may use for the field.
Parameters
Section titled “Parameters”…string[]
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”column()
Section titled “column()”column(
name):Field<V>
Defined in: packages/schema/src/field.ts:103
The column, when it is not the snake_case of the field’s name, such as 'EMP_NAME'.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”columns()
Section titled “columns()”columns(
columns):Field<V>
Defined in: packages/schema/src/relation-field.ts:9
The columns that hold the other record’s key, in the order of that key, for a resource with a key of several columns. See Keys and relations.
Parameters
Section titled “Parameters”columns
Section titled “columns”string[]
Returns
Section titled “Returns”Field<V>
dbDefault()
Section titled “dbDefault()”dbDefault():
Field<V>
Defined in: packages/schema/src/field.ts:139
The database supplies a value when none is given (identity, now(), …).
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”default()
Section titled “default()”default(
value):Field<V>
Defined in: packages/schema/src/field.ts:118
The value a create uses when none is given; the admin’s create form shows it.
Parameters
Section titled “Parameters”V
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”filterable()
Section titled “filterable()”filterable():
Field<V>
Defined in: packages/schema/src/field.ts:149
The field may appear in filter, in filter widgets and in the filters of composed pages. Give it an index.
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”max(
value):Field<V>
Defined in: packages/schema/src/field.ts:169
The greatest value of an integer, or the longest length of a text. Only f.integer() and f.text() take it.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”min(
value):Field<V>
Defined in: packages/schema/src/field.ts:164
The least value of an integer, or the shortest length of a text. Only f.integer() and f.text() take it.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”optional()
Section titled “optional()”optional():
Field<V|null>
Defined in: packages/schema/src/field.ts:113
The column is nullable: the value may be null.
Returns
Section titled “Returns”Field<V | null>
Inherited from
Section titled “Inherited from”readOnly()
Section titled “readOnly()”readOnly():
Field<V>
Defined in: packages/schema/src/field.ts:108
Never written through the API: ids, computed columns, audit timestamps.
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”regex()
Section titled “regex()”regex(
re,message):Field<V>
Defined in: packages/schema/src/field.ts:159
Text must match re; a value that does not gets an issue with message. Only f.text() takes it.
Parameters
Section titled “Parameters”RegExp
message
Section titled “message”string
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”sensitive()
Section titled “sensitive()”sensitive():
Field<V>
Defined in: packages/schema/src/field.ts:134
Hidden like a password: never part of a list, record, search or write response. A caller who may read it fetches the
value of one record on its own (POST /{resource}/{key}:reveal), and every reveal is published as an audit event.
Returns
Section titled “Returns”Field<V>
Inherited from
Section titled “Inherited from”sortable()
Section titled “sortable()”sortable():
Field<V>
Defined in: packages/schema/src/field.ts:154
The field may appear in order_by and in sorts.
Returns
Section titled “Returns”Field<V>