Microsoft SQL Server

Use the SQL server connector to connect to your Microsoft SQL database.

Add connector

  1. Select Connectors in Hub menu and select Add Connector.

  2. Select Microsoft SQL Server

  3. Enter the name and optionally a description.

  4. Enter the configuration values for different environments.

  5. Select Save.

Configuration values

Configuration
Description

Agent Group

Agent group where the connector should be executed

Server

Address to the Microsoft SQL Server

Initial Catalog

The name of the database to be used. If there are multiple databases on the server that you have permission to use, you have to specify the Initial Catalog.

Username

User to login to the database with

Password

Password for User

Connection Pooling

Sets whether connection pooling should be used

Connection Timeout

The timeout, in seconds, for establishing a connection to the SQL Server.

Override Connection String

If a connection string is specified here, it will be used instead of the one generated from the settings above. You can use the connection string to specify additional connection properties.

For example, the following connection string ensures that when connecting to the SQL Server, the client will trust the server's SSL/TLS certificate without validating it against a certificate authority (CA):

Server=<SQL_SERVER_ADDRESS>;Database=<DATABASE_NAME>;User Id=<USERNAME>;Password=<PASSWORD>;TrustServerCertificate=True;

Schema/AppOwner

Database schema name. The default schema is dbo

Initialization Command

Optional command to execute immediately after successful login

Cleanup Command

An optional command to execute on the database after the operation has been completed.

Command Timeout

Command timeout, in seconds, to use when executing a script or a query. If not set, the default value will be used (usually 90 seconds)

Edit connector

  1. Hover over the connector card and the context menu will appear, select Edit.

  2. You can now change or the configuration values for different environments.

Delete connector

  1. Hover over the connector card and the context menu will appear, select Delete.

  2. Confirm and the connector will be deleted.

Last updated

Was this helpful?