Hitachi

In-Memory Data Grid Hitachi Elastic Application Data Store

14.3.24 listecf (displays a list of information about persistent data)

This subsection is applicable when you are using disk caches or two-way caches.

Organization of this subsection

(1) Description

This subcommand displays a list of information about the persistent data in the cluster.

To Page Top

(2) Rules

To Page Top

(3) Format

eztool listecf [-v [--divide number-of-segments]] [-s] [--threshold threshold-value]
               [cache-name]
               [--format format-name]
               [--columns column-name[,column-name]...]
               [--filter filter-condition]
               [--match matching-condition]

To Page Top

(4) Options and arguments

(a) -v or --verbose

Specify this option if you want to display the details of the command's execution results.

(b) --divide number-of-segments

When the -v or --verbose option is specified, the distribution of the numbers of files in each compaction effect range is displayed in the command execution results. Use this option to specify a desired number of ranges in which to distribute the file counts.

You can specify an integer from 1 to 10 for the number of ranges.

If this option is omitted, the value of the eads.command.compaction.effect.division parameter in the command properties is assumed as the number of segments (default is 5).

(c) -s or --single

Specify this option if you want to display the execution results for only the EADS server on which the command is executed.

(d) --threshold threshold-value

Specify this option if you want to display the number of cache data files whose compaction effects are at least a specified threshold (%).

You can specify for the threshold value an integer from 1 to 100.

If this option is omitted, the value of the eads.command.compaction.effect.threshold parameter in the command properties is used as the threshold (default is 50).

(e) cache-name

Specify this option if you want to display information about only the specified cache.

You can specify for the cache name a maximum of 32 single-byte alphanumeric characters (0 to 9, A to Z, a to z).

(f) --format format-name

For details about this option, see 14.4.2 How to specify the display format.

(g) --columns column-name[,column-name]...

For details about this option, see 14.4.3 How to specify column filters.

(h) --filter filter-condition

For details about this option, see 14.4.4 How to specify row filters.

(i) --match matching-condition

For details about this option, see 14.4.5 How to specify a condition match.

To Page Top

(5) Output example

The following shows output examples of the eztool listecf command's execution results.

For details about the components of the displayed information, see 14.4.1 Components of the displayed information.

[Figure] If option -v or --verbose is omitted

[Figure]

[Figure] If option -v or --verbose is specified

[Figure]

The following tables list and describe the summary and content information that are displayed.

Table 14‒48: Summary information displayed by the eztool listecf command

No.

Summary name

Description

Whether displayed

-v or --verbose option

Specification of -s or --single option

Omitted

Specified

1

CP: CacheProperties

CP is the abbreviation for a cache property file (CacheProperties).

N

Y

N

2

CI: CacheInfoFile

CI is the abbreviation for a cache information file (CacheInfoFile).

N

Y

N

3

CD: CacheDataFiles

CD is the abbreviation for cache data files (CacheDataFiles).

N

Y

N

4

FC: FileCount

FC is the abbreviation for the number of files (FileCount).

Y

Y

Y

5

CE: CompactionEffect

CE is the abbreviation for compaction effect (CompactionEffect).

Y

Y

Y

6

Ac: Accord

Ac is the abbreviation for match (Accord).

N

Y

N

7

Ex: Exist

Ex is the abbreviation for exist (Exist).

Y

Y

N
Legend:

Y: Displayed

N: Not displayed

Table 14‒49: Content information displayed by the eztool listecf command

No.

Column name

Description

Whether displayed

-v or --verbose option

Specification of -s or --single option

Omitted

Specified

1

Cache

Cache name.#1

Names of disk caches and two-way caches are extracted from the following cache information and then displayed:

  • Caches existing on the EADS servers

  • Caches specified in the cache property files

Y

Y

Y

2

ExCache

Whether the cache exists on the EADS server.#1

One of the following is displayed:

  • true

    The cache exists on the EADS server.

  • false

    The cache does not exist on the EADS server.

Y

Y

N

3

AcCP

Whether the cache property files match among the EADS servers.#1

This item displays whether the cache property files exist and whether they match among all EADS servers.

One of the following is displayed:

  • true

    Match.

  • false

    Do not match.

N

Y

N

4

AcCI

Whether the cache information files match among the EADS servers.#1

This item displays whether the cache information files match, ignoring EADS servers that do not have cache information files.

One of the following is displayed:

  • true

    Match.

  • false

    Do not match.

N

Y

N

5

Range

Range ID.#1

Number (integer 1 to 96) used to identify a range in the cache. The range ID matches the server ID of the EADS server on which the data is stored.

Y

Y

Y

6

Server

IP address of the EADS server that is included in Range and the EADS server's port number used to communicate with the EADS clients.

This information is displayed in the following format:

IP address:port number

Y

Y

N

7

ExCP

Whether the cache property file exists.

One of the following is displayed:

  • true

    Exists.

  • false

    Does not exist.

Nothing is displayed if the EADS server is not running or a communication error has occurred.

N

Y

N

8

ExCI

Whether the cache information file exists.

One of the following is displayed:

  • true

    Exists.

  • false

    Does not exist.

Nothing is displayed in the following cases:

  • The EADS server is not running.

  • A communication error has occurred.

  • The cache has not been imported to the EADS server and ExCP is false.

  • The cache has not been imported to the EADS server and the parameter required for acquiring ExCI information is not specified in the cache property file.

N

Y

N

9

ExCD

Whether the cache data file exists.

One of the following is displayed:

  • true

    Exists.

  • false

    Does not exist.

Nothing is displayed in the following cases:

  • The EADS server is not running.

  • A communication error has occurred.

  • The cache has not been imported to the EADS server and ExCP is false.

  • The cache has not been imported to the EADS server and the parameter required for acquiring ExCD information is not specified in the cache property file.

N

Y

N

10

UnusedFC

Number of unused files.

Nothing is displayed in the following cases:

  • The EADS server is not running.

  • A communication error has occurred.

  • The cache does not exist on the EADS server.

Y

Y

Y

11

MaxCE

Maximum compaction effects on the cache data files in the range.#2

Nothing is displayed in the following cases:

  • The EADS server is not running.

  • A communication error has occurred.

  • The cache does not exist on the EADS server.

Y

Y

Y

12

FilterCE(x%)#3

Number of files whose compaction effects are equal to or greater than the threshold value.#4

Nothing is displayed in the following cases:

  • The EADS server is not running.

  • A communication error has occurred.

  • The cache does not exist on the EADS server.

Y

Y

Y

13

CE(x-y%)#5

Distribution of the numbers of files in each compaction effects range.#4

Nothing is displayed in the following cases:

  • The EADS server is not running.

  • A communication error has occurred.

  • The cache does not exist on the EADS server.

N

Y

Y

(displayed only when the -v or --verbose option is specified)

Legend:

Y: Displayed

N: Not displayed

Notes:

The execution results are displayed according to the following priorities:

  1. Displayed in natural order of the Cache values.

  2. Rows with the same Cache value are displayed in ascending order of the Range values.

  3. Rows with the same Cache and Range values are displayed in the order of the Server values (in the order of EADS server that stores data and EADS server from which data was copied). This does not apply if the -s or --single option is specified.

#1

If the execution results contain multiple consecutive cells with the same value, only the first such cell is displayed and the other cells are omitted.

#2

All digits following the decimal point are discarded from the value indicating the compaction effects.

#3

The value set as the threshold is displayed for x.

#4

The number of files is totaled, with digits following the decimal point discarded from the value indicating compaction effects.

#5

The range obtained from the number of segments is displayed. For columns starting in 2, only (x-y%) is displayed as the range.

To Page Top

(6) Return code

The following table lists the return codes that this subcommand returns.

Table 14‒50: Return codes returned by the eztool listecf command

No.

Return code

Description

eads.command.compat parameter omitted in the command properties

0300 specified in the eads.command.compat parameter in the command properties

1

0

0

Command execution was successful.

2

101

101

Initialization of the command failed.

3

110

Connection establishment failed.

4

111

The command failed due to a communication timeout.

5

120

The command failed due to a syntax error.

6

130

The command failed because it could not be executed.

7

150

The command failed during execution.

8

200

The command failed due to a timeout.
When the --match option is specified:

If the condition was satisfied, the subcommand returns 0; otherwise, the subcommand returns 1. If the command's execution failed, the return code is the same as when the --match option is not specified.

To Page Top

(7) Notes

If the command times out during output processing, the output results might not be complete. The command might time out even if output processing is complete. If this happens, increase the command's timeout value, and then re-execute the command.

To Page Top

Trademarks

All Rights Reserved. Copyright (C) 2015, Hitachi, Ltd.