Microsoft SQL Server destination plugin configuration reference

Example Configuration #

kind: destination
spec:
  name: "mssql"
  path: "cloudquery/mssql"
  registry: "cloudquery"
  version: "v5.1.4"
  spec:
    # Connection string in the format `server=localhost;user id=SA;password=yourStrongP@ssword;port=1433;database=cloudquery;`
    connection_string: "${MSSQL_CONNECTION_STRING}"
    # Optional parameters:
    # auth_mode: ms
    # schema: dbo
    # batch_size: 1000 # 1K entries
    # batch_size_bytes: 5242880 # 5 MiB
    # batch_timeout: 20s

Microsoft SQL Server spec #

• connection_string (string) (required)

  Connection string to connect to the database. See SDK documentation for details.

  Example connection strings:

  • "sqlserver://username:password@hostname/instance" basic connection using a named instance
  • "sqlserver://username:password@localhost?database=master&connection+timeout=30" select "master" database and set connection timeout (default instance)

• auth_mode (string) (optional) (default: ms)

- `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 schema named dbo.
• batch_size (integer) (optional) (default: 1000)

  Maximum amount of items that may be grouped together to be written in a single write.
• batch_size_bytes (integer) (optional) (default: 5242880 (= 5 MiB))

  Maximum size of items that may be grouped together to be written in a single write.
• batch_timeout (duration) (optional) (default: 20s (= 20 seconds))

  Maximum interval between batch writes.

Verbose logging for debug #

kind: destination
spec:
  name:     "mssql"
  path:     "cloudquery/mssql"
  registry:   "cloudquery"
  version:  "v5.1.4"

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

Microsoft SQL Server destination plugin example

Prerequisites #

Create admin password for Microsoft SQL Server #

Start Microsoft SQL Server locally #

docker run \
  -e "ACCEPT_EULA=Y" \
  -e "MSSQL_SA_PASSWORD=yourStrongP@ssword" \
  -p 1433:1433 \
  -d \
  mcr.microsoft.com/mssql/server:2022-latest

Create database to sync to #

docker exec $(docker ps -alq) \
  /opt/mssql-tools/bin/sqlcmd \
  -U "SA" \
  -P "yourStrongP@ssword" \
  -Q "CREATE DATABASE cloudquery;"

Configure Microsoft SQL Server destination plugin #

server=localhost;user id=SA;password=yourStrongP@ssword;port=1433;database=cloudquery;

kind: destination
spec:
  name: "mssql"
  path: "cloudquery/mssql"
  registry: "cloudquery"
  version: "v5.1.4"

  spec:
    connection_string: "server=localhost;user id=SA;password=yourStrongP@ssword;port=1433;database=cloudquery;"