Kinetica C# API  Version 7.0.19.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 
48  {
49 
67  public struct Encoding
68  {
69  public const string BINARY = "binary";
70  public const string JSON = "json";
71  } // end struct Encoding
72 
73 
140  public struct Options
141  {
142 
145  public const string EXPRESSION = "expression";
146 
151  public const string SORT_BY = "sort_by";
152 
170  public const string SORT_ORDER = "sort_order";
171  public const string ASCENDING = "ascending";
172  public const string DESCENDING = "descending";
173 
177  public const string ORDER_BY = "order_by";
178 
194  public const string CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs";
195  public const string TRUE = "true";
196  public const string FALSE = "false";
197  } // end struct Options
198 
199 
205  public string table_name { get; set; }
206 
208  public IList<string> column_names { get; set; } = new List<string>();
209 
214  public long offset { get; set; } = 0;
215 
227  public long limit { get; set; } = -9999;
228 
245  public string encoding { get; set; } = Encoding.BINARY;
246 
311  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
312 
313 
317 
410  IList<string> column_names,
411  long? offset = null,
412  long? limit = null,
413  IDictionary<string, string> options = null)
414  {
415  this.table_name = table_name ?? "";
416  this.column_names = column_names ?? new List<string>();
417  this.offset = offset ?? 0;
418  this.limit = limit ?? -9999;
419  this.encoding = Encoding.BINARY;
420  this.options = options ?? new Dictionary<string, string>();
421  } // end constructor
422 
423 
532  IList<string> column_names,
533  long? offset = null,
534  long? limit = null,
535  string encoding = null,
536  IDictionary<string, string> options = null)
537  {
538  this.table_name = table_name ?? "";
539  this.column_names = column_names ?? new List<string>();
540  this.offset = offset ?? 0;
541  this.limit = limit ?? -9999;
542  this.encoding = encoding ?? Encoding.BINARY;
543  this.options = options ?? new Dictionary<string, string>();
544  } // end full constructor
545 
546  } // end class GetRecordsByColumnRequest
547 
548 
549 
554  {
555 
558  public string table_name { get; set; }
559 
562  public string response_schema_str { get; set; }
563 
565  public byte[] binary_encoded_response { get; set; }
566 
568  public string json_encoded_response { get; set; }
569 
571  public long total_number_of_records { get; set; }
572 
574  public bool has_more_records { get; set; }
575 
577  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
578 
579  } // end class RawGetRecordsByColumnResponse
580 
581 
582 
587  {
588 
591  public string table_name { get; set; }
592 
594  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
595 
597  public long total_number_of_records { get; set; }
598 
600  public bool has_more_records { get; set; }
601 
603  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
604 
605  } // end class GetRecordsByColumnResponse
606 
607 
608 
609 
610 } // end namespace kinetica
A set of results returned by Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
EXPRESSION: Optional filter expression to apply to the table.
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, e.g., &#39;timestamp asc, x desc&#39;.
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 Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
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 Kinetica.getRecordsByColumn(string,IList{string},long,long,IDictionary{string, string}).
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
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.
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=null, long?limit=null, 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;.
GetRecordsByColumnRequest(string table_name, IList< string > column_names, long?offset=null, long?limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsByColumnRequest object with the specified parameters.
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 CONVERT_WKTS_TO_WKBS
If true, then WKT string columns will be returned as WKB bytes.
const string EXPRESSION
Optional filter expression to apply to the table.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > info
Additional information.
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.