INTERNAL SAP HANA Client 2.0 Document Version: 1.1 – 2020-08-22 SAP HANA Client Interface Programming Reference company. All rights reserved. All rights company. affiliate THE BEST RUN 2020 SAP SE or an SAP SE or an SAP SAP 2020 © Content 1 SAP HANA Client Interface Programming Reference................................. 6 2 Connecting to SAP HANA Databases and Servers................................... 8 2.1 How to Use the Client Interfaces with SAP HANA Platform................................8 2.2 How to Use the Client Interfaces with SAP HANA Cloud................................. 10 2.3 How to Use the Client Interfaces with SAP HANA Service.................................11 2.4 Setting Session-Specific Client Information..........................................12 2.5 Use the User Store (hdbuserstore)................................................15 2.6 Environment Variables.........................................................17 3 Configuring Clients for Secure Connections.......................................23 3.1 Server Certificate Authentication.................................................23 3.2 Configuring the Client for Client-Side Encryption and LDAP.............................. 26 3.3 HTTP Proxy Client Connections..................................................27 Implement HTTP Proxy Client Connections....................................... 27 3.4 Mutual Authentication (SAP HANA Platform)........................................ 28 Implement Mutual Authentication (SAP HANA Platform)..............................28 4 Client Support for Active/Active (Read Enabled) (SAP HANA Platform)..................34 4.1 Connecting Using Active/Active (Read Enabled) (SAP HANA Platform)......................34 4.2 Forced Statement Routing to a Site for Active/Active (Read Enabled) (SAP HANA Platform)....... 35 4.3 Hint-Based Statement Routing for Active/Active (Read Enabled) (SAP HANA Platform).......... 35 5 Performance Tuning.........................................................38 5.1 Network Compression.........................................................38 Configure Network Compression...............................................39 Determine Network Compression Rate..........................................40 5.2 Packet Size.................................................................41 5.3 Prepared Statement Caching....................................................41 5.4 Result Set Prefetch...........................................................44 5.5 Tuning an Application.........................................................44 Reducing the Amount of Data Transferred on the Network.............................46 Reducing the Number of Requests............................................. 46 6 Statement Routing (SAP HANA Platform)........................................48 6.1 Client-side Statement and Batch Routing for Hash Partitioning (SAP HANA Platform)............50 6.2 Client-side Statement Routing for Range Partitioning (SAP HANA Platform)...................51 6.3 Configuring Statement Routing via SQL Hints (SAP HANA Platform)........................52 SAP HANA Client Interface Programming Reference 2 INTERNAL Content 6.4 Determining Statement Routing Details (SAP HANA Platform)............................52 6.5 Enabling SAP HANA Distribution Modes (SAP HANA Platform)............................53 7 SAP HANA Differences from Other Vendors.......................................57 7.1 Timestamps in SAP HANA......................................................57 8 SAP HANA Application Programming Interfaces................................... 59 8.1 ADO.NET Application Programming...............................................59 The SAP HANA Provider for ADO.NET...........................................60 The .NET Core Provider.....................................................86 The Microsoft .NET Framework Provider......................................... 88 Microsoft Visual Studio 2017 Plug-In........................................... 125 SAP HANA Data Provider for ADO.NET API Reference............................... 142 8.2 Go (golang) Application Programming............................................430 Go (golang) Differences from Other Database Vendors..............................432 Build the Go Driver........................................................432 Build and Run the Go Examples...............................................434 Connect to SAP HANA from Go...............................................435 Uninstall the Go Driver.....................................................451 8.3 JDBC Application Programming.................................................452 Connect to SAP HANA via JDBC..............................................452 Cursor Holdability Support..................................................477 JDBC Driver Static Methods.................................................478 Savepoint Support........................................................490 JDBC Tracing and Trace Options.............................................. 491 Hibernate Dialect for SAP HANA..............................................496 8.4 Node.js Application Programming............................................... 497 Configure the Node.js Driver (Client Install)......................................500 Configure the Node.js Driver (Node Package Manager)..............................502 Run the Node.js Examples.................................................. 503 Node.js Connection Properties...............................................504 Node.js Connection Pooling..................................................519 Connection Class.........................................................521 ResultSet Class..........................................................538 Statement Class.........................................................549 Stream Module..........................................................564 Encrypting Node.js Connections.............................................. 571 8.5 ODBC Application Programming.................................................572 Connect to SAP HANA via ODBC..............................................572 ODBC Statement Attributes.................................................593 ODBC Tracing and Trace Options..............................................597 8.6 ODBO Application Programming (SAP HANA Platform)................................603 SAP HANA Client Interface Programming Reference Content INTERNAL 3 8.7 Python Application Programming................................................603 Install the Python Driver....................................................603 Connect to SAP HANA from Python........................................... 605 Uninstall the Python Driver..................................................606 Connect Method and Python Connection Properties................................606 Connection Class.........................................................621 Cursor Class............................................................628 LOB Class..............................................................644 8.8 SQLDBC Library............................................................647 SQLDBC Connection Properties..............................................648 SQLDBC Tracing and Trace Options............................................662 8.9 Ruby Application Programming.................................................669 Configure Ruby for SAP HANA............................................... 670 Configure Ruby on Rails Support..............................................670 Run Ruby Examples.......................................................673 Ruby Connection Properties.................................................674 SAP HANA Ruby API Reference...............................................684 9 SAP HANA HDBSQL (Command-Line Reference)...................................714 9.1 SAP HANA HDBSQL Options................................................... 714 9.2 Log On to a Database.........................................................725 9.3 Run Commands............................................................726 9.4 Run Long Commands in Multiple-Line Mode........................................ 728 9.5 Edit Long Commands in an External File...........................................729 9.6 Redirect Results to a File......................................................730 9.7 Substitution Variables........................................................731 9.8 Implement HTTP Proxy Client Connections for SAP HANA HDBSQL (SAP HANA Cloud).........733 10 SAP HANA Calculation View API...............................................734 10.1 Install the SAP HANA Calculation View API.........................................734 10.2 Getting Started with Calculation Views............................................735 10.3 API Object Methods..........................................................737 10.4 Convert to Java Code........................................................ 738 10.5 Troubleshooting............................................................738 10.6 Limitations and Unsupported Use................................................739 11 SAP HANA Machine Learning APIs.............................................740 11.1 R Machine Learning Client for SAP HANA.......................................... 740 Configure the R Machine Learning Client for SAP HANA..............................740 11.2 Python Machine Learning Client for SAP HANA.......................................741