14.3.19 get (acquires specified data)

Organization of this subsection

(1) Description
(2) Rules
(3) Format
(4) Options and arguments
(5) Output example
(6) Return code
(7) Notes

(1) Description

This subcommand acquires specified value.

This subcommand is used to test whether the configured execution environment is operational.

To Page Top

(2) Rules

You can execute this subcommand when the EADS server is running.

To Page Top

(3) Format

eztool get cache-name key
           [--format format-name]
           [--columns column-name[,column-name]...]
           [--filter filter-condition]
           [--match matching-condition]

To Page Top

(4) Options and arguments

(a) cache-name

Specify the name of the cache containing the value you want to acquire.

The following characters are permitted for a cache name:

If cache property files were not used to create caches

A maximum of 32 single-byte characters in ASCII codes 0x20 to 0x7E
If cache property files were used to create caches

A maximum of 32 single-byte alphanumeric characters (0 to 9, A to Z, and a to z)

(b) key

Specify the key associated with the value you want to acquire.

For details about the data that can be specified as keys, see 15.2.2(1) Data types that can be specified as keys.

(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.

To Page Top

(5) Output example

The following shows an output example of the eztool get command's execution results.

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

[Figure]

The following table lists and describes the summary display information.

Table 14‒37: Summary information displayed by the eztool get command
No.	Summary name	Description
1	`Value`	Acquired value
2	`ValueSize`	Size of acquired value (in bytes)

To Page Top

(6) Return code

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

Table 14‒38: Return codes returned by the eztool get command
No.	Return code		Description
No.	eads.command.compat parameter omitted in the command properties	0300 specified in the eads.command.compat parameter in the command properties	Description
1	`0`	`0`	Command execution was successful.
2	`101`	`101`	Initialization of the command failed.
3	`120`		The command failed due to a syntax error.
4	`150`		The command failed during execution.
5	`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

You can use this subcommand to manipulate data processed by an API function; conversely, you can use an API function to manipulate data processed by this subcommand.

Note that the data types and sizes permitted for key and value are not completely compatible with those permitted by the API functions.
The --format, --columns, and --filter options are ignored, if specified. These options are provided for future extension of functions.
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