Connect to PayPal Data in DBVisualizer

The CData JDBC Driver for PayPal implements JDBC standards to provide connectivity to PayPal data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to PayPal data in DBVisualizer and use the table editor to load PayPal data.

Create a New JDBC Data Source for PayPal Data

Follow the steps below to use the Driver Manager to provide connectivity to PayPal data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
2. Enter a name for the data source.
3. Enter the following in the URL Format box: jdbc:paypal:
   The DBVisualizer Driver Manager.
4. In the User Specified tab, click the Open File button and select the cdata.jdbc.paypal.jar file, located in the lib subfolder of the installation directory.
5. In the Driver Class menu, select the PayPalDriver class, cdata.jdbc.paypal.PayPalDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.

2. In the Connection section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:paypal: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

     jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH
   • Database UserId: The username to use to authenticate to PayPal.
   • Database Password: The password to use to authenticate to PayPal.

3. On the Connection tab, click Connect.

To browse through tables exposed by the PayPal JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.