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 RELATIONAL_STORE_DELEGATE_H 17 #define RELATIONAL_STORE_DELEGATE_H 18 19 #include <map> 20 #include <memory> 21 #include <optional> 22 #include "distributeddb/result_set.h" 23 #include "cloud/cloud_store_types.h" 24 #include "cloud/icloud_db.h" 25 #include "cloud/icloud_data_translate.h" 26 #include "cloud/iAssetLoader.h" 27 #include "query.h" 28 #include "store_types.h" 29 #include "store_observer.h" 30 31 namespace DistributedDB { 32 class RelationalStoreDelegate { 33 public: 34 DB_API virtual ~RelationalStoreDelegate() = default; 35 36 struct Option { 37 StoreObserver *observer = nullptr; 38 // communicator label use dualTuple hash or not; 39 bool syncDualTupleMode = false; 40 bool isEncryptedDb = false; 41 CipherType cipher = CipherType::DEFAULT; 42 CipherPassword passwd; 43 uint32_t iterateTimes = 0; 44 DistributedTableMode tableMode = DistributedTableMode::SPLIT_BY_DEVICE; 45 }; 46 47 struct StoreConfig { 48 std::optional<DistributedTableMode> tableMode; 49 }; 50 SetStoreConfig(const StoreConfig & config)51 DB_API virtual DBStatus SetStoreConfig(const StoreConfig &config) 52 { 53 return OK; 54 } 55 56 DB_API DBStatus CreateDistributedTable(const std::string &tableName, TableSyncType type = DEVICE_COOPERATION) 57 { 58 return CreateDistributedTableInner(tableName, type); 59 } 60 61 DB_API virtual DBStatus Sync(const std::vector<std::string> &devices, SyncMode mode, 62 const Query &query, const SyncStatusCallback &onComplete, bool wait) = 0; 63 GetCloudSyncTaskCount()64 DB_API virtual int32_t GetCloudSyncTaskCount() 65 { 66 return 0; 67 } 68 69 DB_API DBStatus RemoveDeviceData(const std::string &device, ClearMode mode = DEFAULT) 70 { 71 return RemoveDeviceDataInner(device, mode); 72 } 73 74 DB_API virtual DBStatus RemoveDeviceData(const std::string &device, const std::string &tableName) = 0; 75 76 // timeout is in ms. 77 DB_API virtual DBStatus RemoteQuery(const std::string &device, const RemoteCondition &condition, 78 uint64_t timeout, std::shared_ptr<ResultSet> &result) = 0; 79 80 // remove all device data 81 DB_API virtual DBStatus RemoveDeviceData() = 0; 82 Sync(const std::vector<std::string> & devices,SyncMode mode,const Query & query,const SyncProcessCallback & onProcess,int64_t waitTime)83 DB_API virtual DBStatus Sync([[gnu::unused]] const std::vector<std::string> &devices, 84 [[gnu::unused]] SyncMode mode, [[gnu::unused]] const Query &query, 85 [[gnu::unused]] const SyncProcessCallback &onProcess, [[gnu::unused]] int64_t waitTime) 86 { 87 return OK; 88 } 89 SetCloudDB(const std::shared_ptr<ICloudDb> & cloudDb)90 DB_API virtual DBStatus SetCloudDB([[gnu::unused]] const std::shared_ptr<ICloudDb> &cloudDb) 91 { 92 return OK; 93 } 94 SetCloudDbSchema(const DataBaseSchema & schema)95 DB_API virtual DBStatus SetCloudDbSchema([[gnu::unused]] const DataBaseSchema &schema) 96 { 97 return OK; 98 } 99 100 // just support one observer exist at same time 101 DB_API virtual DBStatus RegisterObserver(StoreObserver *observer) = 0; 102 103 DB_API virtual DBStatus UnRegisterObserver() = 0; 104 105 DB_API virtual DBStatus UnRegisterObserver(StoreObserver *observer) = 0; 106 SetIAssetLoader(const std::shared_ptr<IAssetLoader> & loader)107 DB_API virtual DBStatus SetIAssetLoader([[gnu::unused]] const std::shared_ptr<IAssetLoader> &loader) 108 { 109 return OK; 110 } 111 Sync(const CloudSyncOption & option,const SyncProcessCallback & onProcess)112 DB_API virtual DBStatus Sync([[gnu::unused]] const CloudSyncOption &option, 113 [[gnu::unused]] const SyncProcessCallback &onProcess) 114 { 115 return OK; 116 } 117 118 DB_API virtual DBStatus SetTrackerTable(const TrackerSchema &schema) = 0; 119 120 DB_API virtual DBStatus ExecuteSql(const SqlCondition &condition, std::vector<VBucket> &records) = 0; 121 122 DB_API virtual DBStatus SetReference(const std::vector<TableReferenceProperty> &tableReferenceProperty) = 0; 123 124 DB_API virtual DBStatus CleanTrackerData(const std::string &tableName, int64_t cursor) = 0; 125 126 DB_API virtual DBStatus Pragma(PragmaCmd cmd, PragmaData &pragmaData) = 0; 127 128 DB_API virtual DBStatus UpsertData(const std::string &tableName, const std::vector<VBucket> &records, 129 RecordStatus status = RecordStatus::WAIT_COMPENSATED_SYNC) = 0; 130 131 // set the config for cloud sync task SetCloudSyncConfig(const CloudSyncConfig & config)132 DB_API virtual DBStatus SetCloudSyncConfig([[gnu::unused]] const CloudSyncConfig &config) 133 { 134 return OK; 135 } 136 Sync(const CloudSyncOption & option,const SyncProcessCallback & onProcess,uint64_t taskId)137 DB_API virtual DBStatus Sync([[gnu::unused]] const CloudSyncOption &option, 138 [[gnu::unused]] const SyncProcessCallback &onProcess, 139 [[gnu::unused]] uint64_t taskId) 140 { 141 return OK; 142 } 143 GetCloudTaskStatus(uint64_t taskId)144 DB_API virtual SyncProcess GetCloudTaskStatus([[gnu::unused]] uint64_t taskId) 145 { 146 return {}; 147 } 148 149 DB_API virtual DBStatus SetDistributedSchema([[gnu::unused]] const DistributedSchema &schema, 150 [[gnu::unused]] bool isForceUpgrade = false) 151 { 152 return OK; 153 } 154 GetDownloadingAssetsCount()155 DB_API virtual std::pair<DBStatus, int32_t> GetDownloadingAssetsCount() 156 { 157 return {OK, 0}; 158 } 159 protected: 160 virtual DBStatus RemoveDeviceDataInner(const std::string &device, ClearMode mode) = 0; 161 virtual DBStatus CreateDistributedTableInner(const std::string &tableName, TableSyncType type) = 0; 162 }; 163 } // namespace DistributedDB 164 #endif // RELATIONAL_STORE_DELEGATE_H