1 /* 2 * Copyright (c) 2023 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 DATASHARESERVICE_DB_DELEGATE_H 17 #define DATASHARESERVICE_DB_DELEGATE_H 18 19 #include <string> 20 21 #include "abs_shared_result_set.h" 22 #include "concurrent_map.h" 23 #include "datashare_predicates.h" 24 #include "datashare_result_set.h" 25 #include "datashare_values_bucket.h" 26 #include "executor_pool.h" 27 #include "metadata/store_meta_data.h" 28 #include "result_set.h" 29 #include "serializable/serializable.h" 30 31 namespace OHOS::DataShare { 32 class DBDelegate { 33 public: 34 using Time = std::chrono::steady_clock::time_point; 35 static std::shared_ptr<DBDelegate> Create(DistributedData::StoreMetaData &metaData, 36 const std::string &extUri = "", const std::string &backup = ""); 37 virtual int64_t Insert(const std::string &tableName, const DataShareValuesBucket &valuesBucket) = 0; 38 virtual int64_t Update(const std::string &tableName, const DataSharePredicates &predicate, 39 const DataShareValuesBucket &valuesBucket) = 0; 40 virtual int64_t Delete(const std::string &tableName, const DataSharePredicates &predicate) = 0; 41 virtual std::pair<int, std::shared_ptr<DataShareResultSet>> Query(const std::string &tableName, 42 const DataSharePredicates &predicates, const std::vector<std::string> &columns, 43 const int32_t callingPid) = 0; 44 virtual std::string Query( 45 const std::string &sql, const std::vector<std::string> &selectionArgs = std::vector<std::string>()) = 0; 46 virtual std::shared_ptr<NativeRdb::ResultSet> QuerySql(const std::string &sql) = 0; 47 virtual bool IsInvalid() = 0; 48 static void SetExecutorPool(std::shared_ptr<ExecutorPool> executor); 49 static void EraseStoreCache(const int32_t tokenId); 50 virtual std::pair<int64_t, int64_t> InsertEx(const std::string &tableName, 51 const DataShareValuesBucket &valuesBucket) = 0; 52 virtual std::pair<int64_t, int64_t> UpdateEx(const std::string &tableName, 53 const DataSharePredicates &predicate, const DataShareValuesBucket &valuesBucket) = 0; 54 virtual std::pair<int64_t, int64_t> DeleteEx(const std::string &tableName, 55 const DataSharePredicates &predicate) = 0; 56 private: 57 static void GarbageCollect(); 58 static void StartTimer(); 59 struct Entity { 60 explicit Entity(std::shared_ptr<DBDelegate> store); 61 std::shared_ptr<DBDelegate> store_; 62 Time time_; 63 }; 64 static constexpr int NO_CHANGE_VERSION = -1; 65 static constexpr int64_t INTERVAL = 20; //seconds 66 static ConcurrentMap<uint32_t, std::map<std::string, std::shared_ptr<Entity>>> stores_; 67 static std::shared_ptr<ExecutorPool> executor_; 68 static ExecutorPool::TaskId taskId_; 69 }; 70 71 class Id : public DistributedData::Serializable { 72 public: 73 static constexpr int INVALID_USER = -1; 74 Id(const std::string &id, const int32_t userId); 75 ~Id() = default; 76 bool Marshal(json &node) const override; 77 bool Unmarshal(const json &node) override; string()78 operator std::string() 79 { 80 return DistributedData::Serializable::Marshall(*this); 81 } 82 83 private: 84 std::string _id; 85 int32_t userId; 86 }; 87 88 class VersionData : public DistributedData::Serializable { 89 public: 90 explicit VersionData(int version); 91 bool Marshal(json &node) const override; 92 bool Unmarshal(const json &node) override; SetVersion(int ver)93 virtual void SetVersion(int ver) 94 { 95 version = ver; 96 }; GetVersion()97 virtual int GetVersion() const 98 { 99 return version; 100 }; 101 102 private: 103 int version; 104 }; 105 106 class KvData { 107 public: 108 explicit KvData(const Id &id); 109 const std::string &GetId() const; 110 virtual bool HasVersion() const = 0; 111 virtual int GetVersion() const = 0; 112 virtual std::string GetValue() const = 0; 113 114 private: 115 std::string id; 116 }; 117 118 class KvDBDelegate { 119 public: 120 static constexpr const char *TEMPLATE_TABLE = "template_"; 121 static constexpr const char *DATA_TABLE = "data_"; 122 static std::shared_ptr<KvDBDelegate> GetInstance( 123 bool reInit = false, const std::string &dir = "", const std::shared_ptr<ExecutorPool> &executors = nullptr); 124 virtual ~KvDBDelegate() = default; 125 virtual int32_t Upsert(const std::string &collectionName, const KvData &value) = 0; 126 virtual int32_t Delete(const std::string &collectionName, const std::string &filter) = 0; 127 virtual int32_t Get(const std::string &collectionName, const Id &id, std::string &value) = 0; 128 virtual int32_t Get(const std::string &collectionName, const std::string &filter, const std::string &projection, 129 std::string &result) = 0; 130 virtual int32_t GetBatch(const std::string &collectionName, const std::string &filter, 131 const std::string &projection, std::vector<std::string> &result) = 0; 132 virtual void NotifyBackup() = 0; 133 }; 134 } // namespace OHOS::DataShare 135 #endif // DATASHARESERVICE_DB_DELEGATE_H 136