Kinetica C# API  Version 6.2.0.1
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 
39  {
40 
58  public struct Encoding
59  {
60  public const string BINARY = "binary";
61  public const string JSON = "json";
62  } // end struct Encoding
63 
64 
130  public struct Options
131  {
132 
135  public const string EXPRESSION = "expression";
136 
139  public const string SORT_BY = "sort_by";
140 
157  public const string SORT_ORDER = "sort_order";
158  public const string ASCENDING = "ascending";
159  public const string DESCENDING = "descending";
160 
164  public const string ORDER_BY = "order_by";
165 
181  public const string CONVERT_WKTS_TO_WKBS = "convert_wkts_to_wkbs";
182  public const string TRUE = "true";
183  public const string FALSE = "false";
184  } // end struct Options
185 
186 
189  public string table_name { get; set; }
190 
192  public IList<string> column_names { get; set; } = new List<string>();
193 
198  public long offset { get; set; }
199 
204  public long limit { get; set; }
205 
222  public string encoding { get; set; } = Encoding.BINARY;
223 
287  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
288 
289 
293 
374  IList<string> column_names,
375  long offset,
376  long limit,
377  IDictionary<string, string> options = null)
378  {
379  this.table_name = table_name ?? "";
380  this.column_names = column_names ?? new List<string>();
381  this.offset = offset;
382  this.limit = limit;
383  this.encoding = Encoding.BINARY;
384  this.options = options ?? new Dictionary<string, string>();
385  } // end constructor
386 
387 
484  IList<string> column_names,
485  long offset,
486  long limit,
487  string encoding = null,
488  IDictionary<string, string> options = null)
489  {
490  this.table_name = table_name ?? "";
491  this.column_names = column_names ?? new List<string>();
492  this.offset = offset;
493  this.limit = limit;
494  this.encoding = encoding ?? Encoding.BINARY;
495  this.options = options ?? new Dictionary<string, string>();
496  } // end full constructor
497 
498  } // end class GetRecordsByColumnRequest
499 
500 
501 
506  {
507 
510  public string table_name { get; set; }
511 
514  public string response_schema_str { get; set; }
515 
517  public byte[] binary_encoded_response { get; set; }
518 
520  public string json_encoded_response { get; set; }
521 
523  public long total_number_of_records { get; set; }
524 
526  public bool has_more_records { get; set; }
527 
528  } // end class RawGetRecordsByColumnResponse
529 
530 
531 
536  {
537 
540  public string table_name { get; set; }
541 
543  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
544 
546  public long total_number_of_records { get; set; }
547 
549  public bool has_more_records { get; set; }
550 
551  } // end class GetRecordsByColumnResponse
552 
553 
554 
555 
556 } // 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.
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>).
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 (if not provided the defau...
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
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.
IList< string > column_names
The list of column values to retrieve.
Specifies the encoding for returned records; either &#39;binary&#39; or &#39;json&#39;.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
IDictionary< string, string > options
EXPRESSION: Optional filter expression to apply to the table.