genai-toolbox/docs/en/resources/sources/mssql.md

title, type, weight, description

title	type	weight	description
SQL Server	docs	1	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.

• mssql-list-tables
  List tables in a SQL Server database.

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

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

Reference

field	type	required	description
kind	string	true	Must be "mssql".
host	string	true	IP address to connect to (e.g. "127.0.0.1").
port	string	true	Port to connect to (e.g. "1433").
database	string	true	Name of the SQL Server database to connect to (e.g. "my_db").
user	string	true	Name of the SQL Server user to connect as (e.g. "my-user").
password	string	true	Password of the SQL Server user (e.g. "my-password").
encrypt	string	false	Encryption 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.