Directus / @directus/sdk / schema / DirectusField

Type Alias: DirectusField<Schema> ​

DirectusField<Schema>: object

Defined in: schema/field.ts:3

Type Parameters ​

• Schema = any

Type declaration ​

collection ​

collection: string

field ​

field: string

meta ​

meta: MergeCoreCollection<Schema, "directus_fields", { collection: string; conditions: FieldMetaConditionType[] | null; display: string | null; display_options: Record<string, any> | null; field: string; group: string | null; hidden: boolean; id: number; interface: string | null; note: string | null; options: Record<string, any> | null; readonly: boolean; required: boolean; sort: number | null; special: string[] | null; translations: FieldMetaTranslationType[] | null; validation: Record<string, any> | null; validation_message: string | null; width: string | null; }>

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_indexed ​

schema.is_indexed: 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