Kinetica   C#   API  Version 7.2.3.1
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 {
45  public struct Encoding
46  {
49  public const string BINARY = "binary";
50 
53  public const string JSON = "json";
54  } // end struct Encoding
55 
59  public struct Options
60  {
76  public const string CREATE_TEMP_TABLE = "create_temp_table";
77 
78  public const string TRUE = "true";
79  public const string FALSE = "false";
80 
89  public const string COLLECTION_NAME = "collection_name";
90 
92  public const string EXPRESSION = "expression";
93 
108  public const string SORT_ORDER = "sort_order";
109 
110  public const string ASCENDING = "ascending";
111  public const string DESCENDING = "descending";
112 
117  public const string ORDER_BY = "order_by";
118 
128  public const string RESULT_TABLE = "result_table";
129 
146  public const string RESULT_TABLE_PERSIST = "result_table_persist";
147 
161  public const string RESULT_TABLE_FORCE_REPLICATED = "result_table_force_replicated";
162 
176  public const string RESULT_TABLE_GENERATE_PK = "result_table_generate_pk";
177 
181  public const string TTL = "ttl";
182 
188  public const string CHUNK_SIZE = "chunk_size";
189 
195  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
196 
202  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
203 
208  public const string COMPRESSION_CODEC = "compression_codec";
209 
213  public const string VIEW_ID = "view_id";
214  } // end struct Options
215 
220  public string table_name { get; set; }
221 
224  public string column_name { get; set; }
225 
230  public long offset { get; set; } = 0;
231 
244  public long limit { get; set; } = -9999;
245 
262  public string encoding { get; set; } = Encoding.BINARY;
263 
458  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
459 
463 
684  string column_name,
685  long? offset = null,
686  long? limit = null,
687  IDictionary<string, string> options = null)
688  {
689  this.table_name = table_name ?? "";
690  this.column_name = column_name ?? "";
691  this.offset = offset ?? 0;
692  this.limit = limit ?? -9999;
693  this.encoding = Encoding.BINARY;
694  this.options = options ?? new Dictionary<string, string>();
695  } // end constructor
696 
932  string column_name,
933  long? offset = null,
934  long? limit = null,
935  string encoding = null,
936  IDictionary<string, string> options = null)
937  {
938  this.table_name = table_name ?? "";
939  this.column_name = column_name ?? "";
940  this.offset = offset ?? 0;
941  this.limit = limit ?? -9999;
942  this.encoding = encoding ?? Encoding.BINARY;
943  this.options = options ?? new Dictionary<string, string>();
944  } // end full constructor
945 } // end class AggregateUniqueRequest
946 
951 {
955  public struct Info
956  {
959  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
960  } // end struct Info
961 
964  public string table_name { get; set; }
965 
968  public string response_schema_str { get; set; }
969 
971  public byte[] binary_encoded_response { get; set; }
972 
974  public string json_encoded_response { get; set; }
975 
978  public bool has_more_records { get; set; }
979 
991  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
992 } // end class RawAggregateUniqueResponse
993 
998 {
1002  public struct Info
1003  {
1006  public const string QUALIFIED_RESULT_TABLE_NAME = "qualified_result_table_name";
1007  } // end struct Info
1008 
1011  public string table_name { get; set; }
1012 
1014  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
1015 
1018  public bool has_more_records { get; set; }
1019 
1031  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1032 } // end class AggregateUniqueResponse
A set of string constants for the parameter encoding.
byte [] binary_encoded_response
Avro binary encoded response.
string table_name
Name of an existing table or view on which the operation will be performed, in [schema_name.
string json_encoded_response
Avro JSON encoded response.
const string TTL
Sets the TTL of the table specified in RESULT_TABLE.
IList< KineticaRecord > data
Avro binary encoded response.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > options
Optional parameters.
A set of string constants for the parameter info.
A set of string constants for the parameter options.
const string RESULT_TABLE_PERSIST
If TRUE, then the result table specified in RESULT_TABLE will be persisted and will not expire unless...
const string EXPRESSION
Filter expression to apply to the table.
AggregateUniqueRequest()
Constructs an AggregateUniqueRequest object with default parameters.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
bool has_more_records
Too many records.
const string COMPRESSION_CODEC
The default compression codec for the result table's columns.
const string CHUNK_SIZE
Indicates the number of records per 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.
bool has_more_records
Too many records.
string table_name
The same table name as was passed in the parameter list.
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 ...
string table_name
The same table name as was passed in the parameter list.
const string RESULT_TABLE_FORCE_REPLICATED
Force the result table to be replicated (ignores any sharding).
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
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, string encoding=null, IDictionary< string, string > options=null)
Constructs an AggregateUniqueRequest object with the specified parameters.
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 COLLECTION_NAME
[DEPRECATED–please specify the containing schema as part of RESULT_TABLE and use Kinetica....
IDictionary< string, string > info
Additional information.
const string ORDER_BY
Comma-separated list of the columns to be sorted by as well as the sort direction,...
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.
string response_schema_str
Avro schema of binary_encoded_response or json_encoded_response.
A set of results returned by Kinetica.aggregateUnique.
const string JSON
Indicates that the returned records should be JSON-encoded.
const string QUALIFIED_RESULT_TABLE_NAME
The fully qualified name of the table (i.e.
A set of parameters for Kinetica.aggregateUnique.
const string CHUNK_MAX_MEMORY
Indicates the target maximum data size for all columns in a chunk to be used for the result table.
string encoding
Specifies the encoding for returned records.
const string BINARY
Indicates that the returned records should be binary encoded.
const string SORT_ORDER
String indicating how the returned values should be sorted.
A set of results returned by Kinetica.aggregateUnique.
const string VIEW_ID
ID of view of which the result table will be a member.
A set of string constants for the parameter info.
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
const string RESULT_TABLE
The name of the table used to store the results, in [schema_name.
IDictionary< string, string > info
Additional information.