Manage GraphQL Data in DBArtisan as a JDBC Source

The CData JDBC Driver for GraphQL seamlessly integrates GraphQL data into database management tools like DBArtisan by enabling you to access GraphQL data as a database. This article shows how to create a JDBC source for GraphQL in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate GraphQL Data into DBArtisan Projects

Follow the steps below to register GraphQL data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

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

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.graphql.jar
   

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

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:graphql:AuthScheme=Basic;User=username;Password=password;URL=https://mysite.com;InitiateOAuth=GETANDREFRESH;

6. Finish the wizard to connect to GraphQL data. GraphQL entities are displayed in the Datasource Explorer.

You can now work with GraphQL data as you work with any other database. See the driver help documentation for more information on the queries supported by the GraphQL API.