Kinetica   C#   API  Version 7.2.3.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 namespace kinetica
10 {
49  {
54  public struct Encoding
55  {
58  public const string BINARY = "binary";
59 
62  public const string JSON = "json";
63  } // end struct Encoding
64 
68  public struct Options
69  {
85  public const string CREATE_TEMP_TABLE = "create_temp_table";
86 
87  public const string TRUE = "true";
88  public const string FALSE = "false";
89 
99  public const string COLLECTION_NAME = "collection_name";
100 
103  public const string EXPRESSION = "expression";
104 
120  public const string SORT_ORDER = "sort_order";
121 
122  public const string ASCENDING = "ascending";
123  public const string DESCENDING = "descending";
124 
129  public const string ORDER_BY = "order_by";
130 
140  public const string RESULT_TABLE = "result_table";
141 
158  public const string RESULT_TABLE_PERSIST = "result_table_persist";
159 
173  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
174 
188  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
189 
193  public const string TTL = "ttl";
194 
200  public const string CHUNK_SIZE = "chunk_size";
201 
207  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
208 
214  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
215 
219  public const string VIEW_ID = "view_id";
220  } // end struct Options
221 
226  public string table_name { get; set; }
227 
231  public string column_name { get; set; }
232 
238  public long offset { get; set; } = 0;
239 
253  public long limit { get; set; } = -9999;
254 
271  public string encoding { get; set; } = Encoding.BINARY;
272 
466  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
467 
471 
693  string column_name,
694  long? offset = null,
695  long? limit = null,
696  IDictionary<string, string> options = null)
697  {
698  this.table_name = table_name ?? "";
699  this.column_name = column_name ?? "";
700  this.offset = offset ?? 0;
701  this.limit = limit ?? -9999;
702  this.encoding = Encoding.BINARY;
703  this.options = options ?? new Dictionary<string, string>();
704  } // end constructor
705 
943  string column_name,
944  long? offset = null,
945  long? limit = null,
946  string encoding = null,
947  IDictionary<string, string> options = null)
948  {
949  this.table_name = table_name ?? "";
950  this.column_name = column_name ?? "";
951  this.offset = offset ?? 0;
952  this.limit = limit ?? -9999;
953  this.encoding = encoding ?? Encoding.BINARY;
954  this.options = options ?? new Dictionary<string, string>();
955  } // end full constructor
956  } // end class AggregateUniqueRequest
957 
962  {
966  public struct Info
967  {
970  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
971  } // end struct Info
972 
975  public string table_name { get; set; }
976 
979  public string response_schema_str { get; set; }
980 
982  public byte[] binary_encoded_response { get; set; }
983 
985  public string json_encoded_response { get; set; }
986 
989  public bool has_more_records { get; set; }
990 
1003  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1004  } // end class RawAggregateUniqueResponse
1005 
1010  {
1014  public struct Info
1015  {
1018  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1019  } // end struct Info
1020 
1023  public string table_name { get; set; }
1024 
1026  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1027 
1030  public bool has_more_records { get; set; }
1031 
1044  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1045  } // end class AggregateUniqueResponse
1046 } // 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....
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 binary_encoded_response or json_encoded_response.
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.
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 CHUNK_COLUMN_MAX_MEMORY
Indicates the target maximum data size for each column in a chunk to be used for the result table.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
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.
A set of string constants for the parameter encoding.
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.
AggregateUniqueRequest()
Constructs an AggregateUniqueRequest object with default parameters.
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for the result table.
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.
const string EXPRESSION
Optional filter expression to apply to the table.
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.
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.
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.
const string SORT_ORDER
String indicating how the returned values should be sorted.
bool has_more_records
Too many records.
A set of string constants for the parameter info.
A set of string constants for the parameter info.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of parameters for Kinetica.aggregateUnique.
string column_name
Name of the column or an expression containing one or more column names on which the unique function ...
A set of string constants for the parameter options.