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 {
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 CHUNKED_EXPRESSION_EVALUATION = "chunked_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 
245  public const string RESULT_TABLE = "result_table";
246 
263  public const string RESULT_TABLE_PERSIST = "result_table_persist";
264 
278  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
279 
293  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
294 
298  public const string TTL = "ttl";
299 
305  public const string CHUNK_SIZE = "chunk_size";
306 
312  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
313 
319  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
320 
326  public const string CREATE_INDEXES = "create_indexes";
327 
331  public const string VIEW_ID = "view_id";
332 
334  public const string PIVOT = "pivot";
335 
340  public const string PIVOT_VALUES = "pivot_values";
341 
349  public const string GROUPING_SETS = "grouping_sets";
350 
353  public const string ROLLUP = "rollup";
354 
357  public const string CUBE = "cube";
358 
365  public const string SHARD_KEY = "shard_key";
366  } // end struct Options
367 
372  public string table_name { get; set; }
373 
376  public IList<string> column_names { get; set; } = new List<string>();
377 
383  public long offset { get; set; } = 0;
384 
398  public long limit { get; set; } = -9999;
399 
416  public string encoding { get; set; } = Encoding.BINARY;
417 
728  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
729 
733 
1071  IList<string> column_names,
1072  long? offset = null,
1073  long? limit = null,
1074  IDictionary<string, string> options = null)
1075  {
1076  this.table_name = table_name ?? "";
1077  this.column_names = column_names ?? new List<string>();
1078  this.offset = offset ?? 0;
1079  this.limit = limit ?? -9999;
1080  this.encoding = Encoding.BINARY;
1081  this.options = options ?? new Dictionary<string, string>();
1082  } // end constructor
1083 
1437  IList<string> column_names,
1438  long? offset = null,
1439  long? limit = null,
1440  string encoding = null,
1441  IDictionary<string, string> options = null)
1442  {
1443  this.table_name = table_name ?? "";
1444  this.column_names = column_names ?? new List<string>();
1445  this.offset = offset ?? 0;
1446  this.limit = limit ?? -9999;
1447  this.encoding = encoding ?? Encoding.BINARY;
1448  this.options = options ?? new Dictionary<string, string>();
1449  } // end full constructor
1450  } // end class AggregateGroupByRequest
1451 
1456  {
1460  public struct Info
1461  {
1464  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1465  } // end struct Info
1466 
1469  public string response_schema_str { get; set; }
1470 
1472  public byte[] binary_encoded_response { get; set; }
1473 
1475  public string json_encoded_response { get; set; }
1476 
1481  public long total_number_of_records { get; set; }
1482 
1485  public bool has_more_records { get; set; }
1486 
1499  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1500  } // end class RawAggregateGroupByResponse
1501 
1506  {
1510  public struct Info
1511  {
1514  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1515  } // end struct Info
1516 
1518  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1519 
1524  public long total_number_of_records { get; set; }
1525 
1528  public bool has_more_records { get; set; }
1529 
1542  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1543  } // end class AggregateGroupByResponse
1544 } // end namespace kinetica
A set of string constants for the parameter encoding.
long total_number_of_records
Total/Filtered number of records.
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
A set of results returned by Kinetica.aggregateGroupBy.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
const string CUBE
This option is used to specify the multidimensional aggregates.
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 QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
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 BINARY
Indicates that the returned records should be binary encoded.
const string KEY
Indicates that the returned values should be sorted by key, which corresponds to the grouping columns...
A set of string constants for the parameter info.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
const string CHUNKED_EXPRESSION_EVALUATION
evaluate the filter expression during group-by chunk processing.
A set of string constants for the parameter info.
IList< KineticaRecord > data
Avro binary encoded response.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string VALUE
Indicates that the returned values should be sorted by value, which corresponds to the aggregates.
IDictionary< string, string > options
Optional parameters.
const string DESCENDING
Indicates that the returned values should be sorted in descending order.
A set of string constants for the parameter options.
IDictionary< string, string > info
Additional information.
long total_number_of_records
Total/Filtered number of records.
const string SORT_ORDER
[DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascend...
bool has_more_records
Too many records.
const string EXPRESSION
Filter expression to apply to the table prior to computing the aggregate group by.
string json_encoded_response
Avro JSON encoded response.
IList< string > column_names
List of one or more column names, expressions, and aggregate expressions.
const string ASCENDING
Indicates that the returned values should be sorted in ascending order.
const string STRATEGY_DEFINITION
The tier strategy for the table and its columns.
byte [] binary_encoded_response
Avro binary encoded response.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
A set of results returned by Kinetica.aggregateGroupBy.
const string JSON
Indicates that the returned records should be json encoded.
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 HAVING
Filter expression to apply to the aggregated results.
const string SORT_BY
[DEPRECATED–use order_by instead] String determining how the results are sorted.
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 VIEW_ID
ID of view of which the result table will be a member.
string encoding
Specifies the encoding for returned 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 RESULT_TABLE_GENERATE_PK
If TRUE then set a primary key for the result table.
string table_name
Name of an existing table or view on which the operation will be performed, in [schema_name.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > info
Additional information.
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.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
const string ROLLUP
This option is used to specify the multilevel aggregates.
const string RESULT_TABLE
The name of a table used to store the results, in [schema_name.
const string GROUPING_SETS
Customize the grouping attribute sets to compute the aggregates.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
const string PIVOT_VALUES
The value list provided will become the column headers in the output.
const string SHARD_KEY
Comma-separated list of the columns to be sharded on; e.g.
const string CREATE_INDEXES
Comma-separated list of columns on which to create indexes on the result table.
A set of parameters for Kinetica.aggregateGroupBy.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....