Official SAP HANA Node.js Driver
npm install @sap/hana-clientFully-featured Node.js driver for SAP HANA. It is used to connect, issue SQL queries, and obtain result sets.
``bash`
npm install @sap/hana-client
This driver communicates with the native HANA libraries, and thus requires
platform-specific native binaries. The official hosted version includes
precompiled libraries for Linux, Windows and Mac OS X.
The @sap/hana-client driver supports versions of Node.js 16 and higher.
SAP Community provides a forum where you can ask and answer questions, and
comment and vote on the questions of others and their answers.
See SAP HANA Community Questions for details.
The SAP HANA Node.js Driver help guide and API reference can be found on help.sap.com.
`js
var hana = require('@sap/hana-client');
var conn = hana.createConnection();
var conn_params = {
serverNode : 'myserver:30015',
uid : 'system',
pwd : 'Password123'
};
conn.connect(conn_params, function(err) {
if (err) throw err;
conn.exec('SELECT Name, Description FROM Products WHERE id = ?', [301], function (err, result) {
if (err) throw err;
console.log('Name: ', result[0].Name, ', Description: ', result[0].Description);
// output --> Name: Tee Shirt, Description: V-neck
conn.disconnect();
})
});
`
A database connection object is created by calling createConnection. Theconnect
connection is established by calling the connection object's method,
and passing in an object representing connection parameters.
#### Example: Connecting over TCP/IP
`js`
conn.connect({
host : 'myserver',
port : '30015',
uid : 'system',
pwd : 'Password123'
});
`js`
conn.disconnect(function(err) {
if (err) throw err;
console.log('Disconnected');
});
Direct statement execution is the simplest way to execute SQL statements. The
inputs are the SQL command to be executed, and an optional array of positional
arguments. The result is returned using callbacks. The type of returned result
depends on the kind of statement.
In the case of a successful DDL Statement, nothing is returned.
`js`
conn.exec('CREATE TABLE Test (id INTEGER PRIMARY KEY, msg VARCHAR(128))', function (err, result) {
if (err) throw err;
console.log('Table Test created!');
});
In the case of a DML Statement the number of affectedRows is returned.
`js`
conn.exec("INSERT INTO Test VALUES(1, 'Hello')", function (err, affectedRows) {
if (err) throw err;
console.log('Number of affected rows:', affectedRows);
});
The exec function is a convenient way to completely retrieve the result of a
query. In this case all selected rows are fetched and returned in the callback.
`js`
conn.exec("SELECT * FROM Test WHERE id < 5", function (err, rows) {
if (err) throw err;
console.log('Rows:', rows);
});
Values in the query can be substitued with JavaScript variables by using ?
placeholders in the query, and passing an array of positional arguments.
`js`
conn.exec("SELECT * FROM Test WHERE id BETWEEN ? AND ?", [5, 8], function (err, rows) {
if (err) throw err;
console.log('Rows:', rows);
});
The connection returns a statement object which can be executed multiple times.
`js`
conn.prepare('SELECT * FROM Test WHERE id = ?', function (err, stmt){
if (err) throw err;
// do something with the statement
});
The execution of a prepared statement is similar to the direct statement execution.
The first parameter of exec function is an array with positional parameters.
`js`
stmt.exec([16], function(err, rows) {
if (err) throw err;
console.log("Rows: ", rows);
});
The execution of a prepared batch statement is similar to the direct statement execution.
The first parameter of execBatch function is an array with positional parameters.
`js`
var stmt=conn.prepare("INSERT INTO Customers(ID, NAME) VALUES(?, ?)");
stmt.execBatch([[1, 'Company 1'], [2, 'Company 2']], function(err, rows) {
if (err) throw err;
console.log("Rows: ", rows);
});
The execution of a prepared query is similar to the direct statement execution.
The first parameter of execQuery function is an array with positional parameters.
`js`
var stmt=conn.prepare("SELECT * FROM Customers WHERE ID >= ? AND ID < ?");
stmt.execQuery([100, 200], function(err, rs) {
if (err) throw err;
var rows = [];
while (rs.next()) {
rows.push(rs.getValues());
}
console.log("Rows: ", rows);
});
`js`
stmt.drop(function(err) {
if (err) throw err;
});
__Transactions are automatically commited.__ Setting autocommit to false implicitly
starts a new transaction that must be explicitly committed, or rolled back.
`js`
conn.setAutoCommit(false);
// Execute some statements
conn.commit(function(err) {
if (err) throw err;
console.log('Transaction commited.');
});
`js``
conn.setAutoCommit(false);
// Execute some statements
conn.rollback(function(err) {
if (err) throw err;
console.log('Transaction rolled back.');
});
The HANA Node.js Driver is provided via the SAP Developer License Agreement.
By using this software, you agree that the following text is incorporated into the terms of the Developer Agreement:
> If you are an existing SAP customer for On Premise software, your use of this current software is also covered by the terms of your software license agreement with SAP, including the Use Rights, the current version of which can be found at: https://www.sap.com/about/agreements/product-use-and-support-terms.html?tag=agreements:product-use-support-terms/on-premise-software/software-use-rights