Skip to content

Azure Synapse

Install

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

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

Writes data to Azure Synapse Analytics via TDS protocol.

Configuration

yaml
warehouse:
  kind: synapse
  connection_string: ${SYNAPSE_CONNECTION_STRING}
  schema: dbo
FieldDefaultDescription
connection_string(required)ADO-style connection string
schemadboTarget schema

CLI

bash
skippr connect warehouse synapse \
  --connection-string "Server=myserver.database.windows.net;User Id=admin;Password=secret;Database=mydb" \
  --schema dbo
FlagDescription
--connection-stringADO.NET connection string
--schemaTarget schema (default: dbo)

Authentication

Configure the connection_string field directly, either in skippr.yaml or with skippr connect warehouse synapse.

For security best practices, we strongly advise against storing the connection string in skippr.yaml. Use environment variable interpolation instead: replace the connection_string value with your own ${ENV_VAR} reference.

The relevant part of skippr.yaml looks like this:

yaml
warehouse:
  kind: synapse
  connection_string: ${SYNAPSE_CONNECTION_STRING}

Set the env var before running skippr:

macOS / Linux

bash
export SYNAPSE_CONNECTION_STRING="Server=myserver.database.windows.net;User Id=admin;Password=secret;Database=mydb"

Windows PowerShell

powershell
$env:SYNAPSE_CONNECTION_STRING = "Server=myserver.database.windows.net;User Id=admin;Password=secret;Database=mydb"

Windows Command Prompt

cmd
set SYNAPSE_CONNECTION_STRING=Server=myserver.database.windows.net;User Id=admin;Password=secret;Database=mydb

Permissions or Network Requirements

The Synapse login needs write access to the target schema, and the runner must be able to reach the Synapse endpoint over the configured TDS connection.

Troubleshooting

SymptomFix
authentication failedVerify the configured connection string and confirm the login can reach the database.
schema or table errorsCheck the target schema name and that the login can create and write objects there.

CDC Support

Azure Synapse supports CDC with exactly-once final-state reconciliation via MERGE. Skippr automatically creates _skippr_order_token columns and tombstone tables.

See CDC Destinations -- Synapse for details.

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