Ready to get started?

Download a free trial of the SAP ByDesign Driver to get started:

 Download Now

Learn more:

SAP ByDesign Icon SAP ByDesign JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP ByDesign.

Connect to SAP ByDesign Data in as an External Source in Dremio



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

The CData JDBC Driver for SAP ByDesign implements JDBC Standards and allows various applications, including Dremio, to work with live SAP ByDesign 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 SAP ByDesign data as a part of your enterprise data lake. This article describes how to connect to SAP ByDesign data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live SAP ByDesign data in Dremio. Once you install the driver, authenticate with SAP ByDesign and gain immediate access to SAP ByDesign data within your data lake. By surfacing SAP ByDesign data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to SAP ByDesign 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 SAP ByDesign to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

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

JDBC Driver for SAP ByDesign

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

Connecting to SAP ByDesign

SAP ByDesign will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to SAP ByDesign 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 SAP ByDesign JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.sapbydesign.jar

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

Set the following connection properties to connect to SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

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:sapbydesign:RTK=5246...;URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;

Access SAP ByDesign as an External Source

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

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

More Information & Free Trial

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