Kinetica   C#   API  Version 7.2.3.0
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 namespace kinetica
10 {
30  {
35  public struct Encoding
36  {
39  public const string BINARY = "binary";
40 
43  public const string JSON = "json";
44  } // end struct Encoding
45 
49  public struct Options
50  {
66  public const string CREATE_TEMP_TABLE = "create_temp_table";
67 
68  public const string TRUE = "true";
69  public const string FALSE = "false";
70 
80  public const string COLLECTION_NAME = "collection_name";
81 
90  public const string RESULT_TABLE = "result_table";
91 
108  public const string RESULT_TABLE_PERSIST = "result_table_persist";
109 
112  public const string EXPRESSION = "expression";
113 
120  public const string ORDER_BY = "order_by";
121 
127  public const string CHUNK_SIZE = "chunk_size";
128 
134  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
135 
141  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
142 
145  public const string LIMIT = "limit";
146 
150  public const string TTL = "ttl";
151 
154  public const string VIEW_ID = "view_id";
155 
163  public const string CREATE_INDEXES = "create_indexes";
164 
178  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
179  } // end struct Options
180 
187  public string table_name { get; set; }
188 
192  public IList<string> column_names { get; set; } = new List<string>();
193 
196  public string variable_column_name { get; set; } = "";
197 
200  public string value_column_name { get; set; } = "";
201 
206  public IList<string> pivoted_columns { get; set; } = new List<string>();
207 
224  public string encoding { get; set; } = Encoding.BINARY;
225 
396  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
397 
401 
591  IList<string> column_names,
592  string variable_column_name,
593  string value_column_name,
594  IList<string> pivoted_columns,
595  IDictionary<string, string> options = null)
596  {
597  this.table_name = table_name ?? "";
598  this.column_names = column_names ?? new List<string>();
599  this.variable_column_name = variable_column_name ?? "";
600  this.value_column_name = value_column_name ?? "";
601  this.pivoted_columns = pivoted_columns ?? new List<string>();
602  this.encoding = Encoding.BINARY;
603  this.options = options ?? new Dictionary<string, string>();
604  } // end constructor
605 
811  IList<string> column_names,
812  string variable_column_name,
813  string value_column_name,
814  IList<string> pivoted_columns,
815  string encoding = null,
816  IDictionary<string, string> options = null)
817  {
818  this.table_name = table_name ?? "";
819  this.column_names = column_names ?? new List<string>();
820  this.variable_column_name = variable_column_name ?? "";
821  this.value_column_name = value_column_name ?? "";
822  this.pivoted_columns = pivoted_columns ?? new List<string>();
823  this.encoding = encoding ?? Encoding.BINARY;
824  this.options = options ?? new Dictionary<string, string>();
825  } // end full constructor
826  } // end class AggregateUnpivotRequest
827 
832  {
836  public struct Info
837  {
840  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
841  } // end struct Info
842 
845  public string table_name { get; set; }
846 
849  public string response_schema_str { get; set; }
850 
852  public byte[] binary_encoded_response { get; set; }
853 
855  public string json_encoded_response { get; set; }
856 
858  public long total_number_of_records { get; set; }
859 
862  public bool has_more_records { get; set; }
863 
876  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
877  } // end class RawAggregateUnpivotResponse
878 
883  {
887  public struct Info
888  {
891  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
892  } // end struct Info
893 
896  public string table_name { get; set; }
897 
899  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
900 
902  public long total_number_of_records { get; set; }
903 
906  public bool has_more_records { get; set; }
907 
920  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
921  } // end class AggregateUnpivotResponse
922 } // 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.
A set of string constants for the parameter info.
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 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.
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.
A set of string constants for the parameter options.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string CHUNK_COLUMN_MAX_MEMORY
Indicates the target maximum data size for each column in a chunk to be used for the result table.
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....
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 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.
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for the result table.
IDictionary< string, string > info
Additional information.
long total_number_of_records
Total/Filtered number of records.
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.
A set of string constants for the parameter encoding.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
const string LIMIT
The number of records to keep.
A set of string constants for the parameter info.
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.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
IList< string > column_names
List of column names or expressions.
const string CREATE_TEMP_TABLE
If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of ...