SQLiteDatabase.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_STORAGE_SQLITESTORAGE_INCLUDE_SQLITESTORAGE_SQLITEDATABASE_H_
#define ALEXA_CLIENT_SDK_STORAGE_SQLITESTORAGE_INCLUDE_SQLITESTORAGE_SQLITEDATABASE_H_

#include <memory>
#include <string>
#include <vector>

#include <sqlite3.h>

#include <SQLiteStorage/SQLiteStatement.h>

namespace alexaClientSDK {
namespace storage {
namespace sqliteStorage {

class SQLiteDatabase {
public:
    class Transaction {
        friend SQLiteDatabase;

    public:
        ~Transaction();

        bool commit();

        bool rollback();

    private:
        Transaction(std::weak_ptr<SQLiteDatabase> dbHandle);

        std::weak_ptr<SQLiteDatabase> m_database;

        bool m_transactionCompleted;
    };

    SQLiteDatabase(const std::string& filePath);

    ~SQLiteDatabase();

    bool initialize();

    bool open();

    bool performQuery(const std::string& sqlString);

    bool tableExists(const std::string& tableName);

    bool clearTable(const std::string& tableName);

    bool dropTable(const std::string& tableName);

    void close();

    std::unique_ptr<SQLiteStatement> createStatement(const std::string& sqlString);

    bool isDatabaseReady();

    std::unique_ptr<Transaction> beginTransaction();

private:
    bool commitTransaction();

    bool rollbackTransaction();

    const std::string m_storageFilePath;

    bool m_transactionIsInProgress;

    sqlite3* m_dbHandle;

    std::shared_ptr<SQLiteDatabase> m_sharedThisPlaceholder;
};

}  // namespace sqliteStorage
}  // namespace storage
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_STORAGE_SQLITESTORAGE_INCLUDE_SQLITESTORAGE_SQLITEDATABASE_H_