Skip to main content

Microsoft SQL Server Connector

Microsoft SQL Server Microsoft SQL Server (MSSQL) is a popular relational database system. This component allows querying an MSSQL database.

API Documentation​

This component was built using the Microsoft SQL Server documentation.

Connections​

Azure Active Directory​

Authenticate requests to a Microsoft SQL Server or Azure SQL Database using Azure Active Directory service principal credentials. Compatible with Microsoft Fabric.

Use the Azure Active Directory connection to connect to Azure SQL Database, Microsoft Fabric, or any SQL Server instance that supports Azure Active Directory authentication via service principal credentials.

Prerequisites​

  • An Azure AD App Registration with a client secret
  • The service principal must have the appropriate permissions on the target database or Fabric workspace

Configure the Connection​

  • Host: The server address (e.g., my-server.database.windows.net for Azure SQL, or my-server.datawarehouse.fabric.microsoft.com for Fabric)
  • Port: The database port (default: 1433)
  • Database: The name of the database or Fabric warehouse
  • Tenant ID: The Directory (Tenant) ID from the Azure AD App Registration
  • Client ID: The Application (Client) ID from the Azure AD App Registration
  • Client Secret: The client secret from the Azure AD App Registration
  • Connection Timeout: Milliseconds before the connection attempt is considered failed (default: 15000)

Token acquisition and refresh are handled automatically by the underlying driver.

InputCommentsDefault
HostThe address of the SQL Server or Fabric warehouse endpoint.
PortThe port the database server is exposing.1433
DatabaseThe name of the database or Fabric warehouse.
Tenant IDThe Directory (Tenant) ID from the Azure AD App Registration.
Client IDThe Application (Client) ID from the Azure AD App Registration.
Client SecretThe Client Secret from the Azure AD App Registration.
Connection TimeoutThe number of milliseconds before the attempt to connect is considered failed.15000

Basic Authentication​

Authenticate requests to a Microsoft SQL Server using a username and password.

Use the Basic Authentication connection to connect to a Microsoft SQL Server instance using a username and password.

Configure the Connection​

  • Host: The address of the database server (e.g., 192.168.0.1)
  • Port: The port the database server is exposing (default: 1433)
  • Database: The name of the database (e.g., msdb)
  • Connection Timeout: The number of milliseconds before the attempt to connect is considered failed (default: 15000)
  • Username: The SQL Server login username for authentication
  • Password: The SQL Server login password for authentication
InputCommentsDefault
HostThe address of the database server.
PortThe port the database server is exposing.1433
DatabaseThe name of the database.
Connection TimeoutThe number of milliseconds before the attempt to connect is considered failed.15000
UsernameThe SQL Server login username for authentication.
PasswordThe SQL Server login password for authentication.

Actions​

Execute Stored Procedure​

Execute a stored procedure on a Microsoft SQL Server database.

InputCommentsDefault
Stored ProcedureThe name of the stored procedure to execute.
TimeoutThe number of milliseconds to wait for a response from the server. If the timeout expires before the server responds, an error will be thrown.60000
ConnectionThe Microsoft SQL Server connection to use.

Query​

Execute a SQL query against a Microsoft SQL Server database.

InputCommentsDefault
QueryThe SQL query to execute against the Microsoft SQL Server database. Supports optional named parameters using the '@variable' operator.SELECT * FROM Customers WHERE customerId = @id
ParametersThe key-value pairs to bind as named parameters in the query, referenced using the '@variable' operator.
Parameters ObjectThe JSON key-value object of named parameters to bind in the query. Values are merged with the Parameters input.
TimeoutThe number of milliseconds to wait for a response from the server. If the timeout expires before the server responds, an error will be thrown.60000
ConnectionThe Microsoft SQL Server connection to use.