/usr/include/odb/database.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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | // file : odb/database.hxx
// copyright : Copyright (c) 2009-2015 Code Synthesis Tools CC
// license : GNU GPL v2; see accompanying LICENSE file
#ifndef ODB_DATABASE_HXX
#define ODB_DATABASE_HXX
#include <odb/pre.hxx>
#include <odb/details/config.hxx> // ODB_CXX11
#include <map>
#include <string>
#include <memory> // std::auto_ptr, std::unique_ptr
#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/traits.hxx>
#include <odb/forward.hxx>
#include <odb/schema-version.hxx>
#include <odb/query.hxx>
#include <odb/prepared-query.hxx>
#include <odb/result.hxx>
#include <odb/connection.hxx>
#include <odb/exceptions.hxx>
#include <odb/details/export.hxx>
#include <odb/details/mutex.hxx>
#include <odb/details/c-string.hxx>
#include <odb/details/function-wrapper.hxx>
#include <odb/details/meta/answer.hxx>
namespace odb
{
class transaction_impl;
class LIBODB_EXPORT database
{
public:
virtual
~database ();
// Object persistence API.
//
public:
// Make the object persistent.
//
template <typename T>
typename object_traits<T>::id_type
persist (T& object);
template <typename T>
typename object_traits<T>::id_type
persist (const T& object);
template <typename T>
typename object_traits<T>::id_type
persist (T* obj_ptr);
template <typename T, template <typename> class P>
typename object_traits<T>::id_type
persist (const P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
typename object_traits<T>::id_type
persist (const P<T, A1>& obj_ptr);
template <typename T, template <typename> class P>
typename object_traits<T>::id_type
persist (P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
typename object_traits<T>::id_type
persist (P<T, A1>& obj_ptr);
template <typename T>
typename object_traits<T>::id_type
persist (const typename object_traits<T>::pointer_type& obj_ptr);
// Bulk persist. Can be a range of references or pointers (including
// smart pointers) to objects.
//
template <typename I>
void
persist (I begin, I end, bool continue_failed = true);
// Load an object. Throw object_not_persistent if not found.
//
template <typename T>
typename object_traits<T>::pointer_type
load (const typename object_traits<T>::id_type& id);
template <typename T>
void
load (const typename object_traits<T>::id_type& id, T& object);
// Load (or reload, if it is already loaded) a section of an object.
//
template <typename T>
void
load (T& object, section&);
// Reload an object.
//
template <typename T>
void
reload (T& object);
template <typename T>
void
reload (T* obj_ptr);
template <typename T, template <typename> class P>
void
reload (const P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
void
reload (const P<T, A1>& obj_ptr);
template <typename T, template <typename> class P>
void
reload (P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
void
reload (P<T, A1>& obj_ptr);
template <typename T>
void
reload (const typename object_traits<T>::pointer_type& obj_ptr);
// Loan an object if found. Return NULL/false if not found.
//
template <typename T>
typename object_traits<T>::pointer_type
find (const typename object_traits<T>::id_type& id);
template <typename T>
bool
find (const typename object_traits<T>::id_type& id, T& object);
// Update the state of a modified objects.
//
template <typename T>
void
update (T& object);
template <typename T>
void
update (T* obj_ptr);
template <typename T, template <typename> class P>
void
update (const P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
void
update (const P<T, A1>& obj_ptr);
template <typename T, template <typename> class P>
void
update (P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
void
update (P<T, A1>& obj_ptr);
template <typename T>
void
update (const typename object_traits<T>::pointer_type& obj_ptr);
// Bulk update. Can be a range of references or pointers (including
// smart pointers) to objects.
//
template <typename I>
void
update (I begin, I end, bool continue_failed = true);
// Update a section of an object. Throws section_not_loaded exception
// if section is not loaded. Note also that this function does not
// clear the changed flag if it is set.
//
template <typename T>
void
update (const T& object, const section&);
// Make the object transient. Throw object_not_persistent if not
// found.
//
template <typename T>
void
erase (const typename object_traits<T>::id_type& id);
template <typename T>
void
erase (T& object);
template <typename T>
void
erase (T* obj_ptr);
template <typename T, template <typename> class P>
void
erase (const P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
void
erase (const P<T, A1>& obj_ptr);
template <typename T, template <typename> class P>
void
erase (P<T>& obj_ptr);
template <typename T, typename A1, template <typename, typename> class P>
void
erase (P<T, A1>& obj_ptr);
template <typename T>
void
erase (const typename object_traits<T>::pointer_type& obj_ptr);
// Bulk erase.
//
template <typename T, typename I>
void
erase (I id_begin, I id_end, bool continue_failed = true);
// Can be a range of references or pointers (including smart pointers)
// to objects.
//
template <typename I>
void
erase (I obj_begin, I obj_end, bool continue_failed = true);
// Erase multiple objects matching a query predicate.
//
template <typename T>
unsigned long long
erase_query ();
template <typename T>
unsigned long long
erase_query (const char*);
template <typename T>
unsigned long long
erase_query (const std::string&);
template <typename T>
unsigned long long
erase_query (const odb::query<T>&);
// Query API.
//
template <typename T>
result<T>
query (bool cache = true);
template <typename T>
result<T>
query (const char*, bool cache = true);
template <typename T>
result<T>
query (const std::string&, bool cache = true);
template <typename T>
result<T>
query (const odb::query<T>&, bool cache = true);
// Query one API.
//
template <typename T>
typename object_traits<T>::pointer_type
query_one ();
template <typename T>
bool
query_one (T& object);
template <typename T>
T
query_value ();
template <typename T>
typename object_traits<T>::pointer_type
query_one (const char*);
template <typename T>
bool
query_one (const char*, T& object);
template <typename T>
T
query_value (const char*);
template <typename T>
typename object_traits<T>::pointer_type
query_one (const std::string&);
template <typename T>
bool
query_one (const std::string&, T& object);
template <typename T>
T
query_value (const std::string&);
template <typename T>
typename object_traits<T>::pointer_type
query_one (const odb::query<T>&);
template <typename T>
bool
query_one (const odb::query<T>&, T& object);
template <typename T>
T
query_value (const odb::query<T>&);
// Query preparation.
//
template <typename T>
prepared_query<T>
prepare_query (const char* name, const char*);
template <typename T>
prepared_query<T>
prepare_query (const char* name, const std::string&);
template <typename T>
prepared_query<T>
prepare_query (const char* name, const odb::query<T>&);
template <typename T>
void
cache_query (const prepared_query<T>&);
template <typename T, typename P>
void
cache_query (const prepared_query<T>&, std::auto_ptr<P> params);
#ifdef ODB_CXX11
template <typename T, typename P>
void
cache_query (const prepared_query<T>&, std::unique_ptr<P> params);
#endif
template <typename T>
prepared_query<T>
lookup_query (const char* name) const;
template <typename T, typename P>
prepared_query<T>
lookup_query (const char* name, P*& params) const;
// Prepared query factory.
//
public:
typedef odb::connection connection_type;
typedef void query_factory_type (const char* name, connection_type&);
typedef query_factory_type* query_factory_ptr;
typedef details::function_wrapper<
query_factory_type> query_factory_wrapper;
#ifndef ODB_CXX11
void
query_factory (const char* name, query_factory_ptr);
#else
template <typename F>
typename std::enable_if<
std::is_convertible<
F, std::function<query_factory_type>>::value, void>::type
query_factory (const char* name, F f)
{
query_factory (name, query_factory_wrapper (std::move (f)));
}
#endif
bool
call_query_factory (const char* name, connection_type&) const;
private:
void
query_factory (const char* name, query_factory_wrapper);
// Native database statement execution.
//
public:
unsigned long long
execute (const char* statement);
unsigned long long
execute (const std::string& statement);
unsigned long long
execute (const char* statement, std::size_t length);
// Transactions.
//
public:
virtual transaction_impl*
begin () = 0;
// Connections.
//
public:
connection_ptr
connection ();
// SQL statement tracing.
//
public:
typedef odb::tracer tracer_type;
void
tracer (tracer_type&);
void
tracer (tracer_type*);
tracer_type*
tracer () const;
// Database schema version.
//
public:
typedef odb::schema_version schema_version_type;
typedef odb::schema_version_migration schema_version_migration_type;
schema_version_type
schema_version (const std::string& schema_name = "") const;
bool
schema_migration (const std::string& schema_name = "") const;
// Note that there is code that relies on the returned reference
// being valid until the version is changed or the database instance
// is destroyed.
//
const schema_version_migration_type&
schema_version_migration (const std::string& schema_name = "") const;
// Set schema version and migration state manually.
//
// Note that the modifier API is not thread-safe. That is, you should
// not modify the schema version while other threads may be accessing
// or modifying the same information.
//
void
schema_version_migration (schema_version_type,
bool migration,
const std::string& schema_name = "");
void
schema_version_migration (const schema_version_migration_type&,
const std::string& schema_name = "");
// Set default schema version table for all the schema names. The table
// name should already be quoted if necessary.
//
void
schema_version_table (const std::string& table_name);
// Set schema version table for a specific schema.
//
void
schema_version_table (const std::string& table_name,
const std::string& schema_name);
// Schema version sequence number. It is incremented every time the
// schema version or migration flag is changed and can be used to
// detect overall version changes. The starting value is 1.
//
unsigned int
schema_version_sequence () const;
protected:
struct schema_version_info: schema_version_migration_type
{
std::string version_table;
};
virtual const schema_version_info&
load_schema_version (const std::string& schema_name) const = 0;
private:
const schema_version_info&
schema_version_migration_ (const std::string& schema_name) const;
// Database id.
//
public:
database_id
id () const;
protected:
database (database_id);
private:
database (const database&);
database& operator= (const database&);
protected:
virtual connection_type*
connection_ () = 0;
protected:
template <typename T, database_id DB>
typename object_traits<T>::id_type
persist_ (T&);
template <typename T, database_id DB>
typename object_traits<T>::id_type
persist_ (const typename object_traits<T>::pointer_type&);
template <typename I, database_id DB>
void
persist_ (I, I, bool);
template <typename I, typename T, database_id DB>
void
persist_ (I, I, bool, details::meta::no ptr);
template <typename I, typename T, database_id DB>
void
persist_ (I, I, bool, details::meta::yes ptr);
template <typename T, database_id DB>
typename object_traits<T>::pointer_type
load_ (const typename object_traits<T>::id_type&);
template <typename T, database_id DB>
void
load_ (const typename object_traits<T>::id_type&, T&);
template <typename T, database_id DB>
void
load_ (T&, section&);
template <typename T, database_id DB>
void
reload_ (T&);
template <typename T, database_id DB>
typename object_traits<T>::pointer_type
find_ (const typename object_traits<T>::id_type&);
template <typename T, database_id DB>
bool
find_ (const typename object_traits<T>::id_type&, T&);
template <typename T, database_id DB>
void
update_ (T&);
template <typename T, database_id DB>
void
update_ (const typename object_traits<T>::pointer_type&);
template <typename I, database_id DB>
void
update_ (I, I, bool);
template <typename T, database_id DB>
void
update_ (const T&, const section&);
template <typename T, database_id DB>
void
erase_ (const typename object_traits<T>::id_type&);
template <typename T, database_id DB>
void
erase_ (T&);
template <typename T, database_id DB>
void
erase_ (const typename object_traits<T>::pointer_type&);
template <typename I, typename T, database_id DB>
void
erase_id_ (I, I, bool);
template <typename I, database_id DB>
void
erase_object_ (I, I, bool);
template <typename T, database_id DB, typename Q>
typename object_traits<T>::pointer_type
query_one_ (const Q&);
template <typename T, database_id DB, typename Q>
bool
query_one_ (const Q&, T&);
template <typename T, database_id DB, typename Q>
T
query_value_ (const Q&);
template <typename T,
database_id DB,
class_kind kind = class_traits<T>::kind>
struct query_;
protected:
typedef
std::map<const char*, query_factory_wrapper, details::c_string_comparator>
query_factory_map;
typedef std::map<std::string, schema_version_info> schema_version_map;
database_id id_;
tracer_type* tracer_;
query_factory_map query_factory_map_;
mutable details::mutex mutex_;
mutable schema_version_map schema_version_map_;
std::string schema_version_table_;
unsigned int schema_version_seq_;
};
}
#include <odb/database.ixx>
#include <odb/database.txx>
#include <odb/post.hxx>
#endif // ODB_DATABASE_HXX
|