Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
ExecuteProc.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 
10 
11 namespace kinetica
12 {
13 
33  {
34 
111  public struct Options
112  {
113 
125  public const string CACHE_INPUT = "cache_input";
126 
139  public const string USE_CACHED_INPUT = "use_cached_input";
140 
148  public const string RUN_TAG = "run_tag";
149 
155  public const string MAX_OUTPUT_LINES = "max_output_lines";
156 
177  public const string EXECUTE_AT_STARTUP = "execute_at_startup";
178  public const string TRUE = "true";
179  public const string FALSE = "false";
180 
184  public const string EXECUTE_AT_STARTUP_AS = "execute_at_startup_as";
185  } // end struct Options
186 
187 
190  public string proc_name { get; set; }
191 
195  public IDictionary<string, string> _params { get; set; } = new Dictionary<string, string>();
196 
200  public IDictionary<string, byte[]> bin_params { get; set; } = new Dictionary<string, byte[]>();
201 
212  public IList<string> input_table_names { get; set; } = new List<string>();
213 
225  public IDictionary<string, IList<string>> input_column_names { get; set; } = new Dictionary<string, IList<string>>();
226 
247  public IList<string> output_table_names { get; set; } = new List<string>();
248 
323  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
324 
325 
328  public ExecuteProcRequest() { }
329 
461  IDictionary<string, string> _params = null,
462  IDictionary<string, byte[]> bin_params = null,
463  IList<string> input_table_names = null,
464  IDictionary<string, IList<string>> input_column_names = null,
465  IList<string> output_table_names = null,
466  IDictionary<string, string> options = null)
467  {
468  this.proc_name = proc_name ?? "";
469  this._params = _params ?? new Dictionary<string, string>();
470  this.bin_params = bin_params ?? new Dictionary<string, byte[]>();
471  this.input_table_names = input_table_names ?? new List<string>();
472  this.input_column_names = input_column_names ?? new Dictionary<string, IList<string>>();
473  this.output_table_names = output_table_names ?? new List<string>();
474  this.options = options ?? new Dictionary<string, string>();
475  } // end constructor
476 
477  } // end class ExecuteProcRequest
478 
479 
480 
485  {
486 
490  public string run_id { get; set; }
491 
493  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
494 
495  } // end class ExecuteProcResponse
496 
497 
498 
499 
500 } // end namespace kinetica
const string EXECUTE_AT_STARTUP_AS
Sets the alternate user name to execute this proc instance as when execute_at_startup is true...
Definition: ExecuteProc.cs:184
const string RUN_TAG
A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus(string,IDictionary{string, string}) or Kinetica.killProc(string,IDictionary{string, string}) to identify the proc instance.
Definition: ExecuteProc.cs:148
const string EXECUTE_AT_STARTUP
If true, an instance of the proc will run when the database is started instead of running immediately...
Definition: ExecuteProc.cs:177
string run_id
The run ID of the running proc instance.
Definition: ExecuteProc.cs:490
IList< string > input_table_names
Names of the tables containing data to be passed to the proc.
Definition: ExecuteProc.cs:212
string proc_name
Name of the proc to execute.
Definition: ExecuteProc.cs:190
const string USE_CACHED_INPUT
A comma-delimited list of run IDs (as returned from prior calls to Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string})) of running or completed proc instances from which input data cached using the cache_input option will be used.
Definition: ExecuteProc.cs:139
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.
Definition: ExecuteProc.cs:460
const string CACHE_INPUT
A comma-delimited list of table names from input_table_names from which input data will be cached for...
Definition: ExecuteProc.cs:125
IDictionary< string, byte[]> bin_params
A map containing named binary parameters to pass to the proc.
Definition: ExecuteProc.cs:200
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteProc.cs:323
A set of results returned by Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}).
Definition: ExecuteProc.cs:484
IList< string > output_table_names
Names of the tables to which output data from the proc will be written, each in [schema_name.
Definition: ExecuteProc.cs:247
ExecuteProcRequest()
Constructs an ExecuteProcRequest object with default parameters.
Definition: ExecuteProc.cs:328
IDictionary< string, IList< string > > input_column_names
Map of table names from to lists of names of columns from those tables that will be passed to the pr...
Definition: ExecuteProc.cs:225
const string MAX_OUTPUT_LINES
The maximum number of lines of output from stdout and stderr to return via Kinetica.showProcStatus(string,IDictionary{string, string}).
Definition: ExecuteProc.cs:155
IDictionary< string, string > info
Additional information.
Definition: ExecuteProc.cs:493
IDictionary< string, string > _params
A map containing named parameters to pass to the proc.
Definition: ExecuteProc.cs:195
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.executeProc(string,IDictionary{string, string},IDictionary{string, byte[]},IList{string},IDictionary{string, IList{string}},IList{string},IDictionary{string, string}).
Definition: ExecuteProc.cs:32