contrib/kyua/store/write_backend.hpp

   1 // Copyright 2011 The Kyua Authors.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 // * Redistributions of source code must retain the above copyright
   9 //   notice, this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright
  11 //   notice, this list of conditions and the following disclaimer in the
  12 //   documentation and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors
  14 //   may be used to endorse or promote products derived from this software
  15 //   without specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 /// \file store/write_backend.hpp
  30 /// Interface to the backend database for write-only operations.
  31
  32 #if !defined(STORE_WRITE_BACKEND_HPP)
  33 #define STORE_WRITE_BACKEND_HPP
  34
  35 #include "store/write_backend_fwd.hpp"
  36
  37 #include <memory>
  38
  39 #include "store/metadata_fwd.hpp"
  40 #include "store/write_transaction_fwd.hpp"
  41 #include "utils/fs/path_fwd.hpp"
  42 #include "utils/sqlite/database_fwd.hpp"
  43
  44 namespace store {
  45
  46
  47 namespace detail {
  48
  49
  50 utils::fs::path schema_file(void);
  51 metadata initialize(utils::sqlite::database&);
  52
  53
  54 }  // anonymous namespace
  55
  56
  57 /// Public interface to the database store for write-only operations.
  58 class write_backend {
  59     struct impl;
  60
  61     /// Pointer to the shared internal implementation.
  62     std::shared_ptr< impl > _pimpl;
  63
  64     friend class metadata;
  65
  66     write_backend(impl*);
  67
  68 public:
  69     ~write_backend(void);
  70
  71     static write_backend open_rw(const utils::fs::path&);
  72     void close(void);
  73
  74     utils::sqlite::database& database(void);
  75     write_transaction start_write(void);
  76 };
  77
  78
  79 }  // namespace store
  80
  81 #endif  // !defined(STORE_WRITE_BACKEND_HPP)