From 1c6d5d4b6aea06554d6d3342262b8d551bf816fd Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Thu, 23 Sep 2010 13:37:38 +0200 Subject: README files for the examples --- README | 16 +++++++++++++- hello/README | 52 ++++++++++++++++++++++++++++++++++++++++++++ hello/makefile | 5 +++-- mapping/README | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ mapping/makefile | 6 +++-- query/README | 50 ++++++++++++++++++++++++++++++++++++++++++ query/makefile | 5 +++-- template/makefile | 5 +++-- 8 files changed, 195 insertions(+), 9 deletions(-) create mode 100644 hello/README create mode 100644 mapping/README create mode 100644 query/README diff --git a/README b/README index 78f0ca9..ae9cd35 100644 --- a/README +++ b/README @@ -6,7 +6,21 @@ For more information see: http://www.codesynthesis.com/products/odb/ -This package contains the ODB examples. +This package contains the ODB examples. The following list gives an +overview of each example. See the README files in example directories +for more information on each example. + +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. + +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. diff --git a/hello/README b/hello/README new file mode 100644 index 0000000..97a15b4 --- /dev/null +++ b/hello/README @@ -0,0 +1,52 @@ +This is a "Hello World" example that shows how to use ODB to perform basic +database operations, such as making objects persistent, loading, updating +and deleting persistent objects, as well as querying the database for +objects matching a certain criteria. + +The example consists of the following files: + +person.hxx + Header file defining the 'person' persistent class. + +person-odb.hxx +person-odb.ixx +person-odb.cxx +person.sql + The first three files contain the database support code and the last file + contains the database schema for the person.hxx header. + + These files are generated by the ODB compiler from person.hxx using the + following command line: + + odb -d --generate-query --generate-schema person.hxx + + Where stands for the database system we are using, for example, + 'mysql'. + +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 person.hxx and person-odb.hxx + headers to gain access to the 'person' class and the database support + code for this class. It also includes database.hxx for the + create_database() function declaration. + + In main() the driver first calls create_database() to obtain the database + instance. Then it executes a number of database transactions on persistent + objects. + +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 < person.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 + diff --git a/hello/makefile b/hello/makefile index 8192aae..2d32e16 100644 --- a/hello/makefile +++ b/hello/makefile @@ -70,9 +70,10 @@ $(dist): sources := $(cxx_tun) $(dist): headers := $(odb_hdr) $(dist): export name := $(name) $(dist): export odb_header_stem := $(basename $(odb_hdr)) -$(dist): export extra_dist := $(call vc9projs,$(name)) $(call vc10projs,$(name)) +$(dist): export extra_dist := README $(call vc9projs,$(name)) \ +$(call vc10projs,$(name)) $(dist): - $(call dist-data,$(sources) $(headers) database.hxx) + $(call dist-data,$(sources) $(headers) README database.hxx) $(call meta-automake,../template/Makefile.am) $(call meta-vc9projs,../template/template,$(name)) $(call meta-vc10projs,../template/template,$(name)) diff --git a/mapping/README b/mapping/README new file mode 100644 index 0000000..fffadcb --- /dev/null +++ b/mapping/README @@ -0,0 +1,65 @@ +This examples shows how to customize the mapping between C++ value types +and database types. The example changes the default mapping for the 'bool' +type which is now stored in the database as the "true" or "false" string. +It also maps the user-defined 'date' type to a suitable database date type. + +The example consists of the following files: + +person.hxx + Header file defining the 'date' value type and the 'person' persistent + class. It also uses the ODB value type pragma to map 'bool' to the + 'VARCHAR(5)' database type and 'date' to the 'DATE' database type. + +traits.hxx + ODB 'value_traits' template specializations for the 'bool' and 'date' + types. These specializations implement conversion between these types + and their database counterparts. + +person-odb.hxx +person-odb.ixx +person-odb.cxx +person.sql + The first three files contain the database support code and the last file + contains the database schema for the person.hxx header. + + These files are generated by the ODB compiler from person.hxx using the + following command line: + + odb -d --generate-query --generate-schema \ + --hxx-prologue '#include "traits.hxx"' person.hxx + + Where stands for the database system we are using, for example, + 'mysql'. + + The --hxx-prologue option included the traits.hxx header at the beginning + of the generated person-odb.hxx file. This makes the 'value_traits' + specializations defined in traits.hxx known to the generated database + support code. + +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 person.hxx and person-odb.hxx + headers to gain access to the 'person' class and the database support + code for this class. 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 persists a number of 'person' objects in the database + and executes a query to find objects matching certain criteria. + +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 < person.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 + diff --git a/mapping/makefile b/mapping/makefile index 7b9c72e..79f79d8 100644 --- a/mapping/makefile +++ b/mapping/makefile @@ -71,9 +71,11 @@ $(dist): headers := $(odb_hdr) $(dist): export name := $(name) $(dist): export extra_headers := traits.hxx $(dist): export odb_header_stem := $(basename $(odb_hdr)) -$(dist): export extra_dist := $(call vc9projs,$(name)) $(call vc10projs,$(name)) +$(dist): export extra_dist := README $(call vc9projs,$(name)) \ +$(call vc10projs,$(name)) $(dist): - $(call dist-data,$(sources) $(headers) $(extra_headers) database.hxx) + $(call dist-data,$(sources) $(headers) $(extra_headers) \ +README database.hxx) $(call meta-automake,../template/Makefile.am) $(call meta-vc9projs,../template/template,$(name)) $(call meta-vc10projs,../template/template,$(name)) diff --git a/query/README b/query/README new file mode 100644 index 0000000..6f6a858 --- /dev/null +++ b/query/README @@ -0,0 +1,50 @@ +This examples shows how to use the ODB Query Language to search the database +for persistent objects matching certain criteria. + +The example consists of the following files: + +person.hxx + Header file defining the 'person' persistent class. + +person-odb.hxx +person-odb.ixx +person-odb.cxx +person.sql + The first three files contain the database support code and the last file + contains the database schema for the person.hxx header. + + These files are generated by the ODB compiler from person.hxx using the + following command line: + + odb -d --generate-query --generate-schema person.hxx + + Where stands for the database system we are using, for example, + 'mysql'. + +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 person.hxx and person-odb.hxx + headers to gain access to the 'person' class and the database support + code for this class. 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 persists a number of 'person' objects in the database + and executes a number of queries to find objects matching various criteria. + +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 < person.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 + diff --git a/query/makefile b/query/makefile index 1445a00..c86a7cf 100644 --- a/query/makefile +++ b/query/makefile @@ -70,9 +70,10 @@ $(dist): sources := $(cxx_tun) $(dist): headers := $(odb_hdr) $(dist): export name := $(name) $(dist): export odb_header_stem := $(basename $(odb_hdr)) -$(dist): export extra_dist := $(call vc9projs,$(name)) $(call vc10projs,$(name)) +$(dist): export extra_dist := README $(call vc9projs,$(name)) \ +$(call vc10projs,$(name)) $(dist): - $(call dist-data,$(sources) $(headers) database.hxx) + $(call dist-data,$(sources) $(headers) README database.hxx) $(call meta-automake,../template/Makefile.am) $(call meta-vc9projs,../template/template,$(name)) $(call meta-vc10projs,../template/template,$(name)) diff --git a/template/makefile b/template/makefile index 887385f..19a898b 100644 --- a/template/makefile +++ b/template/makefile @@ -69,9 +69,10 @@ $(dist): sources := $(cxx_tun) $(dist): headers := $(odb_hdr) $(dist): export name := $(name) $(dist): export odb_header_stem := $(basename $(odb_hdr)) -$(dist): export extra_dist := $(call vc9projs,$(name)) $(call vc10projs,$(name)) +$(dist): export extra_dist := README $(call vc9projs,$(name)) \ +$(call vc10projs,$(name)) $(dist): - $(call dist-data,$(sources) $(headers) database.hxx) + $(call dist-data,$(sources) $(headers) README database.hxx) $(call meta-automake,../template/Makefile.am) $(call meta-vc9projs,../template/template,$(name)) $(call meta-vc10projs,../template/template,$(name)) -- cgit v1.1