Connect Soda to PostgreSQL
Last modified on 31-May-23
For Soda to run quality scans of your data, you must configure it to connect to your data source.
- For Soda Core, add the connection configurations to your
configuration.yml
file. Read more. - For Soda Cloud, add the connection configurations to step 3 of the New Data Source workflow. Read more.
Configuration
Install package: soda-core-postgres
data_source my_datasource_name:
type: postgres
connection:
host: db
port: "5432"
username:
password:
database: postgres
schema: public
Property | Required | Notes |
---|---|---|
type | required | |
host | required | |
port | optional | |
username | required | Consider using system variables to retrieve this value securely. |
password | required | Consider using system variables to retrieve this value securely. |
database | required | |
schema | required |
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?
- Suggest a docs change in GitHub.
- Share feedback in the Soda community on Slack.
Last modified on 31-May-23