VOOZH about

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

⇱ Connect to PhantomBuster Data in RazorSQL


Connect to PhantomBuster Data in RazorSQL

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

The CData JDBC Driver for PhantomBuster 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 PhantomBuster using wizards in RazorSQL.

Create a JDBC Data Source for PhantomBuster 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.

      Using API Key Authentication

      To use the Phantombuster API, you need to obtain an API key from your Phantombuster account settings. Navigate to phantombuster.com, click your profile icon, select Settings, and copy the API key from the API section.

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

      • AuthScheme: Set this to APIKey.
      • APIKey: Set this to your Phantombuster API key from the account settings page.

      Multi-Organization Accounts

      If your API key is associated with multiple organizations, you can target a specific organization by setting the OrganizationId connection property to the desired organization identifier. When set, it is sent as the X-Phantombuster-Org request header.

      Example connection string:

      Profile=C:\profiles\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"
      

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the PhantomBuster 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\Phantombuster.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key_here"
👁 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 PhantomBuster 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.)