Skip to main content

◆ executeProc() [1/2]

ExecuteProcResponse kinetica.Kinetica.executeProc (ExecuteProcRequestrequest_)
inline

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, input_table_names and input_column_names may be passed to the proc to use for reading data, and 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.

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

Definition at line 33696 of file KineticaFunctions.cs.

◆ executeProc() [2/2]

ExecuteProcResponse kinetica.Kinetica.executeProc (stringproc_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

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, input_table_names and input_column_names may be passed to the proc to use for reading data, and 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.

Parameters
proc_nameName of the proc to execute. Must be the name of a currently existing proc.
_paramsA 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_paramsA 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_namesNames 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_namesMap 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_namesNames 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.
optionsOptional parameters.The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 33858 of file KineticaFunctions.cs.

◆ ExecuteProcAsync() [1/2]

async System.Threading.Tasks.Task< ExecuteProcResponse > kinetica.Kinetica.ExecuteProcAsync (ExecuteProcRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

Executes a proc.

(async)

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

If the proc being executed is distributed, input_table_names and input_column_names may be passed to the proc to use for reading data, and 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.

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 33722 of file KineticaFunctions.cs.

◆ ExecuteProcAsync() [2/2]

async System.Threading.Tasks.Task< ExecuteProcResponse > kinetica.Kinetica.ExecuteProcAsync (stringproc_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,
System.Threading.CancellationTokencancellationToken = default )
inline

Executes a proc.

(async)

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

If the proc being executed is distributed, input_table_names and input_column_names may be passed to the proc to use for reading data, and 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.

Parameters
proc_nameName of the proc to execute. Must be the name of a currently existing proc.
_paramsA 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_paramsA 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_namesNames 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_namesMap 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_namesNames 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.
optionsOptional parameters.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 34001 of file KineticaFunctions.cs.