Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
GetRecordsByColumn.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 
34  {
35 
41  public struct Encoding
42  {
43  public const string BINARY = "binary";
44  public const string JSON = "json";
45  } // end struct Encoding
46 
47 
81  public struct Options
82  {
83 
86  public const string EXPRESSION = "expression";
87 
90  public const string SORT_BY = "sort_by";
91 
97  public const string SORT_ORDER = "sort_order";
98  public const string ASCENDING = "ascending";
99  public const string DESCENDING = "descending";
100 
106  public const string ORDER_BY = "order_by";
107  } // end struct Options
108 
109 
112  public string table_name { get; set; }
113 
115  public IList<string> column_names { get; set; } = new List<string>();
116 
121  public long offset { get; set; }
122 
127  public long limit { get; set; }
128 
132  public string encoding { get; set; } = Encoding.BINARY;
133 
165  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
166 
167 
171 
220  IList<string> column_names,
221  long offset,
222  long limit,
223  IDictionary<string, string> options = null)
224  {
225  this.table_name = table_name ?? "";
226  this.column_names = column_names ?? new List<string>();
227  this.offset = offset;
228  this.limit = limit;
229  this.encoding = Encoding.BINARY;
230  this.options = options ?? new Dictionary<string, string>();
231  } // end constructor
232 
233 
285  IList<string> column_names,
286  long offset,
287  long limit,
288  string encoding = null,
289  IDictionary<string, string> options = null)
290  {
291  this.table_name = table_name ?? "";
292  this.column_names = column_names ?? new List<string>();
293  this.offset = offset;
294  this.limit = limit;
295  this.encoding = encoding ?? Encoding.BINARY;
296  this.options = options ?? new Dictionary<string, string>();
297  } // end full constructor
298 
299  } // end class GetRecordsByColumnRequest
300 
301 
302 
305  {
306 
309  public string table_name { get; set; }
310 
313  public string response_schema_str { get; set; }
314 
316  public byte[] binary_encoded_response { get; set; }
317 
319  public string json_encoded_response { get; set; }
320 
322  public long total_number_of_records { get; set; }
323 
325  public bool has_more_records { get; set; }
326 
327  } // end class RawGetRecordsByColumnResponse
328 
329 
330 
333  {
334 
337  public string table_name { get; set; }
338 
340  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
341 
343  public long total_number_of_records { get; set; }
344 
346  public bool has_more_records { get; set; }
347 
348  } // end class GetRecordsByColumnResponse
349 
350 
351 
352 
353 } // end namespace kinetica
A set of results returned by /get/records/bycolumn.
expression Optional filter expression to apply to the table.
const string ORDER_BY
Comma-separated list of the columns to be sorted by; e.g.
long total_number_of_records
Total/Filtered number of records.
bool has_more_records
Too many records. Returned a partial set.
IList< KineticaRecord > data
Avro binary encoded response.
GetRecordsByColumnRequest()
Constructs a GetRecordsByColumnRequest object with default parameters.
string table_name
Name of the table on which this operation will be performed.
A set of parameters for /get/records/bycolumn.
byte[] binary_encoded_response
Avro binary encoded response.
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
A set of results returned by /get/records/bycolumn.
long limit
A positive integer indicating the maximum number of results to be returned (if not provided the defau...
bool has_more_records
Too many records. Returned a partial set.
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
long total_number_of_records
Total/Filtered number of records.
GetRecordsByColumnRequest(string table_name, IList< string > column_names, long offset, long limit, IDictionary< string, string > options=null)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
string encoding
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
GetRecordsByColumnRequest(string table_name, IList< string > column_names, long offset, long limit, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
string json_encoded_response
Avro JSON encoded response.
IList< string > column_names
The list of column values to retrieve.
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;.
string table_name
The same table name as was passed in the parameter list.
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
const string EXPRESSION
Optional filter expression to apply to the table.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string table_name
The same table name as was passed in the parameter list.
const string SORT_BY
Optional column that the data should be sorted by.
IDictionary< string, string > options
expression Optional filter expression to apply to the table.