Kinetica   C#   API  Version 7.2.3.0
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 {
75  public class AggregateGroupByRequest : KineticaData
76  {
81  public struct Encoding
82  {
85  public const string BINARY = "binary";
86 
89  public const string JSON = "json";
90  } // end struct Encoding
91 
95  public struct Options
96  {
112  public const string CREATE_TEMP_TABLE = "create_temp_table";
113 
114  public const string TRUE = "true";
115  public const string FALSE = "false";
116 
126  public const string COLLECTION_NAME = "collection_name";
127 
130  public const string EXPRESSION = "expression";
131 
145  public const string PIPELINED_EXPRESSION_EVALUATION = "pipelined_expression_evaluation";
146 
149  public const string HAVING = "having";
150 
171  public const string SORT_ORDER = "sort_order";
172 
175  public const string ASCENDING = "ascending";
176 
179  public const string DESCENDING = "descending";
180 
206  public const string SORT_BY = "sort_by";
207 
213  public const string KEY = "key";
214 
220  public const string VALUE = "value";
221 
226  public const string ORDER_BY = "order_by";
227 
231  public const string STRATEGY_DEFINITION = "strategy_definition";
232 
237  public const string COMPRESSION_CODEC = "compression_codec";
238 
251  public const string RESULT_TABLE = "result_table";
252 
269  public const string RESULT_TABLE_PERSIST = "result_table_persist";
270 
284  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
285 
299  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
300 
314  public const string RESULT_TABLE_GENERATE_SOFT_PK = "result_table_generate_soft_pk";
315 
319  public const string TTL = "ttl";
320 
326  public const string CHUNK_SIZE = "chunk_size";
327 
333  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
334 
340  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
341 
347  public const string CREATE_INDEXES = "create_indexes";
348 
352  public const string VIEW_ID = "view_id";
353 
355  public const string PIVOT = "pivot";
356 
361  public const string PIVOT_VALUES = "pivot_values";
362 
370  public const string GROUPING_SETS = "grouping_sets";
371 
374  public const string ROLLUP = "rollup";
375 
378  public const string CUBE = "cube";
379 
386  public const string SHARD_KEY = "shard_key";
387  } // end struct Options
388 
393  public string table_name { get; set; }
394 
397  public IList<string> column_names { get; set; } = new List<string>();
398 
404  public long offset { get; set; } = 0;
405 
419  public long limit { get; set; } = -9999;
420 
437  public string encoding { get; set; } = Encoding.BINARY;
438 
778  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
779 
783 
1150  IList<string> column_names,
1151  long? offset = null,
1152  long? limit = null,
1153  IDictionary<string, string> options = null)
1154  {
1155  this.table_name = table_name ?? "";
1156  this.column_names = column_names ?? new List<string>();
1157  this.offset = offset ?? 0;
1158  this.limit = limit ?? -9999;
1159  this.encoding = Encoding.BINARY;
1160  this.options = options ?? new Dictionary<string, string>();
1161  } // end constructor
1162 
1545  IList<string> column_names,
1546  long? offset = null,
1547  long? limit = null,
1548  string encoding = null,
1549  IDictionary<string, string> options = null)
1550  {
1551  this.table_name = table_name ?? "";
1552  this.column_names = column_names ?? new List<string>();
1553  this.offset = offset ?? 0;
1554  this.limit = limit ?? -9999;
1555  this.encoding = encoding ?? Encoding.BINARY;
1556  this.options = options ?? new Dictionary<string, string>();
1557  } // end full constructor
1558  } // end class AggregateGroupByRequest
1559 
1563  public class RawAggregateGroupByResponse : KineticaData
1564  {
1568  public struct Info
1569  {
1572  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1573  } // end struct Info
1574 
1577  public string response_schema_str { get; set; }
1578 
1580  public byte[] binary_encoded_response { get; set; }
1581 
1583  public string json_encoded_response { get; set; }
1584 
1589  public long total_number_of_records { get; set; }
1590 
1593  public bool has_more_records { get; set; }
1594 
1607  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1608  } // end class RawAggregateGroupByResponse
1609 
1613  public class AggregateGroupByResponse : KineticaData
1614  {
1618  public struct Info
1619  {
1622  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1623  } // end struct Info
1624 
1626  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1627 
1632  public long total_number_of_records { get; set; }
1633 
1636  public bool has_more_records { get; set; }
1637 
1650  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1651  } // end class AggregateGroupByResponse
1652 } // end namespace kinetica
A set of string constants for the parameter encoding.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
const string KEY
Indicates that the returned values should be sorted by key, which corresponds to the grouping columns...
long total_number_of_records
Total/Filtered number of records.
const string PIPELINED_EXPRESSION_EVALUATION
evaluate the group-by during last JoinedSet filter plan step.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
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.
AggregateGroupByRequest()
Constructs an AggregateGroupByRequest object with default parameters.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
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.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
string encoding
Specifies the encoding for returned records.
const string BINARY
Indicates that the returned records should be binary encoded.
const string SORT_BY
[DEPRECATED–use order_by instead] String determining how the results are sorted.
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 EXPRESSION
Filter expression to apply to the table prior to computing the aggregate group by.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
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 ...
const string PIVOT_VALUES
The value list provided will become the column headers in the output.
const string ASCENDING
Indicates that the returned values should be sorted in ascending order.
const string SORT_ORDER
[DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascend...
const string CUBE
This option is used to specify the multidimensional aggregates.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
const string SHARD_KEY
Comma-separated list of the columns to be sharded on; e.g.
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
IDictionary< string, string > info
Additional information.
string table_name
Name of an existing table or view on which the operation will be performed, in [schema_name.
bool has_more_records
Too many records.
const string CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the result table.
const string ROLLUP
This option is used to specify the multilevel aggregates.
IDictionary< string, string > info
Additional information.
const string DESCENDING
Indicates that the returned values should be sorted in descending order.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
byte [] binary_encoded_response
Avro binary encoded response.
IDictionary< string, string > options
Optional parameters.
const string GROUPING_SETS
Customize the grouping attribute sets to compute the aggregates.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....
const string VIEW_ID
ID of view of which the result table will be a member.
const string JSON
Indicates that the returned records should be json encoded.
const string VALUE
Indicates that the returned values should be sorted by value, which corresponds to the aggregates.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
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 RESULT_TABLE_GENERATE_PK
If TRUE then set a primary key for the result table.
long total_number_of_records
Total/Filtered number of records.
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.
IList< string > column_names
List of one or more column names, expressions, and aggregate expressions.
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.
IList< KineticaRecord > data
Avro binary encoded response.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
string json_encoded_response
Avro JSON encoded response.