Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
24  {
28  public struct Options
29  {
44  public const string CACHE_INPUT = "cache_input";
45 
60  public const string USE_CACHED_INPUT = "use_cached_input";
61 
69  public const string RUN_TAG = "run_tag";
70 
78  public const string MAX_OUTPUT_LINES = "max_output_lines";
79 
94  public const string EXECUTE_AT_STARTUP = "execute_at_startup";
95 
96  public const string TRUE = "true";
97  public const string FALSE = "false";
98 
104  public const string EXECUTE_AT_STARTUP_AS = "execute_at_startup_as";
105  } // end struct Options
106 
110  public string proc_name { get; set; }
111 
117  public IDictionary<string, string> _params { get; set; } = new Dictionary<string, string>();
118 
124  public IDictionary<string, byte[]> bin_params { get; set; } = new Dictionary<string, byte[]>();
125 
135  public IList<string> input_table_names { get; set; } = new List<string>();
136 
146  public IDictionary<string, IList<string>> input_column_names { get; set; } = new Dictionary<string, IList<string>>();
147 
163  public IList<string> output_table_names { get; set; } = new List<string>();
164 
259  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
260 
263  public ExecuteProcRequest() { }
264 
403  IDictionary<string, string> _params = null,
404  IDictionary<string, byte[]> bin_params = null,
405  IList<string> input_table_names = null,
406  IDictionary<string, IList<string>> input_column_names = null,
407  IList<string> output_table_names = null,
408  IDictionary<string, string> options = null)
409  {
410  this.proc_name = proc_name ?? "";
411  this._params = _params ?? new Dictionary<string, string>();
412  this.bin_params = bin_params ?? new Dictionary<string, byte[]>();
413  this.input_table_names = input_table_names ?? new List<string>();
414  this.input_column_names = input_column_names ?? new Dictionary<string, IList<string>>();
415  this.output_table_names = output_table_names ?? new List<string>();
416  this.options = options ?? new Dictionary<string, string>();
417  } // end constructor
418  } // end class ExecuteProcRequest
419 
424  {
431  public string run_id { get; set; }
432 
434  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
435  } // end class ExecuteProcResponse
436 } // 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:104
const string RUN_TAG
A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica....
Definition: ExecuteProc.cs:69
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:94
string run_id
The run ID of the running proc instance.
Definition: ExecuteProc.cs:431
IList< string > input_table_names
Names of the tables containing data to be passed to the proc.
Definition: ExecuteProc.cs:135
string proc_name
Name of the proc to execute.
Definition: ExecuteProc.cs:110
const string USE_CACHED_INPUT
A comma-delimited list of run IDs (as returned from prior calls to Kinetica.executeProc) of running o...
Definition: ExecuteProc.cs:60
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:402
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:44
IDictionary< string, byte[]> bin_params
A map containing named binary parameters to pass to the proc.
Definition: ExecuteProc.cs:124
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteProc.cs:259
A set of string constants for the parameter options.
Definition: ExecuteProc.cs:28
A set of results returned by Kinetica.executeProc.
Definition: ExecuteProc.cs:423
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:163
ExecuteProcRequest()
Constructs an ExecuteProcRequest object with default parameters.
Definition: ExecuteProc.cs:263
IDictionary< string, IList< string > > input_column_names
Map of table names from input_table_names to lists of names of columns from those tables that will be...
Definition: ExecuteProc.cs:146
const string MAX_OUTPUT_LINES
The maximum number of lines of output from stdout and stderr to return via Kinetica....
Definition: ExecuteProc.cs:78
IDictionary< string, string > info
Additional information.
Definition: ExecuteProc.cs:434
IDictionary< string, string > _params
A map containing named parameters to pass to the proc.
Definition: ExecuteProc.cs:117
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.executeProc.
Definition: ExecuteProc.cs:23