Link Search Menu Expand Document

Connect Soda to PostgreSQL

Last modified on 29-Nov-24

For Soda to run quality scans on your data, you must configure it to connect to your data source.
To learn how to set up Soda and configure it to connect to your data sources, see Get started.

Connection configuration reference

Install package: soda-postgres

data_source my_datasource_name:
  type: postgres
  host: db
  port: "5432"
  username: soda
  password: secret
  database: postgres
  schema: public
  sslmode: prefer
Property Required Notes
type required Identify the type of data source for Soda.
host required Provide a host identifier.
port required Provide a port identifier.
username required Consider using system variables to retrieve this value securely.
password required Consider using system variables to retrieve this value securely.
database required Provide an identifier for your database.
schema optional Provide an identifier for the schema in which your dataset exists.
sslmode optional Provide a value to indicate the type of SSL support:
prefer
require
allow
diable
Default value is prefer.

Test the data source connection

To confirm that you have correctly configured the connection details for the data source(s) in your configuration YAML file, use the test-connection command. If you wish, add a -V option to the command to returns results in verbose mode in the CLI.

soda test-connection -d my_datasource -c configuration.yml -V

Supported data types

Category Data type
text CHARACTER VARYING, CHARACTER, CHAR, TEXT
number SMALLINT, INTEGER, BIGINT, DECIMAL, NUMERIC, VARIABLE, REAL, DOUBLE PRECISION, SMALLSERIAL, SERIAL, BIGSERIAL
time TIMESTAMP, DATE, TIME, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITHOUT TIME ZONE, TIME WITH TIME ZONE, TIME WITHOUT TIME ZONE




Was this documentation helpful?

What could we do to improve this page?

Documentation always applies to the latest version of Soda products
Last modified on 29-Nov-24