PostgreSQL Schema

aggregate

Attributes

Name	Required	Value
comment	false	string
depends_on	false	List of object references
initial_value	false	Aggregate initial value can be one of: bool string number Raw expression defined with sql("expr")
parallel	false	enum (SAFE, UNSAFE, RESTRICTED)
schema	true	Object reference to schema
state_func	true	Object reference to function
state_type	true	Aggregate state type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

Blocks

aggregate.arg

aggregate.arg attributes

Name	Required	Value
default	false	Aggregate argument default value can be one of: bool string number Raw expression defined with sql("expr")
mode	false	Aggregate argument mode can be one of: string enum (IN, OUT, INOUT, VARIADIC)
type	true	Aggregate argument type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

aggregate.arg constraints

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

Constraints

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

composite

The composite block describes a composite type in the schema.

composite "address" {
  schema = schema.public
  field "street" {
    type = text
  }
  field "city" {
    type = text
  }
}

Attributes

Name	Required	Value
comment	false	string
name	false	string
schema	true	Object reference to schema

Blocks

composite.field

composite.field attributes

Name	Required	Value
collate	false	string
type	true	Field type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

composite.field constraints

Constraint	Value
Required	true
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

domain

The domain block describes a DOMAIN type in the schema.

domain "us_postal_code" {
  schema = schema.public
  type   = text
  null   = true
  check "us_postal_code_check" {
    expr = "..."
  }
}

Attributes

Name	Required	Value
comment	false	string
default	false	Domain default value can be one of: bool string number Raw expression defined with sql("expr")
name	false	string
null	false	bool
schema	true	Object reference to schema
type	true	Domain type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

Blocks

domain.check

domain.check attributes

Name	Required	Value
comment	false	string
expr	true	string

domain.check constraints

Constraint	Value
Required	false
Require Name	false
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

enum

The enum block describes an ENUM type in the schema.

enum "status" {
  schema = schema.test
  values = ["on", "off"]
}

Attributes

Name	Required	Value
comment	false	string
name	false	string
schema	true	Object reference to schema
values	true	List of strings

Constraints

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

event_trigger

The event_trigger block describes an event trigger in the database.

event_trigger "record_table_creation" {
  on      = ddl_command_start
  tags    = ["CREATE TABLE"]
  execute = function.record_table_creation
}

Attributes

Name	Required	Value
comment	false	string
execute	true	Object reference to function
on	true	Event trigger on can be one of: string enum (ddl_command_start, ddl_command_end, table_rewrite, sql_drop)
tags	false	List of strings

Constraints

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

extension

The extension block describes an extension in the database.

extension "postgis" {
  schema  = schema.public
}
extension "pgcrypto" {
  schema  = schema.public
  version = "1.3"
  comment = "cryptographic functions"
}

Attributes

Name and description	Required	Value
comment	false	string
depends_on The depends_on attribute specifies the extensions that this extension depends on.	false	List of object reference to extension
name	false	string
schema	false	Object reference to schema
version	false	string

Constraints

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

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
depends_on	false	List of object references
lang	true	Function language can be one of: string enum (SQL, PLpgSQL)
leakproof	false	bool
parallel	false	enum (SAFE, UNSAFE, RESTRICTED)
return	false	Function return type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table
return_set	false	Function return_set type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table
schema	true	Object reference to schema
security	false	enum (DEFINER, INVOKER)
strict	false	bool
volatility	false	enum (VOLATILE, STABLE, IMMUTABLE)

Blocks

function.arg

function.arg attributes

Name	Required	Value
default	false	Function argument default value can be one of: bool string number Raw expression defined with sql("expr")
mode	false	Function argument mode can be one of: string enum (IN, OUT, INOUT, VARIADIC)
type	true	Function argument type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

function.arg constraints

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

function.return_table

function.return_table blocks

function.return_table.column

function.return_table.column attributes

Name	Required	Value
type	true	Function return_table column type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

function.return_table.column constraints

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

function.return_table constraints

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

Constraints

Constraint	Value
Required	false
Require Name	true
Allow Qualifier	true
Repeatable	true
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[return, return_set, return_table]

materialized

The materialized block describes a materialized view in a database schema.

materialized "name" {
  schema = schema.public
  column "total" {
    null = true
    type = numeric
  }
  ...
}

Attributes

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

Blocks

materialized.column

materialized.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") Object reference to enum Object reference to domain Object reference to composite Object reference to table

materialized.column constraints

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

materialized.index

materialized.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
include	false	Index included columns can be one of: List of object reference to column List of object reference to table.column
nulls_distinct	false	bool
page_per_range	false	int
type	false	Index key type can be one of: string enum (BTREE, BRIN, HASH, GIN, GIST, GiST, SPGIST, SPGiST)
unique	false	bool
where	false	string

materialized.index blocks

materialized.index.on

materialized.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
nulls_first	false	bool
nulls_last	false	bool
ops	false	Index operator class can be one of: string Raw expression defined with sql("expr") enum (bit_minmax_ops, box_inclusion_ops, bpchar_bloom_ops, bpchar_minmax_ops, bytea_bloom_ops, bytea_minmax_ops, char_bloom_ops, char_minmax_ops, date_bloom_ops, date_minmax_multi_ops, date_minmax_ops, float4_bloom_ops, float4_minmax_multi_ops, float4_minmax_ops, float8_bloom_ops, float8_minmax_multi_ops, float8_minmax_ops, inet_bloom_ops, inet_inclusion_ops, inet_minmax_multi_ops, inet_minmax_ops, int2_bloom_ops, int2_minmax_multi_ops, int2_minmax_ops, int4_bloom_ops, int4_minmax_multi_ops, int4_minmax_ops, int8_bloom_ops, int8_minmax_multi_ops, int8_minmax_ops, interval_bloom_ops, interval_minmax_multi_ops, interval_minmax_ops, macaddr8_bloom_ops, macaddr8_minmax_multi_ops, macaddr8_minmax_ops, macaddr_bloom_ops, macaddr_minmax_multi_ops, macaddr_minmax_ops, name_bloom_ops, name_minmax_ops, numeric_bloom_ops, numeric_minmax_multi_ops, numeric_minmax_ops, oid_bloom_ops, oid_minmax_multi_ops, oid_minmax_ops, pg_lsn_bloom_ops, pg_lsn_minmax_multi_ops, pg_lsn_minmax_ops, range_inclusion_ops, text_bloom_ops, text_minmax_ops, tid_bloom_ops, tid_minmax_multi_ops, tid_minmax_ops, time_bloom_ops, time_minmax_multi_ops, time_minmax_ops, timestamp_bloom_ops, timestamp_minmax_multi_ops, timestamp_minmax_ops, timestamptz_bloom_ops, timestamptz_minmax_multi_ops, timestamptz_minmax_ops, timetz_bloom_ops, timetz_minmax_multi_ops, timetz_minmax_ops, uuid_bloom_ops, uuid_minmax_multi_ops, uuid_minmax_ops, varbit_minmax_ops, array_ops, bit_ops, bool_ops, bpchar_ops, bpchar_pattern_ops, bytea_ops, char_ops, cidr_ops, date_ops, enum_ops, float4_ops, float8_ops, inet_ops, int2_ops, int4_ops, int8_ops, interval_ops, jsonb_ops, macaddr8_ops, macaddr_ops, money_ops, multirange_ops, name_ops, numeric_ops, oid_ops, oidvector_ops, pg_lsn_ops, range_ops, record_image_ops, record_ops, text_ops, text_pattern_ops, tid_ops, time_ops, timestamp_ops, timestamptz_ops, timetz_ops, tsquery_ops, tsvector_ops, uuid_ops, varbit_ops, varchar_ops, varchar_pattern_ops, xid8_ops, array_ops, jsonb_ops, jsonb_path_ops, tsvector_ops, box_ops, circle_ops, inet_ops, multirange_ops, point_ops, poly_ops, range_ops, tsquery_ops, tsvector_ops, aclitem_ops, array_ops, bool_ops, bpchar_ops, bpchar_pattern_ops, bytea_ops, char_ops, cid_ops, cidr_ops, date_ops, enum_ops, float4_ops, float8_ops, inet_ops, int2_ops, int4_ops, int8_ops, interval_ops, jsonb_ops, macaddr8_ops, macaddr_ops, multirange_ops, name_ops, numeric_ops, oid_ops, oidvector_ops, pg_lsn_ops, range_ops, record_ops, text_ops, text_pattern_ops, tid_ops, time_ops, timestamp_ops, timestamptz_ops, timetz_ops, uuid_ops, varchar_ops, varchar_pattern_ops, xid8_ops, xid_ops, box_ops, inet_ops, kd_point_ops, poly_ops, quad_point_ops, range_ops, text_ops, gin_trgm_ops, gist_trgm_ops, btree_geography_ops, btree_geometry_ops, gist_geography_ops, gist_geometry_ops_2d, gist_geometry_ops_nd, gist_geometry_ops_3d, hash_geometry_ops, brin_geography_inclusion_ops, brin_geometry_inclusion_ops_2d, brin_geometry_inclusion_ops_3d, brin_geometry_inclusion_ops_4d, spgist_geography_ops_nd, spgist_geometry_ops_2d, spgist_geometry_ops_3d, spgist_geometry_ops_nd)

materialized.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], [nulls_last, nulls_first]

materialized.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]

Constraints

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

policy

The policy block describes a row-level security policy for a table.

policy "policy_name" {
  on    = table.users
  for   = UPDATE
  to    = [PUBLIC]
  check = "(name = ( SELECT name FROM allowed_names))"
}

Attributes

Name	Required	Value
as	false	enum (PERMISSIVE, RESTRICTIVE)
check	false	string
comment	false	string
for	false	enum (ALL, SELECT, INSERT, UPDATE, DELETE)
on	true	Object reference to table
to	false	List of strings or/and enums (PUBLIC, CURRENT_ROLE, CURRENT_USER, SESSION_USER)
using	false	string

Constraints

Constraint	Value
Required	false
Require Name	true
Allow Qualifier	false
Repeatable	true
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
depends_on	false	List of object references
lang	true	Procedure language can be one of: string enum (SQL, PLpgSQL)
schema	true	Object reference to schema
security	false	enum (DEFINER, INVOKER)

Blocks

procedure.arg

procedure.arg attributes

Name	Required	Value
default	false	Procedure argument default value can be one of: bool string number Raw expression defined with sql("expr")
mode	false	Procedure argument mode can be one of: string enum (IN, OUT, INOUT, VARIADIC)
type	true	Procedure argument type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

procedure.arg constraints

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

Constraints

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

schema

The schema block describes a database schema.

schema "public" {
  ...
}

Attributes

Name	Required	Value
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

sequence

The sequence block describes a sequence in a database schema.

sequence "name" {
  schema    = schema.public
  type      = int
  increment = 3
  min_value = 9
}

Attributes

Name	Required	Value
cache	false	int
comment	false	string
cycle	false	bool
increment	false	int
max_value	false	int
min_value	false	int
owner	false	Object reference to table.column
schema	true	Object reference to schema
start	false	int
type	false	Schema type

Constraints

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

table

The table block describes a table in a database schema.

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

Attributes

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

Blocks

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
Allow unknown blocks	false
Allow unknown attributes	false

table.column

table.column attributes

Name	Required	Value
as	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
type	true	Column type can be one of: Schema type Raw expression defined with sql("expr") Object reference to enum Object reference to domain Object reference to composite Object reference to table

table.column blocks

table.column.as

table.column.as attributes

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

table.column.as constraints

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

table.column.identity

table.column.identity attributes

Name	Required	Value
generated	false	enum (ALWAYS, BY_DEFAULT)
increment	false	int
start	false	int

table.column.identity 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.exclude

table.exclude attributes

Name	Required	Value
comment	false	string
deferrable	false	enum (INITIALLY_IMMEDIATE, INITIALLY_DEFERRED)
include	false	Index included columns can be one of: List of object reference to column List of object reference to table.column
nulls_distinct	false	bool
page_per_range	false	int
type	false	Index key type can be one of: string enum (BTREE, BRIN, HASH, GIN, GIST, GiST, SPGIST, SPGiST)
where	false	string

table.exclude blocks

table.exclude.on

table.exclude.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
op	false	Exclude element operator can be one of: string Raw expression defined with sql("expr")

table.exclude.on constraints

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

table.exclude constraints

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

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
deferrable	false	enum (INITIALLY_IMMEDIATE, INITIALLY_DEFERRED)
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
include	false	Index included columns can be one of: List of object reference to column List of object reference to table.column
nulls_distinct	false	bool
page_per_range	false	int
type	false	Index key type can be one of: string enum (BTREE, BRIN, HASH, GIN, GIST, GiST, SPGIST, SPGiST)
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
nulls_first	false	bool
nulls_last	false	bool
ops	false	Index operator class can be one of: string Raw expression defined with sql("expr") enum (bit_minmax_ops, box_inclusion_ops, bpchar_bloom_ops, bpchar_minmax_ops, bytea_bloom_ops, bytea_minmax_ops, char_bloom_ops, char_minmax_ops, date_bloom_ops, date_minmax_multi_ops, date_minmax_ops, float4_bloom_ops, float4_minmax_multi_ops, float4_minmax_ops, float8_bloom_ops, float8_minmax_multi_ops, float8_minmax_ops, inet_bloom_ops, inet_inclusion_ops, inet_minmax_multi_ops, inet_minmax_ops, int2_bloom_ops, int2_minmax_multi_ops, int2_minmax_ops, int4_bloom_ops, int4_minmax_multi_ops, int4_minmax_ops, int8_bloom_ops, int8_minmax_multi_ops, int8_minmax_ops, interval_bloom_ops, interval_minmax_multi_ops, interval_minmax_ops, macaddr8_bloom_ops, macaddr8_minmax_multi_ops, macaddr8_minmax_ops, macaddr_bloom_ops, macaddr_minmax_multi_ops, macaddr_minmax_ops, name_bloom_ops, name_minmax_ops, numeric_bloom_ops, numeric_minmax_multi_ops, numeric_minmax_ops, oid_bloom_ops, oid_minmax_multi_ops, oid_minmax_ops, pg_lsn_bloom_ops, pg_lsn_minmax_multi_ops, pg_lsn_minmax_ops, range_inclusion_ops, text_bloom_ops, text_minmax_ops, tid_bloom_ops, tid_minmax_multi_ops, tid_minmax_ops, time_bloom_ops, time_minmax_multi_ops, time_minmax_ops, timestamp_bloom_ops, timestamp_minmax_multi_ops, timestamp_minmax_ops, timestamptz_bloom_ops, timestamptz_minmax_multi_ops, timestamptz_minmax_ops, timetz_bloom_ops, timetz_minmax_multi_ops, timetz_minmax_ops, uuid_bloom_ops, uuid_minmax_multi_ops, uuid_minmax_ops, varbit_minmax_ops, array_ops, bit_ops, bool_ops, bpchar_ops, bpchar_pattern_ops, bytea_ops, char_ops, cidr_ops, date_ops, enum_ops, float4_ops, float8_ops, inet_ops, int2_ops, int4_ops, int8_ops, interval_ops, jsonb_ops, macaddr8_ops, macaddr_ops, money_ops, multirange_ops, name_ops, numeric_ops, oid_ops, oidvector_ops, pg_lsn_ops, range_ops, record_image_ops, record_ops, text_ops, text_pattern_ops, tid_ops, time_ops, timestamp_ops, timestamptz_ops, timetz_ops, tsquery_ops, tsvector_ops, uuid_ops, varbit_ops, varchar_ops, varchar_pattern_ops, xid8_ops, array_ops, jsonb_ops, jsonb_path_ops, tsvector_ops, box_ops, circle_ops, inet_ops, multirange_ops, point_ops, poly_ops, range_ops, tsquery_ops, tsvector_ops, aclitem_ops, array_ops, bool_ops, bpchar_ops, bpchar_pattern_ops, bytea_ops, char_ops, cid_ops, cidr_ops, date_ops, enum_ops, float4_ops, float8_ops, inet_ops, int2_ops, int4_ops, int8_ops, interval_ops, jsonb_ops, macaddr8_ops, macaddr_ops, multirange_ops, name_ops, numeric_ops, oid_ops, oidvector_ops, pg_lsn_ops, range_ops, record_ops, text_ops, text_pattern_ops, tid_ops, time_ops, timestamp_ops, timestamptz_ops, timetz_ops, uuid_ops, varchar_ops, varchar_pattern_ops, xid8_ops, xid_ops, box_ops, inet_ops, kd_point_ops, poly_ops, quad_point_ops, range_ops, text_ops, gin_trgm_ops, gist_trgm_ops, btree_geography_ops, btree_geometry_ops, gist_geography_ops, gist_geometry_ops_2d, gist_geometry_ops_nd, gist_geometry_ops_3d, hash_geometry_ops, brin_geography_inclusion_ops, brin_geometry_inclusion_ops_2d, brin_geometry_inclusion_ops_3d, brin_geometry_inclusion_ops_4d, spgist_geography_ops_nd, spgist_geometry_ops_2d, spgist_geometry_ops_3d, spgist_geometry_ops_nd)

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], [nulls_last, nulls_first]

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.partition

table.partition attributes

Name	Required	Value
columns	false	Partition columns can be one of: List of object reference to column List of object reference to table.column
type	true	enum (RANGE, LIST, HASH)

table.partition blocks

table.partition.by

table.partition.by attributes

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

table.partition.by constraints

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

table.partition constraints

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

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
deferrable	false	enum (INITIALLY_IMMEDIATE, INITIALLY_DEFERRED)
include	false	Primary key included columns can be one of: List of object reference to column List of object reference to table.column
page_per_range	false	int
type	false	Index key type can be one of: string enum (BTREE, BRIN, HASH, GIN, GIST, GiST, SPGIST, SPGiST)

table.primary_key constraints

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

table.row_security

table.row_security attributes

Name	Required	Value
enabled	false	bool
enforced	false	bool

table.row_security constraints

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

table.unique

table.unique attributes

Name	Required	Value
columns	true	Index columns can be one of: List of object reference to column List of object reference to table.column
comment	false	string
deferrable	false	enum (INITIALLY_IMMEDIATE, INITIALLY_DEFERRED)
include	false	Index included columns can be one of: List of object reference to column List of object reference to table.column
nulls_distinct	false	bool
page_per_range	false	int

table.unique 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

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	false	string
comment	false	string
for	false	enum (ROW, STATEMENT)
foreach	false	enum (ROW, STATEMENT)
from	false	Object reference to table
on	true	Trigger on can be one of: Object reference to table Object reference to view
when	false	string

Blocks

trigger.after

trigger.after attributes

Name	Required	Value
delete	false	bool
insert	false	bool
truncate	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
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[update, update_of]
One of required sets	[insert, delete, truncate, update, update_of]

trigger.before

trigger.before attributes

Name	Required	Value
delete	false	bool
insert	false	bool
truncate	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
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[update, update_of]
One of required sets	[insert, delete, truncate, update, update_of]

trigger.execute

trigger.execute attributes

Name	Required	Value
args	false	List of strings
function	false	Object reference to function
procedure	false	Object reference to procedure

trigger.execute constraints

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

trigger.instead_of

trigger.instead_of attributes

Name	Required	Value
delete	false	bool
insert	false	bool
truncate	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
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
Mutually exclusive sets	[update, update_of]
One of required sets	[insert, delete, truncate, update, update_of]

trigger.referencing

trigger.referencing attributes

Name	Required	Value
new_table	false	string
old_table	false	string

trigger.referencing constraints

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

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], [before, after, instead_of], [as, execute]
One of required sets	[before, after, instead_of], [as, execute]

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

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") Object reference to enum Object reference to domain Object reference to composite Object reference to table

view.column constraints

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

view.security

view.security attributes

Name	Required	Value
barrier	false	bool
invoker	false	bool

view.security constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	false
Allow unknown blocks	false
Allow unknown attributes	false
One of required sets	[invoker, barrier]

Constraints

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