Spanner Schema

locality

The locality block defines a Spanner locality configuration.

locality_group "hot_data" {
  storage                    = "ssd"
  ssd_to_hdd_spill_timespan  = "24h"
}

locality attributes

Name	Required	Value
ssd_to_hdd_spill_timespan	false	string
storage	true	string

locality constraints

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

permission

The permission block grants privileges to a role or user.

permission {
  to         = role.app
  for        = table.users
  privileges = [SELECT]
  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 table.column Object reference to view.column
grantable	false	bool
privileges	true	List of strings or/and enums (SELECT, INSERT, UPDATE, DELETE)
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

placement

The placement block defines a Spanner instance placement configuration.

placement "europeplacement" {
  instance_partition = "euro-partition"
  default_leader     = "europe-west1"
}

placement attributes

Name	Required	Value
default_leader	false	string
instance_partition	true	string

placement constraints

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

property_graph

The property_graph block defines a Spanner Property Graph.

property_graph "graph_name" {
  schema = schema.public
  node_table {
    table = table.users
    as = "Person"
    key {
      columns = [table.users.column.id]
    }
  }
  
  edge_table {
    table = table.follows
    key {
      columns = [table.follows.column.id]
    }
    source_key {
      columns = [table.follows.column.from_id]
      ref_columns = [table.users.column.id]
    }
    destination_key {
      columns = [table.follows.column.to_id]
      ref_columns = [table.users.column.id]
    }
  }
}

property_graph attributes

Name	Required	Value
schema	true	Object reference to schema

property_graph blocks

property_graph.edge_table

property_graph.edge_table attributes

Name	Required	Value
as	false	string
table	true	Object reference to table

property_graph.edge_table blocks

property_graph.edge_table.destination_key

property_graph.edge_table.destination_key attributes

Name	Required	Value
columns	true	List of object reference to table.column
ref_columns	false	List of object reference to table.column

property_graph.edge_table.destination_key constraints

Constraint	Value
Required	true
Require Name	false

property_graph.edge_table.key

property_graph.edge_table.key attributes

Name	Required	Value
columns	true	List of object reference to table.column

property_graph.edge_table.source_key

property_graph.edge_table.source_key attributes

Name	Required	Value
columns	true	List of object reference to table.column
ref_columns	false	List of object reference to table.column

property_graph.edge_table.source_key constraints

Constraint	Value
Required	true
Require Name	false

property_graph.edge_table constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	true

property_graph.node_table

property_graph.node_table attributes

Name	Required	Value
as	false	string
table	true	Object reference to table

property_graph.node_table blocks

property_graph.node_table.key

property_graph.node_table.key attributes

Name	Required	Value
columns	true	List of object reference to table.column

property_graph.node_table constraints

Constraint	Value
Required	true
Require Name	false
Repeatable	true

property_graph constraints

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

role

The role block describes a database role.

role "app" {
  member_of = [role.parent]
}

role attributes

Name	Required	Value
member_of	false	List of object reference to role
name	false	string

role constraints

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

schema

The schema block describes a database schema.

schema "public" {
  ...
}

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

sequence

The sequence block defines a Spanner sequence.

sequence "order_seq" {
  kind               = "bit_reversed_positive"
  skip_range_min 	 = 1000
  skip_range_max 	 = 2000
  start_with_counter = 5000
}

sequence attributes

Name	Required	Value
kind	true	enum (bit_reversed_positive)
skip_range_max	false	int
skip_range_min	false	int
start_with_counter	false	int

sequence blocks

sequence.annotation

sequence.annotation constraints

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

sequence constraints

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

stream

The stream block defines a Spanner change stream.

stream "stream_name" {
  for_all = true // track all tables, or use tables = [...] for specific tables
  options = { 
     "option_1" = "option_val"
     "option_2" = "option_val"
   }
  for {
    table   = table.Users
    columns = [column.Name, column.Email]
  }
}

stream attributes

Name	Required	Value
for_all	false	bool
options	false	map
tables	false	List of object references

stream blocks

stream.for

stream.for attributes

Name	Required	Value
columns	false	List of object references
table	false	Object reference

stream constraints

Constraint	Value
Required	false
Require Name (e.g., stream "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
depends_on	false	List of object references
locality_group	false	Object reference
row_deletion_policy	false	Raw expression defined with sql("expr")
schema	true	Object reference to schema

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
expr	true	string

table.check constraints

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

table.column

table.column attributes

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

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 (STORED, HIDDEN)

table.column.options

table.column.options attributes

Name	Required	Value
allow_commit_timestamp	false	bool
locality_group	false	Object reference

table.column constraints

Constraint	Value
Required	false
Require Name (e.g., table.column "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
on_delete	false	enum (NO_ACTION, CASCADE)
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 and description	Required	Value
columns	false	Index columns can be one of: List of object reference to column List of object reference to table.column
disable_search	false	bool
distance_type	false	enum (COSINE, DOT_PRODUCT, EUCLIDEAN)
include	false	Index included columns can be one of: List of object reference to column List of object reference to table.column
interleave_in	false	Object reference
null_filtered	false	bool
num_branches	false	int
num_leaves	false	int
partition_by	false	Search index partition columns can be one of: List of object reference to column List of object reference to table.column
search_index Deprecated: use type = SEARCH instead	false	bool
sort_order_sharding	false	bool
tree_depth	false	int
type	false	enum (SEARCH, VECTOR)
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

table.index.on constraints

Constraint	Value
Required	false
Require Name	false
Repeatable	true

table.index.order_by

table.index.order_by attributes

Name	Required	Value
column	false	Search index order column can be one of: Object reference to column Object reference to table.column
desc	false	bool

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

The interleave block defines a Spanner interleaved table relationship.

table "name" {
  schema = schema.public
  interleave {
    parent    = table.parent_table
    type      = IN_PARENT
    on_delete = CASCADE
  }
}

table.interleave attributes

Name	Required	Value
on_delete	false	enum (NO_ACTION, CASCADE)
parent	true	Object reference to table
type	false	enum (IN_PARENT, IN)

table.primary_key

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

table.primary_key blocks

table.primary_key.on

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

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

user

The user block describes a database user.

user "app_user" {
  member_of = [role.app]
}

user attributes

Name	Required	Value
member_of	false	List of object reference to role
name	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
depends_on	false	List of object references
schema	true	Object reference to schema
security	true	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 constraints

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