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 {
72  public class AggregateGroupByRequest : KineticaData
73  {
78  public struct Encoding
79  {
82  public const string BINARY = "binary";
83 
86  public const string JSON = "json";
87  } // end struct Encoding
88 
92  public struct Options
93  {
109  public const string CREATE_TEMP_TABLE = "create_temp_table";
110 
111  public const string TRUE = "true";
112  public const string FALSE = "false";
113 
123  public const string COLLECTION_NAME = "collection_name";
124 
127  public const string EXPRESSION = "expression";
128 
142  public const string PIPELINED_EXPRESSION_EVALUATION = "pipelined_expression_evaluation";
143 
146  public const string HAVING = "having";
147 
168  public const string SORT_ORDER = "sort_order";
169 
172  public const string ASCENDING = "ascending";
173 
176  public const string DESCENDING = "descending";
177 
203  public const string SORT_BY = "sort_by";
204 
210  public const string KEY = "key";
211 
217  public const string VALUE = "value";
218 
223  public const string ORDER_BY = "order_by";
224 
228  public const string STRATEGY_DEFINITION = "strategy_definition";
229 
234  public const string COMPRESSION_CODEC = "compression_codec";
235 
248  public const string RESULT_TABLE = "result_table";
249 
266  public const string RESULT_TABLE_PERSIST = "result_table_persist";
267 
281  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
282 
296  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
297 
311  public const string RESULT_TABLE_GENERATE_SOFT_PK = "result_table_generate_soft_pk";
312 
316  public const string TTL = "ttl";
317 
323  public const string CHUNK_SIZE = "chunk_size";
324 
330  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
331 
337  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
338 
344  public const string CREATE_INDEXES = "create_indexes";
345 
349  public const string VIEW_ID = "view_id";
350 
352  public const string PIVOT = "pivot";
353 
358  public const string PIVOT_VALUES = "pivot_values";
359 
367  public const string GROUPING_SETS = "grouping_sets";
368 
371  public const string ROLLUP = "rollup";
372 
375  public const string CUBE = "cube";
376 
383  public const string SHARD_KEY = "shard_key";
384  } // end struct Options
385 
390  public string table_name { get; set; }
391 
394  public IList<string> column_names { get; set; } = new List<string>();
395 
401  public long offset { get; set; } = 0;
402 
416  public long limit { get; set; } = -9999;
417 
434  public string encoding { get; set; } = Encoding.BINARY;
435 
775  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
776 
780 
1147  IList<string> column_names,
1148  long? offset = null,
1149  long? limit = null,
1150  IDictionary<string, string> options = null)
1151  {
1152  this.table_name = table_name ?? "";
1153  this.column_names = column_names ?? new List<string>();
1154  this.offset = offset ?? 0;
1155  this.limit = limit ?? -9999;
1156  this.encoding = Encoding.BINARY;
1157  this.options = options ?? new Dictionary<string, string>();
1158  } // end constructor
1159 
1542  IList<string> column_names,
1543  long? offset = null,
1544  long? limit = null,
1545  string encoding = null,
1546  IDictionary<string, string> options = null)
1547  {
1548  this.table_name = table_name ?? "";
1549  this.column_names = column_names ?? new List<string>();
1550  this.offset = offset ?? 0;
1551  this.limit = limit ?? -9999;
1552  this.encoding = encoding ?? Encoding.BINARY;
1553  this.options = options ?? new Dictionary<string, string>();
1554  } // end full constructor
1555  } // end class AggregateGroupByRequest
1556 
1560  public class RawAggregateGroupByResponse : KineticaData
1561  {
1565  public struct Info
1566  {
1569  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1570  } // end struct Info
1571 
1574  public string response_schema_str { get; set; }
1575 
1577  public byte[] binary_encoded_response { get; set; }
1578 
1580  public string json_encoded_response { get; set; }
1581 
1586  public long total_number_of_records { get; set; }
1587 
1590  public bool has_more_records { get; set; }
1591 
1604  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1605  } // end class RawAggregateGroupByResponse
1606 
1610  public class AggregateGroupByResponse : KineticaData
1611  {
1615  public struct Info
1616  {
1619  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1620  } // end struct Info
1621 
1623  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1624 
1629  public long total_number_of_records { get; set; }
1630 
1633  public bool has_more_records { get; set; }
1634 
1647  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1648  } // end class AggregateGroupByResponse
1649 } // 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.