PostgreSQL Schema

`aggregate`

`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`	Aggregate state function can be one of: Object reference to `function` enum (numeric_add, numeric_mul, numeric_avg_accum, numeric_avg, numeric_avg_serialize, numeric_avg_deserialize, numeric_avg_combine, numeric_smaller, numeric_larger, int4pl, int4_avg_accum, int8inc, int8inc_any, int8_avg, int8pl, int8mi, int2pl, int2mi, int4larger, int4smaller, int8larger, int8smaller, float4pl, float4mi, float8pl, float8mi, float4mul, float8mul, float4larger, float4smaller, float8larger, float8smaller, ordered_set_transition, ordered_set_transition_multi, percentile_disc_final, percentile_cont_final, rank_final, dense_rank_final, percent_rank_final, cume_dist_final, array_agg_transfn, array_agg_finalfn, textcat, text_larger, text_smaller, booland_statefunc, boolor_statefunc, booland_statefunc_inv, boolor_statefunc_inv, bitand, bitor, bitxor, point_add, point_sub, json_agg_transfn, json_agg_finalfn, jsonb_agg_transfn, jsonb_agg_finalfn) `string`
`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 `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`

`aggregate` 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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`aggregate.arg` constraints

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

`aggregate` constraints

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

`cast`

The cast block describes a type cast in the database.

# Binary coercion cast (WITHOUT FUNCTION)
cast {
  source = text
  target = composite.my_type
}

# I/O conversion cast (WITH INOUT)
cast {
  source = int4
  target = composite.my_type
  with   = INOUT
}

# Function-based cast (WITH FUNCTION)
cast {
  source = int4
  target = composite.my_type
  with   = function.int4_to_my_type
  as     = IMPLICIT
}

`cast` attributes

Name	Required	Value
`as`	`false`	`enum (ASSIGNMENT, IMPLICIT)`
`source`	`true`	Cast source type can be one of: Schema type Raw expression defined with `sql("expr")` Object reference to `enum` Object reference to `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`
`target`	`true`	Cast target type can be one of: Schema type Raw expression defined with `sql("expr")` Object reference to `enum` Object reference to `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`
`with`	`false`	Cast method (INOUT, function reference, or function expression) can be one of: `enum (INOUT)` Object reference to `function` Raw expression defined with `sql("expr")` `string`

`cast` constraints

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

`collation`

The collation block describes a collation in the schema.

collation "french" {
  schema   = schema.public
  locale   = "fr-x-icu"
  provider = icu
}

collation "german" {
  schema = schema.public
  from   = "german_phonebook"
}

`collation` attributes

Name	Required	Value
`comment`	`false`	`string`
`deterministic`	`false`	`bool`
`lc_collate`	`false`	`string`
`lc_ctype`	`false`	`string`
`locale`	`false`	`string`
`name`	`false`	`string`
`provider`	`false`	Collation provider can be one of: `string` `enum (libc, icu, builtin)`
`rules`	`false`	`string`
`schema`	`true`	Object reference to `schema`
`version`	`false`	`string`

`collation` constraints

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

`composite`

The composite block describes a composite type in the schema.

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

`composite` attributes

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

`composite` blocks

`composite.field`

`composite.field` attributes

Name Required Value

collate

false

Field collation can be one of:

string
Object reference to collation

type

true

Field type can be one of:

Schema type
Raw expression defined with sql("expr")
Object reference to enum
Object reference to range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`composite.field` constraints

Constraint	Value
Required	`true`
Require Name (e.g., `composite.field "name"` )	`true`

`composite` constraints

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

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

`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 = "..."
  }
}

`domain` 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 `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`

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

`domain` constraints

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

`enum`

The enum block describes an ENUM type in the schema.

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

`enum` attributes

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

`enum` constraints

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

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

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

`event_trigger` constraints

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

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

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

`extension` constraints

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

`foreign_table`

`foreign_table` attributes

Name	Required	Value
`comment`	`false`	`string`
`depends_on`	`false`	List of object references
`options`	`false`	`map`
`replica_identity`	`false`	`enum (NOTHING)`
`schema`	`true`	Object reference to `schema`
`server`	`true`	The reference or a name of an existing foreign server to use for the foreign table can be one of: Object reference to `server` `string`

`foreign_table` blocks

`foreign_table.check`

`foreign_table.check` attributes

Name	Required	Value
`comment`	`false`	`string`
`expr`	`true`	`string`

`foreign_table.check` constraints

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

`foreign_table.column`

`foreign_table.column` attributes

Name	Required	Value
`as`	`false`	`string`
`collate`	`false`	Column collation can be one of: `string` Object reference to `collation`
`comment`	`false`	`string`
`null`	`false`	`bool`
`options`	`false`	`map`
`type`	`true`	Column type can be one of: Schema type Raw expression defined with `sql("expr")` Object reference to `enum` Object reference to `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`

`foreign_table.column` blocks

`foreign_table.column.as`

`foreign_table.column.as` attributes

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

`foreign_table.column` constraints

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

`foreign_table` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `foreign_table "name"` )	`true`
Allow Qualifier (e.g., `foreign_table "schema" "name"` )	`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`
`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 `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`
`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 `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`
`schema`	`true`	Object reference to `schema`
`security`	`false`	`enum (DEFINER, INVOKER)`
`strict`	`false`	`bool`
`volatility`	`false`	`enum (VOLATILE, STABLE, IMMUTABLE)`

`function` 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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`function.arg` constraints

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

`function.config_params`

The config_params block describes the configuration parameters to be set when the function is entered.

config_params {
  search_path         = "public"
  work_mem            = "64MB"
  client_min_messages = "warning"
  // Other custom configuration parameters.
}

`function.config_params` attributes

Name	Required	Value
`schema`	`false`	`string`
`search_path`	`false`	`string`
`statement_timeout`	`false`	`string`
`work_mem`	`false`	`string`

`function.config_params` constraints

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

`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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`function.return_table.column` constraints

Constraint	Value
Required	`true`
Require Name (e.g., `function.return_table.column "name"` )	`true`

`function` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `function "name"` )	`true`
Allow Qualifier (e.g., `function "schema" "name"` )	`true`
Repeatable	`true`
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
  }
  ...
}

`materialized` attributes

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

`materialized` 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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`materialized.column` constraints

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

`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`
Mutually exclusive sets	`[column, expr]`, `[nulls_last, nulls_first]`

`materialized.index.storage_params`

`materialized.index.storage_params` attributes

Name	Required	Value
`autosummarize`	`false`	`bool`
`buffering`	`false`	`enum (ON, OFF, AUTO)`
`deduplicate_items`	`false`	`bool`
`fastupdate`	`false`	`bool`
`fillfactor`	`false`	`int`
`gin_pending_list_limit`	`false`	`int`
`pages_per_range`	`false`	`int`

`materialized.index.storage_params` constraints

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

`materialized.index` constraints

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

`materialized` constraints

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

`partition`

The partition block describes a partition in the schema.

partition "cities_partition" {
  of = table.cities
}

partition "cities_1000_to_100000" {
  of = table.cities
  range {
    from = [1000]
    to = [100000]
  }
}

partition "orders_p1" {
  of = table.orders
  with {
    modules = 4
    remainder = 0
  }
}

`partition` attributes

Name	Required	Value
`comment`	`false`	`string`
`name`	`false`	`string`
`of`	`true`	Parent table can be one of: Object reference to `table` Object reference to `partition`
`replica_identity`	`false`	Replica identity for logical replication can be one of: `enum (DEFAULT, NOTHING, FULL)` Object reference to `index`
`schema`	`true`	Object reference to `schema`

`partition` blocks

`partition.check`

`partition.check` attributes

Name	Required	Value
`expr`	`true`	`string`

`partition.check` constraints

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

`partition.column`

`partition.column` attributes

Name Required Value

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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`partition.column` constraints

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

`partition.foreign_key`

`partition.foreign_key` attributes

Name	Required	Value
`columns`	`true`	Foreign key columns can be one of: List of object reference to `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`

`partition.foreign_key` constraints

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

`partition.hash`

`partition.hash` attributes

Name	Required	Value
`modulus`	`true`	`int`
`remainder`	`true`	`int`

`partition.index`

`partition.index` attributes

Name and description	Required	Value
`attached_to` The index on a partitioned table to which this index is attached. `partition "cities_1000_to_100000" { of = table.cities ... index "cities_1000_to_100000_idx" { columns = [column.population] attached_to = table.cities.index.population_idx } }`	`false`	Object reference to `table.index`
`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`

`partition.index` blocks

`partition.index.on`

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

`partition.index.on` constraints

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

`partition.index.storage_params`

`partition.index.storage_params` attributes

Name	Required	Value
`autosummarize`	`false`	`bool`
`buffering`	`false`	`enum (ON, OFF, AUTO)`
`deduplicate_items`	`false`	`bool`
`fastupdate`	`false`	`bool`
`fillfactor`	`false`	`int`
`gin_pending_list_limit`	`false`	`int`
`pages_per_range`	`false`	`int`

`partition.index.storage_params` constraints

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

`partition.index` constraints

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

`partition.list`

`partition.list` attributes

Name	Required	Value
`in`	`true`	List of strings

`partition.partition`

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

`partition.partition` blocks

`partition.partition.by`

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

`partition.partition.by` constraints

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

`partition.range`

`partition.range` attributes

Name	Required	Value
`from`	`true`	List of strings
`to`	`true`	List of strings

`partition.storage_params`

`partition.storage_params` attributes

Name	Required	Value
`autovacuum_analyze_scale_factor`	`false`	`number`
`autovacuum_analyze_threshold`	`false`	`int`
`autovacuum_enabled`	`false`	`bool`
`autovacuum_freeze_max_age`	`false`	`int`
`autovacuum_freeze_min_age`	`false`	`int`
`autovacuum_freeze_table_age`	`false`	`int`
`autovacuum_multixact_freeze_max_age`	`false`	`int`
`autovacuum_multixact_freeze_min_age`	`false`	`int`
`autovacuum_multixact_freeze_table_age`	`false`	`int`
`autovacuum_vacuum_cost_delay`	`false`	`number`
`autovacuum_vacuum_cost_limit`	`false`	`int`
`autovacuum_vacuum_insert_scale_factor`	`false`	`number`
`autovacuum_vacuum_insert_threshold`	`false`	`int`
`autovacuum_vacuum_max_threshold`	`false`	`int`
`autovacuum_vacuum_scale_factor`	`false`	`number`
`autovacuum_vacuum_threshold`	`false`	`int`
`fillfactor`	`false`	`int`
`log_autovacuum_min_duration`	`false`	`int`
`parallel_workers`	`false`	`int`
`toast_tuple_target`	`false`	`int`
`user_catalog_table`	`false`	`bool`
`vacuum_index_cleanup`	`false`	`enum (ON, OFF, AUTO)`
`vacuum_max_eager_freeze_failure_rate`	`false`	`number`
`vacuum_truncate`	`false`	`bool`

`partition.storage_params` constraints

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

`partition` constraints

Constraint	Value
Required	`false`
Require Name	`false`
Repeatable	`true`
Mutually exclusive sets	`[hash, range, list]`

`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 {
  to         = PUBLIC
  for        = table.users
  privileges = [SELECT]
}

`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 `sequence` Object reference to `table.column` Object reference to `view.column`
`grantable`	`false`	`bool`
`privileges`	`true`	List of strings or/and `enums (SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, CREATE, CONNECT, TEMPORARY, EXECUTE, USAGE, SET, ALTER_SYSTEM, MAINTAIN, ALL)`
`to`	`true`	Permission grantee can be one of: `enum (PUBLIC)` `string` Object reference to `role` Object reference to `user`

`permission` constraints

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

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

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

`policy` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `policy "name"` )	`true`
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`
`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)`

`procedure` 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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`procedure.arg` constraints

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

`procedure.config_params`

The config_params block describes the configuration parameters to be set when the procedure is entered.

config_params {
  search_path         = "public"
  work_mem            = "64MB"
  client_min_messages = "warning"
  // Other custom configuration parameters.
}

`procedure.config_params` attributes

Name	Required	Value
`schema`	`false`	`string`
`search_path`	`false`	`string`
`statement_timeout`	`false`	`string`
`work_mem`	`false`	`string`

`procedure.config_params` constraints

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

`procedure` constraints

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

`range`

The range block describes a range type in the schema.

range "time_range" {
  schema          = schema.public
  subtype         = time
  subtype_diff    = function.time_diff
  multirange_name = "multirange_name"
}

`range` attributes

Name	Required	Value
`comment`	`false`	`string`
`multirange_name`	`false`	`string`
`name`	`false`	`string`
`schema`	`true`	Object reference to `schema`
`subtype`	`true`	Range subtype can be one of: Schema type Raw expression defined with `sql("expr")` Object reference to `enum` Object reference to `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`
`subtype_diff`	`false`	Range subtype difference function can be one of: Object reference to `function` `string`

`range` constraints

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

`role`

The role block describes a database role.

role "admin" {
  superuser   = true
  create_db   = true
  create_role = true
  member_of   = [role.dba]
  comment     = "Administrator role"
}

`role` attributes

Name	Required	Value
`bypass_rls`	`false`	`bool`
`comment`	`false`	`string`
`conn_limit`	`false`	`int`
`create_db`	`false`	`bool`
`create_role`	`false`	`bool`
`inherit`	`false`	`bool`
`login`	`false`	`bool`
`member_of`	`false`	List of object reference to `role`
`name`	`false`	`string`
`replication`	`false`	`bool`
`superuser`	`false`	`bool`

`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
`comment`	`false`	`string`
`name`	`false`	`string`

`schema` constraints

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

`sequence`

The sequence block describes a sequence in a database schema.

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

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

`sequence` constraints

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

`server`

The server block describes a foreign server in the database.

server "foreign_server_name" {
  fdw     = extension.postgres_fdw
  options = {
    host   = "127.0.0.1"
    port   = "5432"
    dbname = "postgres"
  }
}

server "foreign_server_name" {
  fdw     = "foreign_data_wrapper_name"
  options = {
    host   = "127.0.0.1"
    port   = "5432"
    dbname = "postgres"
  }
}

`server` attributes

Name and description	Required	Value
`comment`	`false`	`string`
`depends_on` The `depends_on` attribute specifies the extensions that this server depends on.	`false`	List of object reference to `extension`
`fdw`	`true`	Foreign data wrapper can be one of: Object reference to `extension` `string`
`options`	`false`	`map`
`type`	`false`	`string`
`version`	`false`	`string`

`server` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `server "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
`access_method`	`false`	Table access method can be one of: `string` `enum (heap)`
`comment`	`false`	`string`
`depends_on`	`false`	List of object references
`replica_identity`	`false`	Replica identity for logical replication can be one of: `enum (DEFAULT, NOTHING, FULL)` Object reference to `index`
`schema`	`true`	Object reference to `schema`
`unlogged`	`false`	`bool`

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

`table.column`

`table.column` attributes

Name	Required	Value
`as`	`false`	`string`
`collate`	`false`	Column collation can be one of: `string` Object reference to `collation`
`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 `range` Object reference to `domain` Object reference to `composite` Object reference to `table` Object reference to `view`

`table.column` blocks

`table.column.as`

`table.column.as` attributes

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

`table.column.identity`

`table.column.identity` attributes

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

`table.column` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `table.column "name"` )	`true`
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`
Mutually exclusive sets	`[column, expr]`

`table.exclude` constraints

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

`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 (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`
`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`
Mutually exclusive sets	`[column, expr]`, `[nulls_last, nulls_first]`

`table.index.storage_params`

`table.index.storage_params` attributes

Name	Required	Value
`autosummarize`	`false`	`bool`
`buffering`	`false`	`enum (ON, OFF, AUTO)`
`deduplicate_items`	`false`	`bool`
`fastupdate`	`false`	`bool`
`fillfactor`	`false`	`int`
`gin_pending_list_limit`	`false`	`int`
`pages_per_range`	`false`	`int`

`table.index.storage_params` constraints

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

`table.index` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `table.index "name"` )	`true`
Mutually exclusive sets	`[columns, on]`, `[page_per_range, storage_params]`
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`
Mutually exclusive sets	`[column, expr]`

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

`table.primary_key.storage_params`

`table.primary_key.storage_params` attributes

Name	Required	Value
`autosummarize`	`false`	`bool`
`buffering`	`false`	`enum (ON, OFF, AUTO)`
`deduplicate_items`	`false`	`bool`
`fastupdate`	`false`	`bool`
`fillfactor`	`false`	`int`
`gin_pending_list_limit`	`false`	`int`
`pages_per_range`	`false`	`int`

`table.primary_key.storage_params` constraints

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

`table.primary_key` constraints

Constraint	Value
Required	`false`
Require Name	`false`
Mutually exclusive sets	`[page_per_range, storage_params]`

`table.row_security`

`table.row_security` attributes

Name	Required	Value
`enabled`	`false`	`bool`
`enforced`	`false`	`bool`

`table.storage_params`

`table.storage_params` attributes

Name	Required	Value
`autovacuum_analyze_scale_factor`	`false`	`number`
`autovacuum_analyze_threshold`	`false`	`int`
`autovacuum_enabled`	`false`	`bool`
`autovacuum_freeze_max_age`	`false`	`int`
`autovacuum_freeze_min_age`	`false`	`int`
`autovacuum_freeze_table_age`	`false`	`int`
`autovacuum_multixact_freeze_max_age`	`false`	`int`
`autovacuum_multixact_freeze_min_age`	`false`	`int`
`autovacuum_multixact_freeze_table_age`	`false`	`int`
`autovacuum_vacuum_cost_delay`	`false`	`number`
`autovacuum_vacuum_cost_limit`	`false`	`int`
`autovacuum_vacuum_insert_scale_factor`	`false`	`number`
`autovacuum_vacuum_insert_threshold`	`false`	`int`
`autovacuum_vacuum_max_threshold`	`false`	`int`
`autovacuum_vacuum_scale_factor`	`false`	`number`
`autovacuum_vacuum_threshold`	`false`	`int`
`fillfactor`	`false`	`int`
`log_autovacuum_min_duration`	`false`	`int`
`parallel_workers`	`false`	`int`
`toast_tuple_target`	`false`	`int`
`user_catalog_table`	`false`	`bool`
`vacuum_index_cleanup`	`false`	`enum (ON, OFF, AUTO)`
`vacuum_max_eager_freeze_failure_rate`	`false`	`number`
`vacuum_truncate`	`false`	`bool`

`table.storage_params` constraints

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

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

`table.unique` blocks

`table.unique.storage_params`

`table.unique.storage_params` attributes

Name	Required	Value
`autosummarize`	`false`	`bool`
`buffering`	`false`	`enum (ON, OFF, AUTO)`
`deduplicate_items`	`false`	`bool`
`fastupdate`	`false`	`bool`
`fillfactor`	`false`	`int`
`gin_pending_list_limit`	`false`	`int`
`pages_per_range`	`false`	`int`

`table.unique.storage_params` constraints

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

`table.unique` constraints

Constraint	Value
Required	`false`
Require Name (e.g., `table.unique "name"` )	`true`
Mutually exclusive sets	`[page_per_range, storage_params]`

`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`	`false`	`string`
`comment`	`false`	`string`
`constraint`	`false`	`bool`
`deferrable`	`false`	`enum (INITIALLY_IMMEDIATE, INITIALLY_DEFERRED)`
`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` Object reference to `partition`
`when`	`false`	`string`

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

`trigger` constraints

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

`user`

The user block describes a database user.

user "app_user" {
  password    = "<sensitive>"
  valid_until = "2025-12-31 23:59:59+00"
  member_of   = [role.readers]
  comment     = "Application user"
}

`user` attributes

Name	Required	Value
`bypass_rls`	`false`	`bool`
`comment`	`false`	`string`
`conn_limit`	`false`	`int`
`create_db`	`false`	`bool`
`create_role`	`false`	`bool`
`inherit`	`false`	`bool`
`member_of`	`false`	List of object reference to `role`
`name`	`false`	`string`
`password`	`false`	`string`
`replication`	`false`	`bool`
`superuser`	`false`	`bool`
`valid_until`	`false`	`string`

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

`view` 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 range
Object reference to domain
Object reference to composite
Object reference to table
Object reference to view

`view.column` constraints

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

`view.security`

`view.security` attributes

Name	Required	Value
`barrier`	`false`	`bool`
`invoker`	`false`	`bool`

`view.security` constraints

Constraint	Value
Required	`false`
Require Name	`false`
One of required sets	`[invoker, barrier]`

`view` constraints

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

aggregate
- aggregate attributes
- aggregate blocks
- aggregate constraints
cast
- cast attributes
- cast constraints
collation
- collation attributes
- collation constraints
composite
- composite attributes
- composite blocks
- composite constraints
data
- data attributes
- data constraints
domain
- domain attributes
- domain blocks
- domain constraints
enum
- enum attributes
- enum constraints
event_trigger
- event_trigger attributes
- event_trigger constraints
extension
- extension attributes
- extension constraints
foreign_table
- foreign_table attributes
- foreign_table blocks
- foreign_table constraints
function
- function attributes
- function blocks
- function constraints
materialized
- materialized attributes
- materialized blocks
- materialized constraints
partition
- partition attributes
- partition blocks
- partition constraints
permission
- permission attributes
- permission constraints
policy
- policy attributes
- policy constraints
procedure
- procedure attributes
- procedure blocks
- procedure constraints
range
- range attributes
- range constraints
role
- role attributes
- role constraints
schema
- schema attributes
- schema constraints
sequence
- sequence attributes
- sequence constraints
server
- server attributes
- server constraints
table
- table attributes
- table blocks
- table constraints
trigger
- trigger attributes
- trigger blocks
- trigger constraints
user
- user attributes
- user constraints
view
- view attributes
- view blocks
- view constraints

aggregate​

aggregate attributes​

aggregate blocks​

aggregate.arg​

aggregate.arg attributes​

aggregate.arg constraints​

aggregate constraints​

cast​

cast attributes​

cast constraints​

collation​

collation attributes​

collation constraints​

composite​

composite attributes​

composite blocks​

composite.field​

composite.field attributes​

composite.field constraints​

composite constraints​

data​

data attributes​

data constraints​

domain​

domain attributes​

domain blocks​

domain.check​

domain.check attributes​

domain.check constraints​

domain constraints​

enum​

enum attributes​

enum constraints​

event_trigger​

event_trigger attributes​

event_trigger constraints​

extension​

extension attributes​

extension constraints​

foreign_table​

foreign_table attributes​

foreign_table blocks​

foreign_table.check​

foreign_table.check attributes​

foreign_table.check constraints​

foreign_table.column​

foreign_table.column attributes​

foreign_table.column blocks​

foreign_table.column.as​

foreign_table.column.as attributes​

foreign_table.column constraints​

foreign_table constraints​

function​

function attributes​

function blocks​

function.arg​

function.arg attributes​

function.arg constraints​

function.config_params​

function.config_params attributes​

function.config_params constraints​

function.return_table​

function.return_table blocks​

function.return_table.column​

function.return_table.column attributes​

function.return_table.column constraints​

function constraints​

materialized​

materialized attributes​

materialized blocks​

materialized.column​

materialized.column attributes​

materialized.column constraints​

materialized.index​

materialized.index attributes​

materialized.index blocks​

materialized.index.on​

materialized.index.on attributes​

materialized.index.on constraints​

materialized.index.storage_params​

`aggregate`

`aggregate` attributes

`aggregate` blocks

`aggregate.arg`

`aggregate.arg` attributes

`aggregate.arg` constraints

`aggregate` constraints

`cast`

`cast` attributes

`cast` constraints

`collation`

`collation` attributes

`collation` constraints

`composite`

`composite` attributes

`composite` blocks

`composite.field`

`composite.field` attributes

`composite.field` constraints

`composite` constraints

`data`

`data` attributes

`data` constraints

`domain`

`domain` attributes

`domain` blocks

`domain.check`

`domain.check` attributes

`domain.check` constraints

`domain` constraints

`enum`

`enum` attributes

`enum` constraints

`event_trigger`

`event_trigger` attributes

`event_trigger` constraints

`extension`

`extension` attributes

`extension` constraints

`foreign_table`

`foreign_table` attributes

`foreign_table` blocks

`foreign_table.check`

`foreign_table.check` attributes

`foreign_table.check` constraints

`foreign_table.column`

`foreign_table.column` attributes

`foreign_table.column` blocks

`foreign_table.column.as`

`foreign_table.column.as` attributes

`foreign_table.column` constraints

`foreign_table` constraints

`function`

`function` attributes

`function` blocks

`function.arg`

`function.arg` attributes

`function.arg` constraints

`function.config_params`

`function.config_params` attributes

`function.config_params` constraints

`function.return_table`

`function.return_table` blocks

`function.return_table.column`

`function.return_table.column` attributes

`function.return_table.column` constraints

`function` constraints

`materialized`

`materialized` attributes

`materialized` blocks

`materialized.column`

`materialized.column` attributes

`materialized.column` constraints

`materialized.index`

`materialized.index` attributes

`materialized.index` blocks

`materialized.index.on`

`materialized.index.on` attributes

`materialized.index.on` constraints

`materialized.index.storage_params`