Skip to content
On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / schema / DirectusField

Type alias: DirectusField<Schema>

DirectusField<Schema>: Object

Type parameters

Schema extends object

Type declaration

collection

collection: string

field

field: string

meta

meta: MergeCoreCollection<Schema, "directus_fields", Object>

schema

schema: Object

schema.comment

schema.comment: string | null

schema.data_type

schema.data_type: string

schema.default_value

schema.default_value: any | null

schema.foreign_key_column

schema.foreign_key_column: string | null

schema.foreign_key_schema

schema.foreign_key_schema: string | null

schema.foreign_key_table

schema.foreign_key_table: string | null

schema.generation_expression

schema.generation_expression: unknown | null

schema.has_auto_increment

schema.has_auto_increment: boolean

schema.is_generated

schema.is_generated: boolean

schema.is_nullable

schema.is_nullable: boolean

schema.is_primary_key

schema.is_primary_key: boolean

schema.is_unique

schema.is_unique: boolean

schema.max_length

schema.max_length: number | null

schema.name

schema.name: string

schema.numeric_precision

schema.numeric_precision: number | null

schema.numeric_scale

schema.numeric_scale: number | null

schema.schema

schema.schema: string

schema.table

schema.table: string

type

type: string

Source

schema/field.ts:3