sqlite.h

Go to the documentation of this file.

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License 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 SHAKA_EMBEDDED_JS_IDB_SQLITE_H
#define SHAKA_EMBEDDED_JS_IDB_SQLITE_H

#include <atomic>
#include <string>
#include <vector>

#include "shaka/optional.h"
#include "src/util/macros.h"

struct sqlite3;

namespace shaka {
namespace js {
namespace idb {

enum class DatabaseStatus {
  Success,

  NotFound,
  AlreadyExists,
  Busy,
  BadVersionNumber,
  UnknownError,
};

class SqliteTransaction {
 public:
  SqliteTransaction();
  SqliteTransaction(SqliteTransaction&&);
  ~SqliteTransaction();

  SHAKA_NON_COPYABLE_TYPE(SqliteTransaction);

  SqliteTransaction& operator=(SqliteTransaction&&);

  bool valid() const {
    return db_;
  }

  DatabaseStatus CreateDb(const std::string& db_name, int64_t version);
  DatabaseStatus UpdateDbVersion(const std::string& db_name, int64_t version);
  DatabaseStatus DeleteDb(const std::string& db_name);
  DatabaseStatus GetDbVersion(const std::string& db_name, int64_t* version);

  DatabaseStatus CreateObjectStore(const std::string& db_name,
                                   const std::string& store_name);
  DatabaseStatus DeleteObjectStore(const std::string& db_name,
                                   const std::string& store_name);
  DatabaseStatus ListObjectStores(const std::string& db_name,
                                  std::vector<std::string>* names);

  DatabaseStatus AddData(const std::string& db_name,
                         const std::string& store_name,
                         const std::vector<uint8_t>& data, int64_t* key);
  DatabaseStatus GetData(const std::string& db_name,
                         const std::string& store_name, int64_t key,
                         std::vector<uint8_t>* data);
  DatabaseStatus UpdateData(const std::string& db_name,
                            const std::string& store_name, int64_t key,
                            const std::vector<uint8_t>& data);
  DatabaseStatus DeleteData(const std::string& db_name,
                            const std::string& store_name, int64_t key);
  DatabaseStatus FindData(const std::string& db_name,
                          const std::string& store_name, optional<int64_t> key,
                          bool ascending, int64_t* found_key);

  DatabaseStatus Commit();
  DatabaseStatus Rollback();

 private:
  DatabaseStatus GetStoreId(const std::string& db_name,
                            const std::string& store_name, int64_t* store_id);

  friend class SqliteConnection;
  sqlite3* db_;
};

class SqliteConnection {
 public:
  explicit SqliteConnection(const std::string& file_path);
  ~SqliteConnection();

  SHAKA_NON_COPYABLE_OR_MOVABLE_TYPE(SqliteConnection);

  DatabaseStatus Init();

  DatabaseStatus BeginTransaction(SqliteTransaction* transaction);


  DatabaseStatus Flush();

 private:
  const std::string path_;
  // Use an atomic variable so it can be accessed from different threads without
  // a lock.  Sqlite is internally thread-safe.
  std::atomic<sqlite3*> db_;
};

}  // namespace idb
}  // namespace js
}  // namespace shaka

#endif  // SHAKA_EMBEDDED_JS_IDB_SQLITE_H