Kinetica   C#   API  Version 7.2.3.1
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 
29 {
34  public struct Encoding
35  {
38  public const string BINARY = "binary";
39 
42  public const string JSON = "json";
43  } // end struct Encoding
44 
48  public struct Options
49  {
65  public const string CREATE_TEMP_TABLE = "create_temp_table";
66 
67  public const string TRUE = "true";
68  public const string FALSE = "false";
69 
78  public const string COLLECTION_NAME = "collection_name";
79 
88  public const string RESULT_TABLE = "result_table";
89 
106  public const string RESULT_TABLE_PERSIST = "result_table_persist";
107 
110  public const string EXPRESSION = "expression";
111 
118  public const string ORDER_BY = "order_by";
119 
125  public const string CHUNK_SIZE = "chunk_size";
126 
132  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
133 
139  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
140 
145  public const string COMPRESSION_CODEC = "compression_codec";
146 
149  public const string LIMIT = "limit";
150 
154  public const string TTL = "ttl";
155 
158  public const string VIEW_ID = "view_id";
159 
167  public const string CREATE_INDEXES = "create_indexes";
168 
182  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
183  } // end struct Options
184 
191  public string table_name { get; set; }
192 
196  public IList<string> column_names { get; set; } = new List<string>();
197 
200  public string variable_column_name { get; set; } = "";
201 
204  public string value_column_name { get; set; } = "";
205 
210  public IList<string> pivoted_columns { get; set; } = new List<string>();
211 
228  public string encoding { get; set; } = Encoding.BINARY;
229 
401  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
402 
406 
597  IList<string> column_names,
598  string variable_column_name,
599  string value_column_name,
600  IList<string> pivoted_columns,
601  IDictionary<string, string> options = null)
602  {
603  this.table_name = table_name ?? "";
604  this.column_names = column_names ?? new List<string>();
605  this.variable_column_name = variable_column_name ?? "";
606  this.value_column_name = value_column_name ?? "";
607  this.pivoted_columns = pivoted_columns ?? new List<string>();
608  this.encoding = Encoding.BINARY;
609  this.options = options ?? new Dictionary<string, string>();
610  } // end constructor
611 
817  IList<string> column_names,
818  string variable_column_name,
819  string value_column_name,
820  IList<string> pivoted_columns,
821  string encoding = null,
822  IDictionary<string, string> options = null)
823  {
824  this.table_name = table_name ?? "";
825  this.column_names = column_names ?? new List<string>();
826  this.variable_column_name = variable_column_name ?? "";
827  this.value_column_name = value_column_name ?? "";
828  this.pivoted_columns = pivoted_columns ?? new List<string>();
829  this.encoding = encoding ?? Encoding.BINARY;
830  this.options = options ?? new Dictionary<string, string>();
831  } // end full constructor
832 } // end class AggregateUnpivotRequest
833 
838 {
842  public struct Info
843  {
846  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
847  } // end struct Info
848 
851  public string table_name { get; set; }
852 
855  public string response_schema_str { get; set; }
856 
858  public byte[] binary_encoded_response { get; set; }
859 
861  public string json_encoded_response { get; set; }
862 
864  public long total_number_of_records { get; set; }
865 
868  public bool has_more_records { get; set; }
869 
881  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
882 } // end class RawAggregateUnpivotResponse
883 
888 {
892  public struct Info
893  {
896  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
897  } // end struct Info
898 
901  public string table_name { get; set; }
902 
904  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
905 
907  public long total_number_of_records { get; set; }
908 
911  public bool has_more_records { get; set; }
912 
924  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
925 } // end class AggregateUnpivotResponse
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
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.
A set of string constants for the parameter encoding.
IDictionary< string, string > options
Optional parameters.
string json_encoded_response
Avro JSON encoded response.
A set of string constants for the parameter info.
IList< KineticaRecord > data
Avro binary encoded response.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
byte [] binary_encoded_response
Avro binary encoded response.
long total_number_of_records
Total/Filtered number of records.
string table_name
Typically shows the result-table name if provided in the request (Ignore otherwise).
A set of results returned by Kinetica.aggregateUnpivot.
string variable_column_name
Specifies the variable/parameter column name.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
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 ...
string encoding
Specifies the encoding for returned records.
const string BINARY
Indicates that the returned records should be binary encoded.
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
IList< string > column_names
List of column names or expressions.
string value_column_name
Specifies the value column name.
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for the result table.
const string ORDER_BY
Comma-separated list of the columns to be sorted by; e.g.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
IDictionary< string, string > info
Additional information.
A set of string constants for the parameter info.
A set of string constants for the parameter options.
const string EXPRESSION
Filter expression to apply to the table prior to unpivot processing.
IDictionary< string, string > info
Additional information.
bool has_more_records
Too many records.
const string LIMIT
The number of records to keep.
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.
const string VIEW_ID
View this result table is part of.
IList< string > pivoted_columns
List of one or more values typically the column names of the input table.
long total_number_of_records
Total/Filtered number of records.
bool has_more_records
Too many records.
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.
string table_name
Typically shows the result-table name if provided in the request (Ignore otherwise).
string table_name
Name of the table on which the operation will be performed.
A set of results returned by Kinetica.aggregateUnpivot.
const string COMPRESSION_CODEC
The default compression codec for the result table's columns.
AggregateUnpivotRequest()
Constructs an AggregateUnpivotRequest object with default parameters.
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 CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the table specified in RESULT_TABLE.
const string JSON
Indicates that the returned records should be JSON-encoded.
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 parameters for Kinetica.aggregateUnpivot.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....