Skip to content

MSSQL

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy

Reads data from Microsoft SQL Server tables.

Configuration

yaml
source:
  kind: mssql
  connection_string: ${MSSQL_CONNECTION_STRING}
FieldDefaultDescription
connection_string(required)ADO.NET connection string

Namespace: mssql.{database}.{schema}.{table}

CLI

bash
skippr connect source mssql \
  --connection-string '${MSSQL_CONNECTION_STRING}'

Or run without flags to be prompted interactively.

FlagDescription
--connection-stringADO.NET connection string

Config output

Running connect source mssql writes the following to skippr.yaml:

yaml
source:
  kind: mssql
  connection_string: ${MSSQL_CONNECTION_STRING}

Set the env var before running skippr:

macOS / Linux

bash
export MSSQL_CONNECTION_STRING="server=tcp:127.0.0.1,1433;database=testdb;user id=sa;password=YourPass;TrustServerCertificate=true"

Windows PowerShell

powershell
$env:MSSQL_CONNECTION_STRING = "server=tcp:127.0.0.1,1433;database=testdb;user id=sa;password=YourPass;TrustServerCertificate=true"

Windows Command Prompt

cmd
set MSSQL_CONNECTION_STRING=server=tcp:127.0.0.1,1433;database=testdb;user id=sa;password=YourPass;TrustServerCertificate=true

Authentication

VariableDescription
MSSQL_CONNECTION_STRINGADO.NET connection string for SQL Server

Connection string format

bash
export MSSQL_CONNECTION_STRING="server=tcp:127.0.0.1,1433;database=testdb;user id=sa;password=YourPass;TrustServerCertificate=true"

Common parameters:

ParameterDescription
serverHostname and port (for example tcp:myserver.database.windows.net,1433)
databaseDatabase name
user idSQL Server login
passwordLogin password
TrustServerCertificateSet to true for self-signed certs in dev or test
EncryptSet to true for Azure SQL or production workloads

Azure SQL

For Azure SQL Database, use the fully qualified server name:

bash
export MSSQL_CONNECTION_STRING="server=tcp:myserver.database.windows.net,1433;database=mydb;user id=myuser@myserver;password=MyPass;Encrypt=true;TrustServerCertificate=false"

Local dev with Docker

Spin up a local MSSQL instance for testing:

bash
docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=YourStrong!Passw0rd' \
  -p 1433:1433 --name mssql-dev \
  -d mcr.microsoft.com/mssql/server:2022-latest
bash
export MSSQL_CONNECTION_STRING="server=tcp:127.0.0.1,1433;database=master;user id=sa;password=YourStrong!Passw0rd;TrustServerCertificate=true"

Permissions or Network Requirements

The SQL Server login needs read access to the tables or views you want to ingest, and the machine running skippr must be able to reach the SQL Server endpoint on the configured port.

Troubleshooting

SymptomFix
Login failed for userVerify username and password in the connection string
Cannot open serverCheck the server hostname, port, and network access
SSL Provider: certificate verify failedAdd TrustServerCertificate=true for self-signed certs, or install the server CA certificate

Next steps

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy