Sling Docs
Ask or search…

SQL Server

Connect & Ingest data from / to a SQL Server database

Sling CLI Setup

The following credentials keys are accepted:
  • host (required) -> The hostname / ip of the instance
  • user (required) -> The username to access the instance
  • database (required) -> The database name of the instance
  • instance (optional) -> The SQL Server instance to use
  • schema (optional) -> The default schema to use
  • password (optional) -> The password to access the instance
  • port (optional) -> The port of the instance. Default is 1433.
  • ssh_tunnel (optional) -> The URL of the SSH server you would like to use as a tunnel (example ssh://user:[email protected]:22)
  • ssh_private_key (optional) -> The private key to use to access a SSH server (raw string or path to file).
  • ssh_passphrase (optional) -> The passphrase to use to access a SSH server.

Additional Parameters

Sling uses the go-mssqldb library and thus will accept any paremters listed here. Some parameters that may be of interest:
  • encrypt -> disable, false or true - whether data between client and server is encrypted.
  • log -> logging level (accepts 1, 2, 4, 8, 16, 32).
  • TrustServerCertificate -> true or false - whetherthe server certificate is checked
  • certificate -> The file that contains the public key certificate of the CA that signed the SQL Server certificate. The specified certificate overrides the go platform specific CA certificates.
  • hostNameInCertificate -> Specifies the Common Name (CN) in the server certificate. Default value is the server host.
Here are examples of setting a connection named MSSQL. We must provide the type=sqlserver property:
$ sling conns set MSSQL type=sqlserver host=<host> user=<user> database=<database> password=<password> port=<port>
# Or use url
$ sling conns set MSSQL url="sqlserver://myuser:[email protected]:1433?database=mydatabase"
$ sling conns set MSSQL url="sqlserver://myuser:[email protected]:1433/my_instance?database=master&encrypt=true&TrustServerCertificate=true"

Environment Variable

export MSSQL='sqlserver://myuser:[email protected]:1433?database=mydatabase'
export MSSQL='sqlserver://myuser:[email protected]:1433/my_instance?database=master&encrypt=true&TrustServerCertificate=true'

Sling Env File YAML

See here to learn more about the sling env.yaml file.
type: sqlserver
host: <host>
user: <user>
port: <port>
instance: <instance>
database: <database>
schema: <schema>
password: <password>
encrypt: 'true'
TrustServerCertificate: 'true'
url: "sqlserver://myuser:[email protected]:1433/mydatabase"
If you are facing issues connecting, please reach out to us at [email protected] or open a Github Issue here.
Last modified 19d ago