1 files changed, 51 insertions, 0 deletions
diff --git a/schema/embedded/README b/schema/embedded/README
new file mode 100644
index 0000000..d353bd0
--- /dev/null
+++ b/schema/embedded/README
@@ -0,0 +1,51 @@
+This example shows how to generate and use a database schema that is embedded
+into the application rather than stored as a separate SQL file.
+
+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
+  These files contain the database support code as well as the embedded
+  database schema for the person.hxx header. They are generated by the ODB
+  compiler from person.hxx using the following command line:
+
+  odb -d <database> --generate-schema --schema-format embedded \
+  --generate-query person.hxx
+
+  Where <database> stands for the database system we are using, for example,
+  'mysql'.
+
+  The --generate-schema option requests the generation of the database schema.
+  The --schema-format option is used to instruct the ODB compiler to embed the
+  schema into the generated C++ files.
+
+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 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 uses the ODB schema catalog to create the database
+  schema. During this step the generated code issues a number of SQL
+  statements that drop and create necessary database tables, etc.
+
+  After the database schema is ready, the driver persists a number of 'person'
+  objects, performs a database query, and prints the information about the
+  returned objects.
+
+To run the driver, using MySQL as an example, we can execute the following
+command:
+
+./driver --user odb_test --database odb_test
+
+Here we use 'odb_test' as the database login and also 'odb_test' as the
+database name.