SAP_HANA_Client_Installation_Update_Guide_en.pdf

PUBLIC
SAP HANA Platform SPS 09
Document Version: 1.1 – 2015-02-16
SAP HANA Client Installation and
Update Guide

Content
1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1 Supported Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Software Download. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 SAP HANA Client on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1 Planning on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Available Clients on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Default Installation Paths for UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Installing the SAP HANA Client on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Install the SAP HANA Client on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Logging the Installation on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
2.3 Uninstalling the SAP HANA Client on UNIX or Linux. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Uninstall on UNIX or Linux in Interactive Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Uninstall on UNIX or Linux in Batch Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3 SAP HANA Client on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1 Planning on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Available Clients on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Default Installation Paths for Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.2 Installing the SAP HANA Client on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Install the SAP HANA Client on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Logging the Installation on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.3 Uninstall the SAP HANA Client on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4 Command and Call Option Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2
P U B L I C
© 2015 SAP SE or an SAP affiliate company. All rights reserved.
SAP HANA Client Installation and Update Guide
Content

1 Introduction
SAP HANA provides client interfaces for connecting applications as part of the SAP HANA client software
package. The SAP HANA client can be installed on both UNIX/Linux and Microsoft Windows operating
systems, as well as on a SAP HANA server host during server installation.
Related Information
SAP HANA Server Installation and Update Guide
1.1 Supported Platforms
The SAP HANA client software can be installed on a variety of platforms.
The following platform types are supported:
● AIX
● HP-UX
● Linux
● Microsoft Windows
● Solaris
For more information about supported platforms, see the tabs Operating Systems Clients for your
release in the SAP Product Availability Matrix (PAM).
Related Information
SAP Product Availability Matrix (PAM)
Introduction
P U B L I C
© 2015 SAP SE or an SAP affiliate company. All rights reserved. 3

1.2 Software Download
In the SAP Software Download Center, you have access to the installation media and components for SAP
HANA.
You can find the installation media and components for SAP HANA in the following locations:
● Installation media for an SAP HANA SPS:
SAP Software Download Center Installations and Upgrades A-Z Index Installations and Upgrades -
H SAP In-Memory (SAP HANA) HANA Platform Edition SAP HANA PLATFORM EDITION SAP
HANA PLATFORM EDIT. 1.0 Installation
● Support Packages and Patches for SAP HANA:
SAP Software Download Center Support Packages and Patches A-Z Index Support Packages and
Patches - H SAP HANA PLATFORM EDITION SAP HANA PLATFORM EDIT. 1.0
The responsibility for acquiring and installing SAP HANA depends on the chosen deployment model:
● If a customer chooses the SAP HANA tailored data center integration, the components of SAP HANA
have to be installed on validated hardware by a certified administrator.
● If a customer chooses an SAP HANA appliance, the components of SAP HANA can only be installed by
certified hardware partners on validated hardware running a specific operating system. Any other system
or content developed with systems of this type is not supported by SAP. For more information, see the
information page of the product version. Support Package Stacks (SPS) can be downloaded and applied
to appliances in accordance with agreements with the respective hardware partner.
Related Information
SAP Software Download Center
4
P U B L I C
Introduction

2 SAP HANA Client on UNIX or Linux
The SAP HANA client can be installed or uninstalled on supported UNIX and Linux operating systems.
2.1 Planning on UNIX or Linux
Before installing the SAP HANA client on a supported UNIX or Linux operating system, review the available
supported clients and the default installation paths.
2.1.1 Available Clients on UNIX or Linux
When you install the SAP HANA client software package, supported clients are installed and available.
The clients available on UNIX and Linux platforms are as follows:
● SQLDBC
● ODBC
When using unixODBC, install release 2.3.0 or higher (check with command isql --version).
● JDBC
2.1.2 Default Installation Paths for UNIX or Linux
The SAP HANA client software is unpacked to a default path during installation, depending on the platform
type and user. The default value can be changed by using the path call option.
Note
If you do not specify an installation path during installation, the following default values apply:
Table 1:
Platform Package Version Installation Path
Linux x86, 32-bit 32-bit /usr/sap/hdbclient
Linux x86, 64-bit 64-bit /usr/sap/hdbclient
Linux x86, 64-bit 32-bit /usr/sap/hdbclient32
SAP HANA Client on UNIX or Linux
P U B L I C

Other platforms - /usr/sap/hdbclient
When installing the SAP HANA client without administrative rights the installed SAP HANA client is only
available to the user who installed it, and the default installation folder is <$HOME>/sap/hdbclient.
Related Information
Command and Call Option Reference [page 14]
2.2 Installing the SAP HANA Client on UNIX or Linux
The SAP HANA client can be installed from a graphical user interface or in the command line.
Until SAP HANA SPS 06, the installation of the SAP HANA client was performed as root user. As of SAP HANA
SPS 07, the installation of the SAP HANA client can also be performed without administrative rights and is only
available to the user who installed it.
2.2.1 Install the SAP HANA Client on UNIX or Linux
Install the SAP HANA client from a graphical user interface or in the command line.
Prerequisites
If you plan to use the GUI option, hdbsetup, you need a local X11 graphical environment and an X server on the
machine where you perform the installation.
Procedure
1. Download and extract the software to an empty directory.
2. Open a shell and go to the directory where you unpacked the software.
3. Call the program hdbsetup (GUI installation) or hdbinst (command-line installation) by entering one of the
following commands:
6
P U B L I C

Option Description
GUI ./hdbsetup [-a client]
Command line ./hdbinst [-a client] [<option list>]
You can omit the call option -a client if you only have one installation kit - that is, one installation
variant - on your system.
4. Follow the instructions displayed by the installation tool.
5. For the environment of users that will use the client, including the user <sid>adm, add the installation
path to the library path environment variable. The library path environment variable differs according to
the operating system:
Operating System Library Path Environment Variable
AIX LIBPATH
HP-UX SHLIB_PATH
Linux LD_LIBRARY_PATH
Solaris LD_LIBRARY_PATH
For information on how to set environment variables, see your operating system documentation.
Results
The client software is installed.
Related Information
2.2.2 Logging the Installation on UNIX or Linux
The SAP HANA client installation is logged by the system. There are two log files written during installation.
● *.log: can be read using a text editor
● *.msg: XML format for the display in the installation tool with the graphical user interface
The log files are stored here:
/var/tmp/hdb_client_<time stamp>
P U B L I C

2.3 Uninstalling the SAP HANA Client on UNIX or Linux
Each installation has its own uninstallation tool. Use the hdbuninst program of the software package for which
you want to uninstall the client software.
2.3.1 Uninstall on UNIX or Linux in Interactive Mode
you want to uninstall the client software. Interactive mode requires call options to be accepted or changed
during installation. Defaults are offered for some call options.
Prerequisites
You are logged on to the host where the client software is installed.
Procedure
1. Open a shell and go to the directory where you unpacked the software for this installation.
2. Enter the following command:
./hdbuninst
3. Enter the ID of the client software installation and press Enter .
Results
The client software is removed from this host.
8
P U B L I C

2.3.2 Uninstall on UNIX or Linux in Batch Mode
you want to uninstall the client software. Batch mode runs the installation without interaction. Required call
options must be specified with the command; defaults are accepted for all un-specified call options.
Context
To call the hdbuninst program in batch mode, specify the installation path of the client software using the –
path option.
If you omit the installation path, the program does not run in batch mode but instead queries the installation
ID.
Procedure
1. Open a shell and go to the directory where you unpacked the software for this installation.
./hdbuninst --path <installation path> -b
Results
P U B L I C

3 SAP HANA Client on Windows
The SAP HANA client can be installed or uninstalled on supported Windows operating systems.
3.1 Planning on Windows
Before installing the SAP HANA client on Windows, review the available supported clients and the default
installation paths.
3.1.1 Available Clients on Windows
When you install the SAP HANA client software package, supported clients are installed and available.
The clients available on Microsoft Windows platforms are as follows:
● SQLDBC
● ODBO
● ODBC
● JDBC
● Microsoft ADO.NET
Note
To access the SAP HANA database from Microsoft Excel, you can install the 32-bit SAP HANA client for
Microsoft Excel. This is a self-extracting archive, which you can install independently of the other Windows
clients. It uses an ODBC driver.
For more information on the supported clients for SAP HANA, see SAP Note 1577128.
Related Information
1577128
10
P U B L I C
SAP HANA Client on Windows

3.1.2 Default Installation Paths for Windows
The SAP HANA client software is unpacked to a default path during installation, depending on the platform
type and user. The default value can be changed by using the path call option.
Note
If you do not specify an installation path during installation, the following default values apply:
Table 2:
Microsoft Windows x86, 32-bit 32-bit C:Program Filessap
hdbclient
Microsoft Windows x86, 64-bit 64-bit C:Program Filessap
hdbclient
Microsoft Windows x86, 64-bit 32-bit C:Program Files (x86)sap
hdbclient
When installing the SAP HANA client without administrative rights the installed SAP HANA client is only
available to the user who installed it, and the default installation folder is <%USERPROFILE%>sap
hdbclient.
Related Information
3.2 Installing the SAP HANA Client on Windows
The SAP HANA client can be installed from a graphical user interface or in the command line.
Until SAP HANA SPS 06, the installation of the SAP HANA client was performed as administrator. As of SAP
HANA SPS 07, the installation of the SAP HANA client can also be performed without administrative rights and
is only available to the user who installed it.
P U B L I C

3.2.1 Install the SAP HANA Client on Windows
Install the SAP HANA client from a graphical user interface or in the command line.
Procedure
1. Download and extract the software to an empty directory.
2. Open a command prompt and go to the directory where you unpacked the software.
3. Call the program hdbsetup (GUI installation) or hdbinst (command-line installation) by entering one of the
following commands:
Option Description
GUI hdbsetup [-a client]
Command line hdbinst [-a client] [<option list>]
You can omit the call option -a client if you only have one installation kit - that is, one installation
variant - on your system.
4. Follow the instructions displayed by the installation tool.
5. Add the installation path to the PATH environment variable.
For information on setting environment variables, see the documentation for your operating system.
6. To install the 32-bit SAP HANA client for Microsoft Excel, double-click the self-extracting file
HDBCLIENTXLS.exe and follow the instructions in the installation manager.
Results
The client software is installed.
Related Information
12
P U B L I C

3.2.2 Logging the Installation on Windows
The SAP HANA client installation is logged by the system. There are two log files written during installation.
● *.log: can be read using a text editor
● *.msg: XML format for the display in the installation tool with the graphical user interface
The log files are stored here:
%TEMP%hdb_client_<time stamp>
3.3 Uninstall the SAP HANA Client on Windows
you want to uninstall the client software.
Procedure
1. Open a command prompt and go to the directory where you unpacked the software for this installation.
hdbuninst
3. Enter the installation ID assigned to the client software installation and press Enter .
Results
Note
You can also use the standard Windows functionality Start Control Panel Add or remove programs
to remove the client software.
P U B L I C

4 Command and Call Option Reference
The SAP HANA installation tool, hdbinst, can be called in the command line in combination with call options.
Table 3: Commands
Operating System Syntax
UNIX or Linux ./hdbinst [-a client] [<option list>]
<option list> :: = <option> <option> ...
Microsoft Windows hdbinst [-a client] [<option list>]
<option list> :: = <option> <option> ...
The following call options can be used in combination with the call to SAP HANA lifecycle management tool
hdbinst.
archive_dir
Description
Specifies the installation variant - directory containing the installation kit.
Syntax
In the command line, the following syntax is used:
--archive_dir=<dir>
or, in short form:
-a <dir>
Remarks
The default for this parameter is --archive_dir=server. If the server installation kit
is not present, default values are (in order): client, studio.
batch
Description
14
P U B L I C
Command and Call Option Reference

Runs the SAP HANA lifecycle management tool from the command line in batch mode
using default values for unspecified parameters. If mandatory values are omitted or if
invalid values are specified, the program issues an error message.
Syntax
--batch
or, in short form:
-b
check_files
Description
Checks whether components of the installation kit are already installed on this host.
Syntax
--check_files
configfile
Description
Loads a configuration file of call option key-value pairs to be passed to the SAP HANA
lifecycle management program.
Syntax
--configfile=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
This complement to this call option is the call option dump_configfile_template.
dump_configfile_template
Description
P U B L I C

Specifies a file path to which a template configuration file is exported. The call options
in the template configuration file are set to their default values, and can be edited.
Syntax
--dump_configfile_template=<file path>
Remarks
The configuration file makes installation and configuration tasks more efficient and
reliable. For more information, see Related Information.
This complement to this call option is the call option configfile.
help
Description
Displays the inline help information.
Syntax
--help
or, in short form:
-h
Remarks
A general help output is available for all SAP HANA lifecycle management programs.
Task-specific help output is available for some programs. Refer to the task
documentation for more details.
hostname
Description
Specifies the host name of the machine.
Syntax
--hostname=<host name>
or, in short form:
-H <host name>
16
P U B L I C

Remarks
Restrictions apply to host names in SAP systems. For more information, see SAP Note
661361.
The default for this parameter is the host name of the current machine.
ignore
Description
Ignores failing prerequisite checks. Refer to the inline help output for program-specific
checks that can be ignored.
Syntax
--ignore=<check1>[,<check2>]...
list_packages
Description
Displays available software components and their versions.
Syntax
--list_packages
or, in short form:
-l
list_systems
Description
Displays a list of the installed SAP HANA systems on the current host, including the
SAP system ID (SID), instance number, version number, and hosts.
Syntax
--list_systems
P U B L I C

or, in short form:
-L
no_debug_packages
Description
Suppresses the installation of debug packages.
Syntax
--no_debug_packages
path
Description
Specifies the installation path of a client or studio installation.
Syntax
--path=<path>
or, in short form:
-p <path>
Remarks
The default for this parameter is --path=/usr/sap/hdbclient or --
path=/usr/sap/hdbstudio.
This parameter is available in interactive mode.
sapmnt
Description
Specifies the path to the SAP mount directory, which can be used as a shared directory
between multiple hosts.
Syntax
--sapmnt=<installation path>
18
P U B L I C

Remarks
The default for this parameter is --sapmnt=/hana/shared.
sid
Description
Specifies a system ID. The SAP system ID (SID) is the identifier for the SAP HANA
system.
Syntax
--sid=<SID>
or, in short form:
-s <SID>
version
Description
Displays the version of the SAP HANA lifecycle management tool.
Syntax
--version
or, in short form:
-v
Related Information
Default Installation Paths for UNIX or Linux [page 5]
Default Installation Paths for Windows [page 11]
P U B L I C

Important Disclaimer for Features in SAP
HANA Options
There are several types of licenses available for SAP HANA. Depending on the license type of your SAP HANA
installation, some of the features and tools that are described in the SAP HANA platform documentation may
only be available via the SAP HANA options, which may be released independently of an SAP HANA Platform
Support Package Stack (SPS). Although various features included in SAP HANA options are cited in the SAP
HANA platform documentation, customers who only purchased the license for the base edition of the SAP
HANA platform do not have the right to use features included in SAP HANA options, because these features
are not included in the license of the base edition of the SAP HANA platform. For customers to whom these
license restrictions apply, the use of features included in SAP HANA options in a production system requires
purchasing the corresponding software license(s) from SAP. The documentation for the SAP HANA optional
components is available in SAP Help Portal at http://help.sap.com/hana_options. For more information, see
also SAP Note 2091815 - SAP HANA Options If you have additional questions about what your particular
license provides, or wish to discuss licensing features available in SAP HANA options, please contact your SAP
account team representative.
20
P U B L I C
Important Disclaimer for Features in SAP HANA Options

Important Disclaimers and Legal Information
Coding Samples
Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system
environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and
completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP
intentionally or by SAP's gross negligence.
Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be
a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however,
does not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of
SAP.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as
"sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun
does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does
not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any
damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for
transparency (see: http://help.sap.com/disclaimer).
Important Disclaimers and Legal Information
P U B L I C

www.sap.com/contactsap
No part of this publication may be reproduced or transmitted in any
form or for any purpose without the express permission of SAP SE
or an SAP affiliate company. The information contained herein may
be changed without prior notice.
Some software products marketed by SAP SE and its distributors
contain proprietary software components of other software
vendors. National product specifications may vary.
These materials are provided by SAP SE or an SAP affiliate company
for informational purposes only, without representation or warranty
of any kind, and SAP or its affiliated companies shall not be liable for
errors or omissions with respect to the materials. The only
warranties for SAP or SAP affiliate company products and services
are those that are set forth in the express warranty statements
accompanying such products and services, if any. Nothing herein
should be construed as constituting an additional warranty.
SAP and other SAP products and services mentioned herein as well
as their respective logos are trademarks or registered trademarks
of SAP SE (or an SAP affiliate company) in Germany and other
countries. All other product and service names mentioned are the
trademarks of their respective companies.
Please see http://www.sap.com/corporate-en/legal/copyright/
index.epx for additional trademark information and notices.

SAP_HANA_Client_Installation_Update_Guide_en.pdf

More Related Content

Similar to SAP_HANA_Client_Installation_Update_Guide_en.pdf (20)

Recently uploaded (20)

SAP_HANA_Client_Installation_Update_Guide_en.pdf