aboutsummaryrefslogtreecommitdiff
path: root/odb/schema-catalog.hxx
blob: 5af7c485c6a5ae95794b6d3b0d65f939438e6fcc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
// file      : odb/schema-catalog.hxx
// copyright : Copyright (c) 2009-2013 Code Synthesis Tools CC
// license   : GNU GPL v2; see accompanying LICENSE file

#ifndef ODB_SCHEMA_CATALOG_HXX
#define ODB_SCHEMA_CATALOG_HXX

#include <odb/pre.hxx>

#include <odb/details/config.hxx> // ODB_CXX11

#include <string>

#ifdef ODB_CXX11
#  include <functional> // std::function
#endif

#include <odb/forward.hxx> // schema_version, odb::core

#include <odb/details/export.hxx>

namespace odb
{
  class LIBODB_EXPORT schema_catalog
  {
  public:
    // Schema creation.
    //
    static void
    create_schema (database&, const std::string& name = "", bool drop = true);

    static void
    drop_schema (database&, const std::string& name = "");

    // Schema migration.
    //
  public:
    static void
    migrate_schema_pre (database& db,
                        schema_version v,
                        const std::string& name = "")
    {
      migrate_schema_impl (db, v, name, migrate_pre);
    }

    static void
    migrate_schema_post (database& db,
                         schema_version v,
                         const std::string& name = "")
    {
      migrate_schema_impl (db, v, name, migrate_post);
    }

    static void
    migrate_schema (database& db,
                    schema_version v,
                    const std::string& name = "")
    {
      migrate_schema_impl (db, v, name, migrate_both);
    }

    // Data migration.
    //
  public:
    // If version is 0, then use the current version and also check whether
    // we are in migration.
    //
    static void
    migrate_data (database&,
                  schema_version = 0,
                  const std::string& name = "");

#ifdef ODB_CXX11
    typedef std::function<void (database&)> data_migration_function_type;
#else
    typedef void (*data_migration_function_type) (database&);
#endif

    // Data migration functions are called in the order of registration.
    //
    static void
    data_migration_function (schema_version v,
                             data_migration_function_type f,
                             const std::string& name = "")
    {
      data_migration_function (id_common, v, f, name);
    }

    // Database-specific data migration.
    //
    static void
    data_migration_function (database& db,
                             schema_version v,
                             data_migration_function_type f,
                             const std::string& name = "")
    {
      data_migration_function (db.id (), v, f, name);
    }

    static void
    data_migration_function (database_id,
                             schema_version,
                             data_migration_function_type,
                             const std::string& name = "");

    // Combined schema and data migration.
    //
  public:
    // Migrate both schema and data to the specified version. If version
    // is not specified, then migrate to the latest version.
    //
    static void
    migrate (database&, schema_version = 0, const std::string& name = "");

    // Schema version information.
    //
  public:
    // Return 0 if current is greater or equal to the latest version.
    // If current is not specified, get the current version from the
    // database.
    //
    static schema_version
    next_version (const database& db,
                  schema_version current = 0,
                  const std::string& name = "")
    {
      return next_version (db.id (),
                           current == 0 ? db.schema_version () : current,
                           name);
    }

    static schema_version
    next_version (database_id,
                  schema_version current,
                  const std::string& name = "");

    static schema_version
    latest_version (const database& db, const std::string& name = "")
    {
      return latest_version (db.id (), name);
    }

    static schema_version
    latest_version (database_id, const std::string& name = "");

    // Schema existence.
    //
  public:
    // Test for presence of a schema with a specific name.
    //
    static bool
    exists (const database& db, const std::string& name = "")
    {
      return exists (db.id (), name);
    }

    static bool
    exists (database_id, const std::string& name = "");

  private:
    enum migrate_mode
    {
      migrate_pre,
      migrate_post,
      migrate_both
    };

    static void
    migrate_schema_impl (database&,
                         schema_version,
                         const std::string& name,
                         migrate_mode);
  };

  // Static data migration function registration.
  //
  struct LIBODB_EXPORT data_migration_entry
  {
    typedef schema_catalog::data_migration_function_type function_type;

    data_migration_entry (schema_version v,
                          function_type f,
                          const std::string& name = "")
    {
      schema_catalog::data_migration_function (v, f, name);
    }

    data_migration_entry (database_id id,
                          schema_version v,
                          function_type f,
                          const std::string& name = "")
    {
      schema_catalog::data_migration_function (id, v, f, name);
    }
  };

  namespace common
  {
    using odb::schema_catalog;
    using odb::data_migration_entry;
  }
}

#include <odb/post.hxx>

#endif // ODB_SCHEMA_CATALOG_HXX