Kinetica C# API  Version 6.2.0.1
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 
357  public struct Options
358  {
359 
366  public const string COLLECTION_NAME = "collection_name";
367 
370  public const string EXPRESSION = "expression";
371 
374  public const string HAVING = "having";
375 
395  public const string SORT_ORDER = "sort_order";
396 
399  public const string ASCENDING = "ascending";
400 
403  public const string DESCENDING = "descending";
404 
429  public const string SORT_BY = "sort_by";
430 
436  public const string KEY = "key";
437 
443  public const string VALUE = "value";
444 
453  public const string RESULT_TABLE = "result_table";
454 
473  public const string RESULT_TABLE_PERSIST = "result_table_persist";
474  public const string TRUE = "true";
475  public const string FALSE = "false";
476 
493  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
494 
511  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
512 
516  public const string TTL = "ttl";
517 
521  public const string CHUNK_SIZE = "chunk_size";
522 
526  public const string CREATE_INDEXES = "create_indexes";
527 
530  public const string VIEW_ID = "view_id";
531 
548  public const string MATERIALIZE_ON_GPU = "materialize_on_gpu";
549 
551  public const string PIVOT = "pivot";
552 
556  public const string PIVOT_VALUES = "pivot_values";
557 
563  public const string GROUPING_SETS = "grouping_sets";
564 
567  public const string ROLLUP = "rollup";
568 
571  public const string CUBE = "cube";
572  } // end struct Options
573 
574 
577  public string table_name { get; set; }
578 
581  public IList<string> column_names { get; set; } = new List<string>();
582 
587  public long offset { get; set; }
588 
593  public long limit { get; set; } = 1000;
594 
614  public string encoding { get; set; } = Encoding.BINARY;
615 
849  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
850 
851 
855 
1107  IList<string> column_names,
1108  long offset,
1109  long? limit = null,
1110  IDictionary<string, string> options = null)
1111  {
1112  this.table_name = table_name ?? "";
1113  this.column_names = column_names ?? new List<string>();
1114  this.offset = offset;
1115  this.limit = limit ?? 1000;
1116  this.encoding = Encoding.BINARY;
1117  this.options = options ?? new Dictionary<string, string>();
1118  } // end constructor
1119 
1120 
1391  IList<string> column_names,
1392  long offset,
1393  long? limit = null,
1394  string encoding = null,
1395  IDictionary<string, string> options = null)
1396  {
1397  this.table_name = table_name ?? "";
1398  this.column_names = column_names ?? new List<string>();
1399  this.offset = offset;
1400  this.limit = limit ?? 1000;
1401  this.encoding = encoding ?? Encoding.BINARY;
1402  this.options = options ?? new Dictionary<string, string>();
1403  } // end full constructor
1404 
1405  } // end class AggregateGroupByRequest
1406 
1407 
1408 
1413  {
1414 
1417  public string response_schema_str { get; set; }
1418 
1420  public byte[] binary_encoded_response { get; set; }
1421 
1423  public string json_encoded_response { get; set; }
1424 
1426  public long total_number_of_records { get; set; }
1427 
1429  public bool has_more_records { get; set; }
1430 
1431  } // end class RawAggregateGroupByResponse
1432 
1433 
1434 
1439  {
1440 
1442  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1443 
1445  public long total_number_of_records { get; set; }
1446 
1448  public bool has_more_records { get; set; }
1449 
1450  } // end class AggregateGroupByResponse
1451 
1452 
1453 
1454 
1455 } // end namespace kinetica
Specifies the encoding for returned records.
A set of results returned by Kinetica.aggregateGroupBy(string,IList<string>,long,long,IDictionary<string, string>).
AggregateGroupByRequest()
Constructs an AggregateGroupByRequest object with default parameters.
const string BINARY
Indicates that the returned records should be binary encoded.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
IDictionary< string, string > options
Optional parameters.
AggregateGroupByRequest(string table_name, IList< string > column_names, long offset, long? limit=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.
AggregateGroupByRequest(string table_name, IList< string > column_names, long offset, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateGroupByRequest object with the specified parameters.
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.
string encoding
Specifies the encoding for returned records.
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...
A set of parameters for Kinetica.aggregateGroupBy(string,IList<string>,long,long,IDictionary<string, string>).