Skip to main content

MSSQL Connection

Examples​

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

MSSQLConnection​

info

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

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

PropertyDefaultTypeRequiredDescription
descriptionstring
NoA brief description of what the model does.
metadataNoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
ssh_tunnelstring
No
mssqlYesMSSQL Server Connection options.

Property Details​

Connection​

Data source/sink Connection.

PropertyDefaultTypeRequiredDescription
connectionOne of:
  S3Connection
  GcsConnection
  AbfsConnection
  LocalFileConnection
  SnowflakeConnection
  BigQueryConnection
  MSSQLConnection
  MySQLConnection
  OracleConnection
  PostgresConnection
  HttpConnection
  DuckDBConnection
  SFTPConnection
  DatabricksConnection
YesData system Connection.

MSSQLConnectionOptions​

PropertyDefaultTypeRequiredDescription
hoststringYesMSSQL server host to connect to.
userstring
NoMSSQL Server user to connect as.
passwordstring
NoMSSQL Server user password.
schemadbostringNoMSSQL schema to use.
portinteger
NoMSSQL Server port to connect to.
driverstring ("ODBC Driver 18 for SQL Server", "FreeTDS")YesDriver to use for the MSSQL Connection.
trust_server_certificateboolean
No
databasestringYesMSSQL 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.

PropertyDefaultTypeRequiredDescription
sourceNoThe origin or source information for the resource.
source_event_uuidstring
NoUUID of the event that is associated with creation of this resource.

ResourceLocation​

The origin or source information for the resource.

PropertyDefaultTypeRequiredDescription
pathstringYesPath within repository files where the resource is defined.
first_line_numberinteger
NoFirst line number within path file where the resource is defined.