• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_KVDB_HANDLE_POOL_H
17 #define SQLITE_KVDB_HANDLE_POOL_H
18 
19 #include <vector>
20 
21 #include "macro_utils.h"
22 #include "storage_engine.h"
23 #include "sqlite_utils.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     const OpenDbProperties &GetOpenOption() const;
48 
49     virtual void IncreaseCacheRecordVersion();
50     virtual uint64_t GetCacheRecordVersion() const;
51     virtual uint64_t GetAndIncreaseCacheRecordVersion();
52 
53     virtual bool IsEngineCorrupted() const;
54 
55     void ClearEnginePasswd() override;
56 
57     int CheckEngineOption(const KvDBProperties &kvdbOption) const override;
58 
59 protected:
60 
61     virtual int Upgrade(sqlite3 *db);
62 
63     virtual StorageExecutor *NewSQLiteStorageExecutor(sqlite3 *dbHandle, bool isWrite, bool isMemDb) = 0;
64 
65     int CreateNewExecutor(bool isWrite, StorageExecutor *&handle) override;
66 
67     virtual int ReInit();
68 
69     bool IsNeedMigrate() const override;
70 
71     OpenDbProperties option_;
72 };
73 } // namespace DistributedDB
74 #endif // SQLITE_DB_HANDLE_H
75