DbSchema for Azure Synapse Database

DbSchema is a powerful database management and design tool for Azure Synapse. It offers features such as visual schema design, team collaboration with GIT, schema deployment and HTML schema documentation.

How to Connect to Azure Synapse Database

For written documentation, please continue reading...

Open DbSchema, then click "Connect to Database" on the Main Screen and choose your database system. DbSchema will automatically download the required JDBC driver.

Configure the Remote Connection in DbSchema

First, you will need the Dedicated SQL endpoint from your Synapse workspace.

Step 1: Obtain the Dedicated SQL endpoint

Open the Azure Synapse portal and navigate to your Synapse workspace.

In the Overview section, locate the Dedicated SQL endpoint.

Copy the endpoint URL.

Here you can find the SQL admin username that you set up when you created your Synapse workspace, wich will be neccessary in DbSchema.

Step 2: Configure the Connection in DbSchema

• Choose the "Standard" connection option.
• Paste the Dedicated SQL endpoint you copied earlier into the Server Host or IP field.(e.g., dbschemasynapse1.sql.azuresynapse.net)
• Enter your SQL admin user and password, then click "Connect."

Once connected, DbSchema will reverse-engineer your database schema, creating a visual layout of your tables and relationships.

If you need more detailed connection information, read the Connection Dialog

Troubleshoot Firewall Issues

If you experience connection problems, check your firewall and antivirus settings, as they might be blocking the connection. More information on enabling Firewall Connections is available if needed.

If you encounter connection errors, enable logging for diagnostics by following the instructions here.