| Qore DbDataProvider Module Reference 2.2

Loading...
Searching...
No Matches
DbTableDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
24
26 namespace DbDataProvider {
28 class DbTableDataProvider : public DbDataProviderBase {
29
30 public:
32 const ProviderInfo = ...;
33
34
36
41 const MapperKeyInfo = ...;
42
43
45 const ConstructorOptions = ...;
46
47
49
58 const CreateOptions = ...;
59
60
62
69 const UpsertOptions = ...;
70
71
73
96 const SearchOptions = ...;
97
98
100 const DbUpsertMap = ...;
101
102
103 protected:
105 AbstractTable table;
106
108 Mutex db_lock();
109
110 public:
111
113 constructor(AbstractTable table, *LoggerInterface logger) ;
114
115
117 constructor(*hash<auto> options);
118
119
121 string getName();
122
123
125 *string getDesc();
126
127
129 hash<DataProviderInfo> getInfo();
130
131
133
140 beginTransaction();
141
142
144
149 commit();
150
151
153
158 rollback();
159
160
162
164 AbstractDataProviderBulkOperation getBulkInserter();
165
166
168
170 AbstractDataProviderBulkOperation getBulkUpserter();
171
172
174
176 *hash<string, hash<MapperRuntimeKeyInfo>> getMapperRuntimeKeys();
177
178
180 protected:
181 *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
182 public:
183
184
186
194 protected:
195 *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
196 public:
197
198
200
208 string upsertRecordImpl(hash<auto> rec, *hash<auto> upsert_options);
209
210
212
217 protected:
218 *hash<auto> searchSingleRecordImpl(*hash<auto> where_cond, *hash<auto> search_options);
219 public:
220
221
223
230 protected:
231 AbstractDataProviderBulkRecordInterface searchRecordsBulkImpl(int block_size = 1000, *hash<auto> where_cond, *hash<auto> search_options);
232 public:
233
234
236
244 protected:
245 DbTableRecordIterator searchRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
246 public:
247
248
250
259 protected:
260 bool updateSingleRecordImpl(hash<auto> set, hash<auto> where_cond, *hash<auto> search_options);
261 public:
262
263
265
274 protected:
275 int updateRecordsImpl(hash<auto> set, *hash<auto> where_cond, *hash<auto> search_options);
276 public:
277
278
280
291 protected:
292 int deleteRecordsImpl(*hash<auto> where_cond, *hash<auto> search_options);
293 public:
294
295
297 protected:
298 hash<DataProviderInfo> getStaticInfoImpl();
299 public:
300
301
303
311 protected:
312 addFieldImpl(AbstractDataField field, *hash<auto> field_add_options);
313 public:
314
315
317
323 protected:
324 updateFieldImpl(string name, AbstractDataField field, *hash<auto> field_update_options);
325 public:
326
327
329
334 protected:
335 deleteFieldImpl(string name, *hash<auto> field_delete_options);
336 public:
337
338
340 protected:
341 alignTable(hash<auto> table_desc);
342 public:
343
344
346 protected:
347 execDdlSql(list<auto> sqll);
348 public:
349
350};
351};
DbDataProvider::DbDataProviderBase
The database data provider base class.
Definition DbDataProviderBase.qc.dox.h:28
DbDataProvider::DbTableDataProvider
Defines a data provider based on a single SQL table.
Definition DbTableDataProvider.qc.dox.h:28
DbDataProvider::DbTableDataProvider::execDdlSql
execDdlSql(list< auto > sqll)
Executes the given DDL SQL string list.
DbDataProvider::DbTableDataProvider::addFieldImpl
addFieldImpl(AbstractDataField field, *hash< auto > field_add_options)
Creates a new field.
DbDataProvider::DbTableDataProvider::getDesc
*string getDesc()
Returns the data provider description.
DbDataProvider::DbTableDataProvider::getName
string getName()
Returns the data provider name.
DbDataProvider::DbTableDataProvider::beginTransaction
beginTransaction()
Begins a transaction in the datasource underlying the table.
DbDataProvider::DbTableDataProvider::db_lock
Mutex db_lock()
lock for "db"
DbDataProvider::DbTableDataProvider::MapperKeyInfo
const MapperKeyInfo
Mapper runtime key info; see details below.
Definition DbTableDataProvider.qc.dox.h:41
DbDataProvider::DbTableDataProvider::DbUpsertMap
const DbUpsertMap
Maps SqlUtil upsert_results to DB Provider Upsert Result Codes.
Definition DbTableDataProvider.qc.dox.h:100
DbDataProvider::DbTableDataProvider::commit
commit()
Commits data written to the data provider.
DbDataProvider::DbTableDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition DbTableDataProvider.qc.dox.h:32
DbDataProvider::DbTableDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
DbDataProvider::DbTableDataProvider::upsertRecordImpl
string upsertRecordImpl(hash< auto > rec, *hash< auto > upsert_options)
Upserts the given record to the data provider.
DbDataProvider::DbTableDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition DbTableDataProvider.qc.dox.h:45
DbDataProvider::DbTableDataProvider::updateSingleRecordImpl
bool updateSingleRecordImpl(hash< auto > set, hash< auto > where_cond, *hash< auto > search_options)
Updates a single record matching the search options.
DbDataProvider::DbTableDataProvider::SearchOptions
const SearchOptions
Search options; see details below.
Definition DbTableDataProvider.qc.dox.h:96
DbDataProvider::DbTableDataProvider::searchRecordsImpl
DbTableRecordIterator searchRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns an iterator for zero or more records matching the search options.
DbDataProvider::DbTableDataProvider::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::DbTableDataProvider::constructor
constructor(AbstractTable table, *LoggerInterface logger)
Creates the object.
DbDataProvider::DbTableDataProvider::alignTable
alignTable(hash< auto > table_desc)
Align table with the given description.
DbDataProvider::DbTableDataProvider::CreateOptions
const CreateOptions
Create options; see details below.
Definition DbTableDataProvider.qc.dox.h:58
DbDataProvider::DbTableDataProvider::searchSingleRecordImpl
*hash< auto > searchSingleRecordImpl(*hash< auto > where_cond, *hash< auto > search_options)
Returns a single record matching the search options.
DbDataProvider::DbTableDataProvider::createRecordImpl
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Writes the given record to the data provider.
DbDataProvider::DbTableDataProvider::getRecordTypeImpl
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
DbDataProvider::DbTableDataProvider::getInfo
hash< DataProviderInfo > getInfo()
Returns data provider info.
DbDataProvider::DbTableDataProvider::getBulkUpserter
AbstractDataProviderBulkOperation getBulkUpserter()
Returns a bulk upsert operation object for the data provider.
DbDataProvider::DbTableDataProvider::deleteRecordsImpl
int deleteRecordsImpl(*hash< auto > where_cond, *hash< auto > search_options)
Deletes zero or more records.
DbDataProvider::DbTableDataProvider::table
AbstractTable table
the table
Definition DbTableDataProvider.qc.dox.h:105
DbDataProvider::DbTableDataProvider::updateFieldImpl
updateFieldImpl(string name, AbstractDataField field, *hash< auto > field_update_options)
Updates an existing field.
DbDataProvider::DbTableDataProvider::getMapperRuntimeKeys
*hash< string, hash< MapperRuntimeKeyInfo > > getMapperRuntimeKeys()
Returns custom data mapper runtime keys.
DbDataProvider::DbTableDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
DbDataProvider::DbTableDataProvider::UpsertOptions
const UpsertOptions
Upsert options; see details below.
Definition DbTableDataProvider.qc.dox.h:69
DbDataProvider::DbTableDataProvider::rollback
rollback()
Rolls back data written to the data provider.
DbDataProvider::DbTableDataProvider::deleteFieldImpl
deleteFieldImpl(string name, *hash< auto > field_delete_options)
Deletes an existing field.
DbDataProvider::DbTableDataProvider::updateRecordsImpl
int updateRecordsImpl(hash< auto > set, *hash< auto > where_cond, *hash< auto > search_options)
Updates zero or more records matching the search options.
DbDataProvider::DbTableDataProvider::getBulkInserter
AbstractDataProviderBulkOperation getBulkInserter()
Returns a bulk insert operation object for the data provider.
DbDataProvider::DbTableRecordIterator
Defines the record iterator class for Table-based iterators.
Definition DbTableRecordIterator.qc.dox.h:28
DbDataProvider
Qore AbstractDbRecordIterator class definition.
Definition AbstractDbRecordIterator.qc.dox.h:26