Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
53  {
54 
60  public struct Encoding
61  {
62 
65  public const string BINARY = "binary";
66 
69  public const string JSON = "json";
70  } // end struct Encoding
71 
72 
122  public struct Options
123  {
124 
130  public const string COLLECTION_NAME = "collection_name";
131 
134  public const string EXPRESSION = "expression";
135 
139  public const string SORT_ORDER = "sort_order";
140  public const string ASCENDING = "ascending";
141  public const string DESCENDING = "descending";
142 
148  public const string RESULT_TABLE = "result_table";
149 
158  public const string RESULT_TABLE_PERSIST = "result_table_persist";
159  public const string TRUE = "true";
160  public const string FALSE = "false";
161 
164  public const string TTL = "ttl";
165  } // end struct Options
166 
167 
170  public string table_name { get; set; }
171 
175  public string column_name { get; set; }
176 
181  public long offset { get; set; }
182 
186  public long limit { get; set; } = 10000;
187 
191  public string encoding { get; set; } = Encoding.BINARY;
192 
240  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
241 
242 
246 
311  string column_name,
312  long offset,
313  long limit = 10000,
314  IDictionary<string, string> options = null)
315  {
316  this.table_name = table_name ?? "";
317  this.column_name = column_name ?? "";
318  this.offset = offset;
319  this.limit = limit;
320  this.encoding = Encoding.BINARY;
321  this.options = options ?? new Dictionary<string, string>();
322  } // end constructor
323 
324 
392  string column_name,
393  long offset,
394  long limit = 10000,
395  string encoding = null,
396  IDictionary<string, string> options = null)
397  {
398  this.table_name = table_name ?? "";
399  this.column_name = column_name ?? "";
400  this.offset = offset;
401  this.limit = limit;
402  this.encoding = encoding ?? Encoding.BINARY;
403  this.options = options ?? new Dictionary<string, string>();
404  } // end full constructor
405 
406  } // end class AggregateUniqueRequest
407 
408 
409 
412  {
413 
416  public string table_name { get; set; }
417 
420  public string response_schema_str { get; set; }
421 
423  public byte[] binary_encoded_response { get; set; }
424 
426  public string json_encoded_response { get; set; }
427 
429  public bool has_more_records { get; set; }
430 
431  } // end class RawAggregateUniqueResponse
432 
433 
434 
437  {
438 
441  public string table_name { get; set; }
442 
444  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
445 
447  public bool has_more_records { get; set; }
448 
449  } // end class AggregateUniqueResponse
450 
451 
452 
453 
454 } // end namespace kinetica
string encoding
Specifies the encoding for returned records.
const string TTL
Sets the TTL of the table specified in &#39;result_table&#39;.
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.
const string COLLECTION_NAME
Name of a collection which is to contain the table specified in &#39;result_table&#39;, otherwise the table w...
string table_name
The same table name as was passed in the parameter list.
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;.
long limit
A positive integer indicating the maximum number of results to be returned.
bool has_more_records
Too many records. Returned a partial set.
const string RESULT_TABLE
The name of the table used to store the results.
const string RESULT_TABLE_PERSIST
If true then the result table specified in result_table will be persisted as a regular table (it will...
IDictionary< string, string > options
Optional parameters.
IList< KineticaRecord > data
Avro binary encoded response.
Specifies the encoding for returned records.
string json_encoded_response
Avro JSON encoded response.
byte[] binary_encoded_response
Avro binary encoded response.
A set of results returned by /aggregate/unique.
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 the table 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 /aggregate/unique.
const string EXPRESSION
Optional filter expression to apply to the table.
string table_name
The same table name as was passed in the parameter list.
const string SORT_ORDER
String indicating how the returned values should be sorted.
bool has_more_records
Too many records. Returned a partial set.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for /aggregate/unique.
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.