SQL Server Source
SQL Server is a relational database management system (RDBMS).
2 minute read
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
SQL Server Source Tools
| Tool Name | Description |
|---|---|
| mssql-execute-sql Tool | A "mssql-execute-sql" tool executes a SQL statement against a SQL Server database. |
| mssql-list-tables Tool | The "mssql-list-tables" tool lists schema information for all or specified tables in a SQL server database. |
| mssql-sql Tool | A "mssql-sql" tool executes a pre-defined SQL statement against 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
kind: sources
name: my-mssql-source
type: 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
| field | type | required | description |
|---|---|---|---|
| type | 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. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.