14.3.10 getposition (displays data storage locations)
- Organization of this subsection
(1) Description
This subcommand displays the EADS servers that store a specified key or group.
(2) Rules
-
This subcommand can be executed only when the status of the cluster is one of the following:
-
Cluster available (AVAILABLE)
-
Cluster partially available (PARTIALLY_AVAILABLE)
-
-
This subcommand can be executed when the EADS servers are in the following status:
-
Initializing
-
Initialized
-
Running
-
Closing
-
Closed
-
Isolated
-
Stopping
-
-
If the -l or --local option is specified, this subcommand can be executed regardless of the cluster or EADS server status.
-
If an EADS server to be added to the cluster has not yet participated in the cluster, this subcommand cannot be executed on that EADS server.
(3) Format
eztool getposition key-or-group-name [-l] [--format format-name] [--columns column-name[,column-name]...] [--filter filter-condition] [--match matching-condition]
(4) Options and arguments
(a) key-or-group-name
Specify the key name or group name associated with the data whose storage EADS servers are to be displayed.
For details about the data that can be specified, see 15.2.2(1) Data types that can be specified as keys or 15.2.2(2) Data that can be specified as group names.
(b) -l or --local
Specify this option if you want to know whether the EADS server stores the specified key or group in the cluster configuration set up in the cluster properties.
When this option is specified, the command imports the contents of the cluster property file for the EADS server on which the command was executed.
An error occurs in the following cases:
-
There is no cluster property file on the EADS server on which the command is executed.
-
The eads.node.EADS-server-ID.address and eads.node.EADS-server-ID.port parameters are not defined in the cluster properties.
- Important note
-
If you want to know from the cluster information currently in use which EADS servers store the specified key or group, execute the subcommand without specifying this option.
If this option is omitted, the subcommand does not display information about the EADS servers that are shut down. Check the data copy status by comparing the number of displayed EADS servers with the value of ReplicationCount (data multiplicity).
(c) --format format-name
For details about this option, see 14.4.2 How to specify the display format.
(d) --columns column-name[,column-name]...
For details about this option, see 14.4.3 How to specify column filters.
(e) --filter filter-condition
For details about this option, see 14.4.4 How to specify row filters.
(f) --match matching-condition
For details about this option, see 14.4.5 How to specify a condition match.
(5) Output example
The following shows an output example of the eztool getposition command's execution results.
For details about the components of the displayed information, see 14.4.1 Components of the displayed information.
The following tables list and describe the summary and content information that are displayed.
No. |
Summary name |
Description |
---|---|---|
1 |
ReplicationCount |
Data multiplicity |
2 |
HashValue |
Hash value of the specified key or group name |
No. |
Column name |
Description |
---|---|---|
1 |
No. |
Data priority# Displayed in ascending order. |
2 |
IP_Address |
IP address of EADS server |
3 |
ClientPort |
EADS server's port number used for communication with the EADS clients |
4 |
Position |
Location of EADS server (hash value) |
- #
-
If redundant copies of data have been created, this information is displayed in order, beginning with the EADS server on which the original data is stored, followed by the EADS servers to which the data has been copied.
In this example, No.1 indicates the EADS server on which the original data is stored and the subsequent numbers starting with No.2 indicate the EADS servers to which data has been copied.
(6) Return code
The following table lists the return codes that this subcommand returns.
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.
(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.
-
This subcommand results in an error if all EADS servers are isolated.