Skip to main content
interface CreateProcRequest
args?: string[];
command?: string;
execution_mode?: string;
files?: Record<string, string>;
options?: Record<string, string>;
proc_name: string;
args? command? execution_mode? files? options? proc_name
args?: string[]

An array of command-line arguments that will be passed to command when the proc is executed.

command?: string

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

execution_mode?: string

The execution mode of the proc.

files?: Record<string, string>

A 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

options?: Record<string, string>

Optional parameters.

proc_name: string

Name of the proc to be created. Must not be the name of a currently existing proc.