Link Search Menu Expand Document

Connect Soda to MS SQL Server

Last modified on 24-May-24

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

data_source my_datasource_name:
  type: sqlserver
  host: host
  port: '1433'
  username: simple
  password: simple_pass
  database: database
  schema: dbo
  trusted_connection: false
  encrypt: false 
  trust_server_certificate: false
  driver: ODBC Driver 18 for SQL Server
Property Required Notes
type required Identify the type of data source for Soda.
host required Provide a host identifier.
port optional Provide a port identifier. You can remove the port config setting entirely. Default: 1433.
username required Use system variables to retrieve this value securely.
password required Use system variables to retrieve this value securely.
database required Provide an identifier for your database.
schema required Provide an identifier for the schema in which your dataset exists.
trusted_connection optional Indicate connection trustworthiness by providing a boolean value: true or false. The default value is false. Set to true if you are using Active Directory authentication.
encrypt optional Indicate the encryption status by providing a boolean value: true or false. The default value is false.
trust_server_certificate optional Specifies whether encryption occurs if there is no verifiable server certificate. Providing a boolean value: true or false. The default value is false.
driver optional Use this config setting to specify the ODBC driver version you use. For example, SQL Server Native Client 11.0 or ODBC Driver 18 for SQL Server.

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?

Documentation always applies to the latest version of Soda products
Last modified on 24-May-24