Connect Using the SAP HANA JDBC Driver

Ensure that you have a Java Development Kit (JDK) installed and ensure that it is accessible from your path. Details on supported versions can be found at SAP Note 3165810 - SAP HANA Client Supported Platforms.

An OpenJDK from SAP is available at SapMachine. If you don’t already have a JDK installed, please install it from SapMachine.

To verify that the JDK is correctly set up, run the following:

java -version
javac -version

If these commands fail, ensure that the folder they are located in, is included in your path.

The following command will install Java on openSUSE Leap 15.5.

sudo zypper install java-11-openjdk-devel

On macOS, you can install Java 11 using Homebrew with the following command:

brew install openjdk@11

To make it visible to system tools and IDEs, you may need to run the following command:

sudo ln -sfn /opt/homebrew/opt/openjdk@11/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-11.jdk

The SAP HANA driver for JDBC is a Multi-Release JAR file and as such supports multiple versions of Java. It is available in the client installation folder at C:\SAP\hdbclient\ngdbc.jar and in the maven repository at MVN Repository - ngdbc.

1. Run the following command for version information. If needed, adjust the path to match the installation location on your machine.

   Shell Copy

   java -jar C:\SAP\hdbclient\ngdbc.jar -v

   Shell Copy

   java -jar ~/sap/hdbclient/ngdbc.jar -v

2. Run the command again without the -v to open the configuration window, which provides driver information and the ability to set trace information:

   

   The JDBC driver has a different version number than the rest of the SAP HANA client interfaces.

   The trace options are further described at JDBC Tracing and Trace Options.

3. Run the following and use either connection details stored in the user store or specify the connection details. Details on where to find host, port, and credentials. are covered in the third and fifth steps of the first tutorial in this mission.

   Shell Copy

   java -jar C:\SAP\hdbclient\ngdbc.jar -k USER1UserKey -o encrypt=True -o validatecertificate=false -c "SELECT  * FROM HOTELS.CUSTOMER"

   Alternatively, you may run

   Shell Copy

   java -jar C:\SAP\hdbclient\ngdbc.jar -u USER1,Password1 -n your_host:your_port -o encrypt=True -o validatecertificate=false -c "SELECT  * FROM HOTELS.CUSTOMER"

   Shell Copy

   java -jar ~/sap/hdbclient/ngdbc.jar -u USER1,Password1 -n your_host:your_port -o encrypt=True -o validatecertificate=false -c "SELECT  * FROM HOTELS.CUSTOMER"

   

See JDBC Command-Line Connection Options for additional details on parameters of ngdbc.jar.

1. The following commands create a folder named java, enter the newly created directory, create a file named JavaQuery.java, and open the file in the Notepad text editor.

   Shell Copy

   mkdir %HOMEPATH%\HANAClientsTutorial\java
   cd %HOMEPATH%\HANAClientsTutorial\java
   notepad JavaQuery.java

   Substitute pico below for your preferred text editor.

   Shell Copy

   mkdir -p $HOME/HANAClientsTutorial/java
   cd $HOME/HANAClientsTutorial/java
   pico JavaQuery.java

2. Copy the following code into JavaQuery.java. Then save and exit the file.

   Java Copy

   import java.sql.*;
   import com.sap.db.jdbc.Driver;
   public class JavaQuery {
       public static void main(String[] argv) {
           System.out.println("Java version: " + com.sap.db.jdbc.Driver.getJavaVersion());
           System.out.println("SAP driver details: " + com.sap.db.jdbc.Driver.getVersionInfo() + "\n");
           Connection connection = null;
           try {  
               connection = DriverManager.getConnection(  
                   //Option 1, retrieve the connection parameters from the hdbuserstore
                   //The below URL gets the host, port and credentials from the hdbuserstore.
                   "jdbc:sap://dummy_host:0/?KEY=USER1UserKey&encrypt=true&validateCertificate=false");
   
                   //Option2, specify the connection parameters
                   //"jdbc:sap://10.11.123.134:39015/?encrypt=true&validateCertificate=false", "User1", "Password1");
   
                   //As of SAP HANA Client 2.6, connections on port 443 enable encryption by default
                   //validateCertificate should be set to false when connecting
                   //to an SAP HANA, express edition instance that uses a self-signed certificate.
   
                   //As of SAP HANA Client 2.7, it is possible to direct trace info to stdout or stderr
                   //"jdbc:sap://10.11.123.134:39015/?encrypt=true&validateCertificate=false&traceFile=stdout&traceOptions=CONNECTIONS", "User1", "Password1");
   
           }
           catch (SQLException e) {
               System.err.println("Connection Failed:");
               System.err.println(e);
               return;
           }
           if (connection != null) {
               try {
                   System.out.println("Connection to HANA successful!");
                   Statement stmt = connection.createStatement();
                   ResultSet resultSet = stmt.executeQuery("SELECT TITLE, FIRSTNAME, NAME FROM HOTELS.CUSTOMER;");
                   while (resultSet.next()) {
                       String title = resultSet.getString(1);
                       String firstName = resultSet.getString(2);
                       String lastName = resultSet.getString(3);
                       System.out.println(title + " " + firstName + " " + lastName);
                   }
               }
               catch (SQLException e) {
                   System.err.println("Query failed!");
               }
           }
       }
   }

   Show all 47 lines Show less

3. Compile the .java file into a .class file using the following command:

   Command Copy

   javac -cp C:\SAP\hdbclient\ngdbc.jar;. JavaQuery.java

   PowerShell Copy

   javac -cp "C:\SAP\hdbclient\ngdbc.jar;." JavaQuery.java

   Shell Copy

   javac -cp ~/sap/hdbclient/ngdbc.jar:. JavaQuery.java

4. Run JavaQuery.class and indicate where the SAP HANA JDBC driver is located. Note that the host, port, UID and PWD will be retrieved from the hdbuserstore.

   Command Copy

   java -classpath C:\SAP\hdbclient\ngdbc.jar;. JavaQuery

   PowerShell Copy

   java -classpath "C:\SAP\hdbclient\ngdbc.jar;." JavaQuery

   Shell Copy

   java -classpath ~/sap/hdbclient/ngdbc.jar:. JavaQuery

   

See JDBC Connection Options in Java Code for additional details on the getConnection method of the DriverManager.

See Connect to SAP HANA Cloud via JDBC for additional details on the certificate used during the connection.

Visual Studio Code provides plugins for Java and can be used to debug an application.

1. If you have not already done so, download Visual Studio Code.

2. If you have not already done so, in Visual Studio Code, choose File | Open Folder, and then select the HANAClientsTutorial folder.

   

3. Open the file JavaQuery.java, and if asked, install the recommended extensions.

   

4. Once the Java Extension Pack has been installed, expand the Java Project Explorer, and click on the + icon to add the JDBC driver as a referenced library.

   

   The JDBC driver is located at C:\SAP\hdbclient\ngdbc.jar.

5. Place a breakpoint and then select Run | Start Debugging.

   Notice that the debug view becomes active.

   Notice that the program stops running at the breakpoint that was set. Step through the code by pressing F10 and observe the variable values in the variables pane.

   

DBeaver is a free and open-source database tool and can be used with the SAP HANA JDBC driver.

The following steps demonstrate how to configure DBeaver to connect to SAP HANA Cloud or SAP HANA, express edition using the JDBC driver.

1. Download, install or unzip, and run the community edition of DBeaver.

   

2. Create a new SAP HANA database connection.

   

   Specify the connection type and fill in the Host and Port. Then press Test Connection. You may be asked to download the required SAP HANA client JDBC driver. The driver can also be updated under the Driver Settings.

   

   Click on Connection details to specify the connection name.

   

3. After finishing the wizard, the catalog of the database can be viewed, and SQL statements can be executed.

   

   DBeaver can also be used to create an entity relationship (ER) diagram, perform a comparison of two selected objects, execute import and export operations, view spatial data on a map, and perform data analysis with its grouping and calc panels.

Congratulations! You have now created and debugged a Java application that connects to and queries an SAP HANA database and used the JDBC driver in DBeaver.