Qore ElasticSearchDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
ElasticSearchIndexTableDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
28
39
40public:
42 string name;
43
45 hash<auto> index;
46
48 const ProviderInfo = ...;
49
50
53
54
56 const TypeMap = ...;
57
58
60 const SearchQueryOptions = ("timeout",);
61
62protected:
64 hash<string, AbstractDataField> record_type = {
65 "_id": new QoreDataField("_id", "the document ID", AbstractDataProviderTypeMap."softstring"),
66 "_score": new QoreDataField("_score", "the score for the match (read-only)", AbstractDataProviderTypeMap."float"),
67 };
68
69public:
70
72 constructor(RestClient::RestClient rest, string name, hash<auto> index) ;
73
74
76 string getName();
77
78
80 *string getDesc();
81
82
84
89protected:
90 DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
91public:
92
93
95
104protected:
105 int updateRecordsImpl(hash<auto> set, *hash<auto> where_cond, *hash<auto> search_options);
106public:
107
108
118protected:
119 int deleteRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
120public:
121
122
124
132protected:
133 *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
134public:
135
136
138 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
139
140
142 DataProvider::AbstractDataProviderType getTypeForProperty(string name, hash<auto> prop);
143
144
146 static string getQueryOptions(string uri, hash<auto> search_options, list<string> query_args);
147
149protected:
150 string getDocUriPath(string uri_str, *hash<auto> where_cond, string action, *hash<auto> search_options, *list<string> query_args);
151public:
152
153
155protected:
157public:
158
159
160protected:
161 *hash<string, DataProvider::AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
162public:
163
164};
165};
The ElasticSearch data provider base class.
Definition ElasticSearchDataProviderBase.qc.dox.h:28
This class exposes ElasticSearch indices as record-based data providers.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:38
const ProviderSummaryInfo
Provider summary info.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:52
const ProviderInfo
Provider info.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:48
static string getQueryOptions(string uri, hash< auto > search_options, list< string > query_args)
Returns a URI path with query options.
DataProvider::AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
int deleteRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
DataProvider::AbstractDataProviderType getTypeForProperty(string name, hash< auto > prop)
Returns a data type for a property.
const SearchQueryOptions
Search query options.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:60
constructor(RestClient::RestClient rest, string name, hash< auto > index)
Creates the object from a REST connection.
int updateRecordsImpl(hash< auto > set, *hash< auto > where_cond, *hash< auto > search_options)
Updates a single document in the index.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
hash< auto > index
Index hash.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:45
hash< string, AbstractDataField > record_type
The record type for the object.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:64
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Writes the given record to the data provider.
string name
Current index name.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:42
*string getDesc()
Returns the data provider description.
string getDocUriPath(string uri_str, *hash< auto > where_cond, string action, *hash< auto > search_options, *list< string > query_args)
Makes sure that the where_cond is only the _id field.
const TypeMap
ElasticSearch property types to data types.
Definition ElasticSearchIndexTableDataProvider.qc.dox.h:56
Qore ElasticSearchDataProvider module definition.
Definition ElasticSearchAcknowledgedDataType.qc.dox.h:26