kinetica.CreateProcRequest Class Reference

A set of parameters for /create/proc. More...

Inheritance diagram for kinetica.CreateProcRequest:

Collaboration diagram for kinetica.CreateProcRequest:

Classes
struct	ExecutionMode
	The execution mode of the proc. More...

Public Member Functions
	CreateProcRequest ()
	Constructs a CreateProcRequest object with default parameters. More...
	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. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	proc_name [get, set]
	Name of the proc to be created. More...
string	execution_mode [get, set]
	The execution mode of the proc. More...
IDictionary< string, byte[]>	files = ExecutionMode.DISTRIBUTED [get, set]
	A map of the files that make up the proc. More...
string	command = new Dictionary<string, byte[]>() [get, set]
	The command (excluding arguments) that will be invoked when the proc is executed. More...
IList< string >	args = "" [get, set]
	An array of command-line arguments that will be passed to when the proc is executed. More...
IDictionary< string, string >	options = new List<string>() [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

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

Detailed Description

A set of parameters for /create/proc.

Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. For details on UDFs, see: User-Defined Functions

Definition at line 21 of file CreateProc.cs.

Constructor & Destructor Documentation

kinetica.CreateProcRequest.CreateProcRequest ( )

inline

Constructs a CreateProcRequest object with default parameters.

Definition at line 87 of file CreateProc.cs.

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. Values: distributed, nondistributed.
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.
command	The command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc 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 , that file will be invoked.
args	An array of command-line arguments that will be passed to when the proc is executed.
options	Optional parameters.

Definition at line 119 of file CreateProc.cs.

Property Documentation

IList<string> kinetica.CreateProcRequest.args = ""

getset

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

Definition at line 79 of file CreateProc.cs.

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

getset

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

It will be invoked from the directory containing the proc 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 , that file will be invoked.

Definition at line 74 of file CreateProc.cs.

string kinetica.CreateProcRequest.execution_mode

getset

The execution mode of the proc.

Values: distributed, nondistributed.

Definition at line 53 of file CreateProc.cs.

IDictionary<string, byte[]> kinetica.CreateProcRequest.files = ExecutionMode.DISTRIBUTED

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.

Definition at line 60 of file CreateProc.cs.

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

getset

Optional parameters.

Definition at line 82 of file CreateProc.cs.

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 48 of file CreateProc.cs.

---

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

• Kinetica/Protocol/CreateProc.cs