Kinetica C# API  Version 7.0.19.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 
75  public struct Encoding
76  {
77 
80  public const string BINARY = "binary";
81 
84  public const string JSON = "json";
85  } // end struct Encoding
86 
87 
219  public struct Options
220  {
221 
226  public const string COLLECTION_NAME = "collection_name";
227 
230  public const string EXPRESSION = "expression";
231 
247  public const string SORT_ORDER = "sort_order";
248  public const string ASCENDING = "ascending";
249  public const string DESCENDING = "descending";
250 
257  public const string RESULT_TABLE = "result_table";
258 
277  public const string RESULT_TABLE_PERSIST = "result_table_persist";
278  public const string TRUE = "true";
279  public const string FALSE = "false";
280 
297  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
298 
315  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
316 
320  public const string TTL = "ttl";
321 
325  public const string CHUNK_SIZE = "chunk_size";
326 
329  public const string VIEW_ID = "view_id";
330  } // end struct Options
331 
332 
335  public string table_name { get; set; }
336 
340  public string column_name { get; set; }
341 
346  public long offset { get; set; } = 0;
347 
359  public long limit { get; set; } = -9999;
360 
380  public string encoding { get; set; } = Encoding.BINARY;
381 
511  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
512 
513 
517 
672  string column_name,
673  long? offset = null,
674  long? limit = null,
675  IDictionary<string, string> options = null)
676  {
677  this.table_name = table_name ?? "";
678  this.column_name = column_name ?? "";
679  this.offset = offset ?? 0;
680  this.limit = limit ?? -9999;
681  this.encoding = Encoding.BINARY;
682  this.options = options ?? new Dictionary<string, string>();
683  } // end constructor
684 
685 
859  string column_name,
860  long? offset = null,
861  long? limit = null,
862  string encoding = null,
863  IDictionary<string, string> options = null)
864  {
865  this.table_name = table_name ?? "";
866  this.column_name = column_name ?? "";
867  this.offset = offset ?? 0;
868  this.limit = limit ?? -9999;
869  this.encoding = encoding ?? Encoding.BINARY;
870  this.options = options ?? new Dictionary<string, string>();
871  } // end full constructor
872 
873  } // end class AggregateUniqueRequest
874 
875 
876 
881  {
882 
885  public string table_name { get; set; }
886 
889  public string response_schema_str { get; set; }
890 
892  public byte[] binary_encoded_response { get; set; }
893 
895  public string json_encoded_response { get; set; }
896 
898  public bool has_more_records { get; set; }
899 
901  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
902 
903  } // end class RawAggregateUniqueResponse
904 
905 
906 
911  {
912 
915  public string table_name { get; set; }
916 
918  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
919 
921  public bool has_more_records { get; set; }
922 
924  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
925 
926  } // end class AggregateUniqueResponse
927 
928 
929 
930 
931 } // end namespace kinetica
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
string encoding
Specifies the encoding for returned records.
const string TTL
Sets the TTL of the table specified in result_table.
const string COLLECTION_NAME
Name of a collection which is to contain the table specified in result_table.
AggregateUniqueRequest(string table_name, string column_name, long?offset=null, long?limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateUniqueRequest object with the specified parameters.
string table_name
The same table name as was passed in the parameter list.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
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 and will not expire unless...
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.
IDictionary< string, string > info
Additional information.
byte[] binary_encoded_response
Avro binary encoded response.
A set of results returned by Kinetica.aggregateUnique(string,string,long,long,IDictionary{string, string}).
AggregateUniqueRequest()
Constructs an AggregateUniqueRequest object with default parameters.
const string RESULT_TABLE_GENERATE_PK
If true then set a primary key for the result table.
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 or view 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}).
const string EXPRESSION
Optional filter expression to apply to the table.
const string VIEW_ID
ID of view of which the result table will be a member.
string table_name
The same table name as was passed in the parameter list.
IDictionary< string, string > info
Additional information.
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 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=null, long?limit=null, IDictionary< string, string > options=null)
Constructs an AggregateUniqueRequest object with the specified parameters.