Qore ElasticSearchDataProvider Module Reference 1.0
Loading...
Searching...
No Matches
ElasticSearchDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
29
30public:
33
35 string uri_path = "/";
36
39
41 const ProviderInfo = <DataProviderInfo>{
42 "type": "ElasticSearchDataProvider",
43 "supports_read": False,
44 "supports_create": False,
45 "supports_update": False,
46 "supports_upsert": False,
47 "supports_delete": False,
48 "supports_native_search": False,
49 "supports_bulk_create": False,
50 "supports_bulk_upsert": False,
51 "supports_children": True,
52 "constructor_options": ConstructorOptions,
53 "search_options": NOTHING,
54 "create_options": NOTHING,
55 "upsert_options": NOTHING,
56 "transaction_management": False,
57 "supports_schema": False,
58 "children_can_support_apis": True,
59 "children_can_support_records": True,
60 "children_can_support_observers": False,
61 };
62
64 const ConstructorOptions = {
65 "restclient": <DataProviderOptionInfo>{
66 "type": AbstractDataProviderType::get(new Type("RestClient")),
67 "desc": "the RestClient object",
68 },
69 "url": <DataProviderOptionInfo>{
70 "type": AbstractDataProviderTypeMap."string",
71 "desc": "the URL to the REST server; overrides any URL in any RestClient object passed as an option",
72 },
73 "restclient_options": <DataProviderOptionInfo>{
74 "type": AbstractDataProviderTypeMap."*hash",
75 "desc": "options to the RestClient constructor; only used if a RestClient object is created for a "
76 "call",
77 },
78 };
79
80protected:
81 const ChildMap = {
82 "document": Class::forName("ElasticSearchDataProvider::ElasticSearchDocumentDataProvider"),
83 "index": Class::forName("ElasticSearchDataProvider::ElasticSearchIndexDataProvider"),
84 "pipeline": Class::forName("ElasticSearchDataProvider::ElasticSearchPipelineDataProvider"),
85 "indexes": Class::forName("ElasticSearchDataProvider::ElasticSearchIndexesDataProvider"),
86 };
87
88public:
89
91 constructor(*hash<auto> options);
92
93
94 static RestClient::RestClient getRestConnection(*hash<auto> options);
95
97 string getName();
98
99
101 *string getDesc();
102
103
105 *list<hash<DataProvider::DataProviderSummaryInfo>> getChildProviderSummaryInfo();
106
107
109
111protected:
113public:
114
115
117
121protected:
123public:
124
125
127protected:
128 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
129public:
130
131};
132
135
137const SoftBoolDataProviderStringType = AbstractDataProviderType::get(SoftBoolStringType);
138
140class SoftBoolStringType : public Qore::Reflection::Type {
141
142public:
145
146
148 auto acceptsValue(auto value);
149
150
153
154};
155};
*RestClient::RestClient rest
The REST client object for API calls.
Definition: ElasticSearchDataProvider.qc.dox.h:32
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
*string getDesc()
Returns the data provider description.
*DataProvider::AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
constructor(*hash< auto > options)
Creates the object from constructor options.
string display_name
The value to returns as the name of the object.
Definition: ElasticSearchDataProvider.qc.dox.h:38
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
string getName()
Returns the data provider name.
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
Boolean string type.
Definition: ElasticSearchDataProvider.qc.dox.h:140
auto getDefaultValue()
Returns the default value for the type or NOTHING if the type has no default value.
auto acceptsValue(auto value)
Returns the value after any conversions by the type.
Qore ElasticSearchDataProvider module definition.
Definition: ElasticSearchAcknowledgedDataType.qc.dox.h:26
const SoftBoolDataProviderStringType
Boolean data provider string type for query parameters.
Definition: ElasticSearchDataProvider.qc.dox.h:137