Connect to JSON Services in DBeaver

Ready to get started?

Download for a free trial:

Download Now

Learn more:

JSON ODBC Driver

The JSON ODBC Driver is a powerful tool that allows you to connect with live JSON web services, directly from any applications that support ODBC connectivity.

Access JSON services like you would any standard database - read, write, and update etc. through a standard ODBC Driver interface.



Use the CData ODBC Driver to connect to JSON services in DBeaver.

The CData ODBC Driver for JSON enables access to live data from JSON under the ODBC standard, allowing you work with JSON services in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage JSON services with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live JSON services in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to JSON, the driver pushes supported SQL operations, like filters and aggregations, directly to JSON and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze JSON services.

Connect to JSON

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

  • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
  • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
  • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

Connecting to the JSON ODBC Data Source in DBeaver

  1. Open the DBeaver application and in the Database menu, select the New Database Connection option.
  2. In the 'Connect to a database' window, select ODBC and click Next.
  3. In the Database/Schema field, enter the DSN name (CData JSON Source by default). It will be automatically added to the JDBC URL as well.
  4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.

Query JSON Services

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table�s data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

Free Trial & More Information

At this point, you have connected to live JSON services from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live JSON services DBeaver today.