backup_iface.hpp

/*
 Copyright 2024 Eugene Gershnik
 
 Use of this source code is governed by a BSD-style
 license that can be found in the LICENSE file or at
 https://github.com/gershnik/thinsqlitepp/blob/master/LICENSE
*/
 
#ifndef HEADER_SQLITEPP_BACKUP_IFACE_INCLUDED
#define HEADER_SQLITEPP_BACKUP_IFACE_INCLUDED
 
#include "handle.hpp"
#include "database_iface.hpp"
#include "exception_iface.hpp"
 
namespace thinsqlitepp
{

    SQLITEPP_EXPORTED
    class backup final : public handle<sqlite3_backup, backup>
    {
    public:
        static std::unique_ptr<backup> init(database & dst, const string_param & dest_dbname, 
                                            database & src, const string_param & src_dbname)
        {
            std::unique_ptr<backup> ret(backup::from(
                sqlite3_backup_init(dst.c_ptr(), dest_dbname.c_str(), src.c_ptr(), src_dbname.c_str())));
            if (!ret)
                throw exception(sqlite3_errcode(dst.c_ptr()), dst);
            return ret;
        }

        ~backup() noexcept
            { sqlite3_backup_finish(c_ptr()); }
 

        enum step_result 
        {
            done,       
            success,    
            busy,       
            locked      
        };

        step_result step(int page_count)
        {
            int ret = sqlite3_backup_step(c_ptr(), page_count);
            switch(ret)
            {
            case SQLITE_BUSY: return busy;
            case SQLITE_LOCKED: return locked;
            case SQLITE_DONE: return done;
            case SQLITE_OK: return success;
            }
            throw exception(ret);
        }

        int remaining() const noexcept
            { return sqlite3_backup_remaining(c_ptr()); }
 

        int pagecount() const noexcept
            { return sqlite3_backup_pagecount(c_ptr()); }
    };
 

}
 
 
#endif