Vespertide Model

Vespertide model file

Type object
File match **/models/**/*.vespertide.json **/models/**/*.vespertide.yaml **/models/**/*.vespertide.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/vespertide-model/latest.json
Source https://www.schemastore.org/vespertide-model.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

columns ColumnDef[] required
constraints TableConstraint[] required
name string required
description string | null

Definitions

ColumnDef object
name string required
nullable boolean required
type SimpleColumnType | ComplexColumnType required
comment string | null
default DefaultValue | null
foreign_key ForeignKeySyntax | null
index StrOrBoolOrArray | null
primary_key PrimaryKeySyntax | null
unique StrOrBoolOrArray | null
ColumnType SimpleColumnType | ComplexColumnType
ComplexColumnType object | object | object | object | object
DefaultValue boolean | integer | number | string

A value that can be a string, boolean, or number. This is used for default values where columns can use literal values directly.

EnumValues string[] | NumValue[]

Enum values definition - either all string or all integer

ForeignKeyDef object
ref_columns string[] required
ref_table string required
on_delete ReferenceAction | null
on_update ReferenceAction | null
ForeignKeySyntax string | ForeignKeyDef
NumValue object

Integer enum variant with name and numeric value

name string required
value integer required
format=int32
PrimaryKeyDef object
auto_increment boolean
Default: false
PrimaryKeySyntax boolean | PrimaryKeyDef
ReferenceAction string
SimpleColumnType string
StrOrBoolOrArray string | string[] | boolean
TableConstraint object | object | object | object | object