Microsoft SQL Server destination plugin configuration reference

Latest: v4.1.0

Example Configuration

kind: destination
spec:
  name: "mssql"
  registry: "github"
  path: "cloudquery/mssql"
  version: "v4.1.0"
  spec:
    connection_string: "server=localhost;user id=SA;password=yourStrongP@ssword;port=1433;database=cloudquery;"

Microsoft SQL Server spec

This is the (nested) spec used by the Microsoft SQL Server destination plugin.

connection_string (string, required)

Connection string to connect to the database. See SDK documentation (opens in a new tab) for more details.
auth_mode (string, optional. Default: ms)

If you need to authenticate via Azure Active Directory ensure you specify azure value. See SDK documentation (opens in a new tab) for more information. Supported values:
- ms connect to Microsoft SQL Server instance
- azure connect to Azure SQL Server instance
schema (string, optional. Default: dbo)

Schema name to be used. By default, Microsoft SQL Server destination plugin will use the default (opens in a new tab) schema named dbo.

Make sure you use environment variable expansion in production instead of committing the credentials to the configuration file directly.

Verbose logging for debug

The Microsoft SQL Server destination can be run in debug mode. To achieve this pass the log option to connection_string. See SDK documentation (opens in a new tab) for more details.

Note: This will use SDK (opens in a new tab) built-in logging and might output data and sensitive information to logs. Make sure not to use it in production environment.

kind: destination
spec:
  name:     "mssql"
  registry: "github"
  path:     "cloudquery/mssql"
  version:  "v4.1.0"

  spec:
    connection_string: "${MS_SQL_CONN_STRING};log=255"

Overview Example