Connect to Azure Data Catalog Data in Aqua Data Studio

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.



Access Azure Data Catalog data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Azure Data Catalog integrates Azure Data Catalog data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Azure Data Catalog data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Azure Data Catalog data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Azure Data Catalog.
    • Driver Location: Click the Browse button and select the cdata.jdbc.azuredatacatalog.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.azuredatacatalog.AzureDataCatalogDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:azuredatacatalog: and is followed by a semicolon-separated list of 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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Azure Data Catalog JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.azuredatacatalog.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:azuredatacatalog:InitiateOAuth=GETANDREFRESH

Query Azure Data Catalog Data

You can now query the tables exposed.