Connect to PayPal Data in as an External Source in Dremio

Ready to get started?

Download for a free trial:

Download Now

Learn more:

PayPal JDBC Driver

Easy-to-use PayPal client enables Java-based applications to easily consume PayPal Transactions, Orders, Sales, Invoices, etc.



Use the CData JDBC Driver to connect to PayPal as an External Source in Dremio.

The CData JDBC Driver for PayPal implements JDBC Standards and allows various applications, including Dremio, to work with live PayPal data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC Driver, you can include live PayPal data as a part of your enterprise data lake. This article describes how to connect to PayPal data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live PayPal data in Dremio. Once you install the driver, authenticate with PayPal and gain immediate access to PayPal data within your data lake. By surfacing PayPal data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to PayPal data.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for PayPal to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-paypal-plugin-20.0.0.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for PayPal

docker cp PATH\TO\cdata.jdbc.paypal.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to PayPal

PayPal will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to PayPal data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the PayPal JDBC Driver. 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.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

jdbc:paypal:RTK=5246...;Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=GETANDREFRESH

Access PayPal as an External Source

To add PayPal as an External Source, click to add a new source and select PayPal. Copy the JDBC URL and paste it into the New PayPal Source wizard.

Save the connection and you are ready to query live PayPal data in Dremio, easily incorporating PayPal data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for PayPal in Dremio, you can incorporate live PayPal data into your data lake. Check out our PayPal connectivity page for more information about connecting to PayPal. Download a free, 30 day trial of the CData JDBC Driver for PayPal and get started today.