/usr/include/odb/schema-catalog.hxx is in libodb-dev 2.4.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 | // file : odb/schema-catalog.hxx
// copyright : Copyright (c) 2009-2015 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>
#include <cstddef> // std::size_t
#ifdef ODB_CXX11
# include <utility> // std::move
# include <functional> // std::function
# include <type_traits> // std::enable_if, std::is_convertible
#endif
#include <odb/forward.hxx> // schema_version, odb::core
#include <odb/database.hxx>
#include <odb/details/export.hxx>
#include <odb/details/unused.hxx>
#include <odb/details/meta/static-assert.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 database version and also
// check whether we are in migration. Returns the number of calls made.
//
static std::size_t
migrate_data (database&,
schema_version = 0,
const std::string& name = "");
typedef void data_migration_function_type (database&);
typedef data_migration_function_type* data_migration_function_ptr;
typedef details::function_wrapper<data_migration_function_type>
data_migration_function_wrapper;
// The following three variants of the registration functions make
// sure that the version is greater that the base model version.
// This helps with identifying and removing data migration function
// that are no longer required.
//
// Data migration functions are called in the order of registration.
//
#ifndef ODB_CXX11
template <schema_version v, schema_version base>
static void
data_migration_function (data_migration_function_ptr f,
const std::string& name = "")
{
data_migration_function<v, base> (id_common, f, name);
}
#else
template <schema_version v, schema_version base, typename F>
static typename std::enable_if<
std::is_convertible<
F, std::function<data_migration_function_type>>::value, void>::type
data_migration_function (F f, const std::string& name = "")
{
data_migration_function<v, base> (id_common, std::move (f), name);
}
#endif
// Database-specific data migration.
//
#ifndef ODB_CXX11
template <schema_version v, schema_version base>
static void
data_migration_function (database& db,
data_migration_function_ptr f,
const std::string& name = "")
{
data_migration_function<v, base> (db.id (), f, name);
}
#else
template <schema_version v, schema_version base, typename F>
static typename std::enable_if<
std::is_convertible<
F, std::function<data_migration_function_type>>::value, void>::type
data_migration_function (database& db, F f, const std::string& name = "")
{
data_migration_function<v, base> (db.id (), std::move (f), name);
}
#endif
#ifndef ODB_CXX11
template <schema_version v, schema_version base>
static void
data_migration_function (database_id id,
data_migration_function_ptr f,
const std::string& name = "")
{
// If the data migration version is below the base model version
// then it will never be called.
//
// Poor man's static_assert.
//
typedef details::meta::static_assert_test<(v > base || base == 0)>
data_migration_function_is_no_longer_necessary;
char sa [sizeof (data_migration_function_is_no_longer_necessary)];
ODB_POTENTIALLY_UNUSED (sa);
data_migration_function (id, v, f, name);
}
#else
template <schema_version v, schema_version base, typename F>
static typename std::enable_if<
std::is_convertible<
F, std::function<data_migration_function_type>>::value, void>::type
data_migration_function (database_id id, F f, const std::string& name = "")
{
// If the data migration version is below the base model version
// then it will never be called.
//
static_assert (v > base || base == 0,
"data migration function is no longer necessary");
data_migration_function (id, v, std::move (f), name);
}
#endif
// The same as above but take the version as an argument and do
// not check whether it is greater than the base model version.
//
#ifndef ODB_CXX11
static void
data_migration_function (schema_version v,
data_migration_function_ptr f,
const std::string& name = "")
{
data_migration_function (id_common, v, f, name);
}
#else
template <typename F>
static typename std::enable_if<
std::is_convertible<
F, std::function<data_migration_function_type>>::value, void>::type
data_migration_function (schema_version v,
F f,
const std::string& name = "")
{
data_migration_function (id_common, v, std::move (f), name);
}
#endif
#ifndef ODB_CXX11
static void
data_migration_function (database& db,
schema_version v,
data_migration_function_ptr f,
const std::string& name = "")
{
data_migration_function (db.id (), v, f, name);
}
#else
template <typename F>
static typename std::enable_if<
std::is_convertible<
F, std::function<data_migration_function_type>>::value, void>::type
data_migration_function (database& db,
schema_version v,
F f,
const std::string& name = "")
{
data_migration_function (db.id (), v, std::move (f), name);
}
#endif
#ifndef ODB_CXX11
static void
data_migration_function (database_id i,
schema_version v,
data_migration_function_ptr f,
const std::string& name = "")
{
data_migration_function (i,
v,
data_migration_function_wrapper (f),
name);
}
#else
template <typename F>
static typename std::enable_if<
std::is_convertible<
F, std::function<data_migration_function_type>>::value, void>::type
data_migration_function (database_id i,
schema_version v,
F f,
const std::string& name = "")
{
data_migration_function (
i,
v,
data_migration_function_wrapper (std::move (f)),
name);
}
#endif
private:
static void
data_migration_function (database_id,
schema_version,
data_migration_function_wrapper,
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 current model version.
//
static void
migrate (database&, schema_version = 0, const std::string& name = "");
// Schema version information.
//
public:
// Return the base model version.
//
static schema_version
base_version (const database& db, const std::string& name = "")
{
return base_version (db.id (), name);
}
static schema_version
base_version (database_id, const std::string& name = "");
// Return the current model version.
//
static schema_version
current_version (const database& db, const std::string& name = "")
{
return current_version (db.id (), name);
}
static schema_version
current_version (database_id, const std::string& name = "");
// Return current model version + 1 (that is, one past current) if
// the passed version is equal to or greater than current. If the
// version is not specified, then use the current database version.
//
static schema_version
next_version (const database& db,
schema_version v = 0,
const std::string& name = "")
{
return next_version (db.id (), v == 0 ? db.schema_version () : v, name);
}
static schema_version
next_version (database_id,
schema_version,
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.
//
template <schema_version v, schema_version base>
struct data_migration_entry
{
typedef schema_catalog::data_migration_function_type function_type;
#ifndef ODB_CXX11
data_migration_entry (function_type* f, const std::string& name = "")
{
schema_catalog::data_migration_function<v, base> (f, name);
}
#else
template <typename F>
data_migration_entry (F f,
const std::string& name = "",
typename std::enable_if<std::is_convertible<
F, std::function<function_type>>::value>
::type* = 0)
{
schema_catalog::data_migration_function<v, base> (std::move (f), name);
}
#endif
#ifndef ODB_CXX11
data_migration_entry (database_id id,
function_type *f,
const std::string& name = "")
{
schema_catalog::data_migration_function<v, base> (id, v, f, name);
}
#else
template <typename F>
data_migration_entry (database_id id,
F f,
const std::string& name = "",
typename std::enable_if<std::is_convertible<
F, std::function<function_type>>::value>
::type* = 0)
{
schema_catalog::data_migration_function<v, base> (id,
v,
std::move (f),
name);
}
#endif
};
namespace common
{
using odb::schema_catalog;
using odb::data_migration_entry;
}
}
#include <odb/post.hxx>
#endif // ODB_SCHEMA_CATALOG_HXX
|