14.3.23 execfunc (executes user functions)

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

To Page Top

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

To Page Top

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

To Page Top

(4) Options and arguments

To Page Top

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

Table 14‒46: Content information displayed by the eztool execfunc command

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	If successful: toString() value in the execution result object of the user function If the value is null, character string null is output. If failed: Information about the exception that occurred

To Page Top

(6) Return code

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

Table 14‒47: Return codes returned by the eztool execfunc 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	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.

To Page Top

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

To Page Top