| Qore DbDataProvider Module Reference 2.2

Loading...
Searching...
No Matches
DbDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace DbDataProvider {
28
31 class DbDataProvider : public DbDataProviderBase {
32
33 public:
35 const ProviderInfo = ...;
36
37
39 const ConstructorOptions = ...;
40
41
43 const SearchOptions = ...;
44
45
47 const ChildCreateOptions = ...;
48
49
50 protected:
52 const ChildMap = ...;
53
54
55 public:
56
58 constructor(AbstractDatasource ds, *hash<auto> opts) ;
59
60
62 constructor(AbstractDatabase db) ;
63
64
66 constructor(*hash<auto> options) ;
67
68
70 string getName();
71
72
74 *string getDesc();
75
76
78
83 static *hash<string, AbstractDataField> getRecordTypeFromDescribeHash(hash<auto> describe_hash);
84
86
90 protected:
91 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
92 public:
93
94
96
103 protected:
104 AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(int block_size = 1000, *hash<auto> where_cond, *hash<auto> search_options);
105 public:
106
107
109
114 protected:
115 AbstractDataProviderRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
116 public:
117
118
120 *list<hash<DataProviderSummaryInfo>> getChildProviderSummaryInfo();
121
122
124
126 protected:
127 *list<string> getChildProviderNamesImpl();
128 public:
129
130
132
138 protected:
139 *AbstractDataProvider getChildProviderImpl(string name);
140 public:
141
142
144 protected:
145 hash<DataProviderInfo> getStaticInfoImpl();
146 public:
147
148
150
158 protected:
159 AbstractDataProvider createChildProviderImpl(string name, hash<string, AbstractDataField> fields, *hash<auto> child_create_options);
160 public:
161
162
164
171 protected:
172 deleteChildProviderImpl(string name, *hash<auto> child_delete_options);
173 public:
174
175};
176};
DbDataProvider::DbDataProviderBase
The database data provider base class.
Definition DbDataProviderBase.qc.dox.h:28
DbDataProvider::DbDataProviderBase::db
AbstractDatabase db
the database object, if required
Definition DbDataProviderBase.qc.dox.h:33
DbDataProvider::DbDataProvider::getRecordTypeFromDescribeHash
static *hash< string, AbstractDataField > getRecordTypeFromDescribeHash(hash< auto > describe_hash)
Returns the record type description from a describe hash.
DbDataProvider::DbDataProvider::searchRecordsBulkImpl
AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(int block_size=1000, *hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
DbDataProvider::DbDataProvider::getDesc
*string getDesc()
Returns the data provider description.
DbDataProvider::DbDataProvider::searchRecordsImpl
AbstractDataProviderRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
DbDataProvider::DbDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition DbDataProvider.qc.dox.h:39
DbDataProvider::DbDataProvider::ChildMap
const ChildMap
Child map.
Definition DbDataProvider.qc.dox.h:52
DbDataProvider::DbDataProvider::SearchOptions
const SearchOptions
Search options.
Definition DbDataProvider.qc.dox.h:43
DbDataProvider::DbDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition DbDataProvider.qc.dox.h:35
DbDataProvider::DbDataProvider::deleteChildProviderImpl
deleteChildProviderImpl(string name, *hash< auto > child_delete_options)
Deletes a child data provider.
DbDataProvider::DbDataProvider::ChildCreateOptions
const ChildCreateOptions
Child provider creation options.
Definition DbDataProvider.qc.dox.h:47
DbDataProvider::DbDataProvider::getChildProviderImpl
*AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
DbDataProvider::DbDataProvider::constructor
constructor(AbstractDatasource ds, *hash< auto > opts)
creates the object
DbDataProvider::DbDataProvider::getChildProviderNamesImpl
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
DbDataProvider::DbDataProvider::getName
string getName()
Returns the data provider name.
DbDataProvider::DbDataProvider::constructor
constructor(AbstractDatabase db)
creates the object
DbDataProvider::DbDataProvider::getRecordTypeImpl
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
DbDataProvider::DbDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
DbDataProvider::DbDataProvider::createChildProviderImpl
AbstractDataProvider createChildProviderImpl(string name, hash< string, AbstractDataField > fields, *hash< auto > child_create_options)
Creates a new child data provider and returns it after adding as a child.
DbDataProvider::DbDataProvider::getChildProviderSummaryInfo
*list< hash< DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
DbDataProvider::DbDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
DbDataProvider
Qore AbstractDbRecordIterator class definition.
Definition AbstractDbRecordIterator.qc.dox.h:26