14.3.23 execfunc (executes user functions)
- Organization of this subsection
(1) Description
This subcommand executes a specified user function.
You can use this subcommand to execute user functions without having to configure an EADS client for executing user functions.
(2) Rules
-
You can execute this subcommand when the EADS server is running.
-
The subcommand executes a specified user function on the EADS servers in descending order of the EADS server locations (Position). The subcommand continues processing even if execution of the user function fails on one of the EADS servers.
(3) Format
eztool execfunc [-k key|-g group-name|-s] cache-name user-function-name [user-function-arguments] [--format format-name] [--columns column-name[,column-name]...] [--filter filter-condition] [--match matching-condition]
(4) Options and arguments
(a) -k key or --key
Specify this option if you want to execute the user function on the EADS servers where a specified key is stored.
For details about the data that can be specified as keys, see 15.2.2(1) Data types that can be specified as keys.
(b) -g group-name or --group group-name
Specify this option if you want to execute the user function on the EADS servers where a specified group is stored.
For details about the data that can be specified as group names, see 15.2.2(2) Data that can be specified as group names.
(c) -s or --single
Specify this option if you want to execute the user function only on the EADS server where the command is executed.
(d) cache-name
Specify the name of the cache for the user function to be executed.
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)
(e) user-function-name
Specify the name of the user function to be executed.
A user function name can consist of alphanumeric characters (0 to 9, A to Z, a to z), underscores (_), periods (.), and dollar signs ($).
There is no limit to the number of characters.
(f) user-function-arguments
Specify this option if you want to pass specific arguments to the user function.
If this option is omitted, null is passed as the arguments.
You can specify for user function arguments a maximum of 1,024 of the single-byte characters 0x20 through 0x7E in ASCII codes.
(g) --format format-name
For details about this option, see 14.4.2 How to specify the display format.
(h) --columns column-name[,column-name]...
For details about this option, see 14.4.3 How to specify column filters.
(i) --filter filter-condition
For details about this option, see 14.4.4 How to specify row filters.
(j) --match matching-condition
For details about this option, see 14.4.5 How to specify a condition match.
(5) Output example
The following shows output examples of the eztool execfunc command's execution results.
For details about the components of the displayed information, see 14.4.1 Components of the displayed information.
The following table lists and describes the content information that is displayed.
No. |
Column name |
Description |
---|---|---|
1 |
Server |
IP address of the EADS server that executed the user function 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 Displayed in natural order. |
2 |
Result |
|
(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 |
120 |
The command failed due to a syntax error. |
|
4 |
150 |
The command failed during execution. If command's execution fails, the corresponding return code is set. If an exception occurs while the user function is running, the command is treated as being successful. For details about an exception, see the displayed Result. |
|
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.
(7) Notes
-
Unlike for user functions that are executed normally on an EADS client, the user function arguments and acquired data of this subcommand are always of the character string data type (java.lang.String). If you will be using this command, take this into account when you create user functions.
If large-sized character strings are used, garbage collection might occur on the EADS server, adversely affecting performance.
-
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.