Kinetica C# API  Version 7.1.10.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 
64  {
65 
86  public struct Encoding
87  {
88 
91  public const string BINARY = "binary";
92 
95  public const string JSON = "json";
96  } // end struct Encoding
97 
98 
258  public struct Options
259  {
260 
281  public const string CREATE_TEMP_TABLE = "create_temp_table";
282  public const string TRUE = "true";
283  public const string FALSE = "false";
284 
292  public const string COLLECTION_NAME = "collection_name";
293 
296  public const string EXPRESSION = "expression";
297 
313  public const string SORT_ORDER = "sort_order";
314  public const string ASCENDING = "ascending";
315  public const string DESCENDING = "descending";
316 
326  public const string RESULT_TABLE = "result_table";
327 
346  public const string RESULT_TABLE_PERSIST = "result_table_persist";
347 
364  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
365 
382  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
383 
387  public const string TTL = "ttl";
388 
392  public const string CHUNK_SIZE = "chunk_size";
393 
396  public const string VIEW_ID = "view_id";
397  } // end struct Options
398 
399 
404  public string table_name { get; set; }
405 
409  public string column_name { get; set; }
410 
415  public long offset { get; set; } = 0;
416 
431  public long limit { get; set; } = -9999;
432 
452  public string encoding { get; set; } = Encoding.BINARY;
453 
611  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
612 
613 
617 
806  string column_name,
807  long? offset = null,
808  long? limit = null,
809  IDictionary<string, string> options = null)
810  {
811  this.table_name = table_name ?? "";
812  this.column_name = column_name ?? "";
813  this.offset = offset ?? 0;
814  this.limit = limit ?? -9999;
815  this.encoding = Encoding.BINARY;
816  this.options = options ?? new Dictionary<string, string>();
817  } // end constructor
818 
819 
1027  string column_name,
1028  long? offset = null,
1029  long? limit = null,
1030  string encoding = null,
1031  IDictionary<string, string> options = null)
1032  {
1033  this.table_name = table_name ?? "";
1034  this.column_name = column_name ?? "";
1035  this.offset = offset ?? 0;
1036  this.limit = limit ?? -9999;
1037  this.encoding = encoding ?? Encoding.BINARY;
1038  this.options = options ?? new Dictionary<string, string>();
1039  } // end full constructor
1040 
1041  } // end class AggregateUniqueRequest
1042 
1043 
1044 
1049  {
1050 
1063  public struct Info
1064  {
1065 
1068  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1069  } // end struct Info
1070 
1071 
1074  public string table_name { get; set; }
1075 
1078  public string response_schema_str { get; set; }
1079 
1081  public byte[] binary_encoded_response { get; set; }
1082 
1084  public string json_encoded_response { get; set; }
1085 
1087  public bool has_more_records { get; set; }
1088 
1099  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1100 
1101  } // end class RawAggregateUniqueResponse
1102 
1103 
1104 
1109  {
1110 
1123  public struct Info
1124  {
1125 
1128  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1129  } // end struct Info
1130 
1131 
1134  public string table_name { get; set; }
1135 
1137  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1138 
1140  public bool has_more_records { get; set; }
1141 
1152  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1153 
1154  } // end class AggregateUniqueResponse
1155 
1156 
1157 
1158 
1159 } // 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
[DEPRECATED–please specify the containing schema as part of result_table and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema 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, or END_OF_SET (-9999) to ...
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
bool has_more_records
Too many records. Returned a partial set.
const string CREATE_TEMP_TABLE
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of ...
const string RESULT_TABLE
The name of the table used to store the results, in [schema_name.
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.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
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, in [schema_name.
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.