Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
AggregateUnpivot.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 
36  {
37 
58  public struct Encoding
59  {
60 
63  public const string BINARY = "binary";
64 
67  public const string JSON = "json";
68  } // end struct Encoding
69 
70 
209  public struct Options
210  {
211 
216  public const string COLLECTION_NAME = "collection_name";
217 
222  public const string RESULT_TABLE = "result_table";
223 
242  public const string RESULT_TABLE_PERSIST = "result_table_persist";
243  public const string TRUE = "true";
244  public const string FALSE = "false";
245 
248  public const string EXPRESSION = "expression";
249 
255  public const string ORDER_BY = "order_by";
256 
260  public const string CHUNK_SIZE = "chunk_size";
261 
264  public const string LIMIT = "limit";
265 
269  public const string TTL = "ttl";
270 
273  public const string VIEW_ID = "view_id";
274 
296  public const string MATERIALIZE_ON_GPU = "materialize_on_gpu";
297 
303  public const string CREATE_INDEXES = "create_indexes";
304 
321  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
322  } // end struct Options
323 
324 
327  public string table_name { get; set; }
328 
332  public IList<string> column_names { get; set; } = new List<string>();
333 
336  public string variable_column_name { get; set; } = "";
337 
340  public string value_column_name { get; set; } = "";
341 
345  public IList<string> pivoted_columns { get; set; } = new List<string>();
346 
366  public string encoding { get; set; } = Encoding.BINARY;
367 
504  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
505 
506 
510 
664  IList<string> column_names,
665  string variable_column_name,
666  string value_column_name,
667  IList<string> pivoted_columns,
668  IDictionary<string, string> options = null)
669  {
670  this.table_name = table_name ?? "";
671  this.column_names = column_names ?? new List<string>();
672  this.variable_column_name = variable_column_name ?? "";
673  this.value_column_name = value_column_name ?? "";
674  this.pivoted_columns = pivoted_columns ?? new List<string>();
675  this.encoding = Encoding.BINARY;
676  this.options = options ?? new Dictionary<string, string>();
677  } // end constructor
678 
679 
852  IList<string> column_names,
853  string variable_column_name,
854  string value_column_name,
855  IList<string> pivoted_columns,
856  string encoding = null,
857  IDictionary<string, string> options = null)
858  {
859  this.table_name = table_name ?? "";
860  this.column_names = column_names ?? new List<string>();
861  this.variable_column_name = variable_column_name ?? "";
862  this.value_column_name = value_column_name ?? "";
863  this.pivoted_columns = pivoted_columns ?? new List<string>();
864  this.encoding = encoding ?? Encoding.BINARY;
865  this.options = options ?? new Dictionary<string, string>();
866  } // end full constructor
867 
868  } // end class AggregateUnpivotRequest
869 
870 
871 
876  {
877 
880  public string table_name { get; set; }
881 
884  public string response_schema_str { get; set; }
885 
887  public byte[] binary_encoded_response { get; set; }
888 
890  public string json_encoded_response { get; set; }
891 
893  public long total_number_of_records { get; set; }
894 
896  public bool has_more_records { get; set; }
897 
899  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
900 
901  } // end class RawAggregateUnpivotResponse
902 
903 
904 
909  {
910 
913  public string table_name { get; set; }
914 
916  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
917 
919  public long total_number_of_records { get; set; }
920 
922  public bool has_more_records { get; set; }
923 
925  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
926 
927  } // end class AggregateUnpivotResponse
928 
929 
930 
931 
932 } // end namespace kinetica
byte[] binary_encoded_response
Avro binary encoded response.
const string RESULT_TABLE_PERSIST
If true, then the result table specified in result_table will be persisted and will not expire unless...
const string ORDER_BY
Comma-separated list of the columns to be sorted by; e.g.
IDictionary< string, string > info
Additional information.
bool has_more_records
Too many records. Returned a partial set.
string variable_column_name
Specifies the variable/parameter column name.
long total_number_of_records
Total/Filtered number of records.
A set of results returned by Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
string encoding
Specifies the encoding for returned records.
AggregateUnpivotRequest(string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateUnpivotRequest object with the specified parameters.
A set of results returned by Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
string value_column_name
Specifies the value column name.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
IDictionary< string, string > options
Optional parameters.
IList< KineticaRecord > data
Avro binary encoded response.
const string MATERIALIZE_ON_GPU
No longer used.
const string TTL
Sets the TTL of the table specified in result_table.
const string COLLECTION_NAME
Name of a collection which is to contain the table specified in result_table.
AggregateUnpivotRequest()
Constructs an AggregateUnpivotRequest object with default parameters.
string table_name
Name of the table on which the operation will be performed.
const string VIEW_ID
view this result table is part of.
A set of parameters for Kinetica.aggregateUnpivot(string,IList{string},string,string,IList{string},IDictionary{string, string}).
string table_name
Typically shows the result-table name if provided in the request (Ignore otherwise).
const string BINARY
Indicates that the returned records should be binary encoded.
IDictionary< string, string > info
Additional information.
long total_number_of_records
Total/Filtered number of records.
bool has_more_records
Too many records. Returned a partial set.
const string EXPRESSION
Filter expression to apply to the table prior to unpivot processing.
string table_name
Typically shows the result-table name if provided in the request (Ignore otherwise).
AggregateUnpivotRequest(string table_name, IList< string > column_names, string variable_column_name, string value_column_name, IList< string > pivoted_columns, IDictionary< string, string > options=null)
Constructs an AggregateUnpivotRequest object with the specified parameters.
IList< string > pivoted_columns
List of one or more values typically the column names of the input table.
string json_encoded_response
Avro JSON encoded response.
const string CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the table specified in result_table...
Specifies the encoding for returned records.
const string RESULT_TABLE
The name of the table used to store the results.
const string LIMIT
The number of records to keep.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string JSON
Indicates that the returned records should be json encoded.
string response_schema_str
Avro schema of &lt;member name=&quot;binary_encoded_response&quot;&gt; or &lt;member name=&quot;json_encoded_response&quot;&gt;.
IList< string > column_names
List of column names or expressions.