Ready to get started?

Download a free trial of the OData Driver to get started:

 Download Now

Learn more:

OData Icon OData JDBC Driver

Easy-to-use OData client (consumer) enables developers to build Java applications that easily communicate with OData services.

Connect to OData Services in DBVisualizer



Integrate OData services with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for OData implements JDBC standards to provide connectivity to OData services in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to OData services in DBVisualizer and use the table editor to edit and save OData services.

Create a New Driver Definition for OData Services

Follow the steps below to use the Driver Manager to provide connectivity to OData services from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager.
  2. Click the plus sign "" to create a new driver.
  3. Select "Custom" as the template.
  4. On the Driver Settings tab:
    • Set Name to a user-friendly name (e.g. "CData OData Driver")
    • Set URL Format to jdbc:odata:
    • In Driver artifacts and jar files (jars are loaded in order from top):
      1. Click the plus sign "" -> "Add Files"
      2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
      3. Select the JAR file (cdata.jdbc.OData.jar) and click "Open"
  5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.odata.ODataDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

  1. In the "Databases" tab, click the plus sign "" and select the driver you just created.
  2. In the "Connection" section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver Type: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:odata: followed by the connection properties in a semicolon-separated list of name-value pairs.

      The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, you will need to specify a URL to a valid OData server organization root or OData services file.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.odata.jar

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

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;
    • NOTE: Since OData does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the OData JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for OData and start working with your live OData services in DbVisualizer. Join the CData Community or reach out to our Support Team if you have any questions.