Kinetica C# API  Version 7.0.19.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 
21  {
22 
73  public struct Options
74  {
75 
87  public const string CACHE_INPUT = "cache_input";
88 
101  public const string USE_CACHED_INPUT = "use_cached_input";
102 
109  public const string KIFS_INPUT_DIRS = "kifs_input_dirs";
110 
118  public const string RUN_TAG = "run_tag";
119  } // end struct Options
120 
121 
124  public string proc_name { get; set; }
125 
129  public IDictionary<string, string> _params { get; set; } = new Dictionary<string, string>();
130 
134  public IDictionary<string, byte[]> bin_params { get; set; } = new Dictionary<string, byte[]>();
135 
140  public IList<string> input_table_names { get; set; } = new List<string>();
141 
150  public IDictionary<string, IList<string>> input_column_names { get; set; } = new Dictionary<string, IList<string>>();
151 
161  public IList<string> output_table_names { get; set; } = new List<string>();
162 
211  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
212 
213 
216  public ExecuteProcRequest() { }
217 
303  IDictionary<string, string> _params = null,
304  IDictionary<string, byte[]> bin_params = null,
305  IList<string> input_table_names = null,
306  IDictionary<string, IList<string>> input_column_names = null,
307  IList<string> output_table_names = null,
308  IDictionary<string, string> options = null)
309  {
310  this.proc_name = proc_name ?? "";
311  this._params = _params ?? new Dictionary<string, string>();
312  this.bin_params = bin_params ?? new Dictionary<string, byte[]>();
313  this.input_table_names = input_table_names ?? new List<string>();
314  this.input_column_names = input_column_names ?? new Dictionary<string, IList<string>>();
315  this.output_table_names = output_table_names ?? new List<string>();
316  this.options = options ?? new Dictionary<string, string>();
317  } // end constructor
318 
319  } // end class ExecuteProcRequest
320 
321 
322 
327  {
328 
332  public string run_id { get; set; }
333 
335  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
336 
337  } // end class ExecuteProcResponse
338 
339 
340 
341 
342 } // end namespace kinetica
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:118
string run_id
The run ID of the running proc instance.
Definition: ExecuteProc.cs:332
IList< string > input_table_names
Names of the tables containing data to be passed to the proc.
Definition: ExecuteProc.cs:140
string proc_name
Name of the proc to execute.
Definition: ExecuteProc.cs:124
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:101
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:302
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:87
IDictionary< string, byte[]> bin_params
A map containing named binary parameters to pass to the proc.
Definition: ExecuteProc.cs:134
IDictionary< string, string > options
Optional parameters.
Definition: ExecuteProc.cs:211
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:326
const string KIFS_INPUT_DIRS
A comma-delimited list of KiFS directories whose local files will be made directly accessible to the ...
Definition: ExecuteProc.cs:109
IList< string > output_table_names
Names of the tables to which output data from the proc will be written.
Definition: ExecuteProc.cs:161
ExecuteProcRequest()
Constructs an ExecuteProcRequest object with default parameters.
Definition: ExecuteProc.cs:216
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:150
IDictionary< string, string > info
Additional information.
Definition: ExecuteProc.cs:335
IDictionary< string, string > _params
A map containing named parameters to pass to the proc.
Definition: ExecuteProc.cs:129
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:20