Design and Manage Azure Synapse Databases Visually with DbSchema

DbSchema lets you design, manage, and document Azure Synapse databases. Create ER diagrams, define tables and columns, and generate SQL scripts - with or without a live database connection.

Use Git to share the design, compare it with the Azure Synapse database, and deploy changes. DbSchema also includes a data editor, query builder, and HTML5 documentation - everything you need in one tool.

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.