Kinetica C# API
Version 7.1.10.0
|
A set of parameters for Kinetica.getRecordsFromCollection{T}(string,long,long,IDictionary{string, string}). More...
Classes | |
struct | Encoding |
Specifies the encoding for returned records; either binary or json. More... | |
struct | Options |
| |
Public Member Functions | |
GetRecordsFromCollectionRequest () | |
Constructs a GetRecordsFromCollectionRequest object with default parameters. More... | |
GetRecordsFromCollectionRequest (string table_name, long?offset=null, long?limit=null, IDictionary< string, string > options=null) | |
Constructs a GetRecordsFromCollectionRequest object with the specified parameters. More... | |
GetRecordsFromCollectionRequest (string table_name, long?offset=null, long?limit=null, string encoding=null, IDictionary< string, string > options=null) | |
Constructs a GetRecordsFromCollectionRequest object with the specified parameters. More... | |
![]() | |
KineticaData (KineticaType type) | |
Constructor from Kinetica Type More... | |
KineticaData (System.Type type=null) | |
Default constructor, with optional System.Type More... | |
object | Get (int fieldPos) |
Retrieve a specific property from this object More... | |
void | Put (int fieldPos, object fieldValue) |
Write a specific property to this object More... | |
Properties | |
string | table_name [get, set] |
Name of the collection or table from which records are to be retrieved, in [schema_name. More... | |
long | offset [get, set] |
A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). More... | |
long | limit = 0 [get, set] |
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. More... | |
string | encoding = -9999 [get, set] |
Specifies the encoding for returned records; either binary or json. More... | |
IDictionary< string, string > | options = Encoding.BINARY [get, set] |
| |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
Additional Inherited Members | |
![]() | |
static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.getRecordsFromCollection{T}(string,long,long,IDictionary{string, string}).
Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords(string,IList{string},IDictionary{string, string}).
This operation supports paging through the data via the offset and limit parameters.
Note that when using the Java API, it is not possible to retrieve records from join views using this operation. (DEPRECATED)
Definition at line 32 of file GetRecordsFromCollection.cs.
|
inline |
Constructs a GetRecordsFromCollectionRequest object with default parameters.
Definition at line 198 of file GetRecordsFromCollection.cs.
|
inline |
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
table_name | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use & to request subsequent pages of results. The default value is -9999. |
options |
|
Definition at line 256 of file GetRecordsFromCollection.cs.
|
inline |
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
table_name | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
limit | A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use & to request subsequent pages of results. The default value is -9999. |
encoding | Specifies the encoding for returned records; either binary or json. Supported values: The default value is BINARY. |
options |
|
Definition at line 341 of file GetRecordsFromCollection.cs.
|
getset |
Specifies the encoding for returned records; either binary or json.
Supported values:
The default value is BINARY.
Definition at line 162 of file GetRecordsFromCollection.cs.
|
getset |
A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use & to request subsequent pages of results. The default value is -9999.
Definition at line 144 of file GetRecordsFromCollection.cs.
|
getset |
A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
The default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
Definition at line 129 of file GetRecordsFromCollection.cs.
|
getset |
Supported values:
The default value is FALSE. EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
The default value is an empty Dictionary.
Definition at line 193 of file GetRecordsFromCollection.cs.
|
getset |
Name of the collection or table from which records are to be retrieved, in [schema_name.
]table_name format, using standard name resolution rules. Must be an existing collection or table.
Definition at line 123 of file GetRecordsFromCollection.cs.