Kinetica   C#   API  Version 7.2.3.1
AggregateGroupBy.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 
69 {
74  public struct Encoding
75  {
78  public const string BINARY = "binary";
79 
82  public const string JSON = "json";
83  } // end struct Encoding
84 
88  public struct Options
89  {
105  public const string CREATE_TEMP_TABLE = "create_temp_table";
106 
107  public const string TRUE = "true";
108  public const string FALSE = "false";
109 
118  public const string COLLECTION_NAME = "collection_name";
119 
122  public const string EXPRESSION = "expression";
123 
137  public const string PIPELINED_EXPRESSION_EVALUATION = "pipelined_expression_evaluation";
138 
141  public const string HAVING = "having";
142 
162  public const string SORT_ORDER = "sort_order";
163 
166  public const string ASCENDING = "ascending";
167 
170  public const string DESCENDING = "descending";
171 
195  public const string SORT_BY = "sort_by";
196 
202  public const string KEY = "key";
203 
209  public const string VALUE = "value";
210 
215  public const string ORDER_BY = "order_by";
216 
220  public const string STRATEGY_DEFINITION = "strategy_definition";
221 
226  public const string COMPRESSION_CODEC = "compression_codec";
227 
239  public const string RESULT_TABLE = "result_table";
240 
257  public const string RESULT_TABLE_PERSIST = "result_table_persist";
258 
272  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
273 
287  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
288 
302  public const string RESULT_TABLE_GENERATE_SOFT_PK = "result_table_generate_soft_pk";
303 
307  public const string TTL = "ttl";
308 
314  public const string CHUNK_SIZE = "chunk_size";
315 
321  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
322 
328  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
329 
335  public const string CREATE_INDEXES = "create_indexes";
336 
373  public const string PARTITION_TYPE = "partition_type";
374 
378  public const string RANGE = "RANGE";
379 
383  public const string INTERVAL = "INTERVAL";
384 
388  public const string LIST = "LIST";
389 
393  public const string HASH = "HASH";
394 
398  public const string SERIES = "SERIES";
399 
405  public const string PARTITION_KEYS = "partition_keys";
406 
422  public const string PARTITION_DEFINITIONS = "partition_definitions";
423 
438  public const string IS_AUTOMATIC_PARTITION = "is_automatic_partition";
439 
443  public const string VIEW_ID = "view_id";
444 
446  public const string PIVOT = "pivot";
447 
452  public const string PIVOT_VALUES = "pivot_values";
453 
460  public const string GROUPING_SETS = "grouping_sets";
461 
464  public const string ROLLUP = "rollup";
465 
468  public const string CUBE = "cube";
469 
476  public const string SHARD_KEY = "shard_key";
477  } // end struct Options
478 
483  public string table_name { get; set; }
484 
487  public IList<string> column_names { get; set; } = new List<string>();
488 
493  public long offset { get; set; } = 0;
494 
507  public long limit { get; set; } = -9999;
508 
525  public string encoding { get; set; } = Encoding.BINARY;
526 
945  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
946 
950 
1395  IList<string> column_names,
1396  long? offset = null,
1397  long? limit = null,
1398  IDictionary<string, string> options = null)
1399  {
1400  this.table_name = table_name ?? "";
1401  this.column_names = column_names ?? new List<string>();
1402  this.offset = offset ?? 0;
1403  this.limit = limit ?? -9999;
1404  this.encoding = Encoding.BINARY;
1405  this.options = options ?? new Dictionary<string, string>();
1406  } // end constructor
1407 
1867  IList<string> column_names,
1868  long? offset = null,
1869  long? limit = null,
1870  string encoding = null,
1871  IDictionary<string, string> options = null)
1872  {
1873  this.table_name = table_name ?? "";
1874  this.column_names = column_names ?? new List<string>();
1875  this.offset = offset ?? 0;
1876  this.limit = limit ?? -9999;
1877  this.encoding = encoding ?? Encoding.BINARY;
1878  this.options = options ?? new Dictionary<string, string>();
1879  } // end full constructor
1880 } // end class AggregateGroupByRequest
1881 
1886 {
1890  public struct Info
1891  {
1894  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1895  } // end struct Info
1896 
1899  public string response_schema_str { get; set; }
1900 
1902  public byte[] binary_encoded_response { get; set; }
1903 
1905  public string json_encoded_response { get; set; }
1906 
1911  public long total_number_of_records { get; set; }
1912 
1915  public bool has_more_records { get; set; }
1916 
1928  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1929 } // end class RawAggregateGroupByResponse
1930 
1935 {
1939  public struct Info
1940  {
1943  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1944  } // end struct Info
1945 
1947  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1948 
1953  public long total_number_of_records { get; set; }
1954 
1957  public bool has_more_records { get; set; }
1958 
1970  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1971 } // end class AggregateGroupByResponse
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
const string SORT_ORDER
[DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascend...
long total_number_of_records
Total/Filtered number of records.
const string RESULT_TABLE_GENERATE_PK
If TRUE then set a primary key for the result table.
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 ...
byte [] binary_encoded_response
Avro binary encoded response.
const string COMPRESSION_CODEC
The default compression codec for the result table's columns.
const string RESULT_TABLE_GENERATE_SOFT_PK
If TRUE then set a soft primary key for the result table.
const string CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the result table.
const string DESCENDING
Indicates that the returned values should be sorted in descending order.
const string CUBE
This option is used to specify the multidimensional aggregates.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
const string PARTITION_KEYS
Comma-separated list of partition keys, which are the columns or column expressions by which records ...
long total_number_of_records
Total/Filtered number of records.
A set of string constants for the parameter encoding.
const string IS_AUTOMATIC_PARTITION
If TRUE, a new partition will be created for values which don't fall into an existing partition.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string BINARY
Indicates that the returned records should be binary encoded.
const string ROLLUP
This option is used to specify the multilevel aggregates.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string GROUPING_SETS
Customize the grouping attribute sets to compute the aggregates.
const string RANGE
Use range partitioning.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
const string SHARD_KEY
Comma-separated list of the columns to be sharded on; e.g.
const string SERIES
Use series partitioning.
A set of results returned by Kinetica.aggregateGroupBy.
const string ASCENDING
Indicates that the returned values should be sorted in ascending order.
const string INTERVAL
Use interval partitioning.
const string EXPRESSION
Filter expression to apply to the table prior to computing the aggregate group by.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string VIEW_ID
ID of view of which the result table will be a member.
IList< string > column_names
List of one or more column names, expressions, and aggregate expressions.
IDictionary< string, string > info
Additional information.
string encoding
Specifies the encoding for returned records.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
const string VALUE
Indicates that the returned values should be sorted by value, which corresponds to the aggregates.
const string JSON
Indicates that the returned records should be JSON-encoded.
const string LIST
Use list partitioning.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
A set of string constants for the parameter info.
IList< KineticaRecord > data
Avro binary encoded response.
const string PARTITION_TYPE
Partitioning scheme to use for the result table.
const string PIVOT_VALUES
Comma-separated list of the values in the PIVOT column.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
const string SORT_BY
[DEPRECATED–use order_by instead] String determining how the results are sorted.
bool has_more_records
Too many records.
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 PIVOT
Pivot column.
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.
AggregateGroupByRequest(string table_name, IList< string > column_names, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
A set of string constants for the parameter options.
A set of parameters for Kinetica.aggregateGroupBy.
const string KEY
Indicates that the returned values should be sorted by key, which corresponds to the grouping columns...
string table_name
Name of an existing table or view on which the operation will be performed, in [schema_name.
IDictionary< string, string > info
Additional information.
string json_encoded_response
Avro JSON encoded response.
AggregateGroupByRequest(string table_name, IList< string > column_names, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
const string PIPELINED_EXPRESSION_EVALUATION
Evaluate the group-by during last JoinedSet filter plan step.
const string PARTITION_DEFINITIONS
Comma-separated list of partition definitions, whose format depends on the choice of PARTITION_TYPE.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
IDictionary< string, string > options
Optional parameters.
const string HASH
Use hash partitioning.
const string HAVING
Filter expression to apply to the aggregated results.
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for the result table.
A set of results returned by Kinetica.aggregateGroupBy.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
AggregateGroupByRequest()
Constructs an AggregateGroupByRequest object with default parameters.
A set of string constants for the parameter info.
bool has_more_records
Too many records.