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 {
48  public class AggregateUniqueRequest : KineticaData
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 
220  public const string COMPRESSION_CODEC = "compression_codec";
221 
225  public const string VIEW_ID = "view_id";
226  } // end struct Options
227 
232  public string table_name { get; set; }
233 
237  public string column_name { get; set; }
238 
244  public long offset { get; set; } = 0;
245 
259  public long limit { get; set; } = -9999;
260 
277  public string encoding { get; set; } = Encoding.BINARY;
278 
481  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
482 
486 
717  string column_name,
718  long? offset = null,
719  long? limit = null,
720  IDictionary<string, string> options = null)
721  {
722  this.table_name = table_name ?? "";
723  this.column_name = column_name ?? "";
724  this.offset = offset ?? 0;
725  this.limit = limit ?? -9999;
726  this.encoding = Encoding.BINARY;
727  this.options = options ?? new Dictionary<string, string>();
728  } // end constructor
729 
976  string column_name,
977  long? offset = null,
978  long? limit = null,
979  string encoding = null,
980  IDictionary<string, string> options = null)
981  {
982  this.table_name = table_name ?? "";
983  this.column_name = column_name ?? "";
984  this.offset = offset ?? 0;
985  this.limit = limit ?? -9999;
986  this.encoding = encoding ?? Encoding.BINARY;
987  this.options = options ?? new Dictionary<string, string>();
988  } // end full constructor
989  } // end class AggregateUniqueRequest
990 
994  public class RawAggregateUniqueResponse : KineticaData
995  {
999  public struct Info
1000  {
1003  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1004  } // end struct Info
1005 
1008  public string table_name { get; set; }
1009 
1012  public string response_schema_str { get; set; }
1013 
1015  public byte[] binary_encoded_response { get; set; }
1016 
1018  public string json_encoded_response { get; set; }
1019 
1022  public bool has_more_records { get; set; }
1023 
1036  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1037  } // end class RawAggregateUniqueResponse
1038 
1042  public class AggregateUniqueResponse : KineticaData
1043  {
1047  public struct Info
1048  {
1051  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1052  } // end struct Info
1053 
1056  public string table_name { get; set; }
1057 
1059  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1060 
1063  public bool has_more_records { get; set; }
1064 
1077  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1078  } // end class AggregateUniqueResponse
1079 } // end namespace kinetica
bool has_more_records
Too many records.
const string VIEW_ID
ID of view of which the result table will be a member.
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 JSON
Indicates that the returned records should be json encoded.
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
bool has_more_records
Too many records.
string table_name
The same table name as was passed in the parameter list.
string table_name
Name of an existing table or view on which the operation will be performed, in [schema_name.
const string SORT_ORDER
String indicating how the returned values should be sorted.
const string CHUNK_SIZE
Indicates the number of records per chunk to be used for the result table.
A set of string constants for the parameter encoding.
string encoding
Specifies the encoding for returned records.
string table_name
The same table name as was passed in the parameter list.
const string EXPRESSION
Optional filter expression to apply to the table.
const string RESULT_TABLE_GENERATE_PK
If TRUE then set a primary key for the result table.
byte [] binary_encoded_response
Avro binary encoded response.
AggregateUniqueRequest()
Constructs an AggregateUniqueRequest object with default parameters.
const string COMPRESSION_CODEC
The default compression codec for the result table's columns.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
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...
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
IDictionary< string, string > info
Additional information.
IList< KineticaRecord > data
Avro binary encoded response.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
const string COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....
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.
IDictionary< string, string > options
Optional parameters.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
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 BINARY
Indicates that the returned records should be binary encoded.
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 RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
IDictionary< string, string > info
Additional information.
string json_encoded_response
Avro JSON encoded response.