kinetica.ExecuteProcRequest

A set of parameters for Kinetica.executeProc. More…

Inheritance diagram for kinetica.ExecuteProcRequest:

Collaboration diagram for kinetica.ExecuteProcRequest:

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

Public Member Functions
	ExecuteProcRequest ()
	Constructs an ExecuteProcRequest object with default parameters.

	ExecuteProcRequest (string proc_name, IDictionary< string, string > _params=null, IDictionary< string, byte[]> bin_params=null, IList< string > input_table_names=null, IDictionary< string, IList< string > > input_column_names=null, IList< string > output_table_names=null, IDictionary< string, string > options=null)
	Constructs an ExecuteProcRequest object with the specified parameters.

	ExecuteProcRequest ()
	Constructs an ExecuteProcRequest object with default parameters.

	ExecuteProcRequest (string proc_name, IDictionary< string, string > _params=null, IDictionary< string, byte[]> bin_params=null, IList< string > input_table_names=null, IDictionary< string, IList< string > > input_column_names=null, IList< string > output_table_names=null, IDictionary< string, string > options=null)
	Constructs an ExecuteProcRequest 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 execute.

IDictionary< string, string >	_params = new Dictionary<string, string>() `[get, set]`
	A map containing named parameters to pass to the proc.

IDictionary< string, byte[]>	bin_params = new Dictionary<string, byte[]>() `[get, set]`
	A map containing named binary parameters to pass to the proc.

IList< string >	input_table_names = new List<string>() `[get, set]`
	Names of the tables containing data to be passed to the proc.

IDictionary< string, IList< string > >	input_column_names = new Dictionary<string, IList<string>>() `[get, set]`
	Map of table names from ExecuteProcRequest.input_table_names to lists of names of columns from those tables that will be passed to the proc.

IList< string >	output_table_names = new List<string>() `[get, set]`
	Names of the tables to which output data from the proc will be written, each in [schema_name.

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

Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.

If the proc being executed is distributed, ExecuteProcRequest.input_table_names and ExecuteProcRequest.input_column_names may be passed to the proc to use for reading data, and ExecuteProcRequest.output_table_names may be passed to the proc to use for writing data.

If the proc being executed is non-distributed, these table parameters will be ignored.

Definition at line 24 of file ExecuteProc.cs.

Constructor & Destructor Documentation

◆ ExecuteProcRequest() [1/4]

kinetica.ExecuteProcRequest.ExecuteProcRequest ( )

inline

Constructs an ExecuteProcRequest object with default parameters.

Definition at line 239 of file ExecuteProc.cs.

◆ ExecuteProcRequest() [2/4]

kinetica.ExecuteProcRequest.ExecuteProcRequest	(	string	proc_name,
		IDictionary< string, string >	_params = null,
		IDictionary< string, byte[]>	bin_params = null,
		IList< string >	input_table_names = null,
		IDictionary< string, IList< string > >	input_column_names = null,
		IList< string >	output_table_names = null,
		IDictionary< string, string >	options = null )

inline

Constructs an ExecuteProcRequest object with the specified parameters.

Parameters

proc_name	Name of the proc to execute. Must be the name of a currently existing proc.
_params	A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary.
bin_params	A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary.
input_table_names	Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table, in [schema_name.]table_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty List.
input_column_names	Map of table names from input_table_names to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from input_table_names is not included, all columns from that table will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty Dictionary.
output_table_names	Names of the tables to which output data from the proc will be written, each in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from input_table_names , excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty List.
options	Optional parameters. CACHE_INPUT: No longer supported; option will be ignored. The default value is ”. USE_CACHED_INPUT: No longer supported; option will be ignored. The default value is ”. RUN_TAG: A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica.killProc to identify the proc instance. The default value is ”. MAX_OUTPUT_LINES: The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’. EXECUTE_AT_STARTUP: If TRUE, an instance of the proc will run when the database is started instead of running immediately. The run_id can be retrieved using Kinetica.showProc and used in Kinetica.showProcStatus. Supported values: TRUE FALSE The default value is FALSE. EXECUTE_AT_STARTUP_AS: Sets the alternate user name to execute this proc instance as when EXECUTE_AT_STARTUP is TRUE. The default value is ”. The default value is an empty Dictionary.

Definition at line 361 of file ExecuteProc.cs.

◆ ExecuteProcRequest() [3/4]

kinetica.ExecuteProcRequest.ExecuteProcRequest ( )

inline

Constructs an ExecuteProcRequest object with default parameters.

Definition at line 239 of file ExecuteProc.cs.

◆ ExecuteProcRequest() [4/4]

kinetica.ExecuteProcRequest.ExecuteProcRequest	(	string	proc_name,
		IDictionary< string, string >	_params = null,
		IDictionary< string, byte[]>	bin_params = null,
		IList< string >	input_table_names = null,
		IDictionary< string, IList< string > >	input_column_names = null,
		IList< string >	output_table_names = null,
		IDictionary< string, string >	options = null )

inline

Constructs an ExecuteProcRequest object with the specified parameters.

Parameters

proc_name	Name of the proc to execute. Must be the name of a currently existing proc.
_params	A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary.
bin_params	A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary.
input_table_names	Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table, in [schema_name.]table_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty List.
input_column_names	Map of table names from input_table_names to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from input_table_names is not included, all columns from that table will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty Dictionary.
output_table_names	Names of the tables to which output data from the proc will be written, each in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from input_table_names , excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty List.
options	Optional parameters. CACHE_INPUT: No longer supported; option will be ignored. The default value is ”. USE_CACHED_INPUT: No longer supported; option will be ignored. The default value is ”. RUN_TAG: A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica.killProc to identify the proc instance. The default value is ”. MAX_OUTPUT_LINES: The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’. EXECUTE_AT_STARTUP: If TRUE, an instance of the proc will run when the database is started instead of running immediately. The run_id can be retrieved using Kinetica.showProc and used in Kinetica.showProcStatus. Supported values: TRUE FALSE The default value is FALSE. EXECUTE_AT_STARTUP_AS: Sets the alternate user name to execute this proc instance as when EXECUTE_AT_STARTUP is TRUE. The default value is ”. The default value is an empty Dictionary.

Definition at line 361 of file ExecuteProc.cs.

Property Documentation

◆ _params

IDictionary< string, string > kinetica.ExecuteProcRequest._params = new Dictionary<string, string>()

getset

A map containing named parameters to pass to the proc.

Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary.

Definition at line 109 of file ExecuteProc.cs.

◆ bin_params

IDictionary< string, byte[]> kinetica.ExecuteProcRequest.bin_params = new Dictionary<string, byte[]>()

getset

A map containing named binary parameters to pass to the proc.

Each key/value pair specifies the name of a parameter and its value. The default value is an empty Dictionary.

Definition at line 116 of file ExecuteProc.cs.

◆ input_column_names

IDictionary< string, IList< string > > kinetica.ExecuteProcRequest.input_column_names = new Dictionary<string, IList<string>>()

getset

Map of table names from ExecuteProcRequest.input_table_names to lists of names of columns from those tables that will be passed to the proc.

Each column name specified must be the name of an existing column in the corresponding table. If a table name from ExecuteProcRequest.input_table_names is not included, all columns from that table will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty Dictionary.

Definition at line 138 of file ExecuteProc.cs.

◆ input_table_names

IList< string > kinetica.ExecuteProcRequest.input_table_names = new List<string>()

getset

Names of the tables containing data to be passed to the proc.

Each name specified must be the name of a currently existing table, in [schema_name.]table_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty List.

Definition at line 127 of file ExecuteProc.cs.

◆ options

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

getset

Optional parameters.

CACHE_INPUT: No longer supported; option will be ignored. The default value is ”.
USE_CACHED_INPUT: No longer supported; option will be ignored. The default value is ”.
RUN_TAG: A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica.killProc to identify the proc instance. The default value is ”.
MAX_OUTPUT_LINES: The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is ‘100’.
EXECUTE_AT_STARTUP: If TRUE, an instance of the proc will run when the database is started instead of running immediately. The run_id can be retrieved using Kinetica.showProc and used in Kinetica.showProcStatus. Supported values:
- TRUE
- FALSE
The default value is FALSE.
EXECUTE_AT_STARTUP_AS: Sets the alternate user name to execute this proc instance as when EXECUTE_AT_STARTUP is TRUE. The default value is ”.

The default value is an empty Dictionary.

Definition at line 235 of file ExecuteProc.cs.

◆ output_table_names

IList< string > kinetica.ExecuteProcRequest.output_table_names = new List<string>()

getset

Names of the tables to which output data from the proc will be written, each in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from ExecuteProcRequest.input_table_names, excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty List.

Definition at line 154 of file ExecuteProc.cs.

◆ proc_name

string kinetica.ExecuteProcRequest.proc_name

getset

Name of the proc to execute.

Must be the name of a currently existing proc.

Definition at line 102 of file ExecuteProc.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/ExecuteProc.cs
Kinetica/Protocol/ExecuteProc.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ ExecuteProcRequest() [1/4]

​◆ ExecuteProcRequest() [2/4]

​◆ ExecuteProcRequest() [3/4]

​◆ ExecuteProcRequest() [4/4]

​Property Documentation

​◆ _params

​◆ bin_params

​◆ input_column_names

​◆ input_table_names

​◆ options

​◆ output_table_names

​◆ proc_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExecuteProcRequest() [1/4]

◆ ExecuteProcRequest() [2/4]

◆ ExecuteProcRequest() [3/4]

◆ ExecuteProcRequest() [4/4]

Property Documentation

◆ _params

◆ bin_params

◆ input_column_names

◆ input_table_names

◆ options

◆ output_table_names

◆ proc_name