summaryrefslogtreecommitdiff
path: root/odb-examples/view/README
blob: 176521f4689cc8d71e0fcb2409526c2a26e15193 (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
This example shows how to define and use views in ODB. It includes views
that show how to load a subset of data members from objects or columns
from tables, perform aggregate queries, and join multiple objects and
tables using object relationships and custom join conditions.

The example consists of the following files:

employee.hxx
  Header file defining the 'country', 'employer', and 'employee' persistent
  classes. The example also uses the "legacy" 'employee_extra' table that is
  not mapped to a persistent class.

  After the persistent classes, this header defines a number of views that
  show how to obtain various information from the above object model.

employee-odb.hxx
employee-odb.ixx
employee-odb.cxx
employee.sql
  The first three files contain the database support code and the last file
  contains the database schema for the employee.hxx header.

  These files are generated by the ODB compiler from employee.hxx using the
  following command line:

  odb --std c++11 -d <database> --generate-schema --generate-query \
  --default-pointer std::shared_ptr --generate-session employee.hxx

  Where <database> stands for the database system we are using, for example,
  'pgsql'.

  The --default-pointer option is used to make std::shared_ptr the default
  object pointer. The --generate-session option is used to enable session
  support for all the objects which is required to use object loading views.

database.hxx
  Contains the create_database() function which instantiates the concrete
  database class corresponding to the database system we are using.

driver.cxx
  Driver for the example. It includes the employee.hxx and employee-odb.hxx
  headers to gain access to the persistent classes and views as well as
  their database support code. It also includes database.hxx for the
  create_database() function declaration.

  In main() the driver first calls create_database() to obtain the database
  instance. It then creates the legacy 'employee_extra' table and proceeds
  to populate the database with a number of 'country', 'employer', and
  'employee' objects. Once this is done, the driver uses views defined in
  employee.hxx to load and print various information about the object model.

To compile and link the example manually from the command line we can use the
following commands (using PostgreSQL as an example; replace 'c++' with your
C++ compiler name):

c++ -c employee-odb.cxx
c++ -DDATABASE_PGSQL -c driver.cxx
c++ -o driver driver.o employee-odb.o -lodb-pgsql -lodb

To run the example we may first need to create the database schema (for some
database systems, such as SQLite, the schema is embedded into the generated
code which makes this step unnecessary). Using PostgreSQL as an example, this
can be achieved with the following command:

psql --username=odb_test --dbname=odb_test -f employee.sql

Here we use 'odb_test' as the database login and also 'odb_test' as the
database name.

Once the database schema is ready, we can run the example (using PostgreSQL as
the database):

./driver --user odb_test --database odb_test