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 {
23  public class ExecuteProcRequest : KineticaData
24  {
28  public struct Options
29  {
32  public const string CACHE_INPUT = "cache_input";
33 
36  public const string USE_CACHED_INPUT = "use_cached_input";
37 
45  public const string RUN_TAG = "run_tag";
46 
54  public const string MAX_OUTPUT_LINES = "max_output_lines";
55 
70  public const string EXECUTE_AT_STARTUP = "execute_at_startup";
71 
72  public const string TRUE = "true";
73  public const string FALSE = "false";
74 
80  public const string EXECUTE_AT_STARTUP_AS = "execute_at_startup_as";
81  } // end struct Options
82 
86  public string proc_name { get; set; }
87 
93  public IDictionary<string, string> _params { get; set; } = new Dictionary<string, string>();
94 
100  public IDictionary<string, byte[]> bin_params { get; set; } = new Dictionary<string, byte[]>();
101 
111  public IList<string> input_table_names { get; set; } = new List<string>();
112 
122  public IDictionary<string, IList<string>> input_column_names { get; set; } = new Dictionary<string, IList<string>>();
123 
139  public IList<string> output_table_names { get; set; } = new List<string>();
140 
213  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
214 
217  public ExecuteProcRequest() { }
218 
335  IDictionary<string, string> _params = null,
336  IDictionary<string, byte[]> bin_params = null,
337  IList<string> input_table_names = null,
338  IDictionary<string, IList<string>> input_column_names = null,
339  IList<string> output_table_names = null,
340  IDictionary<string, string> options = null)
341  {
342  this.proc_name = proc_name ?? "";
343  this._params = _params ?? new Dictionary<string, string>();
344  this.bin_params = bin_params ?? new Dictionary<string, byte[]>();
345  this.input_table_names = input_table_names ?? new List<string>();
346  this.input_column_names = input_column_names ?? new Dictionary<string, IList<string>>();
347  this.output_table_names = output_table_names ?? new List<string>();
348  this.options = options ?? new Dictionary<string, string>();
349  } // end constructor
350  } // end class ExecuteProcRequest
351 
355  public class ExecuteProcResponse : KineticaData
356  {
363  public string run_id { get; set; }
364 
366  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
367  } // end class ExecuteProcResponse
368 } // end namespace kinetica
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:122
const string USE_CACHED_INPUT
No longer supported; option will be ignored.
Definition: ExecuteProc.cs:36
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:80
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteProc.cs:213
IList< string > input_table_names
Names of the tables containing data to be passed to the proc.
Definition: ExecuteProc.cs:111
string proc_name
Name of the proc to execute.
Definition: ExecuteProc.cs:86
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:334
const string CACHE_INPUT
No longer supported; option will be ignored.
Definition: ExecuteProc.cs:32
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:70
string run_id
The run ID of the running proc instance.
Definition: ExecuteProc.cs:363
IDictionary< string, string > info
Additional information.
Definition: ExecuteProc.cs:366
ExecuteProcRequest()
Constructs an ExecuteProcRequest object with default parameters.
Definition: ExecuteProc.cs:217
IDictionary< string, byte[]> bin_params
A map containing named binary parameters to pass to the proc.
Definition: ExecuteProc.cs:100
IDictionary< string, string > _params
A map containing named parameters to pass to the proc.
Definition: ExecuteProc.cs:93
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:139
const string MAX_OUTPUT_LINES
The maximum number of lines of output from stdout and stderr to return via Kinetica....
Definition: ExecuteProc.cs:54
const string RUN_TAG
A string that, if not empty, can be used in subsequent calls to Kinetica.showProcStatus or Kinetica....
Definition: ExecuteProc.cs:45