How to connect to SAP ByDesign Data with Squirrel SQL client

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

Add the JDBC Driver for SAP ByDesign

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 ByDesign.
4. In the Example URL box, enter jdbc:sapbydesign:
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.sapbydesign.SAPByDesignDriver.

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 ByDesign Source.
   • Driver: Select the CData JDBC Driver for SAP ByDesign.
   • URL: Enter jdbc:sapbydesign:
   • 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.

   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.

   Below is a typical connection string:

   jdbc:sapbydesign:URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query SAP ByDesign Data

After the metadata has loaded, a new tab for the SAP ByDesign 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: