Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
87  {
88 
109  public struct Encoding
110  {
111 
114  public const string BINARY = "binary";
115 
118  public const string JSON = "json";
119  } // end struct Encoding
120 
121 
358  public struct Options
359  {
360 
365  public const string COLLECTION_NAME = "collection_name";
366 
369  public const string EXPRESSION = "expression";
370 
373  public const string HAVING = "having";
374 
394  public const string SORT_ORDER = "sort_order";
395 
398  public const string ASCENDING = "ascending";
399 
402  public const string DESCENDING = "descending";
403 
428  public const string SORT_BY = "sort_by";
429 
435  public const string KEY = "key";
436 
442  public const string VALUE = "value";
443 
452  public const string RESULT_TABLE = "result_table";
453 
472  public const string RESULT_TABLE_PERSIST = "result_table_persist";
473  public const string TRUE = "true";
474  public const string FALSE = "false";
475 
492  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
493 
510  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
511 
515  public const string TTL = "ttl";
516 
520  public const string CHUNK_SIZE = "chunk_size";
521 
525  public const string CREATE_INDEXES = "create_indexes";
526 
529  public const string VIEW_ID = "view_id";
530 
552  public const string MATERIALIZE_ON_GPU = "materialize_on_gpu";
553 
555  public const string PIVOT = "pivot";
556 
560  public const string PIVOT_VALUES = "pivot_values";
561 
567  public const string GROUPING_SETS = "grouping_sets";
568 
571  public const string ROLLUP = "rollup";
572 
575  public const string CUBE = "cube";
576  } // end struct Options
577 
578 
581  public string table_name { get; set; }
582 
585  public IList<string> column_names { get; set; } = new List<string>();
586 
591  public long offset { get; set; } = 0;
592 
604  public long limit { get; set; } = -9999;
605 
625  public string encoding { get; set; } = Encoding.BINARY;
626 
861  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
862 
863 
867 
1126  IList<string> column_names,
1127  long? offset = null,
1128  long? limit = null,
1129  IDictionary<string, string> options = null)
1130  {
1131  this.table_name = table_name ?? "";
1132  this.column_names = column_names ?? new List<string>();
1133  this.offset = offset ?? 0;
1134  this.limit = limit ?? -9999;
1135  this.encoding = Encoding.BINARY;
1136  this.options = options ?? new Dictionary<string, string>();
1137  } // end constructor
1138 
1139 
1417  IList<string> column_names,
1418  long? offset = null,
1419  long? limit = null,
1420  string encoding = null,
1421  IDictionary<string, string> options = null)
1422  {
1423  this.table_name = table_name ?? "";
1424  this.column_names = column_names ?? new List<string>();
1425  this.offset = offset ?? 0;
1426  this.limit = limit ?? -9999;
1427  this.encoding = encoding ?? Encoding.BINARY;
1428  this.options = options ?? new Dictionary<string, string>();
1429  } // end full constructor
1430 
1431  } // end class AggregateGroupByRequest
1432 
1433 
1434 
1439  {
1440 
1443  public string response_schema_str { get; set; }
1444 
1446  public byte[] binary_encoded_response { get; set; }
1447 
1449  public string json_encoded_response { get; set; }
1450 
1452  public long total_number_of_records { get; set; }
1453 
1455  public bool has_more_records { get; set; }
1456 
1458  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1459 
1460  } // end class RawAggregateGroupByResponse
1461 
1462 
1463 
1468  {
1469 
1471  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1472 
1474  public long total_number_of_records { get; set; }
1475 
1477  public bool has_more_records { get; set; }
1478 
1480  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1481 
1482  } // end class AggregateGroupByResponse
1483 
1484 
1485 
1486 
1487 } // end namespace kinetica
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.
Specifies the encoding for returned records.
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(string,IList{string},long,long,IDictionary{string, string}).
bool has_more_records
Too many records. Returned a partial set.
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()
Constructs an AggregateGroupByRequest object with default parameters.
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.
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...
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
IList< KineticaRecord > data
Avro binary encoded response.
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.
IDictionary< string, string > info
Additional information.
long total_number_of_records
Total/Filtered number of records.
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
bool has_more_records
Too many records. Returned a partial set.
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.
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.
const string MATERIALIZE_ON_GPU
No longer used.
A set of results returned by Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string}).
const string JSON
Indicates that the returned records should be json encoded.
const string HAVING
Filter expression to apply to the aggregated results.
const string SORT_BY
String determining how the results are sorted.
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.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > info
Additional information.
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 the table used to store the results.
const string GROUPING_SETS
Customize the grouping attribute sets to compute the aggregates.
string response_schema_str
Avro schema of &lt;member name=&quot;binary_encoded_response&quot;&gt; or &lt;member name=&quot;json_encoded_response&quot;&gt;.
const string PIVOT_VALUES
The value list provided will become the column headers in the output.
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(string,IList{string},long,long,IDictionary{string, string}).
const string COLLECTION_NAME
Name of a collection which is to contain the table specified in result_table.