$darkmode
Qore ElasticSearchDataProvider Module Reference 1.0
ElasticSearchIndexesDataProvider.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
26 namespace ElasticSearchDataProvider {
29 
30 public:
32  const ProviderInfo = <DataProviderInfo>{
33  "name": "indexes",
34  "desc": "ElasticSearch indexes data provider; provdes table-like access to ElasticSearch indices",
35  "type": "ElasticSearchIndexesDataProvider",
36  "constructor_options": ElasticSearchDataProvider::ConstructorOptions,
37  "supports_children": True,
38  "children_can_support_records": True,
39  };
40 
42  const ProviderSummaryInfo = cast<hash<DataProviderSummaryInfo>>(ProviderInfo{
43  AbstractDataProvider::DataProviderSummaryInfoKeys
44  });
45 
47  constructor(*hash<auto> options);
48 
49 
52 
53 
55  string getName();
56 
57 
59  *string getDesc();
60 
61 
63  *list<hash<DataProvider::DataProviderSummaryInfo>> getChildProviderSummaryInfo();
64 
65 
67 
69 protected:
70  *list<string> getChildProviderNamesImpl();
71 public:
72 
73 
75 
79 protected:
81 public:
82 
83 
85  hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
86 
87 
89 
91 protected:
92  *hash<auto> getAllIndices();
93 public:
94 
95 
97 
99 protected:
100  *hash<auto> getIndex(string name);
101 public:
102 
103 };
104 };
The AWS REST client base data provider class.
Definition: ElasticSearchDataProviderBase.qc.dox.h:28
const ConstructorOptions
Constructor options.
Definition: ElasticSearchDataProvider.qc.dox.h:61
The ElasticSearch indexes root for providing record-based data providers for each index.
Definition: ElasticSearchIndexesDataProvider.qc.dox.h:28
constructor(RestClient::RestClient rest)
Creates the object from a REST connection.
*DataProvider::AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
const ProviderInfo
Provider info.
Definition: ElasticSearchIndexesDataProvider.qc.dox.h:32
string getName()
Returns the data provider name.
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
constructor(*hash< auto > options)
Creates the object from constructor options.
*hash< auto > getAllIndices()
Returns a hash of indices.
*string getDesc()
Returns the data provider description.
const ProviderSummaryInfo
Provider summary info.
Definition: ElasticSearchIndexesDataProvider.qc.dox.h:42
*hash< auto > getIndex(string name)
Returns a hash of the given index or NOTHING.
const True
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26