Query PayPal Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for PayPal, DataGrip can work with live PayPal data. This article shows how to establish a connection to PayPal data in DataGrip.

Create a New Driver Definition for PayPal

The steps below describe how to create a new Data Source in DataGrip for PayPal.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData PayPal Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.paypal.jar).
   • Set Class to cdata.jdbc.paypal.PayPal.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to PayPal

1. Once the connection is saved, click the plus (), then "Data Source" then "CData PayPal Driver" to create a new PayPal Data Source.
2. In the new window, configure the connection to PayPal with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against PayPal

To browse through the PayPal entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Date, GrossAmount FROM Transactions

Download a free, 30-day trial of the CData JDBC Driver for PayPal and start working with your live PayPal data in DataGrip. Reach out to our Support Team if you have any questions.