FileField
Defined in: packages/schema/src/file-field.ts:6
f.file(): a text column holding a file’s URI, uploaded through :upload. See Files.
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”accept()
Section titled “accept()”accept(
types):FileField<V>
Defined in: packages/schema/src/file-field.ts:8
Allowed types, checked against the type detected from the content: ['image/*', 'application/pdf'].
Parameters
Section titled “Parameters”readonly string[]
Returns
Section titled “Returns”FileField<V>
access()
Section titled “access()”access(
rules):FileField<V>
Defined in: packages/schema/src/file-field.ts:79
Role-based rules for reading and writing the file; uploading needs write access to the field.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”FileField<V>
Overrides
Section titled “Overrides”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):FileField<V>
Defined in: packages/schema/src/file-field.ts:74
The column, when it is not the snake_case of the field’s name.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”FileField<V>
Overrides
Section titled “Overrides”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”derive()
Section titled “derive()”derive(
processors):FileField<V>
Defined in: packages/schema/src/file-field.ts:31
Values computed from each upload, written to other fields of the resource (read-only ones) in the same write as the
file: { image_width: imageSize('width') }. Clearing the file clears them.
Parameters
Section titled “Parameters”processors
Section titled “processors”Record<string, FileProcessor>
Returns
Section titled “Returns”FileField<V>
externalUrls()
Section titled “externalUrls()”externalUrls():
FileField<V>
Defined in: packages/schema/src/file-field.ts:59
Also takes an https URL of a file elsewhere, such as https://images.example.com/photos/42.jpg, stored as it is:
never uploaded, without variants, and drawn from that address. See
External URLs.
Returns
Section titled “Returns”FileField<V>
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”maxSize()
Section titled “maxSize()”maxSize(
size):FileField<V>
Defined in: packages/schema/src/file-field.ts:13
The largest upload, as bytes or text such as 10 MB; default 50 MB.
Parameters
Section titled “Parameters”string | number
Returns
Section titled “Returns”FileField<V>
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():
FileField<V|null>
Defined in: packages/schema/src/file-field.ts:64
The column is nullable: the field may hold no file.
Returns
Section titled “Returns”FileField<V | null>
Overrides
Section titled “Overrides”placeholder()
Section titled “placeholder()”placeholder(
field):FileField<V>
Defined in: packages/schema/src/file-field.ts:39
Computes a ThumbHash of each image into a read-only text field (photo_placeholder), which the admin app shows
while the image loads. Other files leave it null.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”FileField<V>
public()
Section titled “public()”public():
FileField<V>
Defined in: packages/schema/src/file-field.ts:18
Stored with the public provider, at a permanent URL anyone with it may open.
Returns
Section titled “Returns”FileField<V>
readOnly()
Section titled “readOnly()”readOnly():
FileField<V>
Defined in: packages/schema/src/file-field.ts:69
Never written through the API.
Returns
Section titled “Returns”FileField<V>
Overrides
Section titled “Overrides”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>
Inherited from
Section titled “Inherited from”storage()
Section titled “storage()”storage(
provider):FileField<V>
Defined in: packages/schema/src/file-field.ts:23
Stored with this provider of files.providers; default private.
Parameters
Section titled “Parameters”provider
Section titled “provider”string
Returns
Section titled “Returns”FileField<V>
variants()
Section titled “variants()”variants(
variants,options?):FileField<V>
Defined in: packages/schema/src/file-field.ts:47
Resized copies of each image, stored beside it under these names: { card: { width: 640, height: 480, fit: 'cover', format: 'webp' } }. { original } stores that image instead of the upload. Other files get none.
Parameters
Section titled “Parameters”variants
Section titled “variants”Record<string, ImageVariant>
options?
Section titled “options?”ImageVariantOptions = {}
Returns
Section titled “Returns”FileField<V>