summaryrefslogtreecommitdiff
path: root/odb-examples/c++11
diff options
context:
space:
mode:
Diffstat (limited to 'odb-examples/c++11')
-rw-r--r--odb-examples/c++11/README74
-rw-r--r--odb-examples/c++11/buildfile45
-rw-r--r--odb-examples/c++11/database.hxx95
-rw-r--r--odb-examples/c++11/driver.cxx207
-rw-r--r--odb-examples/c++11/employee.hxx182
-rw-r--r--odb-examples/c++11/testscript13
6 files changed, 616 insertions, 0 deletions
diff --git a/odb-examples/c++11/README b/odb-examples/c++11/README
new file mode 100644
index 0000000..0cf15ac
--- /dev/null
+++ b/odb-examples/c++11/README
@@ -0,0 +1,74 @@
+This example shows how to use ODB with C++11. In particular, this example
+examines ODB support for the new std::unique_ptr and std::shared_ptr smart
+pointers and their lazy variants as well as the unordered containers. It
+also shows how to use new C++11 features such as the range-based for-loop
+when working with persistent objects and handling query results.
+
+The example consists of the following files:
+
+employee.hxx
+ Header file defining the 'employee', 'employer', and 'pension_fund'
+ persistent classes. We use the standard std::shared_ptr/weak_ptr smart
+ pointers as well as their lazy versions provided by ODB to establish a
+ bidirectional employee-employer relationship. We also enable session
+ support for these two classes using the 'db session' pragma. Because
+ we don't share the 'pension_fund' objects, we use std::unique_ptr
+ as an object pointer for this persistent class. We also use the
+ std::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 --std c++11 -d <database> --generate-schema --generate-query \
+ employee.hxx
+
+ Where <database> stands for the database system we are using, for example,
+ 'pgsql'.
+
+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', 'employer', and
+ 'pension_fund' objects and persists them in the database. Then the driver
+ loads and prints some information about various objects and their
+ relationships. Finally, the driver performs a database query and iterates
+ over the result printing basic information about the returned objects.
+
+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
diff --git a/odb-examples/c++11/buildfile b/odb-examples/c++11/buildfile
new file mode 100644
index 0000000..e921434
--- /dev/null
+++ b/odb-examples/c++11/buildfile
@@ -0,0 +1,45 @@
+# file : c++11/buildfile
+# license : GNU GPL v2; see accompanying LICENSE file
+
+import libodb = libodb%lib{odb}
+
+import libs = libodb-$database%lib{odb-$database}
+
+exe{driver}: {hxx cxx}{* -employee-odb} {hxx ixx cxx}{employee-odb} testscript
+
+# The metadata library target which we use to extract the poptions variable
+# value for specifying the preprocessor options (-I, etc) on the ODB compiler
+# command line.
+#
+libue{employee-meta}: $libodb
+
+exe{driver}: libue{employee-meta} $libs
+
+<{hxx ixx cxx}{employee-odb}>: hxx{employee} libue{employee-meta} $odb
+{{
+ pops = $cxx.lib_poptions($<[1])
+ depdb hash $pops
+
+ depdb dyndep --dyn-target --target-what 'generated schema' --format lines \
+ -- echo ($sqlite ? '' : "$out_base/employee.sql")
+
+ $odb --std c++11 \
+ --database $database \
+ --generate-schema \
+ --generate-query \
+ --output-dir $out_base \
+ --table-prefix cxx11_ \
+ "-I$src_base" $pops \
+ $path($<[0])
+}}
+
+cxx.poptions =+ "-I$out_base" "-I$src_base" -DDATABASE_$ucase($database)
+
+# Testscript's run-time prerequisites.
+#
+# @@ BUILD2: Eventually we should be able to mark it as test.input once
+# this is supported for testscript tests.
+#
+exe{driver}: ../alias{database-client}: include = adhoc
+
+testscript@./: schema = employee
diff --git a/odb-examples/c++11/database.hxx b/odb-examples/c++11/database.hxx
new file mode 100644
index 0000000..084f8cf
--- /dev/null
+++ b/odb-examples/c++11/database.hxx
@@ -0,0 +1,95 @@
+// file : c++11/database.hxx
+// copyright : not copyrighted - public domain
+
+//
+// Create concrete database instance based on the DATABASE_* macros.
+//
+
+#ifndef DATABASE_HXX
+#define DATABASE_HXX
+
+#include <string>
+#include <memory> // std::unique_ptr
+#include <cstdlib> // std::exit
+#include <iostream>
+
+#include <odb/database.hxx>
+
+#if defined(DATABASE_MYSQL)
+# include <odb/mysql/database.hxx>
+#elif defined(DATABASE_SQLITE)
+# include <odb/connection.hxx>
+# include <odb/transaction.hxx>
+# include <odb/schema-catalog.hxx>
+# include <odb/sqlite/database.hxx>
+#elif defined(DATABASE_PGSQL)
+# include <odb/pgsql/database.hxx>
+#elif defined(DATABASE_ORACLE)
+# include <odb/oracle/database.hxx>
+#elif defined(DATABASE_MSSQL)
+# include <odb/mssql/database.hxx>
+#else
+# error unknown database; did you forget to define the DATABASE_* macros?
+#endif
+
+inline std::unique_ptr<odb::database>
+create_database (int& argc, char* argv[])
+{
+ using namespace std;
+ using namespace odb::core;
+
+ if (argc > 1 && argv[1] == string ("--help"))
+ {
+ cout << "Usage: " << argv[0] << " [options]" << endl
+ << "Options:" << endl;
+
+#if defined(DATABASE_MYSQL)
+ odb::mysql::database::print_usage (cout);
+#elif defined(DATABASE_SQLITE)
+ odb::sqlite::database::print_usage (cout);
+#elif defined(DATABASE_PGSQL)
+ odb::pgsql::database::print_usage (cout);
+#elif defined(DATABASE_ORACLE)
+ odb::oracle::database::print_usage (cout);
+#elif defined(DATABASE_MSSQL)
+ odb::mssql::database::print_usage (cout);
+#endif
+
+ exit (0);
+ }
+
+#if defined(DATABASE_MYSQL)
+ unique_ptr<database> db (new odb::mysql::database (argc, argv));
+#elif defined(DATABASE_SQLITE)
+ unique_ptr<database> db (
+ new odb::sqlite::database (
+ argc, argv, false, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE));
+
+ // Create the database schema. Due to bugs in SQLite foreign key
+ // support for DDL statements, we need to temporarily disable
+ // foreign keys.
+ //
+ {
+ connection_ptr c (db->connection ());
+
+ c->execute ("PRAGMA foreign_keys=OFF");
+
+ transaction t (c->begin ());
+ schema_catalog::create_schema (*db);
+ t.commit ();
+
+ c->execute ("PRAGMA foreign_keys=ON");
+ }
+#elif defined(DATABASE_PGSQL)
+ unique_ptr<database> db (new odb::pgsql::database (argc, argv));
+#elif defined(DATABASE_ORACLE)
+ unique_ptr<database> db (new odb::oracle::database (argc, argv));
+#elif defined(DATABASE_MSSQL)
+ unique_ptr<database> db (
+ new odb::mssql::database (argc, argv, false, "TrustServerCertificate=yes"));
+#endif
+
+ return db;
+}
+
+#endif // DATABASE_HXX
diff --git a/odb-examples/c++11/driver.cxx b/odb-examples/c++11/driver.cxx
new file mode 100644
index 0000000..68793b1
--- /dev/null
+++ b/odb-examples/c++11/driver.cxx
@@ -0,0 +1,207 @@
+// file : c++11/driver.cxx
+// copyright : not copyrighted - public domain
+
+#include <memory> // std::unique_ptr
+#include <iostream>
+
+#include <odb/database.hxx>
+#include <odb/session.hxx>
+#include <odb/transaction.hxx>
+
+#include "database.hxx" // create_database
+
+#include "employee.hxx"
+#include "employee-odb.hxx"
+
+using namespace std;
+using namespace odb::core;
+
+int
+main (int argc, char* argv[])
+{
+ try
+ {
+ unique_ptr<database> db (create_database (argc, argv));
+
+ // Create a few persistent objects.
+ //
+ {
+ pension_fund bf ("Bright Future");
+
+ // Simple Tech Ltd.
+ //
+ {
+ shared_ptr<employer> er (new employer ("Simple Tech Ltd"));
+
+ shared_ptr<employee> john (new employee ("John", "Doe", er));
+ shared_ptr<employee> jane (new employee ("Jane", "Doe", er));
+
+ john->emails ().insert ("john_d@example.com");
+ john->emails ().insert ("john.doe@example.com");
+
+ jane->emails ().insert ("jane_d@example.com");
+ jane->emails ().insert ("jane.doe@example.com");
+
+ // Set the inverse side of the employee-employer relationship.
+ //
+ er->employees ().push_back (john);
+ er->employees ().push_back (jane);
+
+ transaction t (db->begin ());
+
+ db->persist (er);
+
+ db->persist (john);
+ db->persist (jane);
+
+ t.commit ();
+
+ bf.members ().push_back (lazy_shared_ptr<employee> (*db, john));
+ }
+
+ // Complex Systems Inc.
+ //
+ {
+ shared_ptr<employer> er (new employer ("Complex Systems Inc"));
+
+ shared_ptr<employee> john (new employee ("John", "Smith", er));
+ shared_ptr<employee> jane (new employee ("Jane", "Smith", er));
+
+ john->emails ().insert ("john_s@example.com");
+ john->emails ().insert ("john.smith@example.com");
+
+ jane->emails ().insert ("jane_s@example.com");
+ jane->emails ().insert ("jane.smith@example.com");
+
+ // Set the inverse side of the employee-employer relationship.
+ //
+ er->employees ().push_back (john);
+ er->employees ().push_back (jane);
+
+ transaction t (db->begin ());
+
+ db->persist (er);
+
+ db->persist (john);
+ db->persist (jane);
+
+ t.commit ();
+
+ bf.members ().push_back (lazy_shared_ptr<employee> (*db, jane));
+ }
+
+ transaction t (db->begin ());
+ db->persist (bf);
+ t.commit ();
+ }
+
+ // Load the Bright Future pension fund and print its members.
+ //
+ {
+ session s;
+ transaction t (db->begin ());
+
+ unique_ptr<pension_fund> bf (db->load<pension_fund> ("Bright Future"));
+
+ for (auto i (bf->members ().begin ()); i != bf->members ().end (); ++i)
+ {
+ lazy_shared_ptr<employee>& p (*i);
+ p.load ();
+
+ cout << p->first () << ' ' << p->last () << ", " <<
+ p->employer ()->name () << endl;
+ }
+
+ // Alternative implementation using range-based for-loop.
+ //
+ /*
+ for (lazy_shared_ptr<employee>& p: bf->members ())
+ {
+ p.load ();
+ cout << p->first () << ' ' << p->last () << ", " <<
+ p->employer ()->name () << endl;
+ }
+ */
+
+ cout << endl;
+ }
+
+ // Load Simple Tech Ltd and print its employees.
+ //
+ {
+ session s;
+ transaction t (db->begin ());
+
+ shared_ptr<employer> st (db->load<employer> ("Simple Tech Ltd"));
+
+ for (auto i (st->employees ().begin ());
+ i != st->employees ().end ();
+ ++i)
+ {
+ lazy_weak_ptr<employee>& lwp (*i);
+ shared_ptr<employee> p (lwp.load ()); // Load and lock.
+
+ cout << p->first () << ' ' << p->last () << endl
+ << " employer: " << p->employer ()->name () << endl;
+
+ for (auto j (p->emails ().begin ()); j != p->emails ().end (); ++j)
+ {
+ cout << " email: " << *j << endl;
+ }
+
+ cout << endl;
+ }
+
+ // Alternative implementation using range-based for-loop.
+ //
+ /*
+ for (lazy_weak_ptr<employee>& lwp: st->employees ())
+ {
+ shared_ptr<employee> p (lwp.load ()); // Load and lock.
+
+ cout << p->first () << ' ' << p->last () << endl
+ << " employer: " << p->employer ()->name () << endl;
+
+ for (const string& e: p->emails ())
+ cout << " email: " << e << endl;
+
+ cout << endl;
+ }
+ */
+
+ t.commit ();
+ }
+
+
+ // Search for Complex Systems Inc employees with the John first name.
+ //
+ {
+ typedef odb::query<employee> query;
+ typedef odb::result<employee> result;
+
+ session s;
+ transaction t (db->begin ());
+
+ result r (db->query<employee> (
+ query::employer->name == "Complex Systems Inc" &&
+ query::first == "John"));
+
+ for (auto i (r.begin ()); i != r.end (); ++i)
+ cout << i->first () << ' ' << i->last () << endl;
+
+ // Alternative implementation using range-based for-loop.
+ //
+ /*
+ for (const employee& e: r)
+ cout << e.first () << ' ' << e.last () << endl;
+ */
+
+ t.commit ();
+ }
+ }
+ catch (const odb::exception& e)
+ {
+ cerr << e.what () << endl;
+ return 1;
+ }
+}
diff --git a/odb-examples/c++11/employee.hxx b/odb-examples/c++11/employee.hxx
new file mode 100644
index 0000000..a921e31
--- /dev/null
+++ b/odb-examples/c++11/employee.hxx
@@ -0,0 +1,182 @@
+// file : c++11/employee.hxx
+// copyright : not copyrighted - public domain
+
+#ifndef EMPLOYEE_HXX
+#define EMPLOYEE_HXX
+
+#include <string>
+#include <memory> // std::unique_ptr, std::shared_ptr
+#include <vector>
+#include <unordered_set>
+
+#include <odb/core.hxx>
+#include <odb/lazy-ptr.hxx> // odb::lazy_shared_ptr, odb::lazy_weak_ptr
+
+// Forward declarations.
+//
+class employer;
+class employee;
+
+#pragma db object pointer(std::shared_ptr) session
+class employer
+{
+public:
+ employer (const std::string& name)
+ : name_ (name)
+ {
+ }
+
+ const std::string&
+ name () const
+ {
+ return name_;
+ }
+
+ // Employees of this employer.
+ //
+ typedef std::vector<odb::lazy_weak_ptr<employee>> employees_type;
+
+ const employees_type&
+ employees () const
+ {
+ return employees_;
+ }
+
+ employees_type&
+ employees ()
+ {
+ return employees_;
+ }
+
+private:
+ friend class odb::access;
+
+ employer () {}
+
+ #pragma db id
+ std::string name_;
+
+ #pragma db value_not_null inverse(employer_)
+ employees_type employees_;
+};
+
+#pragma db object pointer(std::shared_ptr) session
+class employee
+{
+public:
+ typedef ::employer employer_type;
+
+ employee (const std::string& first,
+ const std::string& last,
+ std::shared_ptr<employer_type> employer)
+ : first_ (first), last_ (last), employer_ (employer)
+ {
+ }
+
+ // Name.
+ //
+ const std::string&
+ first () const
+ {
+ return first_;
+ }
+
+ const std::string&
+ last () const
+ {
+ return last_;
+ }
+
+ // Emails.
+ //
+ typedef std::unordered_set<std::string> emails_type;
+
+ const emails_type&
+ emails () const
+ {
+ return emails_;
+ }
+
+ emails_type&
+ emails ()
+ {
+ return emails_;
+ }
+
+ // Employer.
+ //
+ std::shared_ptr<employer_type>
+ employer () const
+ {
+ return employer_;
+ }
+
+ void
+ employer (std::shared_ptr<employer_type> employer)
+ {
+ employer_ = employer;
+ }
+
+private:
+ friend class odb::access;
+
+ employee () {}
+
+ #pragma db id auto
+ unsigned long id_;
+
+ std::string first_;
+ std::string last_;
+ emails_type emails_;
+
+ #pragma db not_null
+ std::shared_ptr<employer_type> employer_;
+};
+
+// std::unique_ptr is a good choice for an object pointer if we are
+// not planning to do any sharing.
+//
+#pragma db object pointer(std::unique_ptr)
+class pension_fund
+{
+public:
+ pension_fund (const std::string& name)
+ : name_ (name)
+ {
+ }
+
+ const std::string&
+ name () const
+ {
+ return name_;
+ }
+
+ // Members of this fund.
+ //
+ typedef std::vector<odb::lazy_shared_ptr<employee>> members_type;
+
+ const members_type&
+ members () const
+ {
+ return members_;
+ }
+
+ members_type&
+ members ()
+ {
+ return members_;
+ }
+
+private:
+ friend class odb::access;
+
+ pension_fund () {}
+
+ #pragma db id
+ std::string name_;
+
+ #pragma db value_not_null
+ members_type members_;
+};
+
+#endif // EMPLOYEE_HXX
diff --git a/odb-examples/c++11/testscript b/odb-examples/c++11/testscript
new file mode 100644
index 0000000..cb942f6
--- /dev/null
+++ b/odb-examples/c++11/testscript
@@ -0,0 +1,13 @@
+# file : cxx11/testscript
+# license : GNU GPL v2; see accompanying LICENSE file
+
+.include ../database-options.testscript
+.include ../$(database).testscript
+
++if! $sqlite
+ $create_schema
+end
+
+: basics
+:
+$* >|
generated by cgit v1.1 at 2024-09-28 09:37:31 +0000