Kinetica C# API  Version 6.1.0.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 
10 
11 namespace kinetica
12 {
13 
69  {
70 
91  public struct Encoding
92  {
93 
96  public const string BINARY = "binary";
97 
100  public const string JSON = "json";
101  } // end struct Encoding
102 
103 
266  public struct Options
267  {
268 
275  public const string COLLECTION_NAME = "collection_name";
276 
279  public const string EXPRESSION = "expression";
280 
283  public const string HAVING = "having";
284 
304  public const string SORT_ORDER = "sort_order";
305 
308  public const string ASCENDING = "ascending";
309 
312  public const string DESCENDING = "descending";
313 
338  public const string SORT_BY = "sort_by";
339 
345  public const string KEY = "key";
346 
352  public const string VALUE = "value";
353 
363  public const string RESULT_TABLE = "result_table";
364 
383  public const string RESULT_TABLE_PERSIST = "result_table_persist";
384  public const string TRUE = "true";
385  public const string FALSE = "false";
386 
390  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
391 
395  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
396 
400  public const string TTL = "ttl";
401 
405  public const string CHUNK_SIZE = "chunk_size";
406 
423  public const string MATERIALIZE_ON_GPU = "materialize_on_gpu";
424  } // end struct Options
425 
426 
429  public string table_name { get; set; }
430 
433  public IList<string> column_names { get; set; } = new List<string>();
434 
439  public long offset { get; set; }
440 
444  public long limit { get; set; } = 1000;
445 
465  public string encoding { get; set; } = Encoding.BINARY;
466 
627  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
628 
629 
633 
811  IList<string> column_names,
812  long offset,
813  long limit = 1000,
814  IDictionary<string, string> options = null)
815  {
816  this.table_name = table_name ?? "";
817  this.column_names = column_names ?? new List<string>();
818  this.offset = offset;
819  this.limit = limit;
820  this.encoding = Encoding.BINARY;
821  this.options = options ?? new Dictionary<string, string>();
822  } // end constructor
823 
824 
1021  IList<string> column_names,
1022  long offset,
1023  long limit = 1000,
1024  string encoding = null,
1025  IDictionary<string, string> options = null)
1026  {
1027  this.table_name = table_name ?? "";
1028  this.column_names = column_names ?? new List<string>();
1029  this.offset = offset;
1030  this.limit = limit;
1031  this.encoding = encoding ?? Encoding.BINARY;
1032  this.options = options ?? new Dictionary<string, string>();
1033  } // end full constructor
1034 
1035  } // end class AggregateGroupByRequest
1036 
1037 
1038 
1043  {
1044 
1047  public string response_schema_str { get; set; }
1048 
1050  public byte[] binary_encoded_response { get; set; }
1051 
1053  public string json_encoded_response { get; set; }
1054 
1056  public long total_number_of_records { get; set; }
1057 
1059  public bool has_more_records { get; set; }
1060 
1061  } // end class RawAggregateGroupByResponse
1062 
1063 
1064 
1069  {
1070 
1072  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1073 
1075  public long total_number_of_records { get; set; }
1076 
1078  public bool has_more_records { get; set; }
1079 
1080  } // end class AggregateGroupByResponse
1081 
1082 
1083 
1084 
1085 } // 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...
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.
IDictionary< string, string > options
Optional parameters.
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.
IList< string > column_names
List of one or more column names, expressions, and aggregate expressions.
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>).