1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>ODB 2.4.0 Compiler Command Line Manual</title>
<meta name="copyright" content="© 2009-2015 Code Synthesis Tools CC"/>
<meta name="keywords" content="odb,object,relational,mapping,compiler,c++"/>
<meta name="description" content="ODB Compiler Command Line Manual"/>
<link rel="stylesheet" type="text/css" href="default.css" />
<style type="text/css">
#synopsis {
list-style-type: none;
}
#synopsis li {
padding-top : 0.0em;
padding-bottom : 0.0em;
}
#commands dt {
padding-top : 0.4em;
}
#commands dd {
padding-bottom : 0.4em;
padding-left : 2em;
}
.options dt {
padding-top : 0.4em;
}
.options dd {
padding-top : 0.1em;
padding-bottom : 0.4em;
padding-left : 1.4em;
}
</style>
</head>
<body>
<div id="container">
<div id="content">
<h1>NAME</h1>
<p>odb - object-relational mapping (ORM) compiler for C++</p>
<h1>SYNOPSIS</h1>
<dl id="synopsis">
<dt><code><b>odb</b> [<i>options</i>] <i>file</i> [<i>file</i>...]</code></dt>
</dl>
<h1>DESCRIPTION</h1>
<p>Given a set of C++ classes in a header file, <code><b>odb</b></code>
generates C++ code that allows you to persist, query, and update objects
of these classes in a relational database (RDBMS). The relational
database that the generated code should target is specified with the
required <code><b>--database</b></code> option (see below).</p>
<p>For an input file in the form <code><b>name.hxx</b></code> (other
file extensions can be used instead of <code><b>.hxx</b></code>),
in the single-database mode (the default), the generated C++ files
by default have the following names:
<code><b>name-odb.hxx</b></code> (header file),
<code><b>name-odb.ixx</b></code> (inline file), and
<code><b>name-odb.cxx</b></code> (source file).
Additionally, if the <code><b>--generate-schema</b></code> option is
specified and the <code><b>sql</b></code> schema format is requested (see
<code><b>--schema-format</b></code>), the <code><b>name.sql</b></code>
database schema file is generated. If the <code><b>separate</b></code>
schema format is requested, the database creation code is generated
into the separate <code><b>name-schema.cxx</b></code> file.</p>
<p>In the multi-database mode (see the <code><b>--multi-database</b></code>
option below), the generated files corresponding to the
<code><b>common</b></code> database have the same names as in the
single-database mode. For other databases, the file names include
the database name:
<code><b>name-odb-</b><i>db</i><b>.hxx</b></code>,
<code><b>name-odb-</b><i>db</i><b>.ixx</b></code>,
<code><b>name-odb-</b><i>db</i><b>.cxx</b></code>,
<code><b>name-</b><i>db</i><b>.sql</b></code>, and
<code><b>name-schema-</b><i>db</i><b>.cxx</b></code>
(where <code><i>db</i></code> is the database name).</p>
<h1>OPTIONS</h1>
<!--
The following documentation was generated by CLI, a command
line interface compiler for C++.
-->
<dl class="options">
<dt><code><b>--help</b></code></dt>
<dd>Print usage information and exit.</dd>
<dt><code><b>--version</b></code></dt>
<dd>Print version and exit.</dd>
<dt><code><b>-I</b></code> <i>dir</i></dt>
<dd>Add <i>dir</i> to the beginning of the list of directories to be searched
for included header files.</dd>
<dt><code><b>-D</b></code> <i>name</i>[=<i>def</i>]</dt>
<dd>Define macro <i>name</i> with definition <i>def</i>. If definition is
omitted, define <i>name</i> to be 1.</dd>
<dt><code><b>-U</b></code> <i>name</i></dt>
<dd>Cancel any previous definitions of macro <i>name</i>, either built-in or
provided with the <code><b>-D</b></code> option.</dd>
<dt><code><b>--database</b></code>|<code><b>-d</b></code> <i>db</i></dt>
<dd>Generate code for the <i>db</i> database. Valid values are
<code><b>mssql</b></code>, <code><b>mysql</b></code>,
<code><b>oracle</b></code>, <code><b>pgsql</b></code>,
<code><b>sqlite</b></code>, and <code><b>common</b></code> (multi-database
mode only).</dd>
<dt><code><b>--multi-database</b></code>|<code><b>-m</b></code> <i>type</i></dt>
<dd>Enable multi-database support and specify its type. Valid values for this
option are <code><b>static</b></code> and <code><b>dynamic</b></code>.
<p>In the multi-database mode, options that determine the kind (for example,
<code><b>--schema-format</b></code>), names (for example,
<code><b>--odb-file-suffix</b></code>), or content (for example, prologue
and epilogue options) of the output files can be prefixed with the database
name followed by a colon, for example, <code><b>mysql:value</b></code>. This
restricts the value of such an option to only apply to generated files
corresponding to this database.</p></dd>
<dt><code><b>--default-database</b></code> <i>db</i></dt>
<dd>When static multi-database support is used, specify the database that should
be made the default. When dynamic multi-database support is used,
<code><b>common</b></code> is always made the default database.</dd>
<dt><code><b>--generate-query</b></code>|<code><b>-q</b></code></dt>
<dd>Generate query support code. Without this support you cannot use views and
can only load objects via their ids.</dd>
<dt><code><b>--generate-prepared</b></code></dt>
<dd>Generate prepared query execution support code.</dd>
<dt><code><b>--omit-unprepared</b></code></dt>
<dd>Omit un-prepared (once-off) query execution support code.</dd>
<dt><code><b>--generate-session</b></code>|<code><b>-e</b></code></dt>
<dd>Generate session support code. With this option session support will be
enabled by default for all the persistent classes except those for which it
was explicitly disabled using the <code><b>db session</b></code> pragma.</dd>
<dt><code><b>--generate-schema</b></code>|<code><b>-s</b></code></dt>
<dd>Generate the database schema. The database schema contains SQL statements
that create database tables necessary to store persistent classes defined in
the file being compiled. Note that by applying this schema, all the existing
information stored in such tables will be lost.
<p>Depending on the database being used (<code><b>--database</b></code>
option), the schema is generated either as a standalone SQL file or embedded
into the generated C++ code. By default the SQL file is generated for the
MySQL, PostgreSQL, Oracle, and Microsoft SQL Server databases and the schema
is embedded into the C++ code for the SQLite database. Use the
<code><b>--schema-format</b></code> option to alter the default schema
format.</p>
<p>If database schema evolution support is enabled (that is, the object
model version is specified), then this option also triggers the generation
of database schema migration statements, again either as standalong SQL
files or embedded into the generated C++ code. You can suppress the
generation of schema migration statements by specifying the
<code><b>--suppress-migration</b></code> option.</p></dd>
<dt><code><b>--generate-schema-only</b></code></dt>
<dd>Generate only the database schema. Note that this option is only valid when
generating schema as a standalone SQL file (see
<code><b>--schema-format</b></code> for details).</dd>
<dt><code><b>--suppress-migration</b></code></dt>
<dd>Suppress the generation of database schema migration statements.</dd>
<dt><code><b>--suppress-schema-version</b></code></dt>
<dd>Suppress the generation of schema version table. If you specify this option
then you are also expected to manually specify the database schema version
and migration state at runtime using the
<code><b>odb::database::schema_version()</b></code> function.</dd>
<dt><code><b>--schema-version-table</b></code> <i>name</i></dt>
<dd>Specify the alternative schema version table name instead of the default
<code><b>schema_version</b></code>. If you specify this option then you are
also expected to manually specify the schema version table name at runtime
using the <code><b>odb::database::schema_version_table()</b></code>
function. The table name can be qualified.</dd>
<dt><code><b>--schema-format</b></code> <i>format</i></dt>
<dd>Generate the database schema in the specified format. Pass
<code><b>sql</b></code> as <i>format</i> to generate the database schema as
a standalone SQL file or pass <code><b>embedded</b></code> to embed the
schema into the generated C++ code. The <code><b>separate</b></code> value
is similar to <code><b>embedded</b></code> except the schema creation code
is generated into a separate C++ file (<code><b>name-schema.cxx</b></code>
by default). This value is primarily useful if you want to place the schema
creation functionality into a separate program or library. Repeat this
option to generate the same database schema in multiple formats.</dd>
<dt><code><b>--omit-drop</b></code></dt>
<dd>Omit <code><b>DROP</b></code> statements from the generated database schema.</dd>
<dt><code><b>--omit-create</b></code></dt>
<dd>Omit <code><b>CREATE</b></code> statements from the generated database
schema.</dd>
<dt><code><b>--schema-name</b></code> <i>name</i></dt>
<dd>Use <i>name</i> as the database schema name. Schema names are primarily used
to distinguish between multiple embedded schemas in the schema catalog. They
are not to be confused with database schemas (database namespaces) which are
specified with the <code><b>--schema</b></code> option. If this option is
not specified, the empty name, which is the default schema name, is used.</dd>
<dt><code><b>--fkeys-deferrable-mode</b></code> <i>m</i></dt>
<dd>Use constraint checking mode <i>m</i> in foreign keys generated for object
relationships. Valid values for this option are
<code><b>not_deferrable</b></code>, <code><b>immediate</b></code>, and
<code><b>deferred</b></code> (default). MySQL and SQL Server do not support
deferrable foreign keys and for these databases such keys are generated
commented out. Other foreign keys generated by the ODB compiler (such as the
ones used to support containers and polymorphic hierarchies) are always
generated as not deferrable.
<p>Note also that if you use either <code><b>not_deferrable</b></code> or
<code><b>immediate</b></code> mode, then the order in which you persist,
update, and erase objects within a transaction becomes important.</p></dd>
<dt><code><b>--default-pointer</b></code> <i>ptr</i></dt>
<dd>Use <i>ptr</i> as the default pointer for persistent objects and views.
Objects and views that do not have a pointer assigned with the <code><b>db
pointer</b></code> pragma will use this pointer by default. The value of
this option can be <code><b>*</b></code> which denotes the raw pointer and
is the default, or qualified name of a smart pointer class template, for
example, <code><b>std::auto_ptr</b></code>. In the latter case, the ODB
compiler constructs the object or view pointer by adding a single template
argument of the object or view type to the qualified name, for example
<code><b>std::auto_ptr<object></b></code>. The ODB runtime uses object
and view pointers to return, and, in case of objects, pass and cache
dynamically allocated instances of object and view types.
<p>Except for the raw pointer and the standard smart pointers defined in the
<code><b><memory></b></code> header file, you are expected to include the
definition of the default pointer at the beginning of the generated header
file. There are two common ways to achieve this: you can either include the
necessary header in the file being compiled or you can use the
<code><b>--hxx-prologue</b></code> option to add the necessary
<code><b>#include</b></code> directive to the generated code.</p></dd>
<dt><code><b>--session-type</b></code> <i>type</i></dt>
<dd>Use <i>type</i> as the alternative session type instead of the default
<code><b>odb::session</b></code>. This option can be used to specify a
custom session implementation to be use by the persistent classes. Note that
you will also need to include the definition of the custom session type into
the generated header file. This is normally achieved with the
<code><b>--hxx-prologue*</b></code> options.</dd>
<dt><code><b>--profile</b></code>|<code><b>-p</b></code> <i>name</i></dt>
<dd>Specify a profile that should be used during compilation. A profile is an
options file. The ODB compiler first looks for a database-specific version
with the name constructed by appending the
<code><b>-</b></code><code><i>database</i></code><code><b>.options</b></code>
suffix to <i>name</i>, where <code><i>database</i></code> is the database
name as specified with the <code><b>--database</b></code> option. If this
file is not found, then the ODB compiler looks for a database-independant
version with the name constructed by appending just the
<code><b>.options</b></code> suffix.
<p>The profile options files are searched for in the same set of directories
as C++ headers included with the <code><b>#include <...></b></code>
directive (built-in paths plus those specified with the
<code><b>-I</b></code> options). The options file is first searched for in
the directory itself and then in its <code><b>odb/</b></code>
subdirectory.</p>
<p>For the format of the options file refer to the
<code><b>--options-file</b></code> option below. You can repeat this option
to specify more than one profile.</p></dd>
<dt><code><b>--at-once</b></code></dt>
<dd>Generate code for all the input files as well as for all the files that they
include at once. The result is a single set of source/schema files that
contain all the generated code. If more than one input file is specified
together with this option, then the <code><b>--input-name</b></code> option
must also be specified in order to provide the base name for the output
files. In this case, the directory part of such a base name is used as the
location of the combined file. This can be important for the
<code><b>#include</b></code> directive resolution.</dd>
<dt><code><b>--schema</b></code> <i>schema</i></dt>
<dd>Specify a database schema (database namespace) that should be assigned to
the persistent classes in the file being compiled. Database schemas are not
to be confused with database schema names (schema catalog names) which are
specified with the <code><b>--schema-name</b></code> option.</dd>
<dt><code><b>--export-symbol</b></code> <i>symbol</i></dt>
<dd>Insert <i>symbol</i> in places where DLL export/import control statements
(<code><b>__declspec(dllexport/dllimport)</b></code>) are necessary. See
also the <code><b>--extern-symbol</b></code> option below.</dd>
<dt><code><b>--extern-symbol</b></code> <i>symbol</i></dt>
<dd>If <i>symbol</i> is defined, insert it in places where a template
instantiation must be declared <code><b>extern</b></code>. This option is
normally used together with <code><b>--export-symbol</b></code> when both
multi-database support and queries are enabled.</dd>
<dt><code><b>--std</b></code> <i>version</i></dt>
<dd>Specify the C++ standard that should be used during compilation. Valid
values are <code><b>c++98</b></code> (default), <code><b>c++11</b></code>,
and <code><b>c++14</b></code>.</dd>
<dt><code><b>--warn-hard-add</b></code></dt>
<dd>Warn about hard-added data members.</dd>
<dt><code><b>--warn-hard-delete</b></code></dt>
<dd>Warn about hard-deleted data members and persistent classes.</dd>
<dt><code><b>--warn-hard</b></code></dt>
<dd>Warn about both hard-added and hard-deleted data members and persistent
classes.</dd>
<dt><code><b>--output-dir</b></code>|<code><b>-o</b></code> <i>dir</i></dt>
<dd>Write the generated files to <i>dir</i> instead of the current directory.</dd>
<dt><code><b>--input-name</b></code> <i>name</i></dt>
<dd>Use <i>name</i> instead of the input file to derive the names of the
generated files. If the <code><b>--at-once</b></code> option is specified,
then the directory part of <i>name</i> is used as the location of the
combined file. Refer to the <code><b>--at-once</b></code> option for
details.</dd>
<dt><code><b>--changelog</b></code> <i>file</i></dt>
<dd>Read/write changelog from/to <i>file</i> instead of the default changelog
file. The default changelog file name is derived from the input file name
and it is placed into the same directory as the input file. Note that the
<code><b>--output-dir</b></code> option does not affect the changelog file
location. In other words, by default, the changelog file is treated as
another input rather than output even though the ODB compiler may modify it.
Use the <code><b>--changelog-in</b></code> and
<code><b>--changelog-out</b></code> options to specify different input and
output chaneglog files.</dd>
<dt><code><b>--changelog-in</b></code> <i>file</i></dt>
<dd>Read changelog from <i>file</i> instead of the default changelog file. If
this option is specified, then you must also specify the output chanegelog
file with <code><b>--changelog-out</b></code>.</dd>
<dt><code><b>--changelog-out</b></code> <i>file</i></dt>
<dd>Write changelog to <i>file</i> instead of the default changelog file. If
this option is specified, then you must also specify the input chanegelog
file with <code><b>--changelog-in</b></code>.</dd>
<dt><code><b>--changelog-dir</b></code> <i>dir</i></dt>
<dd>Use <i>dir</i> instead of the input file directory as the changelog file
directory. This directory is also added to changelog files specified with
the <code><b>--changelog</b></code>, <code><b>--changelog-in</b></code>, and
<code><b>--changelog-in</b></code> options unless they are absolute paths.</dd>
<dt><code><b>--init-changelog</b></code></dt>
<dd>Force re-initialization of the changelog even if one exists (all the
existing change history will be lost). This option is primarily useful for
automated testing.</dd>
<dt><code><b>--odb-file-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> to construct the names of the generated C++ files. In the
single-database mode the default value for this option is
<code><b>-odb</b></code>. In the multi-database mode it is
<code><b>-odb</b></code> for the files corresponding to the
<code><b>common</b></code> database and <code><b>-odb-</b><i>db</i></code>
(where <code><i>db</i></code> is the database name) for other databases.</dd>
<dt><code><b>--sql-file-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> to construct the name of the generated schema SQL file. In
the single-database mode by default no suffix is used. In the multi-database
mode the default value for this option is <code><b>-</b><i>db</i></code>
(where <code><i>db</i></code> is the database name).</dd>
<dt><code><b>--schema-file-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> to construct the name of the generated schema C++ source
file. In the single-database mode the default value for this option is
<code><b>-schema</b></code>. In the multi-database mode it is
<code><b>-schema-</b><i>db</i></code> (where <code><i>db</i></code> is the
database name). See the <code><b>--schema-format</b></code> option for
details.</dd>
<dt><code><b>--changelog-file-suffix</b></code> <i>sfx</i></dt>
<dd>Use <i>sfx</i> to construct the name of the changelog file. In the
single-database mode by default no suffix is used. In the multi-database
mode the default value for this option is <code><b>-</b><i>db</i></code>
(where <code><i>db</i></code> is the database name).</dd>
<dt><code><b>--hxx-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>.hxx</b></code> to
construct the name of the generated C++ header file.</dd>
<dt><code><b>--ixx-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>.ixx</b></code> to
construct the name of the generated C++ inline file.</dd>
<dt><code><b>--cxx-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>.cxx</b></code> to
construct the name of the generated C++ source file.</dd>
<dt><code><b>--sql-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>.sql</b></code> to
construct the name of the generated database schema file.</dd>
<dt><code><b>--changelog-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>.xml</b></code> to
construct the name of the changelog file.</dd>
<dt><code><b>--hxx-prologue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the beginning of the generated C++ header file.</dd>
<dt><code><b>--ixx-prologue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the beginning of the generated C++ inline file.</dd>
<dt><code><b>--cxx-prologue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the beginning of the generated C++ source file.</dd>
<dt><code><b>--schema-prologue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the beginning of the generated schema C++ source file.</dd>
<dt><code><b>--sql-prologue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the beginning of the generated database schema file.</dd>
<dt><code><b>--migration-prologue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the beginning of the generated database migration
file.</dd>
<dt><code><b>--sql-interlude</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> after all the <code><b>DROP</b></code> and before any
<code><b>CREATE</b></code> statements in the generated database schema file.</dd>
<dt><code><b>--hxx-epilogue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the end of the generated C++ header file.</dd>
<dt><code><b>--ixx-epilogue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the end of the generated C++ inline file.</dd>
<dt><code><b>--cxx-epilogue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the end of the generated C++ source file.</dd>
<dt><code><b>--schema-epilogue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the end of the generated schema C++ source file.</dd>
<dt><code><b>--sql-epilogue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the end of the generated database schema file.</dd>
<dt><code><b>--migration-epilogue</b></code> <i>text</i></dt>
<dd>Insert <i>text</i> at the end of the generated database migration file.</dd>
<dt><code><b>--hxx-prologue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the beginning of the generated C++
header file.</dd>
<dt><code><b>--ixx-prologue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the beginning of the generated C++
inline file.</dd>
<dt><code><b>--cxx-prologue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the beginning of the generated C++
source file.</dd>
<dt><code><b>--schema-prologue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the beginning of the generated schema
C++ source file.</dd>
<dt><code><b>--sql-prologue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the beginning of the generated database
schema file.</dd>
<dt><code><b>--migration-prologue-file</b></code> <i>f</i></dt>
<dd>Insert the content of file <i>f</i> at the beginning of the generated
database migration file.</dd>
<dt><code><b>--sql-interlude-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> after all the <code><b>DROP</b></code> and
before any <code><b>CREATE</b></code> statements in the generated database
schema file.</dd>
<dt><code><b>--hxx-epilogue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the end of the generated C++ header
file.</dd>
<dt><code><b>--ixx-epilogue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the end of the generated C++ inline
file.</dd>
<dt><code><b>--cxx-epilogue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the end of the generated C++ source
file.</dd>
<dt><code><b>--schema-epilogue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the end of the generated schema C++
source file.</dd>
<dt><code><b>--sql-epilogue-file</b></code> <i>file</i></dt>
<dd>Insert the content of <i>file</i> at the end of the generated database
schema file.</dd>
<dt><code><b>--migration-epilogue-file</b></code> <i>f</i></dt>
<dd>Insert the content of file <i>f</i> at the end of the generated database
migration file.</dd>
<dt><code><b>--odb-prologue</b></code> <i>text</i></dt>
<dd>Compile <i>text</i> before the input header file. This option allows you to
add additional declarations, such as custom traits specializations, to the
ODB compilation process.</dd>
<dt><code><b>--odb-prologue-file</b></code> <i>file</i></dt>
<dd>Compile <i>file</i> contents before the input header file. Prologue files
are compiled after all the prologue text fragments
(<code><b>--odb-prologue</b></code> option).</dd>
<dt><code><b>--odb-epilogue</b></code> <i>text</i></dt>
<dd>Compile <i>text</i> after the input header file. This option allows you to
add additional declarations, such as custom traits specializations, to the
ODB compilation process.</dd>
<dt><code><b>--odb-epilogue-file</b></code> <i>file</i></dt>
<dd>Compile <i>file</i> contents after the input header file. Epilogue files are
compiled after all the epilogue text fragments
(<code><b>--odb-epilogue</b></code> option).</dd>
<dt><code><b>--table-prefix</b></code> <i>prefix</i></dt>
<dd>Add <i>prefix</i> to table names and, for databases that have global index
and/or foreign key names, to those names as well. The prefix is added to
both names that were specified with the <code><b>db table</b></code> and
<code><b>db index</b></code> pragmas and those that were automatically
derived from class and data member names. If you require a separator, such
as an underscore, between the prefix and the name, then you should include
it into the prefix value.</dd>
<dt><code><b>--index-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>_i</b></code> to construct
index names. The suffix is only added to names that were automatically
derived from data member names. If you require a separator, such as an
underscore, between the name and the suffix, then you should include it into
the suffix value.</dd>
<dt><code><b>--fkey-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>_fk</b></code> to
construct foreign key names. If you require a separator, such as an
underscore, between the name and the suffix, then you should include it into
the suffix value.</dd>
<dt><code><b>--sequence-suffix</b></code> <i>suffix</i></dt>
<dd>Use <i>suffix</i> instead of the default <code><b>_seq</b></code> to
construct sequence names. If you require a separator, such as an underscore,
between the name and the suffix, then you should include it into the suffix
value.</dd>
<dt><code><b>--sql-name-case</b></code> <i>case</i></dt>
<dd>Convert all automatically-derived SQL names to upper or lower case. Valid
values for this option are <code><b>upper</b></code> and
<code><b>lower</b></code>.</dd>
<dt><code><b>--table-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform automatically-derived table names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--column-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform automatically-derived column names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--index-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform automatically-derived index names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--fkey-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform automatically-derived foreign key names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--sequence-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform automatically-derived sequence names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--statement-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform automatically-derived prepared statement names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--sql-name-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions that is used to
transform all automatically-derived SQL names. See the SQL NAME
TRANSFORMATIONS section below for details.</dd>
<dt><code><b>--sql-name-regex-trace</b></code></dt>
<dd>Trace the process of applying regular expressions specified with the SQL
name <code><b>--*-regex</b></code> options. Use this option to find out why
your regular expressions don't do what you expected them to do.</dd>
<dt><code><b>--accessor-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions used to transform data
member names to function names when searching for a suitable accessor
function. The argument to this option is a Perl-like regular expression in
the form
<code><b>/</b><i>pattern</i><b>/</b><i>replacement</i><b>/</b></code>. Any
character can be used as a delimiter instead of <code><b>/</b></code> and
the delimiter can be escaped inside <code><i>pattern</i></code> and
<code><i>replacement</i></code> with a backslash (<code><b>\</b></code>).
You can specify multiple regular expressions by repeating this option.
<p>All the regular expressions are tried in the order specified and the
first expression that produces a suitable accessor function is used. Each
expression is tried twice: first with the actual member name and then with
the member's <i>public name</i> which is obtained by removing the common
member name decorations, such as leading and trailing underscores, the
<code><b>m_</b></code> prefix, etc. The ODB compiler also includes a number
of built-in expressions for commonly used accessor names, such as
<code><b>get_foo</b></code>, <code><b>getFoo</b></code>,
<code><b>getfoo</b></code>, and just <code><b>foo</b></code>. The built-in
expressions are tried last.</p>
<p>As an example, the following expression transforms data members with
public names in the form <code><b>foo</b></code> to accessor names in the
form <code><b>GetFoo</b></code>:</p>
<p><code><b>/(.+)/Get\u$1/</b></code></p>
<p>See also the REGEX AND SHELL QUOTING section below.</p></dd>
<dt><code><b>--accessor-regex-trace</b></code></dt>
<dd>Trace the process of applying regular expressions specified with the
<code><b>--accessor-regex</b></code> option. Use this option to find out why
your regular expressions don't do what you expected them to do.</dd>
<dt><code><b>--modifier-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions used to transform data
member names to function names when searching for a suitable modifier
function. The argument to this option is a Perl-like regular expression in
the form
<code><b>/</b><i>pattern</i><b>/</b><i>replacement</i><b>/</b></code>. Any
character can be used as a delimiter instead of <code><b>/</b></code> and
the delimiter can be escaped inside <code><i>pattern</i></code> and
<code><i>replacement</i></code> with a backslash (<code><b>\</b></code>).
You can specify multiple regular expressions by repeating this option.
<p>All the regular expressions are tried in the order specified and the
first expression that produces a suitable modifier function is used. Each
expression is tried twice: first with the actual member name and then with
the member's <i>public name</i> which is obtained by removing the common
member name decorations, such as leading and trailing underscores, the
<code><b>m_</b></code> prefix, etc. The ODB compiler also includes a number
of built-in expressions for commonly used modifier names, such as
<code><b>set_foo</b></code>, <code><b>setFoo</b></code>,
<code><b>setfoo</b></code>, and just <code><b>foo</b></code>. The built-in
expressions are tried last.</p>
<p>As an example, the following expression transforms data members with
public names in the form <code><b>foo</b></code> to modifier names in the
form <code><b>SetFoo</b></code>:</p>
<p><code><b>/(.+)/Set\u$1/</b></code></p>
<p>See also the REGEX AND SHELL QUOTING section below.</p></dd>
<dt><code><b>--modifier-regex-trace</b></code></dt>
<dd>Trace the process of applying regular expressions specified with the
<code><b>--modifier-regex</b></code> option. Use this option to find out why
your regular expressions don't do what you expected them to do.</dd>
<dt><code><b>--include-with-brackets</b></code></dt>
<dd>Use angle brackets (<>) instead of quotes ("") in the generated
<code><b>#include</b></code> directives.</dd>
<dt><code><b>--include-prefix</b></code> <i>prefix</i></dt>
<dd>Add <i>prefix</i> to the generated <code><b>#include</b></code> directive
paths.</dd>
<dt><code><b>--include-regex</b></code> <i>regex</i></dt>
<dd>Add <i>regex</i> to the list of regular expressions used to transform
generated <code><b>#include</b></code> directive paths. The argument to this
option is a Perl-like regular expression in the form
<code><b>/</b><i>pattern</i><b>/</b><i>replacement</i><b>/</b></code>. Any
character can be used as a delimiter instead of <code><b>/</b></code> and
the delimiter can be escaped inside <code><i>pattern</i></code> and
<code><i>replacement</i></code> with a backslash (<code><b>\</b></code>).
You can specify multiple regular expressions by repeating this option. All
the regular expressions are tried in the order specified and the first
expression that matches is used.
<p>As an example, the following expression transforms include paths in the
form <code><b>foo/bar-odb.h</b></code> to paths in the form
<code><b>foo/generated/bar-odb.h</b></code>:</p>
<p><code><b>%foo/(.+)-odb.h%foo/generated/$1-odb.h%</b></code></p>
<p>See also the REGEX AND SHELL QUOTING section below.</p></dd>
<dt><code><b>--include-regex-trace</b></code></dt>
<dd>Trace the process of applying regular expressions specified with the
<code><b>--include-regex</b></code> option. Use this option to find out why
your regular expressions don't do what you expected them to do.</dd>
<dt><code><b>--guard-prefix</b></code> <i>prefix</i></dt>
<dd>Add <i>prefix</i> to the generated header inclusion guards. The prefix is
transformed to upper case and characters that are illegal in a preprocessor
macro name are replaced with underscores.</dd>
<dt><code><b>--show-sloc</b></code></dt>
<dd>Print the number of generated physical source lines of code (SLOC).</dd>
<dt><code><b>--sloc-limit</b></code> <i>num</i></dt>
<dd>Check that the number of generated physical source lines of code (SLOC) does
not exceed <i>num</i>.</dd>
<dt><code><b>--options-file</b></code> <i>file</i></dt>
<dd>Read additional options from <i>file</i> with each option appearing on a
separate line optionally followed by space and an option value. Empty lines
and lines starting with <code><b>#</b></code> are ignored. Option values can
be enclosed in double (<code><b>"</b></code>) or single
(<code><b>'</b></code>) quotes to preserve leading and trailing whitespaces
as well as to specify empty values. If the value itself contains trailing or
leading quotes, enclose it with an extra pair of quotes, for example
<code><b>'"x"'</b></code>. Non-leading and non-trailing quotes are
interpreted as being part of the option value.
<p>The semantics of providing options in a file is equivalent to providing
the same set of options in the same order on the command line at the point
where the <code><b>--options-file</b></code> option is specified except that
the shell escaping and quoting is not required. You can repeat this option
to specify more than one options file.</p></dd>
<dt><code><b>-x</b></code> <i>option</i></dt>
<dd>Pass <i>option</i> to the underlying C++ compiler (<code><b>g++</b></code>).
The <i>option</i> value that doesn't start with <code><b>-</b></code> is
considered the <code><b>g++</b></code> executable name.</dd>
<dt><code><b>-v</b></code></dt>
<dd>Print the commands executed to run the stages of compilation.</dd>
<dt><code><b>--trace</b></code></dt>
<dd>Trace the compilation process.</dd>
<dt><code><b>--mysql-engine</b></code> <i>engine</i></dt>
<dd>Use <i>engine</i> instead of the default <code><b>InnoDB</b></code> in the
generated database schema file. For more information on the storage engine
options see the MySQL documentation. If you would like to use the
database-default engine, pass <code><b>default</b></code> as the value for
this option.</dd>
<dt><code><b>--sqlite-override-null</b></code></dt>
<dd>Make all columns in the generated database schema allow
<code><b>NULL</b></code> values. This is primarily useful in schema
migration since SQLite does not support dropping of columns. By making all
columns <code><b>NULL</b></code> we can later "delete" them by setting their
values to <code><b>NULL</b></code>. Note that this option overrides even the
<code><b>not_null</b></code> pragma.</dd>
<dt><code><b>--sqlite-lax-auto-id</b></code></dt>
<dd>Do not force monotonically increasing automatically-assigned object ids. In
this mode the generated database schema omits the
<code><b>AUTOINCREMENT</b></code> keyword which results in faster object
persistence but may lead to automatically-assigned ids not being in a
strictly ascending order. Refer to the SQLite documentation for details.</dd>
<dt><code><b>--pgsql-server-version</b></code> <i>ver</i></dt>
<dd>Specify the minimum PostgreSQL server version with which the generated C++
code and schema will be used. This information is used to enable
version-specific optimizations and workarounds in the generated C++ code and
schema. The version must be in the
<code><i>major</i><b>.</b><i>minor</i></code> form, for example,
<code><b>9.1</b></code>. If this option is not specified, then
<code><b>7.4</b></code> or later is assumed.</dd>
<dt><code><b>--oracle-client-version</b></code> <i>ver</i></dt>
<dd>Specify the minimum Oracle client library (OCI) version with which the
generated C++ code will be linked. This information is used to enable
version-specific optimizations and workarounds in the generated C++ code.
The version must be in the <code><i>major</i><b>.</b><i>minor</i></code>
form, for example, <code><b>11.2</b></code>. If this option is not
specified, then <code><b>10.1</b></code> or later is assumed.</dd>
<dt><code><b>--oracle-warn-truncation</b></code></dt>
<dd>Warn about SQL names that are longer than 30 characters and are therefore
truncated. Note that during database schema generation
(<code><b>--generate-schema</b></code>) ODB detects when such truncations
lead to name conflicts and issues diagnostics even without this option
specified.</dd>
<dt><code><b>--mssql-server-version</b></code> <i>ver</i></dt>
<dd>Specify the minimum SQL Server server version with which the generated C++
code and schema will be used. This information is used to enable
version-specific optimizations and workarounds in the generated C++ code and
schema. The version must be in the
<code><i>major</i><b>.</b><i>minor</i></code> form, for example,
<code><b>9.0</b></code> (SQL Server 2005), <code><b>10.5</b></code>
(2008R2), or <code><b>11.0</b></code> (2012). If this option is not
specified, then <code><b>10.0</b></code> (SQL Server 2008) or later is
assumed.</dd>
<dt><code><b>--mssql-short-limit</b></code> <i>size</i></dt>
<dd>Specify the short data size limit. If a character, national character, or
binary data type has a maximum length (in bytes) less than or equal to this
limit, then it is treated as <i>short data</i>, otherwise it is <i>long
data</i>. For short data ODB pre-allocates an intermediate buffer of the
maximum size and binds it directly to a parameter or result column. This way
the underlying API (ODBC) can read/write directly from/to this buffer. In
the case of long data, the data is read/written in chunks using the
<code><b>SQLGetData()</b></code>/<code><b>SQLPutData()</b></code> ODBC
functions. While the long data approach reduces the amount of memory used by
the application, it may require greater CPU resources. The default short
data limit is 1024 bytes. When setting a custom short data limit, make sure
that it is sufficiently large so that no object id in the application is
treated as long data.</dd>
</dl>
<h1>SQL NAME TRANSFORMATIONS</h1>
<p>The ODB compiler provides a number of mechanisms for transforming
automatically-derived SQL names, such as tables, columns, etc.,
to match a specific naming convention. At the higher level, we can
add a prefix to global names (tables and, for some databases,
indexes and/or foreign keys) with the <code><b>--table-prefix</b></code>
option. Similarly, we can specify custom suffixes for
automatically-derived
index (<code><b>--index-suffix</b></code>; default is <code><b>_i</b></code>),
foreign key (<code><b>--fkey-suffix</b></code>; default is <code><b>_fk</b></code>), and
sequence (<code><b>--sequence-suffix</b></code>; default is <code><b>_seq</b></code>)
names. Finally, we can also convert all the names to upper or lower
case with the <code><b>--sql-name-case</b></code> option (valid values
are <code><b>upper</b></code> and <code><b>lower</b></code>).</p>
<p>At the lower level we can specify a set of regular expressions to
implement arbitrary transformations of the automatically-derived SQL
names. If we want a particular regular expression only to apply to
a specific name, for example, table or column, then we use one of the
<code><b>--</b><i>kind</i><b>-regex</b></code> options, where
<code><i>kind</i></code> can be <code><b>table</b></code>,
<code><b>column</b></code>, <code><b>index</b></code>,
<code><b>fkey</b></code>, <code><b>sequence</b></code>, or
<code><b>statement</b></code>. On the other hand, if we want our
regular expressions to apply to all SQL names, then we use the
<code><b>--sql-name-regex</b></code> option.</p>
<p>The interaction between the higher and lower level transformations
is as follows. Prefixes and suffixes are added first. Then the
regular expression transformations are applied. Finally, if requested,
the name is converted to upper or lower case. Note also that all of
these transformations except for <code><b>--table-prefix</b></code>
only apply to automatically-derived names. In other words, if a table,
column, etc., name was explicitly specified with a pragma, then it
is used as is, without applying any (except for the table prefix)
transformations.</p>
<p>The value for the <code><b>--*-regex</b></code> options is a Perl-like
regular expression in the form
<code><b>/</b><i>pattern</i><b>/</b><i>replacement</i><b>/</b></code>.
Any character can be used as a delimiter instead of <code><b>/</b></code>
and the delimiter can be escaped inside <code><i>pattern</i></code> and
<code><i>replacement</i></code> with a backslash (<code><b>\</b></code>).
You can also specify multiple regular expressions by repeating these
options.</p>
<p>All the regular expressions are tried in the order specified with the
name-specific expressions (for example, <code><b>--table-regex</b></code>)
tried first followed by the generic expressions
(<code><b>--sql-name-regex</b></code>). The first expression that
matches is used.</p>
<p>As an example, consider a regular expression that transforms a class
name in the form <code><b>CFoo</b></code> to a table name in the
form <code><b>FOO</b></code>:</p>
<p><code><b>--table-regex '/C(.+)/\U$1/'</b></code></p>
<p>As a more interesting example, consider the transformation of class
names that follow the upper camel case convention (for example,
<code><b>FooBar</b></code>) to table names that follow the
underscore-separated, all upper case convention (for example,
<code><b>FOO_BAR</b></code>). For this case we have to use
separate expressions to handle one-word, two-word, etc.,
names:</p>
<p><code><b>--table-regex '/([A-z][a-z]+)/\U$1/'</b></code></p>
<p><code><b>--table-regex '/([A-z][a-z]+)([A-z][a-z]+)/\U$1_$2/'</b></code></p>
<p>See also the REGEX AND SHELL QUOTING section below.</p>
<h1>REGEX AND SHELL QUOTING</h1>
<p>When entering a regular expression argument in the shell
command line it is often necessary to use quoting (enclosing
the argument in <code><b>" "</b></code> or
<code><b>' '</b></code>) in order to prevent the shell
from interpreting certain characters, for example, spaces as
argument separators and <code><b>$</b></code> as variable
expansions.</p>
<p>Unfortunately it is hard to achieve this in a manner that is
portable across POSIX shells, such as those found on
GNU/Linux and UNIX, and Windows shell. For example, if you
use <code><b>" "</b></code> for quoting you will get a
wrong result with POSIX shells if your expression contains
<code><b>$</b></code>. The standard way of dealing with this
on POSIX systems is to use <code><b>' '</b></code> instead.
Unfortunately, Windows shell does not remove <code><b>' '</b></code>
from arguments when they are passed to applications. As a result you
may have to use <code><b>' '</b></code> for POSIX and
<code><b>" "</b></code> for Windows (<code><b>$</b></code> is
not treated as a special character on Windows).</p>
<p>Alternatively, you can save regular expression options into
a file, one option per line, and use this file with the
<code><b>--options-file</b></code> option. With this approach
you don't need to worry about shell quoting.</p>
<h1>DIAGNOSTICS</h1>
<p>If the input file is not valid C++, <code><b>odb</b></code>
will issue diagnostic messages to STDERR and exit with non-zero exit
code.</p>
<h1>BUGS</h1>
<p>Send bug reports to the
<a href="mailto:odb-users@codesynthesis.com">odb-users@codesynthesis.com</a> mailing list.</p>
</div>
<div id="footer">
© 2009-2015 <a href="http://www.codesynthesis.com">Code Synthesis Tools CC</a>
<div id="terms">
Permission is granted to copy, distribute and/or modify this
document under the terms of the
<a href="http://codesynthesis.com/licenses/fdl-1.3.txt">GNU Free
Documentation License, version 1.3</a>; with no Invariant Sections,
no Front-Cover Texts and no Back-Cover Texts.
</div>
</div>
</div>
</body>
</html>
|
