Kinetica C# API  Version 6.1.0.0
AggregateUnique.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 
55  {
56 
77  public struct Encoding
78  {
79 
82  public const string BINARY = "binary";
83 
86  public const string JSON = "json";
87  } // end struct Encoding
88 
89 
194  public struct Options
195  {
196 
203  public const string COLLECTION_NAME = "collection_name";
204 
207  public const string EXPRESSION = "expression";
208 
224  public const string SORT_ORDER = "sort_order";
225  public const string ASCENDING = "ascending";
226  public const string DESCENDING = "descending";
227 
236  public const string RESULT_TABLE = "result_table";
237 
256  public const string RESULT_TABLE_PERSIST = "result_table_persist";
257  public const string TRUE = "true";
258  public const string FALSE = "false";
259 
263  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
264 
268  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
269 
273  public const string TTL = "ttl";
274 
278  public const string CHUNK_SIZE = "chunk_size";
279  } // end struct Options
280 
281 
284  public string table_name { get; set; }
285 
289  public string column_name { get; set; }
290 
295  public long offset { get; set; }
296 
300  public long limit { get; set; } = 10000;
301 
321  public string encoding { get; set; } = Encoding.BINARY;
322 
425  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
426 
427 
431 
551  string column_name,
552  long offset,
553  long limit = 10000,
554  IDictionary<string, string> options = null)
555  {
556  this.table_name = table_name ?? "";
557  this.column_name = column_name ?? "";
558  this.offset = offset;
559  this.limit = limit;
560  this.encoding = Encoding.BINARY;
561  this.options = options ?? new Dictionary<string, string>();
562  } // end constructor
563 
564 
703  string column_name,
704  long offset,
705  long limit = 10000,
706  string encoding = null,
707  IDictionary<string, string> options = null)
708  {
709  this.table_name = table_name ?? "";
710  this.column_name = column_name ?? "";
711  this.offset = offset;
712  this.limit = limit;
713  this.encoding = encoding ?? Encoding.BINARY;
714  this.options = options ?? new Dictionary<string, string>();
715  } // end full constructor
716 
717  } // end class AggregateUniqueRequest
718 
719 
720 
725  {
726 
729  public string table_name { get; set; }
730 
733  public string response_schema_str { get; set; }
734 
736  public byte[] binary_encoded_response { get; set; }
737 
739  public string json_encoded_response { get; set; }
740 
742  public bool has_more_records { get; set; }
743 
744  } // end class RawAggregateUniqueResponse
745 
746 
747 
752  {
753 
756  public string table_name { get; set; }
757 
759  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
760 
762  public bool has_more_records { get; set; }
763 
764  } // end class AggregateUniqueResponse
765 
766 
767 
768 
769 } // end namespace kinetica
string encoding
Specifies the encoding for returned records.
AggregateUniqueRequest(string table_name, string column_name, long offset, long limit=10000, IDictionary< string, string > options=null)
Constructs an AggregateUniqueRequest object with the specified parameters.
long limit
A positive integer indicating the maximum number of results to be returned.
IDictionary< string, string > options
Optional parameters.
Specifies the encoding for returned records.
A set of results returned by Kinetica.aggregateUnique(string,string,long,long,IDictionary<string, string>).
AggregateUniqueRequest()
Constructs an AggregateUniqueRequest object with default parameters.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
string table_name
Name of an existing table/collection on which the operation will be performed.
const string BINARY
Indicates that the returned records should be binary encoded.
const string JSON
Indicates that the returned records should be json encoded.
A set of results returned by Kinetica.aggregateUnique(string,string,long,long,IDictionary<string, string>).
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.aggregateUnique(string,string,long,long,IDictionary<string, string>).
string column_name
Name of the column or an expression containing one or more column names on which the unique function ...
AggregateUniqueRequest(string table_name, string column_name, long offset, long limit=10000, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateUniqueRequest object with the specified parameters.