DbSchema Azure Synapse ER Diagram Designer

DbSchema is a Azure Synapse ER diagram database designer and query tool. Using DbSchema, you can design and document Azure Synapse databases while connected to the database server or without a connection.

Next, you can share the design with the team using Git. The design model loaded in DbSchema can be compared with the database, synchronization scripts can be generated, and the schema can be deployed to any database server.

DbSchema Database Designer

Download DbSchema

How to Connect to Azure Synapse Database

Watch the step-by-step video tutorial below:

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.

Connect to Database in DbSchema

DbSchema automatically downloads the JDBC driver to ensure a smooth connection to Amazon Athena.

Configure the Remote Connection in DbSchema

First, you will need 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 Diagram

    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.