Connect Soda to Azure Synapse (Experimental)
Last modified on 27-Sep-23
For Soda to run quality scans of your data, you must configure it to connect to your data source.
- For Soda Library, 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
Because Synapse is compatible with MS SQL server wire protocol, Soda offers indirect, experimental support for Synapse data sources using the soda-sqlserver
package.
data_source my_datasource_name:
type: sqlserver
driver: SQL Server Native Client 11.0
host: my_server.sql.azuresynapse.net
port: '1433'
database: my_database
username: my_user_name
password: my_password
encrypt: true
Property | Required | Notes |
---|---|---|
type | required | |
driver | required | Use this config setting to specify the ODBC driver version you use, such as SQL Server Native Client 11.0 |
host | required | |
port | optional | You can remove the port config setting entirely; defaults to 1433 . |
database | required | |
username | required | Use system variables to retrieve this value securely. |
password | required | Use system variables to retrieve this value securely. |
encrypt | optional | The default value is false . |
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?
- Suggest a docs change in GitHub.
- Share feedback in the Soda community on Slack.
Documentation always applies to the latest version of Soda products
Last modified on 27-Sep-23