KompexSQLiteDatabase.h

Go to the documentation of this file.

/*
    This file is part of Kompex SQLite Wrapper.
    Copyright (c) 2008-2015 Sven Broeske

    Kompex SQLite Wrapper is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Kompex SQLite Wrapper is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Kompex SQLite Wrapper. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef KompexSQLiteDatabase_H
#define KompexSQLiteDatabase_H

#include <string>

#include "sqlite3.h"

#include "KompexSQLitePrerequisites.h"

namespace Kompex
{
    class _SQLiteWrapperExport SQLiteDatabase
    {
    public:
        SQLiteDatabase();

        SQLiteDatabase(const char *filename, int flags, const char *zVfs);

        SQLiteDatabase(const std::string &filename, int flags, const char *zVfs);

        SQLiteDatabase(const wchar_t *filename);

        virtual ~SQLiteDatabase();

        void Open(const char *filename, int flags, const char *zVfs);

        void Open(const std::string &filename, int flags, const char *zVfs);

        void Open(const wchar_t *filename);

        void Close();

        sqlite3 *GetDatabaseHandle() const {return mDatabaseHandle;}
        inline int GetLibVersionNumber() const {return sqlite3_libversion_number();}
        int GetDatabaseChanges() const {return sqlite3_changes(mDatabaseHandle);}
        int GetTotalDatabaseChanges() const {return sqlite3_total_changes(mDatabaseHandle);}
        void InterruptDatabaseOperation() const {sqlite3_interrupt(mDatabaseHandle);}
        int GetAutoCommit() const {return sqlite3_get_autocommit(mDatabaseHandle);}

        inline void ActivateTracing() const {sqlite3_trace(mDatabaseHandle, &Kompex::SQLiteDatabase::TraceOutput, 0);}
        inline void ActivateProfiling() const {sqlite3_profile(mDatabaseHandle, &Kompex::SQLiteDatabase::ProfileOutput, 0);}

        inline void SetSoftHeapLimit(int heapLimit) const {sqlite3_soft_heap_limit(heapLimit);}

        inline int ReleaseMemory(int bytesOfMemory) const {return sqlite3_release_memory(bytesOfMemory);}

        long long GetMemoryUsage() const {return sqlite3_memory_used();}

        long long GetMemoryHighwaterMark(bool resetFlag = false) const {return sqlite3_memory_highwater(resetFlag);}

        enum UtfEncoding {UTF8, UTF16};

        void MoveDatabaseToMemory(UtfEncoding encoding = UTF8);

        void SaveDatabaseFromMemoryToFile(const std::string &filename = "");
        void SaveDatabaseFromMemoryToFile(const wchar_t *filename);

        long long GetLastInsertRowId() const {return sqlite3_last_insert_rowid(mDatabaseHandle);}

        bool IsDatabaseReadOnly();

        inline void ReleaseMemory() {sqlite3_db_release_memory(mDatabaseHandle);}

        void CreateModule(const std::string &moduleName, const sqlite3_module *module, void *clientData, void(*xDestroy)(void*));

        int GetNumberOfCheckedOutLookasideMemorySlots() const;
        int GetHeapMemoryUsedByPagerCaches() const;
        int GetHeapMemoryUsedToStoreSchemas() const;
        int GetHeapAndLookasideMemoryUsedByPreparedStatements() const;
        int GetPagerCacheHitCount() const;
        int GetPagerCacheMissCount() const;
        int GetNumberOfDirtyCacheEntries() const;
        int GetNumberOfUnresolvedForeignKeys() const;
                        
        int GetHighestNumberOfCheckedOutLookasideMemorySlots(bool resetValue = false);
        int GetLookasideMemoryHitCount(bool resetValue = false);
        int GetLookasideMemoryMissCountDueToSmallSlotSize(bool resetValue = false);
        int GetLookasideMemoryMissCountDueToFullMemory(bool resetValue = false);

    protected:
        static void TraceOutput(void *ptr, const char *sql);
        static void ProfileOutput(void* ptr, const char* sql, sqlite3_uint64 time);
        static int ProcessDDLRow(void *db, int nColumns, char **values, char **columns);
        static int ProcessDMLRow(void *db, int nColumns, char **values, char **columns);
        void TakeSnapshot(sqlite3 *destinationDatabase);
        int GetRuntimeStatusInformation(int operation, bool highwaterValue = false, bool resetFlag = false) const;

    private:
        struct sqlite3 *mDatabaseHandle;
        std::string mDatabaseFilenameUtf8;
        std::wstring mDatabaseFilenameUtf16;
        bool mIsMemoryDatabaseActive;

        void CleanUpFailedMemoryDatabase(sqlite3 *memoryDatabase, sqlite3 *rollbackDatabase, bool isDetachNecessary, bool isRollbackNecessary, sqlite3_stmt *stmt, const std::string &errMsg, int internalSqliteErrCode);

    };

};

#endif // KompexSQLiteDatabase_H