$darkmode
Defines the record iterator class for Table-based iterators. More...
Public Member Functions | |
| constructor (RestClient::RestClient rest, string name, hash< auto > index, hash< string, DataProvider::AbstractDataField > record_type, *hash< auto > where_cond, *hash< auto > search_options) | |
| creates the iterator More... | |
| *hash< string, DataProvider::AbstractDataField > | getRecordType () |
| Returns the record description, if available. More... | |
| hash< auto > | getValue () |
| Returns a single record if the iterator is valid. More... | |
| *hash< auto > | makeQuery (*hash< auto > where_cond, *hash< auto > search_options) |
| Returns the query body. | |
| auto | memberGate (string key) |
| Returns the value of the given field in the current row, if the iterator is valid. More... | |
| bool | next () |
| Increments the row pointer when retrieving rows from a select statement. More... | |
| bool | valid () |
| Returns True if the iterator is valid. More... | |
Private Attributes | |
| Qore::ListHashIterator | i |
| record iterator | |
| hash< auto > | index |
| Index hash. | |
| const | MatchOptions = ("operator",) |
| Query match options. | |
| string | name |
| current index name | |
| hash< string, DataProvider::AbstractDataField > | record_type |
| The record type for the object. | |
| RestClient::RestClient | rest |
| The REST client object for API calls. | |
Defines the record iterator class for Table-based iterators.
| ElasticSearchDataProvider::ElasticSearchRecordIterator::constructor | ( | RestClient::RestClient | rest, |
| string | name, | ||
| hash< auto > | index, | ||
| hash< string, DataProvider::AbstractDataField > | record_type, | ||
| *hash< auto > | where_cond, | ||
| *hash< auto > | search_options | ||
| ) |
creates the iterator
| rest | the REST client connection |
| name | the name of the index |
| index | the index definition hash |
| record_type | record type information |
| where_cond | the where clause for the query, if any |
| search_options | search options; assumed to have already been processed for validity before this call |
| *hash<string, DataProvider::AbstractDataField> ElasticSearchDataProvider::ElasticSearchRecordIterator::getRecordType | ( | ) |
Returns the record description, if available.
|
virtual |
Returns a single record if the iterator is valid.
| INVALID-ITERATOR | the iterator is not pointing at a valid element |
Implements DataProvider::AbstractDataProviderRecordIterator.
| auto ElasticSearchDataProvider::ElasticSearchRecordIterator::memberGate | ( | string | key | ) |
Returns the value of the given field in the current row, if the iterator is valid.
| key | the name of the field |
| FIELD-ERROR | invalid or unknown field name |
| bool ElasticSearchDataProvider::ElasticSearchRecordIterator::next | ( | ) |