MSSQL Connection

Examples

simple_synapse_connection.yaml

connection:
  mssql:
    host: your-hostname
    user: your-username
    password: "${vaults.my_vault_name.password}"
    driver: ODBC Driver 18 for SQL Server

mssql_connection_freetds.yaml

connection:
  mssql:
    host: your-hostname
    user: your-username
    password: "${vaults.my_vault_name.password}"
    driver: FreeTDS
    database: your-database
    schema: your-schema
    port: 1433

mssql_connection.yaml

connection:
  mssql:
    host: your-mssql-host
    user: your-username
    password: ${vaults.my_vault_name.your-password}
    database: your-database-name
    schema: your-schema-name
    port: 1433
    driver: ODBC Driver 18 for SQL Server

MSSQLConnection

info

MSSQLConnection is defined beneath the following ancestor nodes in the YAML structure:

• Connection

Below are the properties for the MSSQLConnection. Each property links to the specific details section further down in this page.

Property	Default	Type	Required	Description
description		string	No	A brief description of what the model does.
metadata		ResourceMetadata	No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
name		string	Yes	The name of the model
ssh_tunnel		string	No
mssql		MSSQLConnectionOptions	Yes	The MSSQL Server connection options.

Property Details

Connection

A connection to a data source/sink.

Property	Default	Type	Required	Description
connection		One of:   S3Connection   GcsConnection   AbfsConnection   LocalFileConnection   SnowflakeConnection   BigQueryConnection   MSSQLConnection   MySQLConnection   OracleConnection   PostgresConnection   HttpConnection   DuckDBConnection   SynapseConnection   SFTPConnection   FabricConnection   DatabricksConnection	Yes	The connection to the data system.

MSSQLConnectionOptions

Property	Default	Type	Required	Description
host		string	Yes	The MSSQL server host to connect to.
user		string	No	The MSSQL Server user to connect as.
password		string	No	The MSSQL Server password to use for the connection.
schema	dbo	string	No	The MSSQL schema to use.
port		integer	No	The MS SQL Server port to connect to.
driver		string ("ODBC Driver 18 for SQL Server", "FreeTDS")	Yes	The driver to use for the MSSQL connection.
trust_server_certificate		boolean	No
database		string	No	The MSSQL Server database to connect to.

ResourceMetadata

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

Property	Default	Type	Required	Description
source		ResourceLocation	No	The origin or source information for the resource.
source_event_uuid		string	No	UUID of the event that is associated with creation of this resource.

ResourceLocation

The origin or source information for the resource.

Property	Default	Type	Required	Description
path		string	Yes	Path within repository files where the resource is defined.
first_line_number		integer	No	First line number within path file where the resource is defined.