Connect to GraphQL Data in DBeaver

Ready to get started?

Download for a free trial:

Download Now

Learn more:

GraphQL ODBC Driver

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

Access GraphQL data like you would a database through a standard ODBC Driver interface.



Use the CData ODBC Driver to connect to GraphQL data in DBeaver.

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

The CData ODBC drivers offer unmatched performance for interacting with live GraphQL data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to GraphQL, the driver pushes supported SQL operations, like filters and aggregations, directly to GraphQL 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 GraphQL data.

Connect to GraphQL

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.

You must specify the URL of the GraphQL service. The driver supports two types of authentication:

  • Basic: Set AuthScheme to Basic. You must specify the User and Password of the GraphQL service.
  • OAuth 1.0 & 2.0: Take a look at the OAuth section in the Help documentation for detailed instructions.

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 GraphQL 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 GraphQL 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 GraphQL Data

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 GraphQL data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live GraphQL data DBeaver today.