From 6b8def06796d1e4fc9e6e7e75ce59bccf6899261 Mon Sep 17 00:00:00 2001
From: Boris Kolpackov <boris@codesynthesis.com>
Date: Tue, 10 Jul 2012 15:17:16 +0200
Subject: Add support for custom database type mapping

New pragma qualifier, map, and specifiers: as, to, from. New tests:
<database>/custom.
---
 oracle/custom/custom.sql |  61 ++++++++++++++++++++++++++
 oracle/custom/driver.cxx |  77 ++++++++++++++++++++++++++++++++
 oracle/custom/makefile   | 112 +++++++++++++++++++++++++++++++++++++++++++++++
 oracle/custom/test.hxx   |  41 +++++++++++++++++
 oracle/custom/test.std   |   0
 oracle/custom/traits.hxx |  77 ++++++++++++++++++++++++++++++++
 6 files changed, 368 insertions(+)
 create mode 100644 oracle/custom/custom.sql
 create mode 100644 oracle/custom/driver.cxx
 create mode 100644 oracle/custom/makefile
 create mode 100644 oracle/custom/test.hxx
 create mode 100644 oracle/custom/test.std
 create mode 100644 oracle/custom/traits.hxx

(limited to 'oracle/custom')

diff --git a/oracle/custom/custom.sql b/oracle/custom/custom.sql
new file mode 100644
index 0000000..3200e74
--- /dev/null
+++ b/oracle/custom/custom.sql
@@ -0,0 +1,61 @@
+/* This file contains custom type definitions and helper functions.
+ */
+
+SET FEEDBACK OFF;
+WHENEVER SQLERROR EXIT FAILURE;
+WHENEVER OSERROR EXIT FAILURE;
+
+-- @@ Temporary workaround: we cannot replace a type if there are
+--    tables that use it. So need to drop the tables first, then
+--    create/replace the type, and then create the tables.
+--
+--CREATE OR REPLACE TYPE Numbers AS VARRAY(100) OF NUMBER(10);
+
+BEGIN
+  BEGIN
+    EXECUTE IMMEDIATE 'CREATE TYPE Numbers AS VARRAY(100) OF NUMBER(10)';
+  EXCEPTION
+    WHEN OTHERS THEN
+      IF SQLCODE != -955 THEN RAISE; END IF;
+  END;
+END;
+/
+
+CREATE OR REPLACE FUNCTION string_to_numbers(in_str IN VARCHAR2) RETURN Numbers
+IS
+  ret          Numbers := Numbers();
+  s_pos        NUMBER := 1;
+  e_pos	       NUMBER := 0;
+BEGIN
+   IF in_str IS NOT NULL THEN
+     LOOP
+       e_pos := INSTR(in_str, ',', s_pos);
+       EXIT WHEN e_pos = 0;
+       ret.extend;
+       ret(ret.COUNT) := CAST(SUBSTR(in_str, s_pos, e_pos - s_pos) AS NUMBER);
+       s_pos := e_pos + 1;
+     END LOOP;
+     ret.extend;
+     ret(ret.COUNT) := CAST(SUBSTR(in_str, s_pos) AS NUMBER);
+   END IF;
+   RETURN ret;
+END;
+/
+
+CREATE OR REPLACE FUNCTION numbers_to_string(in_nums IN Numbers) RETURN VARCHAR2
+IS
+  ret          VARCHAR2(1500);
+BEGIN
+  IF in_nums.COUNT != 0 THEN
+    FOR i IN in_nums.FIRST .. in_nums.LAST LOOP
+      IF i != in_nums.FIRST THEN
+        ret := ret || ',';
+      END IF;
+      ret := ret || in_nums(i);
+    END LOOP;
+  END IF;
+  RETURN ret;
+END;
+/
+
+EXIT;
diff --git a/oracle/custom/driver.cxx b/oracle/custom/driver.cxx
new file mode 100644
index 0000000..2425b29
--- /dev/null
+++ b/oracle/custom/driver.cxx
@@ -0,0 +1,77 @@
+// file      : oracle/custom/driver.cxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+// Test custom database type mapping in Oracle.
+//
+
+#include <memory>   // std::auto_ptr
+#include <cassert>
+#include <iostream>
+
+#include <odb/oracle/database.hxx>
+#include <odb/oracle/transaction.hxx>
+
+#include <common/common.hxx>
+
+#include "test.hxx"
+#include "test-odb.hxx"
+
+using namespace std;
+using namespace odb::core;
+
+int
+main (int argc, char* argv[])
+{
+  try
+  {
+    auto_ptr<database> db (create_database (argc, argv));
+
+    object o (1);
+    o.iv.push_back (123);
+    o.iv.push_back (234);
+    o.iv.push_back (-345);
+
+    // Persist.
+    //
+    {
+      transaction t (db->begin ());
+      db->persist (o);
+      t.commit ();
+    }
+
+    // Load.
+    //
+    {
+      transaction t (db->begin ());
+      auto_ptr<object> o1 (db->load<object> (1));
+      t.commit ();
+
+      assert (o == *o1);
+    }
+
+    // Update.
+    //
+    o.iv[0]++;
+    o.iv.pop_back ();
+
+    {
+      transaction t (db->begin ());
+      db->update (o);
+      t.commit ();
+    }
+
+    {
+      transaction t (db->begin ());
+      auto_ptr<object> o1 (db->load<object> (1));
+      t.commit ();
+
+      assert (o == *o1);
+    }
+  }
+  catch (const odb::exception& e)
+  {
+    cerr << e.what () << endl;
+    return 1;
+  }
+}
diff --git a/oracle/custom/makefile b/oracle/custom/makefile
new file mode 100644
index 0000000..97cdb2c
--- /dev/null
+++ b/oracle/custom/makefile
@@ -0,0 +1,112 @@
+# file      : oracle/custom/makefile
+# copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+# license   : GNU GPL v2; see accompanying LICENSE file
+
+include $(dir $(lastword $(MAKEFILE_LIST)))../../build/bootstrap.make
+
+cxx_tun := driver.cxx
+odb_hdr := test.hxx
+cxx_obj := $(addprefix $(out_base)/,$(cxx_tun:.cxx=.o) $(odb_hdr:.hxx=-odb.o))
+cxx_od  := $(cxx_obj:.o=.o.d)
+
+common.l             := $(out_root)/libcommon/common/common.l
+common.l.cpp-options := $(out_root)/libcommon/common/common.l.cpp-options
+
+driver  := $(out_base)/driver
+dist    := $(out_base)/.dist
+test    := $(out_base)/.test
+clean   := $(out_base)/.clean
+
+# Import.
+#
+$(call import,\
+  $(scf_root)/import/odb/stub.make,\
+  odb: odb,odb-rules: odb_rules)
+
+# Build.
+#
+$(driver): $(cxx_obj) $(common.l)
+$(cxx_obj) $(cxx_od): cpp_options := -I$(out_base) -I$(src_base)
+$(cxx_obj) $(cxx_od): $(common.l.cpp-options)
+
+genf := $(addprefix $(odb_hdr:.hxx=-odb),.hxx .ixx .cxx) $(odb_hdr:.hxx=.sql)
+gen  := $(addprefix $(out_base)/,$(genf))
+
+$(gen): $(odb)
+$(gen): odb := $(odb)
+$(gen) $(dist): export odb_options += --database oracle --generate-schema \
+--generate-query --hxx-prologue '\#include "traits.hxx"' \
+--table-prefix oracle_custom_
+$(gen): cpp_options := -I$(src_base)
+$(gen): $(common.l.cpp-options)
+
+$(call include-dep,$(cxx_od),$(cxx_obj),$(gen))
+
+# Alias for default target.
+#
+$(out_base)/: $(driver)
+
+# Dist
+#
+$(dist): sources := $(cxx_tun)
+$(dist): headers := $(odb_hdr)
+$(dist): export extra_headers := traits.hxx custom.sql
+$(dist): data_dist := test.std
+$(dist): export name := $(subst /,-,$(subst $(src_root)/oracle/,,$(src_base)))
+$(dist): export extra_dist := $(data_dist) $(name)-vc9.vcproj \
+$(name)-vc10.vcxproj $(name)-vc10.vcxproj.filters
+$(dist):
+	$(call dist-data,$(sources) $(headers) $(extra_headers) $(data_dist))
+	$(call meta-automake,../template/Makefile.am)
+	$(call meta-vc9proj,../template/template-vc9.vcproj,$(name)-vc9.vcproj)
+	$(call meta-vc10proj,../template/template-vc10.vcxproj,$(name)-vc10.vcxproj)
+
+# Test.
+#
+$(test): $(driver) $(src_base)/test.std
+	$(call schema, custom.sql)
+	$(call message,test $<,$< --options-file $(dcf_root)/db.options \
+>$(out_base)/test.out)
+	$(call message,,diff -u $(src_base)/test.std $(out_base)/test.out)
+	$(call message,,rm -f $(out_base)/test.out)
+
+# Clean.
+#
+$(clean):                            \
+  $(driver).o.clean                  \
+  $(addsuffix .cxx.clean,$(cxx_obj)) \
+  $(addsuffix .cxx.clean,$(cxx_od))  \
+  $(addprefix $(out_base)/,$(odb_hdr:.hxx=-odb.cxx.hxx.clean))
+	$(call message,,rm -f $(out_base)/test.out)
+
+# Generated .gitignore.
+#
+ifeq ($(out_base),$(src_base))
+$(driver): | $(out_base)/.gitignore
+
+$(out_base)/.gitignore: files := driver $(genf)
+$(clean): $(out_base)/.gitignore.clean
+
+$(call include,$(bld_root)/git/gitignore.make)
+endif
+
+# How to.
+#
+$(call include,$(bld_root)/dist.make)
+$(call include,$(bld_root)/meta/vc9proj.make)
+$(call include,$(bld_root)/meta/vc10proj.make)
+$(call include,$(bld_root)/meta/automake.make)
+
+$(call include,$(bld_root)/cxx/standard.make) # cxx_standard
+ifdef cxx_standard
+$(gen): odb_options += --std $(cxx_standard)
+$(call include,$(odb_rules))
+endif
+
+$(call include,$(bld_root)/cxx/cxx-d.make)
+$(call include,$(bld_root)/cxx/cxx-o.make)
+$(call include,$(bld_root)/cxx/o-e.make)
+
+# Dependencies.
+#
+$(call import,$(src_root)/libcommon/makefile)
diff --git a/oracle/custom/test.hxx b/oracle/custom/test.hxx
new file mode 100644
index 0000000..cc46512
--- /dev/null
+++ b/oracle/custom/test.hxx
@@ -0,0 +1,41 @@
+// file      : oracle/custom/test.hxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+#ifndef TEST_HXX
+#define TEST_HXX
+
+#include <vector>
+
+#include <odb/core.hxx>
+
+// Map Numbers VARRAY Oracle type to std::vector<int>. This type is defined
+// in the custom.sql file along with two helper functions that convert
+// between Numbers and its string representation. The other half of this
+// mapping is in traits.hxx (value_traits<std::vector<int>, id_string>).
+//
+#pragma db map type("Numbers")                               \
+               as("VARCHAR2(1500)")                          \
+               to("CAST(string_to_numbers((?)) AS Numbers)") \
+               from("numbers_to_string((?))")
+
+#pragma db object
+struct object
+{
+  object () {}
+  object (unsigned long id_) : id (id_) {}
+
+  #pragma db id
+  unsigned long id;
+
+  #pragma db type("Numbers")
+  std::vector<int> iv;
+
+  bool
+  operator== (const object& y) const
+  {
+    return id == y.id && iv == y.iv;
+  }
+};
+
+#endif // TEST_HXX
diff --git a/oracle/custom/test.std b/oracle/custom/test.std
new file mode 100644
index 0000000..e69de29
diff --git a/oracle/custom/traits.hxx b/oracle/custom/traits.hxx
new file mode 100644
index 0000000..8f3e81e
--- /dev/null
+++ b/oracle/custom/traits.hxx
@@ -0,0 +1,77 @@
+// file      : oracle/types/traits.hxx
+// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
+// license   : GNU GPL v2; see accompanying LICENSE file
+
+#ifndef TRAITS_HXX
+#define TRAITS_HXX
+
+#include <vector>
+#include <sstream>
+#include <cstring> // std::memcpy
+#include <cassert> // std::memcpy
+
+#include <odb/oracle/traits.hxx>
+
+namespace odb
+{
+  namespace oracle
+  {
+
+        template <>
+    class value_traits<std::vector<int>, id_string>
+    {
+    public:
+      typedef std::vector<int> value_type;
+      typedef value_type query_type;
+      typedef details::buffer image_type;
+
+      static void
+      set_value (value_type& v,
+                 const char* b,
+                 std::size_t n,
+                 bool is_null)
+      {
+        v.clear ();
+
+        if (!is_null)
+        {
+          // Array format is "n1,n2,n3...".
+          //
+          std::istringstream is (std::string (b, n));
+
+          for (char c; !is.eof (); is >> c)
+          {
+            v.push_back (int ());
+            is >> v.back ();
+          }
+        }
+      }
+
+      static void
+      set_image (char* b,
+                 std::size_t c,
+                 std::size_t& n,
+                 bool& is_null,
+                 const value_type& v)
+      {
+        is_null = false;
+        std::ostringstream os;
+
+        for (value_type::const_iterator i (v.begin ()), e (v.end ()); i != e;)
+        {
+          os << *i;
+
+          if (++i != e)
+            os << ',';
+        }
+
+        const std::string& s (os.str ());
+        n = s.size ();
+        assert (n <= c);
+        std::memcpy (b, s.c_str (), n);
+      }
+    };
+  }
+}
+
+#endif // TRAITS_HXX
-- 
cgit v1.1