Kinetica C# API  Version 6.1.0.0
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 
33  {
34 
52  public struct Encoding
53  {
54  public const string BINARY = "binary";
55  public const string JSON = "json";
56  } // end struct Encoding
57 
58 
107  public struct Options
108  {
109 
112  public const string EXPRESSION = "expression";
113 
116  public const string SORT_BY = "sort_by";
117 
134  public const string SORT_ORDER = "sort_order";
135  public const string ASCENDING = "ascending";
136  public const string DESCENDING = "descending";
137 
143  public const string ORDER_BY = "order_by";
144  } // end struct Options
145 
146 
149  public string table_name { get; set; }
150 
152  public IList<string> column_names { get; set; } = new List<string>();
153 
158  public long offset { get; set; }
159 
164  public long limit { get; set; }
165 
182  public string encoding { get; set; } = Encoding.BINARY;
183 
230  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
231 
232 
236 
300  IList<string> column_names,
301  long offset,
302  long limit,
303  IDictionary<string, string> options = null)
304  {
305  this.table_name = table_name ?? "";
306  this.column_names = column_names ?? new List<string>();
307  this.offset = offset;
308  this.limit = limit;
309  this.encoding = Encoding.BINARY;
310  this.options = options ?? new Dictionary<string, string>();
311  } // end constructor
312 
313 
393  IList<string> column_names,
394  long offset,
395  long limit,
396  string encoding = null,
397  IDictionary<string, string> options = null)
398  {
399  this.table_name = table_name ?? "";
400  this.column_names = column_names ?? new List<string>();
401  this.offset = offset;
402  this.limit = limit;
403  this.encoding = encoding ?? Encoding.BINARY;
404  this.options = options ?? new Dictionary<string, string>();
405  } // end full constructor
406 
407  } // end class GetRecordsByColumnRequest
408 
409 
410 
415  {
416 
419  public string table_name { get; set; }
420 
423  public string response_schema_str { get; set; }
424 
426  public byte[] binary_encoded_response { get; set; }
427 
429  public string json_encoded_response { get; set; }
430 
432  public long total_number_of_records { get; set; }
433 
435  public bool has_more_records { get; set; }
436 
437  } // end class RawGetRecordsByColumnResponse
438 
439 
440 
445  {
446 
449  public string table_name { get; set; }
450 
452  public IList<KineticaRecord> data { get; set; } = new List<KineticaRecord>();
453 
455  public long total_number_of_records { get; set; }
456 
458  public bool has_more_records { get; set; }
459 
460  } // end class GetRecordsByColumnResponse
461 
462 
463 
464 
465 } // 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.