VOOZH about

URL: https://www.cdata.com/kb/tech/cloudconvert-jdbc-rsql.rst

⇱ Connect to CloudConvert Data in RazorSQL


Connect to CloudConvert Data in RazorSQL

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to CloudConvert from wizards and query CloudConvert data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for CloudConvert enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to CloudConvert using wizards in RazorSQL.

Create a JDBC Data Source for CloudConvert Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.api.APIDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:api: and is followed by a semicolon-separated list of connection properties.

      CloudConvert uses API key authentication. Your CloudConvert API key is used to authenticate requests as a Bearer token. You can generate or view your keys at https://cloudconvert.com/dashboard/api/v2/keys.

      Using API Key Authentication

      After setting the following connection properties, you are ready to connect:

      • AuthScheme: Set this to APIKey.
      • APIKey: Set this to your CloudConvert API key.

      Example connection string:

      Profile=C:\profiles\CloudConvert.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
      

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.api.jar
      

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

      👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

      A typical JDBC URL is the following:

      jdbc:api:Profile=C:\profiles\CloudConvert.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. Connection properties are defined in the JDBC URL. (QuickBooks is shown.)

Query CloudConvert Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.

👁 The resuls of a query in RazorSQL. (QuickBooks is shown.)