Kinetica   C#   API  Version 7.2.3.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 namespace kinetica
10 {
25  {
32  public struct Encoding
33  {
34  public const string BINARY = "binary";
35  public const string JSON = "json";
36  public const string GEOJSON = "geojson";
37  } // end struct Encoding
38 
41  public struct Options
42  {
45  public const string EXPRESSION = "expression";
46 
60  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
61 
62  public const string TRUE = "true";
63  public const string FALSE = "false";
64 
69  public const string SORT_BY = "sort_by";
70 
86  public const string SORT_ORDER = "sort_order";
87 
88  public const string ASCENDING = "ascending";
89  public const string DESCENDING = "descending";
90  } // end struct Options
91 
96  public string table_name { get; set; }
97 
103  public long offset { get; set; } = 0;
104 
118  public long limit { get; set; } = -9999;
119 
138  public string encoding { get; set; } = Encoding.BINARY;
139 
197  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
198 
201  public GetRecordsRequest() { }
202 
284  long? offset = null,
285  long? limit = null,
286  IDictionary<string, string> options = null)
287  {
288  this.table_name = table_name ?? "";
289  this.offset = offset ?? 0;
290  this.limit = limit ?? -9999;
291  this.encoding = Encoding.BINARY;
292  this.options = options ?? new Dictionary<string, string>();
293  } // end constructor
294 
394  long? offset = null,
395  long? limit = null,
396  string encoding = null,
397  IDictionary<string, string> options = null)
398  {
399  this.table_name = table_name ?? "";
400  this.offset = offset ?? 0;
401  this.limit = limit ?? -9999;
402  this.encoding = encoding ?? Encoding.BINARY;
403  this.options = options ?? new Dictionary<string, string>();
404  } // end full constructor
405  } // end class GetRecordsRequest
406 
411  {
414  public string table_name { get; set; }
415 
416  public string type_name { get; set; }
417 
420  public string type_schema { get; set; }
421 
426  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
427 
437  public IList<string> records_json { get; set; } = new List<string>();
438 
440  public long total_number_of_records { get; set; }
441 
444  public bool has_more_records { get; set; }
445 
447  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
448  } // end class RawGetRecordsResponse
449 
456  {
459  public string table_name { get; set; }
460 
461  public string type_name { get; set; }
462 
465  public string type_schema { get; set; }
466 
471  public IList<T> data { get; set; } = new List<T>();
472 
474  public long total_number_of_records { get; set; }
475 
478  public bool has_more_records { get; set; }
479 
481  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
482  } // end class GetRecordsResponse
483 } // end namespace kinetica
IList< byte[]> records_binary
If the encoding was 'binary', then this list contains the binary encoded records retrieved from the t...
Definition: GetRecords.cs:426
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
Definition: GetRecords.cs:86
const string FAST_INDEX_LOOKUP
Indicates if indexes should be used to perform the lookup for a given expression if possible.
Definition: GetRecords.cs:60
string table_name
Name of the table or view from which the records will be fetched, in [schema_name.
Definition: GetRecords.cs:96
A set of results returned by Kinetica.getRecords.
Definition: GetRecords.cs:410
bool has_more_records
Too many records.
Definition: GetRecords.cs:478
const string SORT_BY
Optional column that the data should be sorted by.
Definition: GetRecords.cs:69
string table_name
Value of table_name.
Definition: GetRecords.cs:459
const string EXPRESSION
Optional filter expression to apply to the table.
Definition: GetRecords.cs:45
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:481
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:201
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:440
IDictionary< string, string > options
Definition: GetRecords.cs:197
IList< T > data
If the encoding was 'binary', then this list contains the binary encoded records retrieved from the t...
Definition: GetRecords.cs:471
IList< string > records_json
If the encoding was 'json', then this list contains the JSON encoded records retrieved from the table...
Definition: GetRecords.cs:437
A set of parameters for Kinetica.getRecords.
Definition: GetRecords.cs:24
string type_schema
Avro schema of data or records_json
Definition: GetRecords.cs:465
string type_schema
Avro schema of records_binary or records_json
Definition: GetRecords.cs:420
A set of string constants for the parameter options.
Definition: GetRecords.cs:41
bool has_more_records
Too many records.
Definition: GetRecords.cs:444
string table_name
Value of table_name.
Definition: GetRecords.cs:414
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:474
GetRecordsRequest(string table_name, long? offset=null, long? limit=null, string encoding=null, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:393
string encoding
Specifies the encoding for returned records; one of BINARY, JSON, or GEOJSON.
Definition: GetRecords.cs:138
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of string constants for the parameter encoding.
Definition: GetRecords.cs:32
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: GetRecords.cs:118
A set of results returned by Kinetica.getRecords.
Definition: GetRecords.cs:455
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:103
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:447
GetRecordsRequest(string table_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null)
Constructs a GetRecordsRequest object with the specified parameters.
Definition: GetRecords.cs:283