/create/proc

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/create/proc

Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.

Input Parameter Description

NameTypeDescription
proc_namestringName of the proc to be created. Must not be the name of a currently existing proc.
execution_modestring

The execution mode of the proc. The default value is distributed.

Supported ValuesDescription
distributedInput table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data.
nondistributedThe proc command will be invoked only once per execution, and will not have direct access to any tables named as input or output table parameters in the call to /execute/proc. It will, however, be able to access the database using native API calls.
filesmap of string to bytesA map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc. Files may be loaded from existing files in KiFS. Those file names should be prefixed with the uri kifs:// and the values in the map should be empty. The default value is an empty map ( {} ).
commandstringThe command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc input parameter files and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in input parameter files, that file will be invoked. The default value is ''.
argsarray of stringsAn array of command-line arguments that will be passed to input parameter command when the proc is executed. The default value is an empty array ( [] ).
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
max_concurrency_per_nodeThe maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is '0'.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'create_proc_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /create/proc endpoint:

NameTypeDescription
proc_namestringValue of input parameter proc_name.
infomap of string to stringsAdditional information.

Empty string in case of an error.