aboutsummaryrefslogtreecommitdiff
path: root/README
blob: 0c35ecdd956b2569ddcb0a97ceaf3ff91b0de6fd (plain)
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
ODB is an object-relational mapping (ORM) system for C++. It provides
tools, APIs, and library support that allow you to persist C++ objects
to a relational database (RDBMS) without having to deal with tables,
columns, or SQL and without manually writing any of the mapping code.
For more information see:

http://www.codesynthesis.com/products/odb/

This package contains the ODB examples. The following list gives an
overview of the available examples. See the README file accompanying
each example for more information.

Note also that most of the examples use the --table-prefix ODB compiler
option to assign a unique prefix to tables created by each example. This
is done to allow examples to run against the same  database without
causing any schema conflicts. You don't have to use this option in your
own applications.

hello
  A "Hello World" example that shows how to use ODB to perform basic
  database operations.

query
  Shows how to use the ODB Query Language to search the database for
  persistent objects matching certain criteria.

composite
  Shows how to declare and use composite value types.

container
  Shows how to use containers as data members in persistent objects.

relationship
  Shows how to declare and use unidirectional to-one and to-many
  relationships.

inverse
  Shows how to declare and use bidirectional one-to-one, one-to-many, and
  many-to-many relationships.

inheritance/reuse
  Shows how to use reuse inheritance with ODB.

inheritance/polymorphism
  Shows how to use polymorphism inheritance with ODB.

section
  Shows how to use object sections to implement lazy-loading and change-
  updating of a subset of data members in a persistent class.

view
  Shows how to define and use object, table, mixed, and native views.

prepared
  Shows how to use prepared queries.

optimistic
  Shows how to use optimistic concurrency in ODB.

pimpl
  Shows how to use virtual data members to implement a persistent class that
  employs the pimpl C++ idiom.

c++11
  Shows how to use ODB with C++11.

access
  Shows various approaches used by ODB to access data members that cannot be
  accessed directly.

boost
  Shows how to persist objects that use Boost smart pointers, containers,
  and value types with the help of the Boost profile library (libodb-boost).

qt
  Shows how to persist objects that use Qt smart pointers, containers, and
  value types with the help of the Qt profile library (libodb-qt).

schema/embedded
  Shows how to generate and use a database schema that is embedded into the
  application.

schema/custom
  Shows how to map persistent C++ classes to a custom database schema.

mapping
  Shows how to customize the mapping between C++ value types and database
  types.

See the NEWS file for the user-visible changes from the previous release.

See the LICENSE file for distribution conditions.

See the INSTALL file for prerequisites and installation instructions.

Send questions, bug reports, or any other feedback to the
odb-users@codesynthesis.com mailing list.