SQLite Schema

schema

The schema block describes a database schema.

schema "public" {
  ...
}

schema attributes

Name	Required	Value
comment	false	string
name	false	string

schema blocks

schema.annotation

schema.annotation constraints

Constraint	Value
Required	false
Require Name	false
Allow unknown blocks	true
Allow unknown attributes	true

schema constraints

Constraint	Value
Required	false
Require Name (e.g., schema "name" )	true

table

The table block describes a table in a database schema.

table "users" {
  schema = schema.public
  column "id" {
    type = int
  }
  ...
}

table attributes

Name	Required	Value
comment	false	string
renamed_from	false	string
schema	true	Object reference to schema
strict	false	bool
without_rowid	false	bool

table blocks

table.annotation

table.annotation constraints

Constraint	Value
Required	false
Require Name	false
Allow unknown blocks	true
Allow unknown attributes	true

table.check

table.check attributes

Name	Required	Value
comment	false	string
expr	true	string

table.check constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	true

table.column

table.column attributes

Name	Required	Value
as	false	string
auto_increment	false	bool
comment	false	string
default	false	Column default value can be one of: bool string number Raw expression defined with sql("expr")
null	false	bool
renamed_from	false	string
type	true	Column type can be one of: Schema type Raw expression defined with sql("expr")
unsigned	false	bool

table.column blocks

table.column.annotation

table.column.annotation constraints

Constraint	Value
Required	false
Require Name	false
Allow unknown blocks	true
Allow unknown attributes	true

table.column.as

table.column.as attributes

Name	Required	Value
expr	true	string
type	false	enum (VIRTUAL, STORED)

table.column constraints

Constraint	Value
Required	false
Require Name (e.g., table.column "name" )	true
Mutually exclusive sets	[as (attribute), as (block)]

table.foreign_key

table.foreign_key attributes

Name	Required	Value
columns	true	Foreign key columns can be one of: List of object reference to column List of object reference to table.column
comment	false	string
on_delete	false	enum (NO_ACTION, RESTRICT, CASCADE, SET_NULL, SET_DEFAULT)
on_update	false	enum (NO_ACTION, RESTRICT, CASCADE, SET_NULL, SET_DEFAULT)
ref_columns	true	Foreign key reference columns can be one of: List of object reference to column List of object reference to table.column

table.foreign_key constraints

Constraint	Value
Required	false
Require Name (e.g., table.foreign_key "name" )	true

table.index

table.index attributes

Name	Required	Value
columns	false	Index columns can be one of: List of object reference to column List of object reference to table.column
comment	false	string
renamed_from	false	string
unique	false	bool
where	false	string

table.index blocks

table.index.on

table.index.on attributes

Name	Required	Value
column	false	Index columns can be one of: Object reference to column Object reference to table.column
desc	false	bool
expr	false	string

table.index.on constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	true
Mutually exclusive sets	[column, expr]

table.index constraints

Constraint	Value
Required	false
Require Name (e.g., table.index "name" )	true
Mutually exclusive sets	[columns, on]
One of required sets	[columns, on]

table.primary_key

table.primary_key attributes

Name	Required	Value
columns	true	Primary key columns can be one of: List of object reference to column List of object reference to table.column
comment	false	string

table constraints

Constraint	Value
Required	false
Require Name (e.g., table "name" )	true
Allow Qualifier (e.g., table "schema" "name" )	true

trigger

The trigger block describes a trigger on a table in a database schema.

trigger "trigger_orders_audit" {
  on = table.orders
  ...
}

trigger attributes

Name	Required	Value
as	true	string
for	false	enum (ROW)
foreach	false	enum (ROW)
on	true	Trigger on can be one of: Object reference to table Object reference to view
when	false	string

trigger blocks

trigger.after

trigger.after attributes

Name	Required	Value
delete	false	bool
insert	false	bool
update	false	bool
update_of	false	Trigger update_of columns can be one of: List of object reference to view.column List of object reference to table.column

trigger.after constraints

Constraint	Value
Required	false
Require Name	false
Mutually exclusive sets	[insert, delete, update, update_of]
One of required sets	[insert, delete, update, update_of]

trigger.annotation

trigger.annotation constraints

Constraint	Value
Required	false
Require Name	false
Allow unknown blocks	true
Allow unknown attributes	true

trigger.before

trigger.before attributes

Name	Required	Value
delete	false	bool
insert	false	bool
update	false	bool
update_of	false	Trigger update_of columns can be one of: List of object reference to view.column List of object reference to table.column

trigger.before constraints

Constraint	Value
Required	false
Require Name	false
Mutually exclusive sets	[insert, delete, update, update_of]
One of required sets	[insert, delete, update, update_of]

trigger.instead_of

trigger.instead_of attributes

Name	Required	Value
delete	false	bool
insert	false	bool
update	false	bool
update_of	false	Trigger update_of columns can be one of: List of object reference to view.column List of object reference to table.column

trigger.instead_of constraints

Constraint	Value
Required	false
Require Name	false
Mutually exclusive sets	[insert, delete, update, update_of]
One of required sets	[insert, delete, update, update_of]

trigger constraints

Constraint	Value
Required	false
Require Name (e.g., trigger "name" )	true
Repeatable	true
Mutually exclusive sets	[foreach, for], [before, after, instead_of]
One of required sets	[before, after, instead_of]

view

The view block describes a view in a database schema.

view "clean_users" {
  schema = schema.public
  column "id" {
    type = int
  }
  ...
}

view attributes

Name	Required	Value
as	true	string
comment	false	string
depends_on	false	List of object references
schema	true	Object reference to schema

view blocks

view.annotation

view.annotation constraints

Constraint	Value
Required	false
Require Name	false
Allow unknown blocks	true
Allow unknown attributes	true

view.column

view.column attributes

Name	Required	Value
comment	false	string
null	false	bool
type	true	Column type can be one of: Schema type Raw expression defined with sql("expr")

view.column blocks

view.column.annotation

view.column.annotation constraints

Constraint	Value
Required	false
Require Name	false
Allow unknown blocks	true
Allow unknown attributes	true

view.column constraints

Constraint	Value
Required	false
Require Name (e.g., view.column "name" )	true

view constraints

Constraint	Value
Required	false
Require Name (e.g., view "name" )	true
Allow Qualifier (e.g., view "schema" "name" )	true