1 /* 2 * Copyright (c) 2021 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef SQLITE_STORAGE_ENGINE_H 17 #define SQLITE_STORAGE_ENGINE_H 18 19 #include <vector> 20 21 #include "macro_utils.h" 22 #include "sqlite_utils.h" 23 #include "storage_engine.h" 24 25 namespace DistributedDB { 26 class SQLiteStorageEngine : public StorageEngine { 27 public: 28 SQLiteStorageEngine(); 29 ~SQLiteStorageEngine() override; 30 31 // Delete the copy and assign constructors 32 DISABLE_COPY_ASSIGN_MOVE(SQLiteStorageEngine); 33 34 int InitSQLiteStorageEngine(const StorageEngineAttr &poolSize, const OpenDbProperties &option, 35 const std::string &identifier = std::string()); 36 37 bool IsNeedTobeReleased() const override; 38 39 const std::string &GetIdentifier() const override; 40 41 EngineState GetEngineState() const override; 42 43 int ExecuteMigrate() override; 44 45 void SetEngineState(EngineState state) override; 46 47 virtual void IncreaseCacheRecordVersion(); 48 virtual uint64_t GetCacheRecordVersion() const; 49 virtual uint64_t GetAndIncreaseCacheRecordVersion(); 50 51 virtual bool IsEngineCorrupted() const; 52 53 void ClearEnginePasswd() override; 54 55 int CheckEngineOption(const KvDBProperties &kvDBProp) const override; 56 57 protected: 58 59 virtual int Upgrade(sqlite3 *db); 60 61 virtual StorageExecutor *NewSQLiteStorageExecutor(sqlite3 *dbHandle, bool isWrite, bool isMemDb) = 0; 62 63 int CreateNewExecutor(bool isWrite, StorageExecutor *&handle) override; 64 65 virtual int ReInit(); 66 67 OpenDbProperties option_; 68 }; 69 } // namespace DistributedDB 70 #endif // SQLITE_STORAGE_ENGINE_H 71