kinetica.CreateProcRequest

A set of parameters for Kinetica.createProc. More…

Inheritance diagram for kinetica.CreateProcRequest:

Collaboration diagram for kinetica.CreateProcRequest:

Classes
struct	ExecutionMode
	A set of string constants for the parameter CreateProcRequest.execution_mode. More…

struct	Options
	A set of string constants for the parameter CreateProcRequest.options. More…

Public Member Functions
	CreateProcRequest ()
	Constructs a CreateProcRequest object with default parameters.

	CreateProcRequest (string proc_name, string execution_mode=null, IDictionary< string, byte[]> files=null, string command=null, IList< string > args=null, IDictionary< string, string > options=null)
	Constructs a CreateProcRequest object with the specified parameters.

	CreateProcRequest ()
	Constructs a CreateProcRequest object with default parameters.

	CreateProcRequest (string proc_name, string execution_mode=null, IDictionary< string, byte[]> files=null, string command=null, IList< string > args=null, IDictionary< string, string > options=null)
	Constructs a CreateProcRequest object with the specified parameters.

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

Properties
string	proc_name `[get, set]`
	Name of the proc to be created.

string	execution_mode = ExecutionMode.DISTRIBUTED `[get, set]`
	The execution mode of the proc.

IDictionary< string, byte[]>	files = new Dictionary<string, byte[]>() `[get, set]`
	A map of the files that make up the proc.

string	command = "" `[get, set]`
	The command (excluding arguments) that will be invoked when the proc is executed.

IList< string >	args = new List<string>() `[get, set]`
	An array of command-line arguments that will be passed to CreateProcRequest.command when the proc is executed.

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters.

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class.

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.createProc.

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

Definition at line 18 of file CreateProc.cs.

Constructor & Destructor Documentation

◆ CreateProcRequest() [1/4]

kinetica.CreateProcRequest.CreateProcRequest ( )

inline

Constructs a CreateProcRequest object with default parameters.

Definition at line 151 of file CreateProc.cs.

◆ CreateProcRequest() [2/4]

kinetica.CreateProcRequest.CreateProcRequest	(	string	proc_name,
		string	execution_mode = null,
		IDictionary< string, byte[]>	files = null,
		string	command = null,
		IList< string >	args = null,
		IDictionary< string, string >	options = null )

inline

Constructs a CreateProcRequest object with the specified parameters.

Parameters

proc_name	Name of the proc to be created. Must not be the name of a currently existing proc.
execution_mode	The 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 Kinetica.executeProc. It will, however, be able to access the database using native API calls. The default value is DISTRIBUTED.
files	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. The default value is an empty Dictionary.
command	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. The default value is ”.
args	An array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty List.
options	Optional 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.

Definition at line 228 of file CreateProc.cs.

◆ CreateProcRequest() [3/4]

kinetica.CreateProcRequest.CreateProcRequest ( )

inline

Constructs a CreateProcRequest object with default parameters.

Definition at line 151 of file CreateProc.cs.

◆ CreateProcRequest() [4/4]

kinetica.CreateProcRequest.CreateProcRequest	(	string	proc_name,
		string	execution_mode = null,
		IDictionary< string, byte[]>	files = null,
		string	command = null,
		IList< string >	args = null,
		IDictionary< string, string >	options = null )

inline

Constructs a CreateProcRequest object with the specified parameters.

Parameters

proc_name	Name of the proc to be created. Must not be the name of a currently existing proc.
execution_mode	The 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 Kinetica.executeProc. It will, however, be able to access the database using native API calls. The default value is DISTRIBUTED.
files	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. The default value is an empty Dictionary.
command	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. The default value is ”.
args	An array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty List.
options	Optional 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.

Definition at line 228 of file CreateProc.cs.

Property Documentation

◆ args

IList< string > kinetica.CreateProcRequest.args = new List<string>()

getset

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

The default value is an empty List.

Definition at line 125 of file CreateProc.cs.

◆ command

string kinetica.CreateProcRequest.command = ""

getset

The command (excluding arguments) that will be invoked when the proc is executed.

It will be invoked from the directory containing the proc CreateProcRequest.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 CreateProcRequest.files, that file will be invoked. The default value is ”.

Definition at line 119 of file CreateProc.cs.

◆ execution_mode

string kinetica.CreateProcRequest.execution_mode = ExecutionMode.DISTRIBUTED

getset

The 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 Kinetica.executeProc. It will, however, be able to access the database using native API calls.

The default value is DISTRIBUTED.

Definition at line 94 of file CreateProc.cs.

◆ files

IDictionary< string, byte[]> kinetica.CreateProcRequest.files = new Dictionary<string, byte[]>()

getset

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. The default value is an empty Dictionary.

Definition at line 105 of file CreateProc.cs.

◆ options

IDictionary< string, string > kinetica.CreateProcRequest.options = new Dictionary<string, string>()

getset

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

Definition at line 147 of file CreateProc.cs.

◆ proc_name

string kinetica.CreateProcRequest.proc_name

getset

Name of the proc to be created.

Must not be the name of a currently existing proc.

Definition at line 64 of file CreateProc.cs.

The documentation for this class was generated from the following files:

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateProc.cs
Kinetica/Protocol/CreateProc.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ CreateProcRequest() [1/4]

​◆ CreateProcRequest() [2/4]

​◆ CreateProcRequest() [3/4]

​◆ CreateProcRequest() [4/4]

​Property Documentation

​◆ args

​◆ command

​◆ execution_mode

​◆ files

​◆ options

​◆ proc_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateProcRequest() [1/4]

◆ CreateProcRequest() [2/4]

◆ CreateProcRequest() [3/4]

◆ CreateProcRequest() [4/4]

Property Documentation

◆ args

◆ command

◆ execution_mode

◆ files

◆ options

◆ proc_name