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 bool isNeedCompressOnSync = false; 46 uint8_t compressionRate = 100; // Valid in [1, 100] 47 }; 48 49 struct StoreConfig { 50 std::optional<DistributedTableMode> tableMode; 51 }; 52 SetStoreConfig(const StoreConfig & config)53 DB_API virtual DBStatus SetStoreConfig(const StoreConfig &config) 54 { 55 return OK; 56 } 57 58 DB_API DBStatus CreateDistributedTable(const std::string &tableName, TableSyncType type = DEVICE_COOPERATION) 59 { 60 return CreateDistributedTableInner(tableName, type); 61 } 62 63 DB_API virtual DBStatus Sync(const std::vector<std::string> &devices, SyncMode mode, 64 const Query &query, const SyncStatusCallback &onComplete, bool wait) = 0; 65 GetCloudSyncTaskCount()66 DB_API virtual int32_t GetCloudSyncTaskCount() 67 { 68 return 0; 69 } 70 ClearMetaData(const ClearMetaDataOption & option)71 DB_API virtual DBStatus ClearMetaData([[gnu::unused]] const ClearMetaDataOption &option) 72 { 73 return OK; 74 } 75 76 DB_API DBStatus RemoveDeviceData(const std::string &device, ClearMode mode = DEFAULT) 77 { 78 return RemoveDeviceDataInner(device, mode); 79 } 80 81 DB_API virtual DBStatus RemoveDeviceData(const std::string &device, const std::string &tableName) = 0; 82 83 // timeout is in ms. 84 DB_API virtual DBStatus RemoteQuery(const std::string &device, const RemoteCondition &condition, 85 uint64_t timeout, std::shared_ptr<ResultSet> &result) = 0; 86 87 // remove all device data 88 DB_API virtual DBStatus RemoveDeviceData() = 0; 89 Sync(const std::vector<std::string> & devices,SyncMode mode,const Query & query,const SyncProcessCallback & onProcess,int64_t waitTime)90 DB_API virtual DBStatus Sync([[gnu::unused]] const std::vector<std::string> &devices, 91 [[gnu::unused]] SyncMode mode, [[gnu::unused]] const Query &query, 92 [[gnu::unused]] const SyncProcessCallback &onProcess, [[gnu::unused]] int64_t waitTime) 93 { 94 return OK; 95 } 96 SetCloudDB(const std::shared_ptr<ICloudDb> & cloudDb)97 DB_API virtual DBStatus SetCloudDB([[gnu::unused]] const std::shared_ptr<ICloudDb> &cloudDb) 98 { 99 return OK; 100 } 101 SetCloudDbSchema(const DataBaseSchema & schema)102 DB_API virtual DBStatus SetCloudDbSchema([[gnu::unused]] const DataBaseSchema &schema) 103 { 104 return OK; 105 } 106 107 // just support one observer exist at same time 108 DB_API virtual DBStatus RegisterObserver(StoreObserver *observer) = 0; 109 110 DB_API virtual DBStatus UnRegisterObserver() = 0; 111 112 DB_API virtual DBStatus UnRegisterObserver(StoreObserver *observer) = 0; 113 SetIAssetLoader(const std::shared_ptr<IAssetLoader> & loader)114 DB_API virtual DBStatus SetIAssetLoader([[gnu::unused]] const std::shared_ptr<IAssetLoader> &loader) 115 { 116 return OK; 117 } 118 Sync(const CloudSyncOption & option,const SyncProcessCallback & onProcess)119 DB_API virtual DBStatus Sync([[gnu::unused]] const CloudSyncOption &option, 120 [[gnu::unused]] const SyncProcessCallback &onProcess) 121 { 122 return OK; 123 } 124 125 DB_API virtual DBStatus SetTrackerTable(const TrackerSchema &schema) = 0; 126 127 DB_API virtual DBStatus ExecuteSql(const SqlCondition &condition, std::vector<VBucket> &records) = 0; 128 129 DB_API virtual DBStatus SetReference(const std::vector<TableReferenceProperty> &tableReferenceProperty) = 0; 130 131 DB_API virtual DBStatus CleanTrackerData(const std::string &tableName, int64_t cursor) = 0; 132 133 DB_API virtual DBStatus Pragma(PragmaCmd cmd, PragmaData &pragmaData) = 0; 134 135 DB_API virtual DBStatus UpsertData(const std::string &tableName, const std::vector<VBucket> &records, 136 RecordStatus status = RecordStatus::WAIT_COMPENSATED_SYNC) = 0; 137 138 // set the config for cloud sync task SetCloudSyncConfig(const CloudSyncConfig & config)139 DB_API virtual DBStatus SetCloudSyncConfig([[gnu::unused]] const CloudSyncConfig &config) 140 { 141 return OK; 142 } 143 Sync(const CloudSyncOption & option,const SyncProcessCallback & onProcess,uint64_t taskId)144 DB_API virtual DBStatus Sync([[gnu::unused]] const CloudSyncOption &option, 145 [[gnu::unused]] const SyncProcessCallback &onProcess, 146 [[gnu::unused]] uint64_t taskId) 147 { 148 return OK; 149 } 150 GetCloudTaskStatus(uint64_t taskId)151 DB_API virtual SyncProcess GetCloudTaskStatus([[gnu::unused]] uint64_t taskId) 152 { 153 return {}; 154 } 155 156 DB_API virtual DBStatus SetDistributedSchema([[gnu::unused]] const DistributedSchema &schema, 157 [[gnu::unused]] bool isForceUpgrade = false) 158 { 159 return OK; 160 } 161 GetDownloadingAssetsCount()162 DB_API virtual std::pair<DBStatus, int32_t> GetDownloadingAssetsCount() 163 { 164 return {OK, 0}; 165 } 166 OperateDataStatus(uint32_t dataOperator)167 DB_API virtual DBStatus OperateDataStatus([[gnu::unused]] uint32_t dataOperator) 168 { 169 return OK; 170 } 171 GetDeviceSyncTaskCount()172 DB_API virtual int32_t GetDeviceSyncTaskCount() 173 { 174 return 0; 175 } 176 protected: 177 virtual DBStatus RemoveDeviceDataInner(const std::string &device, ClearMode mode) = 0; 178 virtual DBStatus CreateDistributedTableInner(const std::string &tableName, TableSyncType type) = 0; 179 }; 180 } // namespace DistributedDB 181 #endif // RELATIONAL_STORE_DELEGATE_H