Kinetica C# API  Version 6.0.1.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 
67  {
68 
74  public struct Encoding
75  {
76 
79  public const string BINARY = "binary";
80 
83  public const string JSON = "json";
84  } // end struct Encoding
85 
86 
153  public struct Options
154  {
155 
163  public const string COLLECTION_NAME = "collection_name";
164 
167  public const string EXPRESSION = "expression";
168 
171  public const string HAVING = "having";
172 
177  public const string SORT_ORDER = "sort_order";
178 
181  public const string ASCENDING = "ascending";
182 
185  public const string DESCENDING = "descending";
186 
190  public const string SORT_BY = "sort_by";
191 
197  public const string KEY = "key";
198 
204  public const string VALUE = "value";
205 
215  public const string RESULT_TABLE = "result_table";
216 
224  public const string RESULT_TABLE_PERSIST = "result_table_persist";
225  public const string TRUE = "true";
226  public const string FALSE = "false";
227 
231  public const string TTL = "ttl";
232  } // end struct Options
233 
234 
237  public string table_name { get; set; }
238 
243  public IList<string> column_names { get; set; } = new List<string>();
244 
249  public long offset { get; set; }
250 
254  public long limit { get; set; } = 1000;
255 
259  public string encoding { get; set; } = Encoding.BINARY;
260 
325  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
326 
327 
331 
415  IList<string> column_names,
416  long offset,
417  long limit = 1000,
418  IDictionary<string, string> options = null)
419  {
420  this.table_name = table_name ?? "";
421  this.column_names = column_names ?? new List<string>();
422  this.offset = offset;
423  this.limit = limit;
424  this.encoding = Encoding.BINARY;
425  this.options = options ?? new Dictionary<string, string>();
426  } // end constructor
427 
428 
515  IList<string> column_names,
516  long offset,
517  long limit = 1000,
518  string encoding = null,
519  IDictionary<string, string> options = null)
520  {
521  this.table_name = table_name ?? "";
522  this.column_names = column_names ?? new List<string>();
523  this.offset = offset;
524  this.limit = limit;
525  this.encoding = encoding ?? Encoding.BINARY;
526  this.options = options ?? new Dictionary<string, string>();
527  } // end full constructor
528 
529  } // end class AggregateGroupByRequest
530 
531 
532 
535  {
536 
539  public string response_schema_str { get; set; }
540 
542  public byte[] binary_encoded_response { get; set; }
543 
545  public string json_encoded_response { get; set; }
546 
548  public long total_number_of_records { get; set; }
549 
551  public bool has_more_records { get; set; }
552 
553  } // end class RawAggregateGroupByResponse
554 
555 
556 
559  {
560 
562  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
563 
565  public long total_number_of_records { get; set; }
566 
568  public bool has_more_records { get; set; }
569 
570  } // end class AggregateGroupByResponse
571 
572 
573 
574 
575 } // end namespace kinetica
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 /aggregate/groupby.
bool has_more_records
Too many records. Returned a partial set.
AggregateGroupByRequest()
Constructs an AggregateGroupByRequest object with default 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.
AggregateGroupByRequest(string table_name, IList< string > column_names, long offset, long limit=1000, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
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.
long total_number_of_records
Total/Filtered number of records.
AggregateGroupByRequest(string table_name, IList< string > column_names, long offset, long limit=1000, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
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.
A set of results returned by /aggregate/groupby.
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.
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 as a regular table (it will...
string table_name
Name of the table on which the operation will be performed.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
long limit
A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to i...
const string RESULT_TABLE
The name of the table used to store the results.
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;.
A set of parameters for /aggregate/groupby.
const string COLLECTION_NAME
Name of a collection which is to contain the table specified in result_table, otherwise the table wil...