MySQL Schema

function

The function block describes a function in a database schema.

function "positive" {
  schema = schema.public
  lang   = SQL
  arg "v" {
    type = integer
  }
  ...
}

Attributes

Name	Required	Value
as	true	string
comment	false	string
data_access	false	enum (CONTAINS_SQL, NO_SQL, READS_SQL_DATA, MODIFIES_SQL_DATA)
deterministic	false	bool
return	true	Function return type can be one of: Schema type Raw expression defined with sql("expr")
schema	true	Object reference to schema
security	false	enum (DEFINER, INVOKER)

Blocks

function.arg

function.arg attributes

Name	Required	Value
charset	false	string
collate	false	string
mode	false	enum (IN)
type	true	Function argument type can be one of: Schema type Raw expression defined with sql("expr")

function.arg constraints

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

Constraints

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

procedure

The procedure block describes a procedure in a database schema.

procedure "proc" {
  schema = schema.public
  lang   = SQL
  arg "a" {
    type = integer
  }
  ...
}

Attributes

Name	Required	Value
as	true	string
comment	false	string
data_access	false	enum (CONTAINS_SQL, NO_SQL, READS_SQL_DATA, MODIFIES_SQL_DATA)
deterministic	false	bool
schema	true	Object reference to schema
security	false	enum (DEFINER, INVOKER)

Blocks

procedure.arg

procedure.arg attributes

Name	Required	Value
charset	false	string
collate	false	string
mode	false	enum (IN, OUT, INOUT)
type	true	Procedure argument type can be one of: Schema type Raw expression defined with sql("expr")

procedure.arg constraints

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

Constraints

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

schema

The schema block describes a database schema.

schema "public" {
  ...
}

Attributes

Name	Required	Value
charset	false	string
collate	false	string
collation	false	string
comment	false	string
name	false	string

Constraints

Constraint	Value
Required	false
Require Name	true
Allow Qualifier	false
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[collate, collation]

table

The table block describes a table in a database schema.

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

Attributes

Name	Required	Value
auto_increment	false	int
charset	false	string
collate	false	string
comment	false	string
engine	false	Table engine can be one of: string enum (InnoDB, MyISAM, Memory, CSV, NDB)
schema	true	Object reference to schema

Blocks

table.check

table.check attributes

Name	Required	Value
comment	false	string
enforced	false	bool
expr	true	string

table.check constraints

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

table.column

table.column attributes

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

table.column blocks

table.column.as

table.column.as attributes

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

table.column.as constraints

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

table.column constraints

Constraint	Value
Required	false
Require Name	true
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
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	true
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false

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
parser	false	Index parser can be one of: string enum (ngram, mecab)
type	false	Index key type can be one of: string enum (BTREE, HASH, FULLTEXT, SPATIAL)
unique	false	bool

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
prefix	false	int

table.index.on constraints

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

table.index constraints

Constraint	Value
Required	false
Require Name	true
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[columns, on]
One of required sets	[columns, on]

table.primary_key

table.primary_key attributes

Name	Required	Value
columns	false	Primary key columns can be one of: List of object reference to column List of object reference to table.column
comment	false	string
type	false	Primary key type can be one of: string enum (BTREE, HASH, FULLTEXT, SPATIAL)

table.primary_key blocks

table.primary_key.on

table.primary_key.on attributes

Name	Required	Value
column	true	Index columns can be one of: Object reference to column Object reference to table.column
desc	false	bool
prefix	false	int

table.primary_key.on constraints

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

table.primary_key constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[columns, on]
One of required sets	[columns, on]

Constraints

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

trigger

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

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

Attributes

Name	Required	Value
as	true	string
follows	false	Object reference to trigger
for	false	enum (ROW)
foreach	false	enum (ROW)
on	true	Object reference to table
precedes	false	Object reference to trigger

Blocks

trigger.after

trigger.after attributes

Name	Required	Value
delete	false	bool
insert	false	bool
update	false	bool

trigger.after constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[insert, delete, update]
One of required sets	[insert, delete, update]

trigger.before

trigger.before attributes

Name	Required	Value
delete	false	bool
insert	false	bool
update	false	bool

trigger.before constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[insert, delete, update]
One of required sets	[insert, delete, update]

Constraints

Constraint	Value
Required	false
Require Name	true
Allow Qualifier	false
Repeatable	true
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[foreach, for], [follows, precedes], [before, after]
One of required sets	[before, after]

view

The view block describes a view in a database schema.

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

Attributes

Name	Required	Value
as	true	string
check_option	false	enum (LOCAL, CASCADED)
comment	false	string
depends_on	false	List of object references
schema	true	Object reference to schema
security	false	enum (DEFINER, INVOKER)

Blocks

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")
unsigned	false	bool

view.column constraints

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

Constraints

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