Process & Analyze SAP Netweaver Gateway Data in Azure Databricks

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP Netweaver Gateway JDBC Driver

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



Host the CData JDBC Driver for SAP Netweaver Gateway in Azure and use Databricks to perform data engineering and data science on live SAP Netweaver Gateway data.

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live SAP Netweaver Gateway data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live SAP Netweaver Gateway data in Databricks.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SAP Netweaver Gateway data. When you issue complex SQL queries to SAP Netweaver Gateway, the driver pushes supported SQL operations, like filters and aggregations, directly to SAP Netweaver Gateway and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze SAP Netweaver Gateway data using native data types.

Install the CData JDBC Driver in Azure

To work with live SAP Netweaver Gateway data in Databricks, install the driver on your Azure cluster.

  1. Navigate to your Databricks administration screen and select the target cluster.
  2. On the Libraries tab, click "Install New."
  3. Select "Upload" as the Library Source and "Jar" as the Library Type.
  4. Upload the JDBC JAR file (cdata.jdbc.sapgateway.jar) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for SAP Netweaver Gateway\lib).

Connect to SAP Netweaver Gateway from Databricks

With the JAR file installed, we are ready to work with live SAP Netweaver Gateway data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query SAP Netweaver Gateway, and create a basic report.

Configure the Connection to SAP Netweaver Gateway

Connect to SAP Netweaver Gateway by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

driver = "cdata.jdbc.sapgateway.SAPGatewayDriver"
url = "jdbc:sapgateway:RTK=5246...;User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH"

Built-in Connection String Designer

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

java -jar cdata.jdbc.sapgateway.jar

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

SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts. In addition to authenticating, set the following connection properties to access SAP Gateway tables.

  • Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment URL would just be: https://sapes5.sapdevcenter.com.
  • Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full URL to the service is specified.
  • Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full URL is specified.

Authenticate via Basic Authentication

In basic authentication, you use your login credentials to connect. Set the following properties:

  • User: This is the username you use to log in to SAP Gateway.
  • Password: This is the password you use to log in to SAP Gateway.

Authenticate via OAuth Authentication

You can connect to SAP Gateway using the embedded OAuth connectivity (without setting any additional authentication connection properties). When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

Load SAP Netweaver Gateway Data

Once the connection is configured, you can load SAP Netweaver Gateway data as a dataframe using the CData JDBC Driver and the connection information.

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "SalesOrderLineItems") \
	.load ()

Display SAP Netweaver Gateway Data

Check the loaded SAP Netweaver Gateway data by calling the display function.

display (remote_table.select ("ProductID"))

Analyze SAP Netweaver Gateway Data in Azure Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

The SparkSQL below retrieves the SAP Netweaver Gateway data for analysis.

% sql

SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15

The data from SAP Netweaver Gateway is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

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