Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
53  public struct Encoding
54  {
55  public const string BINARY = "binary";
56  public const string JSON = "json";
57  public const string GEOJSON = "geojson";
58  } // end struct Encoding
59 
60 
121  public struct Options
122  {
123 
126  public const string EXPRESSION = "expression";
127 
146  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
147  public const string TRUE = "true";
148  public const string FALSE = "false";
149 
152  public const string SORT_BY = "sort_by";
153 
170  public const string SORT_ORDER = "sort_order";
171  public const string ASCENDING = "ascending";
172  public const string DESCENDING = "descending";
173  } // end struct Options
174 
175 
178  public string table_name { get; set; }
179 
184  public long offset { get; set; } = 0;
185 
197  public long limit { get; set; } = -9999;
198 
217  public string encoding { get; set; } = Encoding.BINARY;
218 
277  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
278 
279 
282  public GetRecordsRequest() { }
283 
365  long? offset = null,
366  long? limit = null,
367  IDictionary<string, string> options = null)
368  {
369  this.table_name = table_name ?? "";
370  this.offset = offset ?? 0;
371  this.limit = limit ?? -9999;
372  this.encoding = Encoding.BINARY;
373  this.options = options ?? new Dictionary<string, string>();
374  } // end constructor
375 
376 
476  long? offset = null,
477  long? limit = null,
478  string encoding = null,
479  IDictionary<string, string> options = null)
480  {
481  this.table_name = table_name ?? "";
482  this.offset = offset ?? 0;
483  this.limit = limit ?? -9999;
484  this.encoding = encoding ?? Encoding.BINARY;
485  this.options = options ?? new Dictionary<string, string>();
486  } // end full constructor
487 
488  } // end class GetRecordsRequest
489 
490 
491 
496  {
497 
500  public string table_name { get; set; }
501  public string type_name { get; set; }
502 
505  public string type_schema { get; set; }
506 
510  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
511 
518  public IList<string> records_json { get; set; } = new List<string>();
519 
521  public long total_number_of_records { get; set; }
522 
524  public bool has_more_records { get; set; }
525 
527  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
528 
529  } // end class RawGetRecordsResponse
530 
531 
532 
539  public class GetRecordsResponse<T> : KineticaData
540  {
541 
544  public string table_name { get; set; }
545  public string type_name { get; set; }
546 
549  public string type_schema { get; set; }
550 
554  public IList<T> data { get; set; } = new List<T>();
555 
557  public long total_number_of_records { get; set; }
558 
560  public bool has_more_records { get; set; }
561 
563  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
564 
565  } // end class GetRecordsResponse
566 
567 
568 
569 
570 } // end namespace kinetica
IList< byte[]> records_binary
If the was &#39;binary&#39;, then this list contains the binary encoded records retrieved from the table...
Definition: GetRecords.cs:510
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
Definition: GetRecords.cs:170
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:475
const string FAST_INDEX_LOOKUP
Indicates if indexes should be used to perform the lookup for a given expression if possible...
Definition: GetRecords.cs:146
string table_name
Name of the table from which the records will be fetched.
Definition: GetRecords.cs:178
A set of results returned by Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}).
Definition: GetRecords.cs:495
const string SORT_BY
Optional column that the data should be sorted by.
Definition: GetRecords.cs:152
const string EXPRESSION
Optional filter expression to apply to the table.
Definition: GetRecords.cs:126
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:282
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:364
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:521
IDictionary< string, string > options
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:277
IList< string > records_json
If the was &#39;json&#39;, then this list contains the JSON encoded records retrieved from the table...
Definition: GetRecords.cs:518
A set of parameters for Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}).
Definition: GetRecords.cs:30
string type_schema
Avro schema of &lt;member name=&quot;records_binary&quot;&gt; or &lt;member name=&quot;records_json&quot;&gt;
Definition: GetRecords.cs:505
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:121
bool has_more_records
Too many records. Returned a partial set.
Definition: GetRecords.cs:524
string table_name
Value of .
Definition: GetRecords.cs:500
string encoding
Specifies the encoding for returned records.
Definition: GetRecords.cs:217
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
Specifies the encoding for returned records.
Definition: GetRecords.cs:53
long limit
A positive integer indicating the maximum number of results to be returned.
Definition: GetRecords.cs:197
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:184
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:527