A set of results returned by Kinetica.getRecordsFromCollection. More…
Classes | |
| struct | Info |
| A set of string constants for the parameter RawGetRecordsFromCollectionResponse.info. More… | |
Properties | |
| string | table_name [get, set] |
| Value of table_name. | |
| IList< string > | type_names = new List<string>() [get, set] |
| The type IDs of the corresponding records in RawGetRecordsFromCollectionResponse.records_binary or RawGetRecordsFromCollectionResponse.records_json. | |
| IList< byte[]> | records_binary = new List<byte[]>() [get, set] |
| If the encoding parameter of the request was ‘binary’ then this list contains the binary encoded records retrieved from the table/collection. | |
| IList< string > | records_json = new List<string>() [get, set] |
| If the encoding parameter of the request was ‘json’, then this list contains the JSON encoded records retrieved from the table/collection. | |
| IList< string > | record_ids = new List<string>() [get, set] |
| If the ‘return_record_ids’ option of the request was ‘true’, then this list contains the internal ID for each object. | |
| IDictionary< string, string > | info = new Dictionary<string, string>() [get, set] |
| Additional information. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| 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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of results returned by Kinetica.getRecordsFromCollection.
Definition at line 337 of file GetRecordsFromCollection.cs.
Property Documentation
◆ info
| getset |
Additional information.
- TOTAL_NUMBER_OF_RECORDS: Total number of records.
- HAS_MORE_RECORDS: Too many records. Returned a partial set. Supported values:
The default value is an empty Dictionary.
Definition at line 435 of file GetRecordsFromCollection.cs.
◆ record_ids
| getset |
If the ‘return_record_ids’ option of the request was ‘true’, then this list contains the internal ID for each object.
Otherwise it will be empty.
Definition at line 404 of file GetRecordsFromCollection.cs.
◆ records_binary
| getset |
If the encoding parameter of the request was ‘binary’ then this list contains the binary encoded records retrieved from the table/collection.
Otherwise, empty list.
Definition at line 393 of file GetRecordsFromCollection.cs.
◆ records_json
| getset |
If the encoding parameter of the request was ‘json’, then this list contains the JSON encoded records retrieved from the table/collection.
Otherwise, empty list.
Definition at line 399 of file GetRecordsFromCollection.cs.
◆ table_name
| getset |
Value of table_name.
Definition at line 378 of file GetRecordsFromCollection.cs.
◆ type_names
| getset |
The type IDs of the corresponding records in RawGetRecordsFromCollectionResponse.records_binary or RawGetRecordsFromCollectionResponse.records_json.
This is useful when table_name is a heterogeneous collection (collections containing tables of different types).
Definition at line 387 of file GetRecordsFromCollection.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/GetRecordsFromCollection.cs
- Kinetica/Protocol/GetRecordsFromCollection.cs