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/read_backend.hpp 30 /// Interface to the backend database for read-only operations. 31 32 #if !defined(STORE_READ_BACKEND_HPP) 33 #define STORE_READ_BACKEND_HPP 34 35 #include "store/read_backend_fwd.hpp" 36 37 #include <memory> 38 39 #include "store/read_transaction_fwd.hpp" 40 #include "utils/fs/path_fwd.hpp" 41 #include "utils/sqlite/database_fwd.hpp" 42 43 namespace store { 44 45 46 namespace detail { 47 48 49 utils::sqlite::database open_and_setup(const utils::fs::path&, const int); 50 51 52 } // anonymous namespace 53 54 55 /// Public interface to the database store for read-only operations. 56 class read_backend { 57 struct impl; 58 59 /// Pointer to the shared internal implementation. 60 std::shared_ptr< impl > _pimpl; 61 62 read_backend(impl*); 63 64 public: 65 ~read_backend(void); 66 67 static read_backend open_ro(const utils::fs::path&); 68 void close(void); 69 70 utils::sqlite::database& database(void); 71 read_transaction start_read(void); 72 }; 73 74 75 } // namespace store 76 77 #endif // !defined(STORE_READ_BACKEND_HPP) 78