Connect to Azure Data Catalog Data in Squirrel SQL Client

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Azure Data Catalog JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Azure Data Catalog.



Connect to Azure Data Catalog data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Azure Data Catalog enables you to execute queries to Azure Data Catalog data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Azure Data Catalog data and execute queries.

Add the JDBC Driver for Azure Data Catalog

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Azure Data Catalog.
  4. In the Example URL box, enter jdbc:azuredatacatalog:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.azuredatacatalog.AzureDataCatalogDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Azure Data Catalog Source.
    • Driver: Select the CData JDBC Driver for Azure Data Catalog.
    • URL: Enter jdbc:azuredatacatalog:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

      CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

    Connect Using OAuth Authentication

    You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

    Below is a typical connection string:

    jdbc:azuredatacatalog:InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Azure Data Catalog Data

After the metadata has loaded, a new tab for the Azure Data Catalog data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT DslAddressDatabase, Type FROM Tables WHERE Name = 'FactProductInventory'