Connect Soda to DuckDB

Access configuration details to connect Soda to a DuckDB data source.

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-duckdb

data_source my_datasource_name:
  type: duckdb
  database: filename.db
  read_only: true
  schema_name: public

Property	Required	Notes
type	required	Identify the type of data source for Soda.
database	required	Identify the location of the duckdb database. Refer to DuckDB documentation for details on persistent storage and how to create a .db file. This can also be a MotherDuck database. Some users have reported issues using the database key, but have been successful using path instead.
read_only	required	Indicate users’ access by providing a boolean value: true or false
schema_name	optional	Provide an identifier for the schema in which your dataset exists.

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