Postgres Connection

Connection to a PostgreSQL database.

Examples

postgres_connection_basic.yaml

connection:
  postgres:
    host: your-hostname
    user: your-username
    password: "${secret.my_vault_name.password}"

postgres_connection_schema_port.yaml

connection:
  postgres:
    host: your-hostname
    user: your-username
    password: "${secret.my_vault_name.password}"
    schema: your-schema
    port: 5432

postgres_connection_setup.yaml

connection:
  postgres:
    host: your-hostname
    user: your-username
    password: "${secret.my_vault_name.password}"
    database: your-database
    schema: your-schema
    port: 5432

PostgresConnection

info

PostgresConnection is defined beneath the following ancestor nodes in the YAML structure:

• Connection

Below are the properties for the PostgresConnection. Each property links to the specific details section further down in this page.

Property	Default	Type	Required	Description
name		string	No	The name of the model
description		string	No	A brief description of what the model does.
metadata		ResourceMetadata	No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
postgres		PostgresConnectionOptions	Yes	The PostgreSQL connection options.

Property Details

Connection

A connection to a data source/sink.

Property	Default	Type	Required	Description
connection		One of:   S3Connection   GcsConnection   AbfsConnection   LocalFileConnection   SnowflakeConnection   BigQueryConnection   MSSQLConnection   MySQLConnection   OracleConnection   PostgresConnection   HttpConnection   DuckDBConnection   CustomPythonConnection   SynapseConnection	Yes	The connection to the data system.

PostgresConnectionOptions

PostgreSQL connection options.

Property	Default	Type	Required	Description
host		string	Yes	The PostgreSQL host to connect to.
user		string	Yes	The PostgreSQL user to connect as.
password		string	Yes	The PostgreSQL password to use for the connection.
database		string	No	The PostgreSQL database to connect to.
schema	public	string	No	The PostgreSQL schema to use.
port		integer	No	The PostgreSQL port to connect to.

ResourceMetadata

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

Property	Default	Type	Required	Description
source		ResourceLocation	No	The origin or source information for the resource.
source_event_uuid		string	No	UUID of the event that is associated with creation of this resource.

ResourceLocation

The origin or source information for the resource.

Property	Default	Type	Required	Description
path		string	Yes	Path within repository files where the resource is defined.
first_line_number		integer	No	First line number within path file where the resource is defined.