14.3.28 compaction (performs compaction on cache data files)
This subsection is applicable when you are using disk caches or two-way caches.
- Organization of this subsection
(1) Description
This subcommand performs compaction on the cache data files on the EADS server on which the subcommand is executed.
(2) Rules
-
This subcommand can be executed on an EADS server that is in any of the following statuses, regardless of the cluster's status:
-
Initialized
-
Running
-
Closed
-
Isolated
-
-
The subcommand selects the cache data files that will yield the greatest compaction effects on the EADS server on which the subcommand is executed. If there are multiple candidate files, the subcommand processes them in descending order of the compaction effects.
(3) Format
eztool compaction [--cache cache-name [--range range-ID]]
[--limit execution-count|--unused_fc number-of-unused-files]
[--threshold threshold-value]eztool compaction [--break]
(4) Options and arguments
(a) --cache cache-name
This option specifies the name of the cache on which compaction is to be performed.
Specify for the cache name a maximum of 32 single-byte alphanumeric characters (0 to 9, A to Z, a to z).
If this option is omitted, compaction is performed on all caches.
(b) --range range-ID
A range ID is a number (integer 1 to 96) used to identify a range in a cache. The range ID matches the server ID of the EADS server on which the data is stored.
This option specifies the range of compaction processing. If no data belongs to the range with the specified range ID on the EADS server on which the subcommand is executed, compaction processing will not be performed.
If this option is omitted, all ranges of the specified cache are subject to compaction processing.
(c) --limit execution-count
This option specifies the maximum compaction count (maximum number of cache data files on which compaction is to be performed by one execution of the command). If there are no more target files, the subcommand terminates even before the actual count reaches the specified value.
Specify for the execution count an integer from 1 to 20971520.
If this option is omitted, the default is 20971520.
(d) --unused_fc number-of-unused-files
Specify this option if you want to perform compaction processing until the number of unused cache data files reaches the specified value. If the number of unused files is already equal to or greater than the specified value in all ranges, compaction is not performed. If there are no more target files or the compaction count has reached 20,971,520, the subcommand terminates with a warning even though the number of unused files has not reached the specified value.
For the number of unused files, you can specify an integer from 1 to 32766.
(e) --threshold threshold-value
Specify this option if you want to perform compaction on the cache data files that will yield at least the effects specified as the threshold value (%). If there are no cache data files that will yield the specified level of effects, compaction will not be performed.
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 assumed as the threshold value (default is 50).
(f) --break
Specify this option to stop compaction processing.
You can stop compaction processing in units of files. Compaction processing cannot be stopped in the middle of a file.
(5) 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 |
1 |
1 |
Compaction was not performed because there were no target files. |
|
3 |
2 |
2 |
Compaction was not performed because the number of unused files was equal to or greater than the value specified in the --unused_fc option. |
|
4 |
3 |
3 |
There were no more target files before the number of unused files reached the value specified in the --unused_fc option. Compaction processing has been completed. |
|
5 |
10 |
10 |
The --break option was specified, but compaction was not being performed. |
|
6 |
11 |
11 |
The --break option was specified, but cancellation of compaction processing had already been queued. |
|
7 |
101 |
101 |
Initialization of the command failed. |
|
8 |
110 |
Connection establishment failed. |
|
|
9 |
111 |
The command failed due to a communication timeout. |
|
|
10 |
120 |
The command failed due to a syntax error. |
|
|
11 |
130 |
The command failed because it could not be executed. |
|
|
12 |
131 |
The command failed because another command was executing. |
|
|
13 |
150 |
The command failed during execution. |
|
|
14 |
200 |
The command failed due to a timeout. |
|
(6) Notes
-
This subcommand can be executed while the EADS servers are running, but performance might be affected adversely.
-
If cancellation of compaction processing is queued and this subcommand times out or its processing stops, the process waiting for cancellation is not completed. If this happens, either wait until the process times out or terminate the process.
-
No compaction is underway between the time compaction on one file is completed and compaction on the next file begins. If an attempt is made during this interval to stop compaction processing by specifying the --break option, a message indicating that compaction processing is not in progress might be displayed, prohibiting the compaction processing from being stopped. If this happens, repeat execution of the eztool compaction --break command until compaction processing stops.