hdb/lib/protocol/part/ConnectOptions.js

SAP HANA Database Client for Node

// Copyright 2013 SAP AG.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http: //www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
// either express or implied. See the License for the specific
// language governing permissions and limitations under the License.
'use strict';

var util = require('../../util');
var AbstractOptions = require('./AbstractOptions');
var common = require('../common');

var DataFormatVersion = common.DataFormatVersion;
var ClientDistributionMode = common.ClientDistributionMode;
var DistributionProtocolVersion = common.DistributionProtocolVersion;

module.exports = ConnectOptions;

util.inherits(ConnectOptions, AbstractOptions);

function ConnectOptions() {
  AbstractOptions.call(this);

  // This field contains the connection ID.
  // It is filled by the server when the connection is established.
  // This number can be used in DISCONNECT / KILL commands for command
  // or session cancellation.
  this.connectionId = undefined;

  // This field is set if array commands continue to process
  // remaining input when detecting an error in an input row.
  // Always set for current client and server.
  this.completeArrayExecution = true;

  // The session locale can be set by the client.
  // The locale is used in language-dependent handling
  // within the SAP HANA database calculation engine.
  this.clientLocale = 'en_US';

  // This field is set by the server to process array commands.
  this.supportsLargeBulkOperations = undefined;

  // This field is set by the server to indicate
  // support of a large number of parameters.
  this.largeNumberOfParametersSupport = undefined;

  // This option is set by the server and filled with the SAPSYSTEMNAME
  // of the connected instance for tracing and supportability purposes.
  this.systemId = undefined;

  // This field is set by the client to indicate that the client is able
  // to handle the special function code for SELECT ... FOR UPDATE commands.
  this.selectForUpdateSupported = false;

  // This field is set by the client to indicate the mode for handling
  // statement routing and client distribution.
  // The server sets this field to the appropriate support level
  // depending on the client value and its own configuration.
  //
  // The following values are supported:
  // *  `0` OFF, no routing or distributed transaction handling is done.
  // *  `1` CONNECTION, client can connect to any (master/slave) server
  //        in the topology, and connections are enabled, such that the
  //        connection load on the nodes is balanced.
  // *  `2` STATEMENT, server returns information about which node is preferred
  //        for executing the statement, clients execute on that node,
  //        if possible.
  // *  `3` STATEMENT_CONNECTION, both STATEMENT and CONNECTION level
  this.clientDistributionMode = ClientDistributionMode.OFF;

  // The server sets this field to the maximum version it is able to support.
  // The possible values correspond to the `dataFormatVersion` property.
  this.engineDataFormatVersion = undefined;

  // This field is set by the client and indicates
  // the support level in the protocol for distribution features.
  // The server may choose to disable distribution if the support level
  // is not sufficient for the handling.
  // *  `0` BASE Baseline version
  // *  `1` Client handles statement sequence number information
  //        (statement context part handling).
  // `clientDistributionMode` is OFF if a value less than one
  // is returned by the server.
  this.distributionProtocolVersion = DistributionProtocolVersion.BASE;

  // This field is sent by the client and returned by the server
  // if configuration allows splitting batch (array)
  // commands for parallel execution.
  this.splitBatchCommands = true;

  // This field is sent by the server to indicate the client should gather the
  // state of the current transaction only from the `TRANSACTIONFLAGS` command,
  // not from the nature of the command (DDL, UPDATE, and so on).
  this.useTransactionFlagsOnly = undefined;

  // This field is sent by the server to indicate it ignores unknown parts
  // of the communication protocol instead of raising a fatal error.
  this.ignoreUnknownParts = undefined;

  // This field is sent by the server and is the server version string
  this.fullVersionString = undefined;

  // This field is sent by the server and is the Cloud version that the
  // server was released under (undefined for on-premise servers)
  this.cloudVersionString = undefined;

  // The client indicates this set of understood type codes and field formats.
  // The server then defines the value according to its own capabilities,
  // and sends it back. The following values are supported:
  // *  `1` Baseline data type support (SAP HANA SPS 02)
  // *  `4` Baseline data type support (SAP HANA SPS 06)
  //        Support for ALPHANUM, TEXT, SHORTTEXT, LONGDATE, SECONDDATE,
  //        DAYDATE, and SECONDTIME.
  // *  `5` Support for ST_GEOMETRY and ST_POINT
  // *  `6` Specifies to send the data type BINTEXT to the client
  // *  `7` Support for BOOLEAN
  // *  `8` Support for FIXED8/12/16
  // TODO: Once implementation and testing for data format version 4 are
  // complete, replace dataFormatVersion and dataFormatVersion2 with the
  // commented-out lines.
  this.dataFormatVersion = DataFormatVersion.COMPLETE_DATATYPE_SUPPORT;
  //this.dataFormatVersion = DataFormatVersion.LEVEL4;
  this.dataFormatVersion2 = DataFormatVersion.COMPLETE_DATATYPE_SUPPORT;
  //this.dataFormatVersion2 = DataFormatVersion.LEVEL4;
}

ConnectOptions.prototype.PROPERTY_NAMES = common.ConnectOptionName;
ConnectOptions.prototype.TYPES = common.ConnectOptionType;
ConnectOptions.prototype.KEYS = [
  common.ConnectOption.COMPLETE_ARRAY_EXECUTION,
  common.ConnectOption.CLIENT_LOCALE,
  common.ConnectOption.CLIENT_DISTRIBUTION_MODE,
  common.ConnectOption.DISTRIBUTION_PROTOCOL_VERSION,
  common.ConnectOption.SELECT_FOR_UPDATE_SUPPORTED,
  common.ConnectOption.SPLIT_BATCH_COMMANDS,
  common.ConnectOption.DATA_FORMAT_VERSION,
  common.ConnectOption.DATA_FORMAT_VERSION2,
  common.ConnectOption.OS_USER,
  common.ConnectOption.FULL_VERSION_STRING,
  common.ConnectOption.REDIRECTION_TYPE,
  common.ConnectOption.REDIRECTED_HOST,
  common.ConnectOption.REDIRECTED_PORT,
  common.ConnectOption.ENDPOINT_HOST,
  common.ConnectOption.ENDPOINT_PORT,
  common.ConnectOption.ENDPOINT_LIST,
  common.ConnectOption.CLOUD_VERSION_STRING,
  common.ConnectOption.COMPRESSION_LEVEL_AND_FLAGS,
];