PostgreSQL

This connector is used to query a PostgreSQL database using SQL.

Connection configuration

Two connection modes are available: password and connection_string.

Password mode

NameMandatoryDefaultDescription
modenopasswordConnection mode: password or connectionstring
hostnameyesServer hostname or IP address
databaseyesDatabase name
usernameyesUsername
passwordyesPassword
portno5432Port number
sslcontextnofalseEnable SSL connection

Connection string mode

NameMandatoryDefaultDescription
modeyesMust be connectionstring
connectionstringyesSQLAlchemy connection string

Example (password mode)

connections:
  postgresql_connection:
    type: postgresql
    hostname: my-server.postgres.database.azure.com
    database: my_database
    username: my_user
    password: $var.pg_password
    port: 5432
    ssl_context: true

Example (connection string mode)

connections:
  postgresql_connection:
    type: postgresql
    mode: connection_string
    connection_string: postgresql+pg8000://user:password@host:5432/database

Test case configuration

NameMandatoryDefaultDescription
queryyesSQL query to execute

Example

Example PostgreSQL:
  source:
    type: postgresql
    connection: postgresql_connection
    query: |
      SELECT *
      FROM employees
      WHERE hire_date < '2000-01-01'
  expected:
    type: csv
    path: data/employeesbefore2000.csv

Requirements

  • pip install pg8000 (included in ploosh full installation)