SQL Server

Connect to a SQL Server database

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

  • 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.

Here is an example of setting a connection named MSSQL:

# URL format
export MSSQL="sqlserver://myuser:mypass@host.ip:1433/mydatabase"

# YAML format
export MSSQL="{type: sqlserver, host: <host>, user: <user>, database: <database>, password: <password>, port: <port>}"

Last updated