SQL Server

SQL Server is a relational database management system (RDBMS).

About

SQL Server is a relational database management system (RDBMS) developed by Microsoft that allows users to store, retrieve, and manage large amount of data through a structured format.

Available Tools

  • mssql-sql
    Execute pre-defined SQL Server queries with placeholder parameters.

  • mssql-execute-sql
    Run parameterized SQL Server queries in SQL Server.

Requirements

Database User

This source only uses standard authentication. You will need to create a SQL Server user to login to the database with.

Example

sources:
    my-mssql-source:
        kind: mssql
        host: 127.0.0.1
        port: 1433
        database: my_db
        user: ${USER_NAME}
        password: ${PASSWORD}
        # encrypt: strict

Tip

Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.

Reference

fieldtyperequireddescription
kindstringtrueMust be “mssql”.
hoststringtrueIP address to connect to (e.g. “127.0.0.1”).
portstringtruePort to connect to (e.g. “1433”).
databasestringtrueName of the SQL Server database to connect to (e.g. “my_db”).
userstringtrueName of the SQL Server user to connect as (e.g. “my-user”).
passwordstringtruePassword of the SQL Server user (e.g. “my-password”).
encryptstringfalseEncryption level for data transmitted between the client and server (e.g., “strict”). If not specified, defaults to the github.com/microsoft/go-mssqldb package’s default encrypt value.