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 SINGLE_VER_DATABASE_UPGRADER_H
17 #define SINGLE_VER_DATABASE_UPGRADER_H
18 
19 #include "database_upgrader.h"
20 
21 namespace DistributedDB {
22 class SingleVerDatabaseUpgrader : virtual public DatabaseUpgrader {
23 public:
~SingleVerDatabaseUpgrader()24     ~SingleVerDatabaseUpgrader() override {};
25     int Upgrade() override;
26     virtual bool IsValueNeedUpgrade() const = 0;
27 protected:
28     virtual int BeginUpgrade() = 0;
29     virtual int ExecuteUpgrade();
30     virtual int EndUpgrade(bool isSuccess) = 0;
31 
32     // Database structure related upgrade
33     virtual int GetDatabaseVersion(int &version) const = 0;
34     virtual int SetDatabaseVersion(int version) = 0;
35     virtual int UpgradeFromDatabaseVersion(int version) = 0;
36 
37     // Database version only increased when the structure of database changed
38     int dbVersion_ = 0;
39     bool valueNeedUpgrade_ = false;
40 };
41 } // namespace DistributedDB
42 #endif // SINGLE_VER_DATABASE_UPGRADER_H