udf_engines.conf Fields
Each section can contain several fields with predefined names. The fields are as follows:
port
Specifies the port used by the engine. If the value = 0, the port is assigned by the OS and communicated back to the X100 server. A port value of zero is not supported with containers because they require a predefined port number. This value can be overridden with the --port option on the UDF engine command line. The default is based on the installation ID. You must change this only if there is a conflict with the existing port.
socket_retry
Specifies the number of times the X100 server will retry opening a socket to the UDF engine before failing. Defaults to 3.
name
Overrides the name given in the section title. Defaults to empty.
host
Specifies the host name (or IP) of the UDF engine. This is useful only when connecting to a UDF engine that is already running on a different host machine. Default is "localhost".
command
Specifies the complete command line used to launch the UDF engine on X100 startup when launch is true. The command defaults to empty and is ignored if not launching this engine process. The command line can contain the following substitutions:
$PORT - The port number from the port field
$UDF_LANGUAGES - UDF languages as defined by system/udf_languages
$INSTANCE_TAG - Unique tag assigned to this UDF engine instance
$UID - User ID
$GID - Group ID (always empty in Windows)
$PORT_FILE_PATH - Communicates port information to the database server (applies only to non-containerized UDF engine)
launch
Indicates whether the X100 engine should run command to start the UDF engine. When true, the engine starts. When false, it is expected that the UDF engine is already running.
is_container
Must be set to true when the UDF engine is running in a container. This allows the X100 server to make minor adjustments. When true, port=0 is not supported and extra time to launch the process is given. Default is false.
enabled
When true, the X100 server uses this engine entry. When false, the entry is ignored. Default is true.
pool_limit
Specifies the number of concurrent connections to the UDF engine the X100 server maintains to avoid repeated connection creations and tear-downs. Default is 16.
Last modified date: 08/14/2024