Kinetica C# API  Version 7.1.10.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 
33  {
34 
56  public struct Encoding
57  {
58  public const string BINARY = "binary";
59  public const string JSON = "json";
60  public const string GEOJSON = "geojson";
61  } // end struct Encoding
62 
63 
124  public struct Options
125  {
126 
129  public const string EXPRESSION = "expression";
130 
149  public const string FAST_INDEX_LOOKUP = "fast_index_lookup";
150  public const string TRUE = "true";
151  public const string FALSE = "false";
152 
155  public const string SORT_BY = "sort_by";
156 
173  public const string SORT_ORDER = "sort_order";
174  public const string ASCENDING = "ascending";
175  public const string DESCENDING = "descending";
176  } // end struct Options
177 
178 
183  public string table_name { get; set; }
184 
189  public long offset { get; set; } = 0;
190 
205  public long limit { get; set; } = -9999;
206 
226  public string encoding { get; set; } = Encoding.BINARY;
227 
286  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
287 
288 
291  public GetRecordsRequest() { }
292 
378  long? offset = null,
379  long? limit = null,
380  IDictionary<string, string> options = null)
381  {
382  this.table_name = table_name ?? "";
383  this.offset = offset ?? 0;
384  this.limit = limit ?? -9999;
385  this.encoding = Encoding.BINARY;
386  this.options = options ?? new Dictionary<string, string>();
387  } // end constructor
388 
389 
494  long? offset = null,
495  long? limit = null,
496  string encoding = null,
497  IDictionary<string, string> options = null)
498  {
499  this.table_name = table_name ?? "";
500  this.offset = offset ?? 0;
501  this.limit = limit ?? -9999;
502  this.encoding = encoding ?? Encoding.BINARY;
503  this.options = options ?? new Dictionary<string, string>();
504  } // end full constructor
505 
506  } // end class GetRecordsRequest
507 
508 
509 
514  {
515 
518  public string table_name { get; set; }
519  public string type_name { get; set; }
520 
523  public string type_schema { get; set; }
524 
528  public IList<byte[]> records_binary { get; set; } = new List<byte[]>();
529 
536  public IList<string> records_json { get; set; } = new List<string>();
537 
539  public long total_number_of_records { get; set; }
540 
542  public bool has_more_records { get; set; }
543 
545  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
546 
547  } // end class RawGetRecordsResponse
548 
549 
550 
557  public class GetRecordsResponse<T> : KineticaData
558  {
559 
562  public string table_name { get; set; }
563  public string type_name { get; set; }
564 
567  public string type_schema { get; set; }
568 
572  public IList<T> data { get; set; } = new List<T>();
573 
575  public long total_number_of_records { get; set; }
576 
578  public bool has_more_records { get; set; }
579 
581  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
582 
583  } // end class GetRecordsResponse
584 
585 
586 
587 
588 } // 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:528
const string SORT_ORDER
String indicating how the returned values should be sorted - ascending or descending.
Definition: GetRecords.cs:173
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:493
const string FAST_INDEX_LOOKUP
Indicates if indexes should be used to perform the lookup for a given expression if possible...
Definition: GetRecords.cs:149
string table_name
Name of the table or view from which the records will be fetched, in [schema_name.
Definition: GetRecords.cs:183
A set of results returned by Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}).
Definition: GetRecords.cs:513
const string SORT_BY
Optional column that the data should be sorted by.
Definition: GetRecords.cs:155
const string EXPRESSION
Optional filter expression to apply to the table.
Definition: GetRecords.cs:129
GetRecordsRequest()
Constructs a GetRecordsRequest object with default parameters.
Definition: GetRecords.cs:291
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:377
long total_number_of_records
Total/Filtered number of records.
Definition: GetRecords.cs:539
IDictionary< string, string > options
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:286
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:536
A set of parameters for Kinetica.getRecords{T}(string,long,long,IDictionary{string, string}).
Definition: GetRecords.cs:32
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:523
EXPRESSION: Optional filter expression to apply to the table.
Definition: GetRecords.cs:124
bool has_more_records
Too many records. Returned a partial set.
Definition: GetRecords.cs:542
string table_name
Value of .
Definition: GetRecords.cs:518
string encoding
Specifies the encoding for returned records; one of binary, json, or geojson.
Definition: GetRecords.cs:226
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
Specifies the encoding for returned records; one of binary, json, or geojson.
Definition: GetRecords.cs:56
long limit
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to ...
Definition: GetRecords.cs:205
long offset
A positive integer indicating the number of initial results to skip (this can be useful for paging th...
Definition: GetRecords.cs:189
IDictionary< string, string > info
Additional information.
Definition: GetRecords.cs:545