Skip to main content

Microsoft SQL Server

Overview

Connect Superblocks to Microsoft SQL to build apps with read and write access to a Microsoft SQL database:

  • Read data from a database and utilize it in API steps or UI components

  • Save information retrieved by other API steps or UI components by writing data to a database

Setting up Microsoft SQL

1. Select Microsoft SQL from the in-app integrations page

Select Microsoft SQL from the in-app integrations page and fill out the form with the following configuration:

  • Display Name - Name that will be displayed to users when selecting this integration in Superblocks
  • Host - Hostname or IP address to connect to
  • Port - Port to use when connecting to Microsoft SQL
  • Database Name - Name of database to connect to
  • Database Username - Username to use to connect
  • Database Password - Password for database username
  • Enable SSL - Connect via SSL if selected
  • Use a self-signed SSL certificate - Use a self-signed SSL certificate if selected, for example when connecting to Cloud SQL

2. Fill out the form and click "Create Integration"

info

If using Superblocks Cloud, add these Superblocks IPs to your allowlist (not necessary for On-Premise-Agent).

3. Set environments

After creating the integration, you can optionally set different connection settings for your Production and Staging environments. Be sure to click Test Connection for each environment.

success

Microsoft SQL Connected You can now write SQL to read from and write to Microsoft SQL in any Application, Workflow, or Scheduled Job.

Creating Microsoft SQL steps

Connect to your Microsoft SQL integration from Superblocks by creating steps in Application APIs, Workflows, and Scheduled Jobs. You can configure a Superblocks Microsoft SQL integration with read only, read/write, or write only users. You can then configure a Superblocks Microsoft SQL step to read from a database, as well as modify/delete data. To get started, enter your SQL query into the text area of the Microsoft SQL step. Then click "Run" to see the Result and Executed SQL statement below.

Use cases

Applications

Create an admin dashboard that reads from Microsoft SQL and other sources. Mix in APIs to allow support agents to refund orders, update shipping statuses, or transform large datasets in a single UI.

Workflows

Enrich customer order data within Microsoft SQL with shipping data from snowflake or other datastores.

Scheduled Jobs

Send out a daily report via email of new customer bookings.

info

Note that javascript may be injected via {{ }}. Here we use javascript's moment package to easily manipulate the timestamp to the start and end of the previous day.

Troubleshooting

Check out our guide on common errors across database integrations, in addition to common Microsoft SQL Server connection issues. If you are encountering an error that you don't see in the guide, or the provided steps are insufficient to resolve the error, please contact us at help@superblockshq.com.