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 {
40  public class AggregateUniqueRequest : KineticaData
41  {
46  public struct Encoding
47  {
50  public const string BINARY = "binary";
51 
54  public const string JSON = "json";
55  } // end struct Encoding
56 
60  public struct Options
61  {
77  public const string CREATE_TEMP_TABLE = "create_temp_table";
78 
79  public const string TRUE = "true";
80  public const string FALSE = "false";
81 
91  public const string COLLECTION_NAME = "collection_name";
92 
95  public const string EXPRESSION = "expression";
96 
112  public const string SORT_ORDER = "sort_order";
113 
114  public const string ASCENDING = "ascending";
115  public const string DESCENDING = "descending";
116 
121  public const string ORDER_BY = "order_by";
122 
132  public const string RESULT_TABLE = "result_table";
133 
150  public const string RESULT_TABLE_PERSIST = "result_table_persist";
151 
165  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
166 
180  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
181 
185  public const string TTL = "ttl";
186 
192  public const string CHUNK_SIZE = "chunk_size";
193 
199  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
200 
206  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
207 
212  public const string COMPRESSION_CODEC = "compression_codec";
213 
217  public const string VIEW_ID = "view_id";
218  } // end struct Options
219 
224  public string table_name { get; set; }
225 
229  public string column_name { get; set; }
230 
236  public long offset { get; set; } = 0;
237 
251  public long limit { get; set; } = -9999;
252 
269  public string encoding { get; set; } = Encoding.BINARY;
270 
473  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
474 
478 
709  string column_name,
710  long? offset = null,
711  long? limit = null,
712  IDictionary<string, string> options = null)
713  {
714  this.table_name = table_name ?? "";
715  this.column_name = column_name ?? "";
716  this.offset = offset ?? 0;
717  this.limit = limit ?? -9999;
718  this.encoding = Encoding.BINARY;
719  this.options = options ?? new Dictionary<string, string>();
720  } // end constructor
721 
968  string column_name,
969  long? offset = null,
970  long? limit = null,
971  string encoding = null,
972  IDictionary<string, string> options = null)
973  {
974  this.table_name = table_name ?? "";
975  this.column_name = column_name ?? "";
976  this.offset = offset ?? 0;
977  this.limit = limit ?? -9999;
978  this.encoding = encoding ?? Encoding.BINARY;
979  this.options = options ?? new Dictionary<string, string>();
980  } // end full constructor
981  } // end class AggregateUniqueRequest
982 
986  public class RawAggregateUniqueResponse : KineticaData
987  {
991  public struct Info
992  {
995  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
996  } // end struct Info
997 
1000  public string table_name { get; set; }
1001 
1004  public string response_schema_str { get; set; }
1005 
1007  public byte[] binary_encoded_response { get; set; }
1008 
1010  public string json_encoded_response { get; set; }
1011 
1014  public bool has_more_records { get; set; }
1015 
1028  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1029  } // end class RawAggregateUniqueResponse
1030 
1034  public class AggregateUniqueResponse : KineticaData
1035  {
1039  public struct Info
1040  {
1043  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1044  } // end struct Info
1045 
1048  public string table_name { get; set; }
1049 
1051  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1052 
1055  public bool has_more_records { get; set; }
1056 
1069  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1070  } // end class AggregateUniqueResponse
1071 } // 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.