MariaDB Schema

`data`

The data block defines seed/lookup data for a table.

data {
  table = table.countries
  rows = [
    { code = "US", name = "United States" },
    { code = "CA", name = "Canada" },
  ]
}

`data` attributes

Name	Required	Value
`rows`	`true`	Any value
`table`	`true`	Object reference to `table`

`data` constraints

Constraint	Value
Required	`false`
Require Name	`false`
Repeatable	`true`

`function`

The function block describes a function in a database schema.

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

`function` 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)`

`function` blocks

`function.annotation`

`function.annotation` constraints

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

`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 (e.g., `function.arg "name"` )	`true`
Repeatable	`true`

`function` constraints

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

`permission`

The permission block describes permissions (privileges) granted on database objects.

permission {
  to         = "app_user"
  for        = table.users
  privileges = [SELECT]
}

permission {
  to         = role.admin
  for        = schema.public
  privileges = [ALL]
  grantable  = true
}

`permission` attributes

Name	Required	Value
`for`	`true`	Permission target resource can be one of: Object reference to `schema` Object reference to `table` Object reference to `view` Object reference to `function` Object reference to `procedure` Object reference to `table.column` Object reference to `view.column`
`grantable`	`false`	`bool`
`privileges`	`true`	List of strings or/and `enums (TRIGGER, SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE_TEMPORARY_TABLES, LOCK_TABLES, EXECUTE, CREATE_VIEW, SHOW_VIEW, CREATE_ROUTINE, ALTER_ROUTINE, EVENT, DELETE_HISTORY)`
`to`	`true`	Permission grantee can be one of: `string` Object reference to `role` Object reference to `user`

`permission` constraints

Constraint	Value
Required	`false`
Require Name	`false`
Repeatable	`true`

`procedure`

The procedure block describes a procedure in a database schema.

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

`procedure` 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)`

`procedure` blocks

`procedure.annotation`

`procedure.annotation` constraints

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

`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 (e.g., `procedure.arg "name"` )	`true`
Repeatable	`true`

`procedure` constraints

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

`role`

The role block describes a database role.

role "admin" {
  password_expired     = false
  password_lifetime    = 90
  max_questions        = 1000
  max_updates          = 500
  max_connections      = 10
  max_user_connections = 5
  auth_plugin          = "mysql_native_password"
  member_of            = [role.dba]
}

`role` attributes

Name	Required	Value
`auth_plugin`	`false`	`string`
`comment`	`false`	`string`
`max_connections`	`false`	`int`
`max_questions`	`false`	`int`
`max_updates`	`false`	`int`
`max_user_connections`	`false`	`int`
`member_of`	`false`	List of object reference to `role`
`password_expired`	`false`	`bool`
`password_lifetime`	`false`	`int`

`role` constraints

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

`schema`

The schema block describes a database schema.

schema "public" {
  ...
}

`schema` attributes

Name	Required	Value
`charset`	`false`	`string`
`collate`	`false`	`string`
`collation`	`false`	`string`
`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`
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
  }
  ...
}

`table` attributes

Name	Required	Value
`auto_increment`	`false`	Table auto increment can be one of: `int` Raw expression defined with `sql("expr")`
`charset`	`false`	`string`
`collate`	`false`	`string`
`comment`	`false`	`string`
`engine`	`false`	Table engine can be one of: `string` `enum (InnoDB, MyISAM, Memory, CSV, NDB)`
`renamed_from`	`false`	`string`
`schema`	`true`	Object reference to `schema`
`system_versioned`	`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`
`enforced`	`false`	`bool`
`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`
`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")`
`renamed_from`	`false`	`string`
`srid`	`false`	`int`
`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`
`parser`	`false`	Index parser can be one of: `string` `enum (ngram, mecab)`
`renamed_from`	`false`	`string`
`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`
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.partition`

`table.partition` attributes

Name	Required	Value
`columns`	`false`	List of object references
`type`	`true`	`enum (RANGE, RANGE_COLUMNS, LIST, LIST_COLUMNS, HASH, LINEAR_HASH, KEY, LINEAR_KEY)`

`table.partition` blocks

`table.partition.by`

`table.partition.by` attributes

Name	Required	Value
`column`	`false`	Object reference to `column`
`expr`	`false`	`string`

`table.partition.by` constraints

Constraint	Value
Required	`false`
Require Name	`false`
Repeatable	`true`

`table.partition.partition`

`table.partition.partition` attributes

Name	Required	Value
`comment`	`false`	`string`
`values_in`	`false`	List of strings
`values_less_than`	`false`	List of strings

`table.partition.partition` constraints

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

`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`

`table.primary_key` constraints

Constraint	Value
Required	`false`
Require Name	`false`
Mutually exclusive sets	`[columns, on]`
One of required sets	`[columns, on]`

`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`
`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`

`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`
Mutually exclusive sets	`[insert, delete, update]`
One of required sets	`[insert, delete, update]`

`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`

`trigger.before` constraints

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

`trigger` constraints

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

`user`

The user block describes a database user.

user "app_user" {
  password_expired     = false
  password_lifetime    = 30
  max_questions        = 500
  max_updates          = 100
  max_connections      = 5
  max_user_connections = 3
  auth_plugin          = "caching_sha2_password"
  password             = "*A1B2C3D4E5F..."
  member_of            = [role.readers]
}

`user` attributes

Name	Required	Value
`auth_plugin`	`false`	`string`
`comment`	`false`	`string`
`max_connections`	`false`	`int`
`max_questions`	`false`	`int`
`max_updates`	`false`	`int`
`max_user_connections`	`false`	`int`
`member_of`	`false`	List of object reference to `role`
`password`	`false`	`string`
`password_expired`	`false`	`bool`
`password_lifetime`	`false`	`int`

`user` constraints

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

`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`
`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)`

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

`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`

data​

data attributes​

data constraints​

function​

function attributes​

function blocks​

function.annotation​

function.annotation constraints​

function.arg​

function.arg attributes​

function.arg constraints​

function constraints​

permission​

permission attributes​

permission constraints​

procedure​

procedure attributes​

procedure blocks​

procedure.annotation​

procedure.annotation constraints​

procedure.arg​

procedure.arg attributes​

procedure.arg constraints​

procedure constraints​

role​

role attributes​

role constraints​

schema​

schema attributes​

schema blocks​

schema.annotation​

schema.annotation constraints​

schema constraints​

table​

table attributes​

table blocks​

table.annotation​

table.annotation constraints​

table.check​

table.check attributes​

table.check constraints​

table.column​

table.column attributes​

table.column blocks​

table.column.annotation​

table.column.annotation constraints​

table.column.as​

table.column.as attributes​

table.column constraints​

table.foreign_key​

table.foreign_key attributes​

table.foreign_key constraints​

table.index​

table.index attributes​

table.index blocks​

table.index.on​

table.index.on attributes​

table.index.on constraints​

table.index constraints​

table.partition​

table.partition attributes​

table.partition blocks​

table.partition.by​

table.partition.by attributes​

table.partition.by constraints​

table.partition.partition​

table.partition.partition attributes​

table.partition.partition constraints​

table.primary_key​

table.primary_key attributes​

table.primary_key blocks​

table.primary_key.on​

table.primary_key.on attributes​

table.primary_key.on constraints​

table.primary_key constraints​

table constraints​

trigger​

trigger attributes​

trigger blocks​

trigger.after​