aboutsummaryrefslogtreecommitdiff
path: root/boost/README
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2011-02-04 14:02:12 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2011-02-04 14:02:12 +0200
commitacba5c43f189dfddef4992371fadaa6f019a8027 (patch)
treea10ac88a6ab8f84c33a3a19cf092feddb802ee7f /boost/README
parentb3fa74d407c8a7bdc39c381137612a2d94c58831 (diff)
Add Boost profile example
Diffstat (limited to 'boost/README')
-rw-r--r--boost/README62
1 files changed, 62 insertions, 0 deletions
diff --git a/boost/README b/boost/README
new file mode 100644
index 0000000..c731bad
--- /dev/null
+++ b/boost/README
@@ -0,0 +1,62 @@
+This example shows how to persist objects that use Boost smart pointers,
+containers, and value types with the help of the Boost profile library
+(libodb-boost).
+
+The example consists of the following files:
+
+employee.hxx
+ Header file defining the 'employee' and 'employer' persistent classes.
+ We use shared_ptr/weak_ptr smart pointers provided by Boost (as well
+ as their lazy versions provided by the Boost profile library) to
+ establish a bidirectional employee-employer relationship. We also use
+ the boost::gregorian::date type to store the employee's date of birth.
+ Finally, we use the boost::unordered_set container to keep track of
+ the employee's email addresses.
+
+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 boost --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 Boost
+ profile.
+
+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 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 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 a data member of the Boost
+ gregorian::date type in its criterion.
+
+To run the example we first need to create the database schema. 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