Connect Soda to MS SQL Server

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

data_source my_datasource_name:
  type: sqlserver
  host: host
  port: '1433'
  username: xxx
  password: ...
  database: 
  schema: dbo
  trusted_connection: false
  encrypt: false 
  trust_server_certificate: false
  driver: 

Property	Required	Notes
type	required
host	required
port	optional	You can remove the `port` config setting entirely; defaults to `1433`.
username	required	Use system variables to retrieve this value securely.
password	required	Use system variables to retrieve this value securely.
database	required
schema	required
trusted_connection	optional	The default value is `false`. Set to `true` if using Active Directory authentication.
encrypt	optional	The default value is `false`.
trust_server_certificate	optional	The default value is `false`.
driver	optional	Use this config setting to specify the ODBC driver version you use, such as `SQL Server Native Client 11.0`

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.

Last modified on 31-May-23