Microsoft SQL Server is a relational database management system developed by Microsoft.
The Microsoft SQL Server Data Connector enables federated/accelerated SQL queries on data stored in MSSQL databases.
:::warning[Limitations]
geography) are not supported, and columns with these types will be ignored.:::
fromThe from field takes the form mssql:database.schema.table where database.schema.table is the fully-qualified table name in the SQL server.
nameThe dataset name. This will be used as the table name within Spice.
Example:
The dataset name cannot be a reserved keyword or any of the following keywords that are reserved by Microsoft SQL Server:
OUTERSETQUALIFYWINDOWENDFORparamsThe data connector supports the following params. Use the secret replacement syntax to load the secret from a secret store, e.g. ${secrets:my_mssql_conn_string}.
| Parameter Name | Description |
|---|---|
mssql_connection_string | The ADO connection string to use to connect to the server. This can be used instead of providing individual connection parameters. |
mssql_host | The hostname or IP address of the Microsoft SQL Server instance. |
mssql_port | (Optional) The port of the Microsoft SQL Server instance. Default value is 1433. |
mssql_database | (Optional) The name of the database to connect to. The default database (master) will be used if not specified. |
mssql_username | The username for the SQL Server authentication. |
mssql_password | The password for the SQL Server authentication. |
mssql_encrypt | (Optional) Specifies whether encryption is required for the connection. true: (default) This mode requires an SSL connection. If a secure connection cannot be established, server will not connect.false: This mode will not attempt to use an SSL connection, even if the server supports it. Only the login procedure is encrypted. |
mssql_trust_server_certificate | (Optional) Specifies whether the server certificate should be trusted without validation when encryption is enabled. : The server certificate will not be validated and it is accepted as-is.: (default) Server certificate will be validated against system's certificate storage. |
Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation. Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide.
truefalse