aboutsummaryrefslogtreecommitdiff
path: root/qt/README
blob: 99ec974fa67526aafd89f94d5bdee96a0119e833 (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
This example shows how to persist objects that use Qt smart pointers,
containers, and value types with the help of the Qt profile library
(libodb-qt).

The example consists of the following files:

employee.hxx
  Header file defining the 'employee' and 'employer' persistent classes.
  We use QSharedPointer/QWeakPointer smart pointers provided by Qt (as
  well as their lazy versions provided by the Qt profile library) to
  establish a bidirectional employee-employer relationship. The QList
  type is used to store the collection of employees employed by the
  employer. We also use the QDateTime type to store the employee's date
  of birth and QString to store the employee's first and last name. A
  QSet instance keeps track of the employee's email addresses. Finally
  we use QByteArray to store the employee's public key.

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 -d <database> -p qt --generate-schema --generate-query employee.hxx

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

  The -p option is used to instruct the ODB compiler to load the Qt
  profile.

database.hxx
  Contains the createDatabase() 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 their database support
  code. It also includes database.hxx for the createDatabase() function
  declaration.

  In main() the driver first calls createDatabase() to obtain the database
  instance. It then creates a number of 'Employee' and 'Employer' objects and
  persists them in the database. The next transaction loads all the employees
  of a particular employer using the employee-employer relationship. Finally,
  the driver performs a database query which uses data member of the Qt
  QString and QDate types in its criterion.

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 MySQL as an example, this
can be achieved with the following command:

mysql --user=odb_test --database=odb_test < 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 MySQL as
the database):

./driver --user odb_test --database odb_test