Qore SchemaReverse Module Reference 1.1
Loading...
Searching...
No Matches
SchemaReverse.qm.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
4/* SchemaReverse.qm Copyright 2016 - 2023 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FORANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23*/
24
25// this module requires Qore 0.8.13 or better
26
27// requires the SqlUtil module
28
29// requires the Util module
30
31// requires the Qorize module
32
33
34
35
124namespace SchemaReverse {
125
127 const TYPE_TO_CLASS = ...;
128
129
131 const MULTI_TO_CLASS = ...;
132
133
135 const TEMPLATE = ...;
136
137
139
146
147public:
148protected:
149 AbstractDatasource m_ds;
150 Database m_db;
151 string m_name;
152
153public:
154
159 constructor(AbstractDatasource ds, string name);
160
161
163 AbstractDatasource datasource();
164
165
167 Database database();
168
169
171 string name();
172
173
175
178 abstract any toQore();
179
181
183 string toString();
184
185 }; // class AbstractReverseObject
186
189
190public:
194 constructor(AbstractDatasource ds, string name) ;
195
196
197 hash toQore();
198
199 }; // class SequenceReverse
200
202
205
206public:
210 constructor(AbstractDatasource ds, string mask = '.*') ;
211
212
213 hash toQore();
214
215 }; // class SequencesReverse
216
219
220public:
224 constructor(AbstractDatasource ds, string name) ;
225
226
227 hash toQore();
228
229 }; // class TypeReverse
230
233
234public:
238 constructor(AbstractDatasource ds, string mask = '.*') ;
239
240
241 hash toQore();
242
243 }; // class TypesReverse
244
247
248public:
252 constructor(AbstractDatasource ds, string name) ;
253
254
255 hash toQore();
256
257
258 any columnToQore(AbstractColumn c);
259
260
261 }; // class TableReverse
262
265
266public:
270 constructor(AbstractDatasource ds, string mask = '.*') ;
271
272
273 hash toQore();
274
275 }; // class TablesReverse
276
278
283
284public:
285protected:
286 string m_object_type;
287 string m_function_name;
288 hash<string, bool> m_ignored_keys;
289
290public:
291
298 constructor(string object_type, AbstractDatasource ds, string name, string function_name, softlist ignored_keys )
299 ;
300
301
302 hash toQore();
303
304 }; // class CodeBaseReverse
305
307
312
313public:
314protected:
315 string m_object_type;
316 string m_function_name;
317
318public:
319
325 constructor(string object_type, AbstractDatasource ds, string mask, string function_name, )
326 ;
327
328
329 hash toQore();
330
331 }; // class CodeBaseReverse
332
335
336public:
340 constructor(AbstractDatasource ds, string name) ;
341
342 }; // class ViewReverse
343
346
347public:
351 constructor(AbstractDatasource ds, string mask = '.*') ;
352
353 }; // class ViewsReverse
354
357
358public:
362 constructor(AbstractDatasource ds, string name) ;
363
364 }; // class MViewReverse
365
368
369public:
373 constructor(AbstractDatasource ds, string mask = '.*') ;
374
375 }; // class MViewsReverse
376
379
380public:
384 constructor(AbstractDatasource ds, string name) ;
385
386
387 string toQore();
388
389 }; // class FunctionReverse
390
393
394public:
398 constructor(AbstractDatasource ds, string mask = '.*') ;
399
400 }; // class FunctionsReverse
401
404
405public:
409 constructor(AbstractDatasource ds, string name) ;
410
411
412 string toQore();
413
414 }; // class ProcedureReverse
415
418
419public:
423 constructor(AbstractDatasource ds, string mask = '.*') ;
424
425 }; // class ProceduresReverse
426
429
430public:
434 constructor(AbstractDatasource ds, string name) ;
435
436
437 hash toQore();
438
439 }; // class ProcedureReverse
440
443
444public:
448 constructor(AbstractDatasource ds, string mask = '.*') ;
449
450 }; // class ProceduresReverse
451
454
455public:
456protected:
457 AbstractDatasource m_ds;
458 string m_class_name;
459
460public:
461
465 constructor(AbstractDatasource ds, string class_name);
466
467
468 string toString();
469
470
471 }; // class SchemaReverse
472
474
480
481
482}; // namespace SchemaReverse
A basic class for all SchemaReverse DB object related classes.
Definition: SchemaReverse.qm.dox.h:145
abstract any toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
string toString()
Make a string with Qore code from a structure prepared by AbstractReverseObject::toQore().
constructor(AbstractDatasource ds, string name)
A basic class for all DB object classes which use SQL code as base of its content.
Definition: SchemaReverse.qm.dox.h:282
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(string object_type, AbstractDatasource ds, string name, string function_name, softlist ignored_keys)
A basic class for all DB object classes which use SQL code as base of its content.
Definition: SchemaReverse.qm.dox.h:311
constructor(string object_type, AbstractDatasource ds, string mask, string function_name,)
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
Structure dump of a function.
Definition: SchemaReverse.qm.dox.h:378
string toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string name)
Structure dump of functions.
Definition: SchemaReverse.qm.dox.h:392
constructor(AbstractDatasource ds, string mask='.*')
Structure dump of a materialized view or snapshot.
Definition: SchemaReverse.qm.dox.h:356
constructor(AbstractDatasource ds, string name)
Structure dump of materialized views or snapshots.
Definition: SchemaReverse.qm.dox.h:367
constructor(AbstractDatasource ds, string mask='.*')
Structure dump of a package.
Definition: SchemaReverse.qm.dox.h:428
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string name)
Structure dump of packages.
Definition: SchemaReverse.qm.dox.h:442
constructor(AbstractDatasource ds, string mask='.*')
Structure dump of a procedure.
Definition: SchemaReverse.qm.dox.h:403
constructor(AbstractDatasource ds, string name)
string toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
Structure dump of procedures.
Definition: SchemaReverse.qm.dox.h:417
constructor(AbstractDatasource ds, string mask='.*')
constructor(AbstractDatasource ds, string class_name)
Structure dump of a sequence.
Definition: SchemaReverse.qm.dox.h:188
constructor(AbstractDatasource ds, string name)
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
Structure dump of sequences.
Definition: SchemaReverse.qm.dox.h:204
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string mask='.*')
Structure dump of a table.
Definition: SchemaReverse.qm.dox.h:246
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string name)
Structure dump of tables.
Definition: SchemaReverse.qm.dox.h:264
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string mask='.*')
Structure dump of a 'type' or 'named type'.
Definition: SchemaReverse.qm.dox.h:218
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string name)
Structure dump of 'types' or 'named types'.
Definition: SchemaReverse.qm.dox.h:232
hash toQore()
Dedicated functionlity to get DB object info into the internal structure is done here.
constructor(AbstractDatasource ds, string mask='.*')
Structure dump of a view.
Definition: SchemaReverse.qm.dox.h:334
constructor(AbstractDatasource ds, string name)
Structure dump of views.
Definition: SchemaReverse.qm.dox.h:345
constructor(AbstractDatasource ds, string mask='.*')
this namespace contains all public definitions in the SchemaReverse module
Definition: SchemaReverse.qm.dox.h:124
const TEMPLATE
A template string for full schema used in SchemaReverse::SchemaReverse class.
Definition: SchemaReverse.qm.dox.h:135
const TYPE_TO_CLASS
A map translating simple DB object name into its class.
Definition: SchemaReverse.qm.dox.h:127
AbstractReverseObject get_object(string object_type)
An universal wrapper to get any of SchemaReverse::AbstractReverseObject instance.
const MULTI_TO_CLASS
A map translating multi DB objects name into its class.
Definition: SchemaReverse.qm.dox.h:131