Link Search Menu Expand Document

Connect Soda to ClickHouse (Experimental)

Last modified on 06-Dec-22

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.

Because Clickhouse is compatible with MySQL wire protocol, Soda offers indirect, experimental support for ClickHouse data sources using the soda-core-mysql package.

Configuration

data_source my_datasource_name:
  type: mysql
  connection:
    host: 
    port: `9004`
    username: xxx
    password: ...
    database:
Property Required Notes
type required  
host required  
port required  
username required Use system variables to retrieve this value securely.
password required Use system variables to retrieve this value securely.
database 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 CHAR, VARCHAR, TEXT
number BIG INT, NUMERIC, BIT, SMALLINT, DECIMAL, SMALLMONEY, INT, TINYINT, MONEY, FLOAT, REAL
time DATE, TIME, DATETIME, DATETIMEOFFSET




Was this documentation helpful?

What could we do to improve this page?


Last modified on 06-Dec-22