Hitachi

Hitachi Advanced Database Application Development Guide


4.2.2 HADB client for Linux

This subsection explains how to install and uninstall an HADB client for Linux.

Important
  • An HADB client is installed by the OS user who will be managing the HADB client.

  • This OS user's user name must not exceed 32 bytes.

Note that the client directory, as described later in this document, stores the files that relate to a single client process.

Organization of this subsection

(1) Matters to check before installing an HADB client

Before installing the HADB client, confirm that the packages required for the HADB client to function correctly are installed on the OS. The necessary packages are shown in the following table.

Table 4‒1: Necessary packages

No.

Package name

Linux version

RHEL 8

RHEL 9

RHEL 10

1

compat-openssl10

S

--

--

2

glibc

S

S

S

3

libaio

S

S

S

4

libcurl

--

S

S

5

libuuid

S

S

S

6

openssl-libs

--

S

S

7

zlib

S

S

--

8

zlib-ng-compat

--

--

S

Legend:

S: The package is required for this Linux version.

--: The package is not required for this Linux version.

■ How to check installed packages

Executing the following command will display a list of packages installed on the OS.

yum list installed

If there are packages that are not installed, install those packages on the OS. For instructions on how to install packages, refer to the OS manual.

■ How to check if a specific package is installed

Example:

Check if the package libaio is installed.

yum list installed | grep libaio

If the package libaio is displayed in the command output, the package libaio is installed. If the package libaio does not appear in the command output, this means that the package is not installed.

(2) Installing an HADB client

The following explains how to install an HADB client.

Note
  • Install an HADB client that corresponds to the version of the HADB server.

  • There are two types of HADB client installation data: installation data for RHEL 8, and installation data for RHEL 9 or later. Perform the installation of the HADB client by using the installation data corresponding to the version of Linux you are using. In particular, if you have installation data for both RHEL 8 and RHEL 9 or later, be sure to use the correct installation data.

  • Use the installation data stored on the HADB client installation CD-ROM. Do not perform the installation by using tar.gz files, etc., stored on a different CD-ROM.

Procedure

  1. Log in as the OS user who manages the HADB client.

  2. Create the directory for storing the installation data.

    mkdir /home/osuser01/client

    In the above example, /home/osuser01/client is created as the directory to store the HADB client installation data.

  3. Assign write permission to the directory you created.

    chmod 755 /home/osuser01/client

    Assign write permission to the directory you created so that the OS user who manages the HADB client can write to the directory (in this example, /home/osuser01/client).

  4. Mount the file system CD-ROM.

    Allow the file system CD-ROM containing the installation data for the HADB client to mount automatically.

    If the file system CD-ROM cannot be mounted automatically, mount it by executing the following command:

    mount /dev/cdrom /media

    The underlined portion is the mount directory name of the CD-ROM file system. It might differ in your environment.

    Important

    The directory names and file names on the CD-ROM may appear differently from what is described here, depending on the machine you are using. Execute the ls OS command and enter the displayed directory names as they are shown.

  5. Copy the installation data.

    Copy the following files stored in the mounted CD-ROM file system to the directory created in step 2 to store the installation data.

    • File in tar.gz format

    • Executable file of the adbinstall command

    cp /media/hitachi_advanced_database_client-$VER.tar.gz /home/osuser01/client ...a
    cp /media/adbinstall /home/osuser01/client                                   ...b

    Explanation:

    1. Copy the tar.gz file (the compressed file containing the HADB client program).

    2. Copy the executable file for the adbinstall command (the installation command for the HADB client).

    The underlined portion is the mount directory name of the CD-ROM file system. It might differ in your environment.

    $VER represents the HADB client version and release number.

    Important

    Be sure to copy the aforementioned two files into the same directory. If you copy them to different directories, the HADB client cannot be installed.

  6. Check that the copied files are not corrupted.

    Check that the files copied in step 5 are not corrupted. Run the following commands.

    cd /home/osuser01/client
    sha256sum -c /media/adbhashfile_client_sha256.txt

    The underlined portion is the mount directory name of the CD-ROM file system. It might differ in your environment.

    If there is a possibility that the file is corrupted (the hash value of the file is different), an error message will be displayed. In this case, redo the process from step 5.

    For details on the output messages, refer to the OS manual.

  7. Grant permissions.

    Assign execution permission for the adbinstall command (the installation command for the HADB client) to the OS user who manages the HADB client.

    Also, grant read permissions for the tar.gz file.

    chmod 555 /home/osuser01/client/adbinstall
    chmod 444 /home/osuser01/client/hitachi_advanced_database_client-$VER.tar.gz

    $VER represents the client version and release number of the HADB client.

  8. Install the HADB client.

    Execute the installation command (adbinstall command).

    /home/osuser01/client/adbinstall -c /home/osuser01/clientdir

    For the underlined part, specify the directory where you stored the installation data created in step 2.

    The HADB client is installed under the directory specified for the -c option (in the above, this is under the /home/osuser01/clientdir directory). This directory becomes the client directory.

    Note

    If the directory specified for the -c option does not exist, the directory is automatically created when the adbinstall command is executed.

    The following rules apply to the client directory:

    • The client directory path must not exceed 118 bytes.

    • For information on the characters that can be used in a client directory path, see <path name> under ■ Conventions: Syntax elements in the Preface.

    • When you specify a directory for the -c option of the adbinstall command, make sure that the OS user who will manage the HADB client can write to the directory.

  9. Verify that the HADB client has been installed correctly

    Open the adbinstcl.log file in the client directory and check its contents. If the HADB client is installed correctly, the following information is listed.

    Hitachi Advanced Database Client 06-00-/B (20250725131854)

    The first underlined part shows the output version information of the installed HADB client.

    The second underlined part shows the output date and time when the HADB client was installed (in the example above, July 25, 2025, at 13:18:54).

    Note
    • If the adbinstcl.log file already exists when the adbinstall command is run, the contents of the adbinstcl.log file is updated. Additionally, if the adbinstall command is executed multiple times, the date and time of the last execution are recorded.

    • If the return code of the adbinstall command (the return code output in the KFAA91552-I message) is not 0 or 4, the contents of the adbinstcl.log file will not be updated.

    • If the KFAA91555-I message is output when executing the adbinstall command, the contents of the adbinstcl.log file will not be updated.

Important

To use an ODBC driver, the version information of the ODBC driver must be the same as the version information of the HADB client. Therefore, do not replace some of the DLL files in the client\bin folder under the client directory.

■ Action to take when KFAA91553-E message is output

In the -c option of the adbinstall command, if you specify a directory for which the OS user who manages the HADB client does not have write permissions, the KFAA91553-E message is output.

The KFAA91553-E message is also output if the OS user who manages the HADB client does not have write permission for the directory that contains the installation data.

If the KFAA91553-E message is output, assign write permission to the OS user for the directory concerned.

■ Action to take when KFAA91558-W message is output

If the root user executes the adbinstall command instead of the OS user who manages the HADB client, the KFAA91558-W message is output.

Under normal circumstances, the OS user who manages the HADB client executes the adbinstall command. If the KFAA91558-W message is output, check whether executing the adbinstall command as a root user might cause any issues.

If doing so might cause an issue, press n (or N) when prompted for input by the KFAA91559-Q message output after the KFAA91558-W message. Then, execute the adbinstall command using the account of the OS user who manages the HADB client.

Note
  • The KFAA91558-W message is not output if a superuser other than root executes the adbinstall command.

  • root is the user whose value is 0 in the output of the id -u OS command. This includes situations in which you use the su command of the OS to elevate an OS user to root, giving that user a value of 0 in the output of the id -u command.

■ Tasks to be performed after installation
  • Setting environment variables

    After you have finished the installation, specify environment variables. For details about the environment variables to be specified, see 4.3.2 HADB client for Linux.

    Specify in the ADBCLTDIR environment variable the absolute path of the client directory. In the installation procedure example provided above, the client directory is /home/osuser01/clientdir.

  • Reviewing the targets of scans by antivirus software

    If antivirus software is installed on the client machine where HADB client is installed, review the scope of virus scans.

    • If the files and directories used by the HADB client are included in the scope of scans by antivirus software, the HADB client might not work correctly. For this reason, you need to configure the antivirus software to not scan the client directory.

    • If you are using PAM authentication, exclude the directory where public key files are stored from your antivirus software's scan targets.

Note

For details about the structure of the client directory that is created when an HADB client is installed by using the adbinstall command, see (1) Structure of the client directory (at installation) in B.2 HADB clients for Linux.

(3) Uninstalling an HADB client

An HADB client is uninstalled by the OS user who installed the HADB client.

Before uninstalling an HADB client, perform the following:

This subsection explains how to uninstall an HADB client.

Procedure

  1. Delete the client directory.

    The client directory must be deleted by the OS user who installed the HADB client.

    rm -rf /home/osuser01/clientdir
  2. Delete the directory for storing installation data.

    The directory for storing installation data must be deleted by the OS user who installed the HADB client.

    rm -rf /home/osuser01/client
  3. Delete the specifications for the environment variables that were set during installation.