Hitachi

Hitachi Advanced Database Command Reference


Preface

This manual describes the command syntax used by Hitachi Advanced Database.

Note that, in this manual, and in the information output by the product (messages, command output results, and so on), HADB is often used in place of Hitachi Advanced Database.

Organization of this preface

■ Intended readers

This manual is intended for system engineers who design and set up HADB systems, and for system administrators.

Readers of this manual must have:

■ Organization of this manual

This manual is organized into the following chapters:

1. List of Commands and Common Rules

This chapter lists the HADB commands and explains the command specification format and common rules.

2. adbarchivechunk (Archive Chunk)

This chapter explains the adbarchivechunk command's functions and how to use the command.

3. adbaudittrail (Manage the Audit Trail Facility)

This chapter explains the adbaudittrail command's functions and how to use the command.

4. adbcancel (Forcibly Terminate Transactions or Commands)

This chapter explains the adbcancel command's functions and how to use the command.

5. adbchgchunkcomment (Set, Change, and Delete Comments for Chunks)

This chapter explains the adbchgchunkcomment command's functions and how to use the command.

6. adbchgchunkstatus (Change Chunk Status)

This chapter explains the adbchgchunkstatus command's functions and how to use the command.

7. adbchgnodetype (Change the HADB Server's Node Type)

This chapter explains the adbchgnodetype command's functions and how to use the command.

8. adbchgsqltrc (Start or Stop Output of SQL Trace Information)

This chapter explains the adbchgsqltrc command's functions and how to use the command.

9. adbchgsrvmode (Change the HADB Server Operation Mode)

This chapter explains the adbchgsrvmode command's functions and how to use the command.

10. adbclientdefmang (Centralized Management of Client Definitions)

This chapter explains the adbclientdefmang command's functions and how to use the command.

11. adbcolumnize (Manage the Updated-Row Columnizing Facility)

This chapter explains the adbcolumnize command's functions and how to use the command.

12. adbconvertaudittrailfile (Convert the Audit Trail File)

This chapter explains the adbconvertaudittrailfile command's functions and how to use the command.

13. adbdbstatus (Analyze the Database Status)

This chapter explains the adbdbstatus command's functions and how to use the command.

14. adbexport (Export Data)

This chapter explains the adbexport command's functions and how to use the command.

15. adbgetcst (Collect Cost Information)

This chapter explains the adbgetcst command's functions and how to use the command.

16. adbidxrebuild (Rebuild Indexes)

This chapter explains the adbidxrebuild command's functions and how to use the command.

17. adbimport (Import Data)

This chapter explains the adbimport command's functions and how to use the command.

18. adbinfoget (Collect Troubleshooting Information)

This chapter explains the adbinfoget command's functions and how to use the command.

19. adbinfosweep (Delete Troubleshooting Information)

This chapter explains the adbinfosweep command's functions and how to use the command.

20. adbinit (Initialize the Database)

This chapter explains the adbinit command's functions and how to use the command.

21. adbinstall (Install HADB Server or Client)

This chapter explains the adbinstall command's functions and how to use the command.

22. adbls -d cltgrp (Display Information of Client Groups and Command Groups)

This chapter explains the adbls -d cltgrp command's functions and how to use the command.

23. adbls -d cnct (Display the Connection Status)

This chapter explains the adbls -d cnct command's functions and how to use the command.

24. adbls -d gbuf (Display Global Buffer Information)

This chapter explains the adbls -d gbuf command's functions and how to use the command.

25. adbls -d lbuf (Display Local Work Table Buffer Information)

This chapter explains the adbls -d lbuf command's functions and how to use the command.

26. adbls -d lock (Display the Status of Locked Resources)

This chapter explains the adbls -d lock command's functions and how to use the command.

27. adbls -d mem (Display the Memory Usage Status)

This chapter explains the adbls -d mem command's functions and how to use the command.

28. adbls -d node (Display the HADB Server Status on Each Node)

This chapter explains the adbls -d node command's functions and how to use the command.

29. adbls -d shm (Display Shared Memory Information)

This chapter explains the adbls -d shm command's functions and how to use the command.

30. adbls -d srv (Display the HADB Server Status)

This chapter explains the adbls -d srv command's functions and how to use the command.

31. adbls -d thd (Display the Thread Status)

This chapter explains the adbls -d thd command's functions and how to use the command.

32. adbls -d ver (Display the HADB Server's Version Information)

This chapter explains the adbls -d ver command's functions and how to use the command.

33. adbmergechunk (Merge Chunks)

This chapter explains the adbmergechunk command's functions and how to use the command.

34. adbmodarea (Add and Change DB Areas)

This chapter explains the adbmodarea command's functions and how to use the command.

35. adbmodbuff (Change the Buffer)

This chapter explains the adbmodbuff command's functions and how to use the command.

36. adbmonitor (Monitor the HADB Server)

This chapter explains the adbmonitor command's functions and how to use the command.

37. adbreorgsystemdata (Reorganize the System Table)

This chapter explains the adbreorgsystemdata command's functions and how to use the command.

38. adbsql (Execute SQL Statements)

This chapter explains the adbsql command's functions and how to use the command.

39. adbstart (Start the HADB Server)

This chapter explains the adbstart command's functions and how to use the command.

40. adbstat (Perform Statistical Analysis of the HADB Server)

This chapter explains the adbstat command's functions and how to use the command.

41. adbstop (Terminate the HADB Server)

This chapter explains the adbstop command's functions and how to use the command.

42. adbsyndict (Manage the Synonym Dictionary)

This chapter explains the adbsyndict command's functions and how to use the command.

43. adbunarchivechunk (Unarchive Chunks)

This chapter explains the adbunarchivechunk command's functions and how to use the command.

■ Related publications

This manual is part of a related set of manuals. The manuals in the set are listed below (with the manual numbers):

In references to Hitachi Advanced Database manuals, this manual uses HADB in place of Hitachi Advanced Database.

Example: HADB Setup and Operation Guide

In references to the HA Monitor manual, this manual uses HA Monitor for Linux(R) (x86) in place of HA Monitor Cluster Software Guide (for Linux(R) (x86) Systems).

Example: HA Monitor for Linux(R) (x86)

In references to the Job Management Partner 1/Automatic Job Management System 3 manual, this manual uses Job Management Partner 1/Automatic Job Management System 3 System Design (Work Tasks) Guide in place of Job Management Partner 1 Version 10 Job Management Partner 1/Automatic Job Management System 3 System Design (Work Tasks) Guide.

Example: Job Management Partner 1/Automatic Job Management System 3 System Design (Work Tasks) Guide

In references to the JP1/Base manual, this manual uses JP1/Base User's Guide in place of JP1 Version 11 JP1/Base User's Guide.

Example: JP1/Base User's Guide

■ Conventions: Abbreviations for product names

This manual uses the following abbreviations for product names:

Abbreviation

Full name or meaning

HADB

HADB server

Hitachi Advanced Database

HADB client

Hitachi Advanced Database Client

Linux

Linux

Linux(R)

Red Hat Enterprise Linux Server 6

Red Hat(R) Enterprise Linux(R) Server 6 (64-bit x86_64)

Red Hat Enterprise Linux Server 6 (64-bit x86_64)

Red Hat Enterprise Linux Server 7

Red Hat(R) Enterprise Linux(R) Server 7 (64-bit x86_64)

Red Hat Enterprise Linux Server 7 (64-bit x86_64)

HDLM

Hitachi Dynamic Link Manager Software

JP1/AJS3

Job Management Partner 1/Automatic Job Management System 3

JP1/Audit

JP1/Audit Management - Manager

Red Hat Enterprise Linux Server 6 (64-bit x86_64)

Red Hat(R) Enterprise Linux(R) Server 6 (64-bit x86_64)

Red Hat Enterprise Linux Server 7 (64-bit x86_64)

Red Hat(R) Enterprise Linux(R) Server 7 (64-bit x86_64)

■ Conventions: Acronyms

This manual also uses the following acronyms:

Acronym

Full name or meaning

APD

Application Parameter Descriptor

API

Application Programming Interface

ARD

Application Row Descriptor

BI

Business Intelligence

BLOB

Binary Large Object

BNF

Backus-Naur Form

BOM

Byte Order Mark

CLI

Call Level Interface

CLOB

Character Large Object

CPU

Central Processing Unit

CSV

Character-Separated Values

DB

Database

DBMS

Database Management System

DMMP

Device Mapper Multipath

DNS

Domain Name System

ER

Entity Relationship

HBA

Host Bus Adapter

ID

Identification number

IEF

Integrity Enhancement Facility

IP

Internet Protocol

IPD

Implementation Parameter Descriptor

IRD

Implementation Row Descriptor

JAR

Java Archive File

JDBC

Java Database Connectivity

JDK

Java Developer's Kit

JNDI

Java Naming and Directory Interface

JRE

Java Runtime Environment

JTA

Java Transaction API

LOB

Large Object

LRU

Least Recently Used

LV

Logical Volume

LVM

Logical Volume Manager

MSDN

Microsoft Developer Network

NFS

Network File System

NIC

Network Interface Card

NTP

Network Time Protocol

ODBC

Open Database Connectivity

OS

Operating System

PP

Program Product

RAID

Redundant Array of Independent Disks

RDBMS

Relational Database Management System

TLB

Translation Lookaside Buffer

URL

Uniform Resource Locator

VG

Volume Group

WWN

World Wide Name

■ Conventions: Fonts and symbols

The following table explains the fonts used in this manual:

Font

Convention

Bold

Bold type indicates text on a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example:

  • From the File menu, choose Open.

  • Click the Cancel button.

  • In the Enter name entry box, type your name.

Italics

Italics are used to indicate a placeholder for some actual text to be provided by the user or system. For example:

  • Write the command as follows:

    copy source-file target-file

  • The following message appears:

    A file was not found. (file = file-name)

Italics are also used for emphasis. For example:

  • Do not delete the configuration file.

Code font

A code font indicates text that the user enters without change, or text (such as messages) output by the system. For example:

  • At the prompt, enter dir.

  • Use the send command to send mail.

  • The following message is displayed:

    The password is incorrect.

The table below shows the symbols used in this manual for explaining commands and operands, such as the operands used in server definitions.

Note that these symbols are used for explanatory purposes only; do not specify them in the actual operand or command.

Symbol

Meaning

Example

|

In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.

adb_sql_text_out = {Y|N}

In this example, the vertical bar means that you can specify either Y or N.

[ ]

In syntax explanations, square brackets indicate that the enclosed item or items are optional.

adbsql [-V]

In this example, the square brackets mean that you can specify adbsql, or you can specify adbsql -V.

{ }

In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected.

adbcancel {--ALL|-u connection-ID}

In this example, the curly brackets mean that you can specify either --ALL or -u connection-ID.

...

In syntax explanations, an ellipsis (...) indicates that the immediately preceding item can be repeated as many times as necessary.

adbbuff -n DB-area-name[, DB-area-name] ...

In this example, the ellipsis means that you can specify DB-area-name as many times as necessary.

{{ }}

In syntax explanations, double curly brackets indicate that the enclosed items can be repeated as a single unit.

{{adbinitdbarea -n data-DB-area-name}}

In this example, the double curly brackets mean that you can specify adbinitdbarea -n data-DB-area-name as many times as necessary.

X

(underline)

In syntax explanations, underlined characters indicate a default value.

adb_import_errmsg_lv = {0|1}

In this example, the underline means that the value 0 is assumed by HADB when the operand is omitted.

~

A swung dash indicates that the text following it explains the properties of the specified value.

adb_sys_max_users = maximum-number-of-concurrent-connections

~ <integer> ((1 to 1024)) <<10>>

In this example, the text following the swung dash means that you can specify an integer in the range from 1 to 1024. If the operand is not specified, the value 10 is assumed by HADB.

< >

Single angle brackets explain the data type of the specified value.

(( ))

Double parentheses indicate the scope of the specified value.

<< >>

Double angle brackets indicate a default value.

■ Conventions: Path names

■ Conventions: Symbols used in mathematical formulas

The following table explains special symbols used by this manual in mathematical formulas:

Symbol

Meaning

↑ ↑

Round up the result to the next integer.

Example: The result of ↑34 ÷ 3↑ is 12.

↓ ↓

Discard digits following the decimal point.

Example: The result of ↓34 ÷ 3↓ is 11.

MAX

Select the largest value as the result.

Example: The result of MAX(3 × 6, 4 + 7) is 18.

MIN

Select the smallest value as the result.

Example: The result of MIN(3 × 6, 4 + 7) is 11.

■ Conventions: Syntax elements

Syntax element notation

Meaning

<path name>

The following characters can be used in path names:

  • In Linux

    Alphanumeric characters, hash mark (#), hyphen (-), forward slash (/), at mark (@), and underscore (_)

  • In Windows

    Alphanumeric characters, hash mark (#), hyphen (-), forward slash (/), at mark (@), underscore (_), backslash (\), and colon (:)

Note, however, that the characters that can be used might differ depending on the operating system.

<OS path name>

For an OS path name, all characters that can be used in a path name in the operating system can be used. For details about available characters, see the documentation for the operating system you are using.

<character string>

Any character string can be specified.

<integer suffixed by the unit>

Specify the value in a format consisting of a numeric character (in the range from 0 to 9) followed by a unit (MB (megabyte), GB (gigabyte), or TB (terabyte)). Do not enter a space between the numeric character and the unit.

  • Examples of correct specification

    1024MB

    512GB

    32TB

  • Example of specification that causes an error

    512 GB

■ Conventions: KB, MB, GB, TB, PB, and EB

This manual uses the following conventions:

■ Conventions: Version numbers

The version numbers of Hitachi program products are usually written as two sets of two digits each, separated by a hyphen. For example:

The version number might be shown on the spine of a manual as Ver. 2.00, but the same version number would be written in the program as 02-00.