connection.hpp

Go to the documentation of this file.

/*##############################################################################
 VSQLite++ - virtuosic bytes SQLite3 C++ wrapper
 
 Copyright (c) 2006-2014 Vinzenz Feenstra vinzenz.feenstra@gmail.com
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of virtuosic bytes nor the names of its contributors may
   be used to endorse or promote products derived from this software without
   specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 
##############################################################################*/
#ifndef GUARD_SQLITE_CONNECTION_HPP_INCLUDED
#define GUARD_SQLITE_CONNECTION_HPP_INCLUDED
#include <cstdint>
#include <memory>
#include <string>
#include <sqlite/filesystem_adapter.hpp>
#include <sqlite/statement_cache.hpp>

struct sqlite3;
 
namespace sqlite {
inline namespace v2 {
    enum class open_mode {
        open_readonly,  
        open_existing,  
        open_or_create, 
        always_create   
    };

    struct connection {
        connection(std::string const &db);
        connection(std::string const &db, filesystem_adapter_ptr fs);
        connection(connection const &)            = delete;
        connection &operator=(connection const &) = delete;

        connection(std::string const &db, sqlite::open_mode open_mode);
        connection(std::string const &db, sqlite::open_mode open_mode, filesystem_adapter_ptr fs);

        ~connection();

        void attach(std::string const &db, std::string const &database_alias);

        void detach(std::string const &database_alias);

        std::int64_t get_last_insert_rowid();
 
        void configure_statement_cache(statement_cache_config const &cfg);
        statement_cache_config statement_cache_settings() const;
        void clear_statement_cache();
 
    private:
        friend struct private_accessor;
 
    private:
        void open(std::string const &db);
        void open(std::string const &db, bool readonly);
        void open(std::string const &db, sqlite::open_mode open_mode);
        void close();
        void access_check();
        void open_with_flags(std::string const &db, int flags);
        sqlite3_stmt *acquire_cached_statement(std::string const &sql);
        void release_cached_statement(std::string const &sql, sqlite3_stmt *stmt);
 
    private:
        sqlite3 *handle;
        filesystem_adapter_ptr filesystem;
        statement_cache cache_;
    };
} // namespace v2
} // namespace sqlite
#endif // GUARD_SQLITE_CONNECTION_HPP_INCLUDED