pg
Stores the state in a Postgres database version 10 or newer.
This backend supports state locking.
Example Configuration
Before initializing the backend with terraform init
, the database must already exist:
This createdb
command is found in Postgres client applications which are installed along with the database server.
We recommend using a
partial configuration
for the conn_str
variable, because it typically contains access credentials that should not be committed to source control:
Then, set the credentials when initializing the configuration:
To use a Postgres server running on the same machine as Terraform, configure localhost with SSL disabled:
Data Source Configuration
To make use of the pg remote state in another configuration, use the terraform_remote_state
data source.
Configuration Variables
The following configuration options or environment variables are supported:
conn_str
- (Required) Postgres connection string; apostgres://
URLschema_name
- Name of the automatically-managed Postgres schema, defaultterraform_remote_state
.skip_schema_creation
- If set totrue
, the Postgres schema must already exist. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator.skip_table_creation
- If set totrue
, the Postgres table must already exist. Terraform won't try to create the table, this is useful when it has already been created by a database administrator.skip_index_creation
- If set totrue
, the Postgres index must already exist. Terraform won't try to create the index, this is useful when it has already been created by a database administrator.
Technical Design
This backend creates one table states in the automatically-managed Postgres schema configured by the schema_name
variable.
The table is keyed by the workspace name. If workspaces are not in use, the name default
is used.
Locking is supported using Postgres advisory locks. force-unlock
is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the pg_locks
system view.
The states table contains:
- a serial integer
id
, used as the key for advisory locks - the workspace
name
key as text with a unique index - the Terraform state
data
as text