DbSchema for Azure Synapse Database

DbSchema is a comprehensive tool for designing and managing Azure Synapse databases. It provides powerful features, like visual schema design, team collaboration with Git, easy schema deployment, and interactive HTML5 documentation.

How to Connect to an Azure Synapse Database

For a step-by-step video tutorial, click here

For written documentation, please continue reading below.

To configure a remote connection to an Azure Synapse database in DbSchema, obtain the Dedicated SQL endpoint from your Synapse workspace.

Connection Dialog

Step 1: Obtain the Dedicated SQL endpoint

  • Open the Azure Synapse portal and navigate to your Synapse workspace.
    • Azure Synapse portal
  • 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.
    • Synapse Workspace

    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."
      • Standard Connection Setup

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

    DbSchema Layout

    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.

    Enable Windows Firewalls Note: Firewalls and antivirus software may block database connections.

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