How to connect to SAP Netweaver Gateway Data with Squirrel SQL client



Connect to SAP Netweaver Gateway data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for SAP Netweaver Gateway enables you to execute queries to SAP Netweaver Gateway data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for SAP Netweaver Gateway data and execute queries.

Add the JDBC Driver for SAP Netweaver Gateway

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for SAP Netweaver Gateway.
  4. In the Example URL box, enter jdbc:sapgateway:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.sapgateway.SAPGatewayDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData SAP Netweaver Gateway Source.
    • Driver: Select the CData JDBC Driver for SAP Netweaver Gateway.
    • URL: Enter jdbc:sapgateway:
    • User Name: Enter the username, which is added to the JDBC URL.
    • Password: Enter the password, which is added to the JDBC URL.
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    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.

    Below is a typical connection string:

    jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query SAP Netweaver Gateway Data

After the metadata has loaded, a new tab for the SAP Netweaver Gateway data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15

Ready to get started?

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

 Download Now

Learn more:

SAP Netweaver Gateway Icon SAP Netweaver Gateway JDBC Driver

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