Skip to main content

Connect to Microsoft SQL Server

Learn how to connect your Microsoft SQL Server database to Retool.

You can connect to Microsoft SQL and make it available as a resource in Retool. Once complete, your users can write queries that interact with Microsoft SQL data.

Requirements and settings

Autofill credentials

You can automatically populate resource configuration fields by importing an AWS-hosted data source or providing a database connection string.

The following requirements for a Microsoft SQL resource depend on whether you are creating a resource on a cloud-hosted Retool organization or a self-hosted deployment.

For more information on how to obtain the necessary information from Microsoft SQL, refer to its documentation.

Requirements for cloud-hosted Retool

The following requirements must be met to successfully create Microsoft SQL resources.

RequirementDescription
Sufficient user permissions to create resources

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

Resource configuration settings

You must be able to provide the settings needed to create a resource. This may require you to perform actions, such as generating access credentials or creating a client application.

Resource authentication settings

You must have access to the data source and sufficient permissions to perform the actions needed, and be able to provide valid authentication settings.

Allow Retool access to the data source

If the data source is behind a firewall or restricts access based on IP address then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

Configuration settings for cloud-hosted Retool

Cloud-hosted Retool organizations support the following configuration settings.

SettingDescription
Host

The host server address.

Port

The host server connection port.

Database name

The name of the database to use.

Connection options

Key-value pairs to customize the connection.

Cloud-hosted Retool organizations can also optionally configure the following advanced options.

SettingDescription
Override default outbound Retool region

Specify a different outbound region from which Retool connects. This can improve performance if your resource is located in a different region to us-west-2.

Disable converting queries to prepared statements

Whether to disable SQL injection protection that allows dynamically generated SQL using JavaScript.

Show write GUI mode only

Whether to prevent users from writing raw SQL statements.

Enable SSH tunnel

Whether to enable SSH tunneling.

Use dynamic database names

Whether to override the database name with a dynamically generated value. This allows using Retool with a database that has been sharded into several different databases.

Use dynamic database host

Whether to override the database host with a dynamically generated value. This allows using Retool with several different databases.

Use dynamic database credentials

Whether to override the database credentials with dynamically generated values.

SQL Server Proxy host

The proxy server host to use when connecting to your database.

TDS version

The TDS version to use.

Connect to a read-only replica

When using Azure read scale-out, whether to connect using a read-only connection.

Authentication settings for cloud-hosted Retool

Cloud-hosted Retool organizations can authenticate with this resource using the following methods. You must be able to provide the necessary credentials for the method you wish to use.

Username and password

Authentication is performed using the provided username and password.

SettingDescription
Username

The username with which to authenticate.

Password

The password with which to authenticate.

1. Create a resource

Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Microsoft SQL.

2. Configure the resource

Specify a name and location for your Microsoft SQL resource. Retool displays the resource name and type in query editors to help users identify them. Next, provide the required information to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

3. Test the connection

Click Test Connection to verify that Retool can successfully connect to Microsoft SQL. If the test fails, check the resource settings and try again.

Testing only verifies connection

Testing a connection only checks whether Retool can successfully connect to the resource. It cannot check whether the provided credentials have sufficient privileges or can perform every supported action.

4. Save the resource

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your Microsoft SQL resource is now ready to use. To start querying Microsoft SQL data:

  1. Add a Resource query to an app or a Resource query block to a workflow.
  2. Select the new Microsoft SQL resource from the resources dropdown.
  3. Write and run a query.