How to Connect DBeaver to PayPal via a JDBC Driver

The CData JDBC Driver for PayPal implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to PayPal data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for PayPal Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for PayPal).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.paypal.PayPalDriver.
   • Set URL Template to jdbc:paypal:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.PayPal.jar).

Create a Connection to PayPal Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for PayPal) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   The provider surfaces tables from two PayPal APIs. The APIs use different authentication methods.

   • The REST API uses the OAuth standard. To authenticate to the REST API, you will need to set the OAuthClientId, OAuthClientSecret, and CallbackURL properties.
   • The Classic API requires Signature API credentials. To authenticate to the Classic API, you will need to obtain an API username, password, and signature.

   See the "Getting Started" chapter of the help documentation for a guide to obtaining the necessary API credentials.

   To select the API you want to work with, you can set the Schema property to REST or SOAP. By default the SOAP schema will be used.

   For testing purposes you can set UseSandbox to true and use sandbox credentials.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.paypal.jar

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

   Below is a typical connection string:

   jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query PayPal Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial