A set of parameters for Kinetica.getRecordsFromCollection. More...
Inheritance diagram for kinetica.GetRecordsFromCollectionRequest:
Collaboration diagram for kinetica.GetRecordsFromCollectionRequest:
Classes | |
| struct | Encoding |
| A set of string constants for the parameter encoding. More... | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
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... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| 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 = 0 [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 = -9999 [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 = Encoding.BINARY [get, set] |
| Specifies the encoding for returned records; either BINARY or JSON. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.getRecordsFromCollection.
Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as Kinetica.deleteRecords.
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 23 of file GetRecordsFromCollection.cs.
Constructor & Destructor Documentation
◆ GetRecordsFromCollectionRequest() [1/3]
|
inline |
Constructs a GetRecordsFromCollectionRequest object with default parameters.
Definition at line 140 of file GetRecordsFromCollection.cs.
◆ GetRecordsFromCollectionRequest() [2/3]
|
inline |
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
- 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 offset & limit to request subsequent pages of results. The default value is -9999. options - RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values: The default value is FALSE.
- EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
Definition at line 193 of file GetRecordsFromCollection.cs.
◆ GetRecordsFromCollectionRequest() [3/3]
|
inline |
Constructs a GetRecordsFromCollectionRequest object with the specified parameters.
- 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 offset & limit 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 - RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. Supported values: The default value is FALSE.
- EXPRESSION: Optional filter expression to apply to the table. The default value is ''.
Definition at line 270 of file GetRecordsFromCollection.cs.
Property Documentation
◆ encoding
|
getset |
◆ limit
|
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 offset & limit to request subsequent pages of results. The default value is -9999.
Definition at line 90 of file GetRecordsFromCollection.cs.
◆ offset
|
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 77 of file GetRecordsFromCollection.cs.
◆ options
|
getset |
- RETURN_RECORD_IDS: If TRUE then return the internal record ID along with each returned record. 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 136 of file GetRecordsFromCollection.cs.
◆ table_name
|
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 70 of file GetRecordsFromCollection.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/GetRecordsFromCollection.cs
