Microsoft SQL Server Data Connector

The Microsoft SQL Server Data Connector enables federated SQL queries on data stored in Microsoft SQL Server databases.

datasets:
  - from: mssql:path.to.my_dataset
    name: my_dataset
    params:
      mssql_connection_string: ${secrets:mssql_connection_string}

Configuration

The data connector supports the following params. Use the secret replacement syntax to load the secret from a secret store, e.g. ${secrets:my_mssql_conn_string}.

mssql_connection_string: The ADO connection string to use to connect to the server. This can be used instead of providing individual connection parameters.
mssql_host: The hostname or IP address of the Microsoft SQL Server instance.
mssql_port: (Optional) The port of the Microsoft SQL Server instance. Default value is 1433.
mssql_database: (Optional) The name of the database to connect to. The default database will be used if not specified.
mssql_username: The username for the SQL Server authentication.
mssql_password: The password for the SQL Server authentication.
mssql_encrypt: (Optional) Specifies whether encryption is required for the connection.
- true: (default) This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.
- false: This mode will not attempt to use an SSL connection, even if the server supports it. Only the login procedure is encrypted
mssql_trust_server_certificate: Optional parameter to specify whether the server certificate should be trusted without validation when encryption is enabled
- true: The server certificate will not be validated and it is accepted as-is
- false: (default) Server certificate will be validated against system's certificate storage

datasets:
  - from: mssql:SalesLT.Customer
    name: customer
    params:
      mssql_host: mssql-host.database.windows.net
      mssql_database: my_catalog
      mssql_username: my_user
      mssql_password: ${secrets:mssql_pass}
      mssql_encrypt: true
      mssql_trust_server_certificate: true

Limitations

The connector supports SQL Server authentication (SQL Login and Password) only.
Spatial types (geography) are not supported, and columns with these types will be ignored.

Configuration​

Configuration