Skip to main content

​
◆ createProc() [1/2]

CreateProcResponse kinetica.Kinetica.createProc (CreateProcRequestrequest_)
 inline

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 22000 of file KineticaFunctions.cs.

​
◆ createProc() [2/2]

CreateProcResponse kinetica.Kinetica.createProc (stringproc_name,
stringexecution_mode = CreateProcRequest::ExecutionMode::DISTRIBUTED,
IDictionary< string, byte[]>files = null,
stringcommand = "",
IList< string >args = null,
IDictionary< string, string >options = null )
 inline

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

Parameters
proc_nameName of the proc to be created. Must not be the name of a currently existing proc.
execution_modeThe execution mode of the proc. Supported values:
  • DISTRIBUTED: Input 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.
  • NONDISTRIBUTED: The 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 executeProc. It will, however, be able to access the database using native API calls.
The default value is DISTRIBUTED.
filesA 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 Dictionary.
commandThe command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc 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 files , that file will be invoked. The default value is ”.
argsAn array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty List.
optionsOptional parameters.
  • MAX_CONCURRENCY_PER_NODE: The maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is ‘0’.
  • SET_ENVIRONMENT: A python environment to use when executing the proc. Must be an existing environment, else an error will be returned. The default value is ”.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 22105 of file KineticaFunctions.cs.

​
◆ CreateProcAsync() [1/2]

async System.Threading.Tasks.Task< CreateProcResponse > kinetica.Kinetica.CreateProcAsync (CreateProcRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 22018 of file KineticaFunctions.cs.

​
◆ CreateProcAsync() [2/2]

async System.Threading.Tasks.Task< CreateProcResponse > kinetica.Kinetica.CreateProcAsync (stringproc_name,
stringexecution_mode = CreateProcRequest::ExecutionMode::DISTRIBUTED,
IDictionary< string, byte[]>files = null,
stringcommand = "",
IList< string >args = null,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

Parameters
proc_nameName of the proc to be created. Must not be the name of a currently existing proc.
execution_modeThe execution mode of the proc. Supported values:
  • DISTRIBUTED: Input 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.
  • NONDISTRIBUTED: The 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 executeProc. It will, however, be able to access the database using native API calls.
The default value is DISTRIBUTED.
filesA 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 Dictionary.
commandThe command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc 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 files , that file will be invoked. The default value is ”.
argsAn array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty List.
optionsOptional parameters.
  • MAX_CONCURRENCY_PER_NODE: The maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is ‘0’.
  • SET_ENVIRONMENT: A python environment to use when executing the proc. Must be an existing environment, else an error will be returned. The default value is ”.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 22197 of file KineticaFunctions.cs.