13.2.1 Explanation of the specification format and options (outputting summary information or usage information)

(1) Specification format

The following indicates the specification format of the adbdbstatus command for outputting summary information or usage information.

For details about the specification format to output information about the need for reorganization of column store tables, see (1) Specification format in 13.2.2 Explanation of the specification format and options (outputting information about the need for reorganization of column store tables).

adbdbstatus
  [-d {summary|used}]
  [-c {dbarea|table|index|archivechunk}]
  [-n {DB-area-name|table-name|index-name}]
  [-t]
  [-k enclosing-character]
  [-s {delimiter|tab}]
  [-S {K|M|G}]
  [-r range-specification]
  [--shared-lock]

To Page Top

(2) Relationships among specified options and output information

When the adbdbstatus command outputs summary information or usage information, the type of information to be output is determined by the combination of the following options:

• -d option

• -c option

• -n option

The table below shows the relationships among the DB status analysis pattern to be executed, the type of information that is output, and the combination of options. For details about the options, see the descriptions of the -d, -c, and -n options in (3) Explanation of options.

Table 13‒1: Relationships among the DB status analysis pattern to be executed, the type of information that is output, and the combination of options

No.	DB status analysis pattern		Type of information that is output	Combination of options
	Target of analysis	Information to be analyzed		-d option specification	-c option specification	-n option specification
1	Entire database (all DB areas)	Usage of DB areas	Summary information for DB areas	summary or omitted	dbarea or omitted	--
2		Usage of DB area files and chunks	Usage information for DB areas, tables, and indexes	used	dbarea or omitted	--
3	Specific DB area	Usage of a DB area	Summary information for DB areas	summary or omitted	dbarea or omitted	DB-area-name
4		Usage of DB area's files and chunks	Usage information for DB areas, tables, and indexes	used	dbarea or omitted	DB-area-name
5	All tables	Usage and status of tables	Summary information for tables	summary or omitted	table	--
6		Usage of DB area files in DB areas where tables and chunks are stored	Usage information for DB areas, tables, and indexes	used	table	--
7	Specific table	Usage and status of a table	Summary information for tables	summary or omitted	table	table-name
8		Usage of DB area files in DB areas where tables and chunks are stored	Usage information for DB areas, tables, and indexes	used	table	table-name
9	All indexes	Usage and status of indexes	Summary information for indexes	summary or omitted	index	--
10		Usage of DB area files in DB areas where indexes and chunks are stored	Usage information for DB areas, tables, and indexes	used	index	--
11	Specific index	Usage and status of an index	Summary information for indexes	summary or omitted	index	index-name
12		Usage of DB area files in DB areas where indexes and chunks are stored	Usage information for DB areas, tables, and indexes	used	index	index-name
13	Archived chunk created in a specific table	Usage and status of chunks created in a multi-chunk table	Summary information of archived chunks	summary or omitted	archivechunk	table-name
14		Usage information of each archive file corresponding to an archived chunk	Usage information of archived chunks	used	archivechunk	table-name

Legend:

--: The -n option is omitted.

To Page Top

(3) Explanation of options

The following describes the options of the adbdbstatus command used to output summary information or usage information. For details about the options used to output information about the need for reorganization of column store tables, see (2) Explanation of options in 13.2.2 Explanation of the specification format and options (outputting information about the need for reorganization of column store tables).

• -d {summary|used}

Specifies the type of output results:

summary: Summary information

For details about the items that are displayed as the summary information, see the following:

• 13.3 Items that are output as summary information for DB areas

• 13.4 Items that are output as summary information for tables

• 13.5 Items that are output as summary information for indexes

• 13.6 Items that are output in the summary information of archived chunks

used: Usage information

For details about the items that are output as the usage information, see the following:

• 13.7 Items that are output as usage information for DB areas, tables, and indexes

• 13.8 Items that are output in the usage information of archived chunks

• -c {dbarea|table|index|archivechunk}

Specifies the range of information to be collected by the adbdbstatus command:

dbarea: DB area information

Information about DB areas is to be collected.

table: Table information

Information about tables is to be collected.

index: Index information

Information about indexes is to be collected.

archivechunk: Archived chunks created in a table

Information about archived chunks created in a table is to be collected.

If archivechunk is specified, the table name of the archivable multi-chunk table must be specified in the -n option.

• -n {DB-area-name|table-name|index-name}

~<character string>

Specifies the name of a DB area, table, or index when you want to collect information about a specific DB area, table, or index.

DB-area-name

Specifies the name of a DB area.

This option can be specified when either the -c option is omitted or dbarea is specified in the -c option. The work table DB area name (ADBWRK) and the master directory DB area name (ADBMST) cannot be specified.

table-name

Specifies a table name in the format schema-name.table-identifier. The schema name cannot be omitted. Specifying a viewed table results in an error.

This option can be specified when table is specified in the -c option.

In addition, if archivechunk is specified in the -c option, the table name of the archivable multi-chunk table must be specified.

To specify the table name of a dictionary table (base table) or system table (base table), specify HADB as the schema name.

For details about the specification rules that apply when a schema name or table identifier includes any lowercase letter or backslash (\), see 1.4.3 Table name specification rules.

index-name

Specifies an index name in the format schema-name.index-identifier. The schema name cannot be omitted.

This option can be specified when index is specified in the -c option.

To collect information about the B-tree index corresponding to the primary key, you must specify the index identifier (same as the constraint name) that was generated automatically. For details about how to check the index identifier of the B-tree index corresponding to the primary key, see Searching a dictionary table in the HADB Setup and Operation Guide.

To specify an index defined in a dictionary table (base table) and system table (base table), specify HADB as the schema name.

The following rules apply to specification of DB area names and index names:

• The specified character string is treated as being in all uppercase letters.

• If the character string to be specified as the name includes a lowercase letter, enclose the entire name in double quotation marks ("), and then enclose it in single quotation marks ('). If the name is not enclosed in double quotation marks (") and then within single quotation marks ('), it is treated as being in all uppercase letters.

  Example: -n '"ADBuser01"'.'"Index01"'

For details about the naming rules for DB areas, tables, and indexes, see Specifying names in SQL writing conventions in SQL Basics in the manual HADB SQL Reference.

• -t

Specifies that title lines (column headers) are not to be output.

• -k enclosing-character

~<character string>((1 byte))<<">>

Specifies an enclosing character to be used for the character strings in CSV format. If this option is omitted, the double quotation mark (") is assumed to be the enclosing character.

A single-byte character must be specified as the enclosing character (a character string consisting of two or more bytes cannot be specified). None of the following characters can be specified as the enclosing character:

• Space, tab, or asterisk (*)

• The character that is used as the delimiter (the value of or default value for the -s option)

Important

• If you specify a single quotation mark (') as the enclosing character, enclose each in double quotation marks (").

  Example: If you specify a single quotation mark (') as the enclosing character:

  adbdbstatus ... -k "'" ...

• If you specify as the enclosing character a special character used by the shell, such as the vertical bar (|), enclose each in either double quotation marks (") or single quotation marks (').

  Example: If you specify the vertical bar (|) as the enclosing character:

  adbdbstatus ... -k "|" ...

• Do not use as the enclosing character any character that is used in the column titles and contents output by the adbdbstatus command. For details about the columns that are output by the adbdbstatus command, see the following:

  - 13.3.2 List of items that are output as summary information for DB areas

  - 13.4.2 List of items that are output as summary information for tables

  - 13.5.2 List of items that are output as summary information for indexes

  - 13.6.2 List of items that are output in the summary information of archived chunks

  - 13.7.2 List of items that are output as usage information for DB areas, tables, and indexes

  - 13.8.2 List of items that are output in the usage information of archived chunks

• -s {delimiter|tab}

~<character string>((1 byte))<<,>>

Specifies the delimiter used in CSV format. To specify the tab character as the delimiter, specify tab. If this option is omitted, the comma (,) is assumed to be the delimiter.

Only tab or a single-byte character can be specified as the delimiter (except for tab, a character string consisting of two or more bytes cannot be specified). None of the following characters can be specified as the delimiter:

• Uppercase letters (A to Z), lowercase letters (a to z), numeric characters (0 to 9), underscore (_), double quotation mark ("), or asterisk (*)

• The character that is used as the enclosing character (the value of or default value for the -k option)

Important

• If you specify a single quotation mark (') as the delimiter, enclose it in double quotation marks (").

  Example: If you specify a single quotation mark (') as the delimiter:

  adbdbstatus ... -s "'" ...

• If you specify as the delimiter a special character used by the shell, such as the vertical bar (|), enclose it in either double quotation marks (") or single quotation marks (').

  Example: If you specify the vertical bar (|) as the delimiter:

  adbdbstatus ... -s "|" ...

• Do not use as the delimiter any character that is used in the column titles and contents output by the adbdbstatus command. For details about the columns that are output by the adbdbstatus command, see the following:

  - 13.3.2 List of items that are output as summary information for DB areas

  - 13.4.2 List of items that are output as summary information for tables

  - 13.5.2 List of items that are output as summary information for indexes

  - 13.6.2 List of items that are output in the summary information of archived chunks

  - 13.7.2 List of items that are output as usage information for DB areas, tables, and indexes

  - 13.8.2 List of items that are output in the usage information of archived chunks

• -S {K|M|G}

Specifies that the output items for usage amounts are to be displayed in kilobytes, megabytes, or gigabytes, rather than in segments or pages.

When this option is omitted, the output items for usage amounts are displayed in segments or pages.

K: Kilobytes

Specifies that the output items for usage amounts are to be displayed in kilobytes.

M: Megabytes

Specifies that the output items for usage amounts are to be displayed in megabytes.

G: Gigabytes

Specifies that the output items for usage amounts are to be displayed in gigabytes.

When this option is specified, the column titles for the corresponding output items are also changed to match the units specified for the display information. The following table shows the relationships among the value of this option, the display units for output items, and the column titles.

Table 13‒2: Display units and column titles for usage amount output items

No.	Information type	Output item	Value of this option	Display units for output items	Column title
1	Summary information for DB areas	Number of segments in use in the DB area	--	Segments	Used_segments
2			K	Kilobytes	KB_Used_segments
3			M	Megabytes	MB_Used_segments
4			G	Gigabytes	GB_Used_segments
5		Total number of segments in the DB area	--	Segments	Total_segments
6			K	Kilobytes	KB_Total_segments
7			M	Megabytes	MB_Total_segments
8			G	Gigabytes	GB_Total_segments
9	Summary information for tables	Number of segments in use by the table	--	Segments	Used_segments
10			K	Kilobytes	KB_Used_segments
11			M	Megabytes	MB_Used_segments
12			G	Gigabytes	GB_Used_segments
13		Number of pages in use by the table	--	Pages	Used_pages
14			K	Kilobytes	KB_Used_pages
15			M	Megabytes	MB_Used_pages
16			G	Gigabytes	GB_Used_pages
17	Summary information for indexes	Number of segments in use by the index	--	Segments	Used_segments
18			K	Kilobytes	KB_Used_segments
19			M	Megabytes	MB_Used_segments
20			G	Gigabytes	GB_Used_segments
21		Number of pages in use by the index	--	Pages	Used_pages
22			K	Kilobytes	KB_Used_pages
23			M	Megabytes	MB_Used_pages
24			G	Gigabytes	GB_Used_pages
25	Usage information for DB areas, tables, and indexes	Number of segments in use	--	Segments	Used_segments
26			K	Kilobytes	KB_Used_segments
27			M	Megabytes	MB_Used_segments
28			G	Gigabytes	GB_Used_segments
29		Number of pages in use	--	Pages	Used_pages
30			K	Kilobytes	KB_Used_pages
31			M	Megabytes	MB_Used_pages
32			G	Gigabytes	GB_Used_pages
33		Total number of segments in the DB area file	--	Segments	Total_segments
34			K	Kilobytes	KB_Total_segments
35			M	Megabytes	MB_Total_segments
36			G	Gigabytes	GB_Total_segments
37		Number of initialized pages in the DB area file	--	Pages	Initialized_pages
38			K	Kilobytes	KB_Initialized_pages
39			M	Megabytes	MB_Initialized_pages
40			G	Gigabytes	GB_Initialized_pages

Legend:

--: This option is omitted.

• -r range-specification

If you want to output information about archived chunks, specify the range of chunks whose information you want to output. For details about the -r option, see (4) Explanation of the -r option (range specification).

• --shared-lock

Specifies that the lock of the adbdbstatus command is to be changed. Specify this option if you want to execute the adbdbstatus command concurrently with the following commands and SQL statements:

• adbimport command (when background import is performed)

• adbmergechunk command

• Update SQL statements (INSERT statement, DELETE statement, and UPDATE statement)

For details about the lock when the --shared-lock option is specified, see Locked resources that are reserved and their lock modes in the HADB Setup and Operation Guide.

If the adbdbstatus command with the --shared-lock option specified is executed, some output items cannot be acquired. Also, if the adbdbstatus command with the --shared-lock option specified is executed concurrently with a transaction that updates the database, values of some output items might be inconsistent. For details, see the following.

Important

For details about the output items when the --shared-lock option is specified, see 13.4.2 List of items that are output as summary information for tables, 13.5.2 List of items that are output as summary information for indexes, and 13.7.2 List of items that are output as usage information for DB areas, tables, and indexes.

■ Output items that cannot be acquired if the --shared-lock option is specified

If the --shared-lock option is specified, the following output items cannot be acquired. In this case, no_check is always displayed.

• Summary information for tables

  Whether the table is non-updatable (Non-updatable), and command termination status (Command_status)

• Summary information for indexes

  Uniqueness constraint violation (Unique_constraint_violated), and whether the index is in unfinished status (Unfinished)

In addition, if the --shared-lock option is specified, information about deletion-pending chunks corresponding to the following tables or indexes is not output:

• System table (base table)

• Index defined for a system table (base table)

• Table for which the adbmergechunk command is being executed

• Index defined for a table for which the adbmergechunk command is being executed

■ Restrictions on output items when the --shared-lock option is specified

The adbdbstatus command with the --shared-lock option specified can be executed for a table for which one of the following commands was executed. In this case, the latest value might not be displayed for items relating to the number of segments, pages, or chunks. (The values that existed when the relevant command started might be displayed.) Therefore, a displayed value might be inconsistent with the values of other output items.

• adbimport command (when background import is performed)

• adbidxrebuild command (executed with the --create-temp-file option specified after background import is canceled)

• adbmergechunk command

• adbreorgsystemdata command

Note that if the --shared-lock option is specified when the following information is to be output, the adbdbstatus command causes an error:

• Summary information for DB areas

  If summary is specified for the -d option (or the -d option is omitted) and dbarea is specified for the -c option (or the -c option is omitted)

• Summary information of archived chunks

  If summary is specified for the -d option (or the -d option is omitted) and archivechunk is specified for the -c option

• Usage information of archived chunks

  If used is specified for the -d option and archivechunk is specified for the -c option

To Page Top

(4) Explanation of the -r option (range specification)

When you want to output information about archived chunks, use the -r option to specify the range of chunks whose information is to be output. If the specified range contains any part of the range of values in the archive range column (the column used to narrow down the search range when searching the archivable multi-chunk table), the corresponding chunks' information is output. If the corresponding chunk does not exist, no information is output.

The range specification is interpreted based on the data type in the archive range column.

The following table lists the types of range specifications and links to their detailed explanations.

Table 13‒3: Types of range specifications and their links

No.	Type of range specification	Link
1	Date range specification	(a) Specifying ranges of dates
2	Time range specification	(b) Specifying ranges of times
3	Time stamp range specification	(c) Specifying ranges of time stamps
4	Fixed-length character string range specification	(d) Specifying ranges of fixed-length character strings
5	Decimal range specification	(e) Specifying ranges of decimal numbers
6	Integer range specification	(f) Specifying ranges of integers
7	Floating point range specification	(g) Specifying ranges of floating point numbers

This section shows which chunks' information is to be output, using the following conditions as an example:

• The data type in the archive range column is DATE.

• The date range 2015/02/10 - 2015/04/01 is specified in the range specification.

Figure 13‒2: Relationship between the content of the date range specification and the chunks whose information is to be output

The rules for specifying the -r option are as follows:

• When this option is specified, archivechunk must be specified in the -c option. If archivechunk is not specified in the -c option, KFAA90002-E message is output. In addition, the table name of the archivable multi-chunk table must be specified in the -n option. If the specified table name is not the table name of the archivable multi-chunk table, the KFAA50280-E message is output.

• You can only specify one range. Multiple ranges cannot be specified.

• If 1,024 bytes or more are specified in the range specification, the KFAA90003-E message is output.

• In this option, specify the value that results after characters such as shell enclosing characters have been parsed. The specified value and the actual interpreted value might differ depending on how the shell parses the characters. The following is an example of specifying a range of fixed-length character strings.

  Option specification value: -r 'abc'-'def'

  Actual interpreted value: -r abc-def

  Single quotation marks (') have been omitted from the actual interpreted value.

To Page Top