Query SAP Netweaver Gateway 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 SAP Netweaver Gateway, DataGrip can work with live SAP Netweaver Gateway data. This article shows how to establish a connection to SAP Netweaver Gateway data in DataGrip and use the table editor to load SAP Netweaver Gateway data.

Create a New Driver Definition for SAP Netweaver Gateway

The steps below describe how to create a new Data Source in DataGrip for SAP Netweaver Gateway.

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 SAP Netweaver Gateway 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.sapgateway.jar).
   • Set Class to cdata.jdbc.sapgateway.SAPGateway.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 SAP Netweaver Gateway

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

   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.

3. Set URL to the connection string, e.g., jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;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 SAP Netweaver Gateway

To browse through the SAP Netweaver Gateway 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 ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15

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 DataGrip. Reach out to our Support Team if you have any questions.