Skip to main content
Version: 3.0.0

Postgres Connection

Connection to a PostgreSQL database.

Examples​

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

PostgresConnection​

info

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

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

PropertyDefaultTypeRequiredDescription
descriptionstring
NoA brief description of what the model does.
metadataNoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
ssh_tunnelstring
No
postgresYesThe PostgreSQL connection options.

Property Details​

Connection​

A connection to a data source/sink.

PropertyDefaultTypeRequiredDescription
connectionOne of:
  S3Connection
  GcsConnection
  AbfsConnection
  LocalFileConnection
  SnowflakeConnection
  BigQueryConnection
  MSSQLConnection
  MySQLConnection
  OracleConnection
  PostgresConnection
  HttpConnection
  DuckDBConnection
  SFTPConnection
  DatabricksConnection
YesThe connection to the data system.

PostgresConnectionOptions​

PostgreSQL connection options.

PropertyDefaultTypeRequiredDescription
hoststringYesThe PostgreSQL host to connect to.
userstringYesThe PostgreSQL user to connect as.
passwordstringYesThe PostgreSQL password to use for the connection.
databasestringYesThe PostgreSQL database to connect to.
schemapublicstring
NoThe PostgreSQL schema to use.
portinteger
NoThe 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.

PropertyDefaultTypeRequiredDescription
sourceNoThe origin or source information for the resource.
source_event_uuidstring
NoUUID of the event that is associated with creation of this resource.

ResourceLocation​

The origin or source information for the resource.

PropertyDefaultTypeRequiredDescription
pathstringYesPath within repository files where the resource is defined.
first_line_numberinteger
NoFirst line number within path file where the resource is defined.