111be35a1SLionel Sambuc // Copyright 2011 Google Inc. 211be35a1SLionel Sambuc // All rights reserved. 311be35a1SLionel Sambuc // 411be35a1SLionel Sambuc // Redistribution and use in source and binary forms, with or without 511be35a1SLionel Sambuc // modification, are permitted provided that the following conditions are 611be35a1SLionel Sambuc // met: 711be35a1SLionel Sambuc // 811be35a1SLionel Sambuc // * Redistributions of source code must retain the above copyright 911be35a1SLionel Sambuc // notice, this list of conditions and the following disclaimer. 1011be35a1SLionel Sambuc // * Redistributions in binary form must reproduce the above copyright 1111be35a1SLionel Sambuc // notice, this list of conditions and the following disclaimer in the 1211be35a1SLionel Sambuc // documentation and/or other materials provided with the distribution. 1311be35a1SLionel Sambuc // * Neither the name of Google Inc. nor the names of its contributors 1411be35a1SLionel Sambuc // may be used to endorse or promote products derived from this software 1511be35a1SLionel Sambuc // without specific prior written permission. 1611be35a1SLionel Sambuc // 1711be35a1SLionel Sambuc // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1811be35a1SLionel Sambuc // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1911be35a1SLionel Sambuc // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2011be35a1SLionel Sambuc // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2111be35a1SLionel Sambuc // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2211be35a1SLionel Sambuc // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2311be35a1SLionel Sambuc // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2411be35a1SLionel Sambuc // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2511be35a1SLionel Sambuc // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2611be35a1SLionel Sambuc // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2711be35a1SLionel Sambuc // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2811be35a1SLionel Sambuc 2911be35a1SLionel Sambuc /// \file utils/sqlite/database.hpp 3011be35a1SLionel Sambuc /// Wrapper classes and utilities for the SQLite database state. 3111be35a1SLionel Sambuc /// 3211be35a1SLionel Sambuc /// This module contains thin RAII wrappers around the SQLite 3 structures 3311be35a1SLionel Sambuc /// representing the database, and lightweight. 3411be35a1SLionel Sambuc 3511be35a1SLionel Sambuc #if !defined(UTILS_SQLITE_DATABASE_HPP) 3611be35a1SLionel Sambuc #define UTILS_SQLITE_DATABASE_HPP 3711be35a1SLionel Sambuc 3811be35a1SLionel Sambuc extern "C" { 3911be35a1SLionel Sambuc #include <stdint.h> 4011be35a1SLionel Sambuc } 4111be35a1SLionel Sambuc 4211be35a1SLionel Sambuc #include <cstddef> 4311be35a1SLionel Sambuc 4411be35a1SLionel Sambuc #include "utils/fs/path.hpp" 45*84d9c625SLionel Sambuc #include "utils/shared_ptr.hpp" 4611be35a1SLionel Sambuc 4711be35a1SLionel Sambuc namespace utils { 4811be35a1SLionel Sambuc namespace sqlite { 4911be35a1SLionel Sambuc 5011be35a1SLionel Sambuc 5111be35a1SLionel Sambuc class database_c_gate; 5211be35a1SLionel Sambuc class statement; 5311be35a1SLionel Sambuc class transaction; 5411be35a1SLionel Sambuc 5511be35a1SLionel Sambuc 5611be35a1SLionel Sambuc /// Constant for the database::open flags: open in read-only mode. 5711be35a1SLionel Sambuc static const int open_readonly = 1 << 0; 5811be35a1SLionel Sambuc /// Constant for the database::open flags: open in read-write mode. 5911be35a1SLionel Sambuc static const int open_readwrite = 1 << 1; 6011be35a1SLionel Sambuc /// Constant for the database::open flags: create on open. 6111be35a1SLionel Sambuc static const int open_create = 1 << 2; 6211be35a1SLionel Sambuc 6311be35a1SLionel Sambuc 6411be35a1SLionel Sambuc /// A RAII model for the SQLite 3 database. 6511be35a1SLionel Sambuc /// 6611be35a1SLionel Sambuc /// This class holds the database of the SQLite 3 interface during its existence 6711be35a1SLionel Sambuc /// and provides wrappers around several SQLite 3 library functions that operate 6811be35a1SLionel Sambuc /// on such database. 6911be35a1SLionel Sambuc /// 7011be35a1SLionel Sambuc /// These wrapper functions differ from the C versions in that they use the 7111be35a1SLionel Sambuc /// implicit database hold by the class, they use C++ types where appropriate 7211be35a1SLionel Sambuc /// and they use exceptions to report errors. 7311be35a1SLionel Sambuc /// 7411be35a1SLionel Sambuc /// The wrappers intend to be as lightweight as possible but, in some 7511be35a1SLionel Sambuc /// situations, they are pretty complex because of the workarounds needed to 7611be35a1SLionel Sambuc /// make the SQLite 3 more C++ friendly. We prefer a clean C++ interface over 7711be35a1SLionel Sambuc /// optimal efficiency, so this is OK. 7811be35a1SLionel Sambuc class database { 7911be35a1SLionel Sambuc struct impl; 8011be35a1SLionel Sambuc 8111be35a1SLionel Sambuc /// Pointer to the shared internal implementation. 82*84d9c625SLionel Sambuc std::shared_ptr< impl > _pimpl; 8311be35a1SLionel Sambuc 8411be35a1SLionel Sambuc friend class database_c_gate; 8511be35a1SLionel Sambuc database(void*, const bool); 8611be35a1SLionel Sambuc void* raw_database(void); 8711be35a1SLionel Sambuc 8811be35a1SLionel Sambuc public: 8911be35a1SLionel Sambuc ~database(void); 9011be35a1SLionel Sambuc 9111be35a1SLionel Sambuc static database in_memory(void); 9211be35a1SLionel Sambuc static database open(const fs::path&, int); 9311be35a1SLionel Sambuc static database temporary(void); 9411be35a1SLionel Sambuc void close(void); 9511be35a1SLionel Sambuc 9611be35a1SLionel Sambuc void exec(const std::string&); 9711be35a1SLionel Sambuc 9811be35a1SLionel Sambuc transaction begin_transaction(void); 9911be35a1SLionel Sambuc statement create_statement(const std::string&); 10011be35a1SLionel Sambuc 10111be35a1SLionel Sambuc int64_t last_insert_rowid(void); 10211be35a1SLionel Sambuc }; 10311be35a1SLionel Sambuc 10411be35a1SLionel Sambuc 10511be35a1SLionel Sambuc } // namespace sqlite 10611be35a1SLionel Sambuc } // namespace utils 10711be35a1SLionel Sambuc 10811be35a1SLionel Sambuc #endif // !defined(UTILS_SQLITE_DATABASE_HPP) 109