Kinetica C# API  Version 6.1.0.0
GetRecords.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 
31  {
32 
49  public struct Encoding
50  {
51  public const string BINARY = "binary";
52  public const string JSON = "json";
53  } // end struct Encoding
54 
55 
116  public struct Options
117  {
118 
121  public const string EXPRESSION = "expression";
122 
141  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
142  public const string TRUE = "true";
143  public const string FALSE = "false";
144 
147  public const string SORT_BY = "sort_by";
148 
165  public const string SORT_ORDER = "sort_order";
166  public const string ASCENDING = "ascending";
167  public const string DESCENDING = "descending";
168  } // end struct Options
169 
170 
173  public string table_name { get; set; }
174 
179  public long offset { get; set; } = 0;
180 
184  public long limit { get; set; } = 10000;
185 
200  public string encoding { get; set; } = Encoding.BINARY;
201 
260  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
261 
262 
265  public GetRecordsRequest() { }
266 
340  long offset = 0,
341  long limit = 10000,
342  IDictionary<string, string> options = null)
343  {
344  this.table_name = table_name ?? "";
345  this.offset = offset;
346  this.limit = limit;
347  this.encoding = Encoding.BINARY;
348  this.options = options ?? new Dictionary<string, string>();
349  } // end constructor
350 
351 
439  long offset = 0,
440  long limit = 10000,
441  string encoding = null,
442  IDictionary<string, string> options = null)
443  {
444  this.table_name = table_name ?? "";
445  this.offset = offset;
446  this.limit = limit;
447  this.encoding = encoding ?? Encoding.BINARY;
448  this.options = options ?? new Dictionary<string, string>();
449  } // end full constructor
450 
451  } // end class GetRecordsRequest
452 
453 
454 
459  {
460 
463  public string table_name { get; set; }
464  public string type_name { get; set; }
465 
468  public string type_schema { get; set; }
469 
473  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
474 
478  public IList<string> records_json { get; set; } = new List<string>();
479 
481  public long total_number_of_records { get; set; }
482 
484  public bool has_more_records { get; set; }
485 
486  } // end class RawGetRecordsResponse
487 
488 
489 
497  {
498 
501  public string table_name { get; set; }
502  public string type_name { get; set; }
503 
506  public string type_schema { get; set; }
507 
511  public IList<T> data { get; set; } = new List<T>();
512 
514  public long total_number_of_records { get; set; }
515 
517  public bool has_more_records { get; set; }
518 
519  } // end class GetRecordsResponse
520 
521 
522 
523 
524 } // end namespace kinetica
string table_name
Name of the table from which the records will be fetched.
Definition: GetRecords.cs:173
A set of results returned by Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Definition: GetRecords.cs:458
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:265
IDictionary< string, string > options
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:260
GetRecordsRequest(string table_name, long offset=0, long limit=10000, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:438
A set of parameters for Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Definition: GetRecords.cs:30
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:116
GetRecordsRequest(string table_name, long offset=0, long limit=10000, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:339
string encoding
Specifies the encoding for returned records.
Definition: GetRecords.cs:200
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
Specifies the encoding for returned records.
Definition: GetRecords.cs:49
long limit
A positive integer indicating the maximum number of results to be returned.
Definition: GetRecords.cs:184
A set of results returned by Kinetica.getRecords<T>(string,long,long,IDictionary<string, string>).
Definition: GetRecords.cs:496
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:179