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 DISTRIBUTEDDB_CONSTANT_H 17 #define DISTRIBUTEDDB_CONSTANT_H 18 19 #include <string> 20 21 namespace DistributedDB { 22 class DBConstant { 23 public: 24 static constexpr const size_t MAX_KEY_SIZE = 1024; 25 static constexpr const size_t MAX_VALUE_SIZE = 4 * 1024 * 1024; // 4M 26 static constexpr const size_t MAX_SET_VALUE_SIZE = 64 * 1024 * 1024; // 64M 27 static constexpr const size_t MAX_BATCH_SIZE = 128; 28 static constexpr const size_t MAX_DEV_LENGTH = 128; 29 static constexpr const size_t MAX_TRANSACTION_KEY_VALUE_LENS = 512 * 1024 * 1024; // 512M 30 31 static constexpr const size_t MAX_DATA_DIR_LENGTH = 512; 32 33 static constexpr const size_t MAX_INKEYS_SIZE = 128; 34 static constexpr const size_t MAX_SQL_ARGS_COUNT = 100; 35 static constexpr const size_t MAX_IN_COUNT = 100; 36 37 static constexpr const int DB_TYPE_LOCAL = 1; 38 static constexpr const int DB_TYPE_MULTI_VER = 2; 39 static constexpr const int DB_TYPE_SINGLE_VER = 3; 40 41 static constexpr const int QUEUED_SYNC_LIMIT_DEFAULT = 32; 42 static constexpr const int QUEUED_SYNC_LIMIT_MIN = 1; 43 static constexpr const int QUEUED_SYNC_LIMIT_MAX = 4096; 44 45 static constexpr const int MAX_DEVICES_SIZE = 100; 46 static constexpr const int MAX_COMMIT_SIZE = 1000000; 47 static constexpr const int MAX_ENTRIES_SIZE = 1000000; 48 49 static constexpr const uint32_t MAX_COLUMN = 32767; 50 51 static constexpr const int MAX_REMOTEDATA_SIZE = 4 * 1024 * 1024; // 4M. 52 53 static constexpr const int DEFAULT_ITER_TIMES = 5000; 54 55 // In querySync, when getting query data finished, 56 // if the block size reach the half of max block size, will get deleted data next; 57 // if the block size not reach the half of max block size, will not get deleted data. 58 static constexpr const float QUERY_SYNC_THRESHOLD = 0.50; 59 60 static constexpr const uint64_t MAX_USER_ID_LENGTH = 128; 61 static constexpr const uint64_t MAX_APP_ID_LENGTH = 128; 62 static constexpr const uint64_t MAX_STORE_ID_LENGTH = 128; 63 static constexpr const uint64_t MAX_SUB_USER_LENGTH = 128; 64 65 static const std::string MULTI_SUB_DIR; 66 static const std::string SINGLE_SUB_DIR; 67 static const std::string LOCAL_SUB_DIR; 68 69 static const std::string MAINDB_DIR; 70 static const std::string METADB_DIR; 71 static const std::string CACHEDB_DIR; 72 73 static constexpr const char *LOCAL_DATABASE_NAME = "local"; 74 static constexpr const char *MULTI_VER_DATA_STORE = "multi_ver_data"; 75 static constexpr const char *MULTI_VER_COMMIT_STORE = "commit_logs"; 76 static constexpr const char *MULTI_VER_VALUE_STORE = "value_storage"; 77 static constexpr const char *MULTI_VER_META_STORE = "meta_storage"; 78 static const std::string SINGLE_VER_DATA_STORE; 79 static const std::string SINGLE_VER_META_STORE; 80 static const std::string SINGLE_VER_CACHE_STORE; 81 82 static constexpr const char *SQLITE_URL_PRE = "file:"; 83 static constexpr const char *DB_EXTENSION = ".db"; 84 static constexpr const char *SQLITE_MEMDB_IDENTIFY = "?mode=memory&cache=shared"; 85 86 static constexpr const char *SCHEMA_KEY = "schemaKey"; 87 static const std::string RELATIONAL_SCHEMA_KEY; 88 static const std::string RELATIONAL_TRACKER_SCHEMA_KEY; 89 90 static constexpr const char *RD_KV_COLLECTION_MODE = "{\"mode\" : \"kv\"}"; 91 static constexpr const char *RD_KV_HASH_COLLECTION_MODE = "{\"mode\" : \"kv\",\"indextype\" : \"hash\"}"; 92 93 static constexpr const char *PATH_POSTFIX_UNPACKED = "_unpacked"; 94 static constexpr const char *PATH_POSTFIX_IMPORT_BACKUP = "_import_bak"; 95 static constexpr const char *PATH_POSTFIX_IMPORT_ORIGIN = "_import_ori"; 96 static constexpr const char *PATH_POSTFIX_IMPORT_DUP = "_import_dup"; 97 static constexpr const char *PATH_POSTFIX_EXPORT_BACKUP = "_export_bak"; 98 // use for make sure create datebase and set label complete 99 static constexpr const char *PATH_POSTFIX_DB_INCOMPLETE = "_db_incomplete.lock"; 100 101 static constexpr const char *REKEY_FILENAME_POSTFIX_PRE = "_ctrl_pre"; 102 static constexpr const char *REKEY_FILENAME_POSTFIX_OK = "_ctrl_ok"; 103 static constexpr const char *UPGRADE_POSTFIX = "_upgrade.lock"; 104 // used for make sure meta split upgrade atomically 105 static constexpr const char *SET_SECOPT_POSTFIX = "_secopt.lock"; 106 static constexpr const char *PATH_BACKUP_POSTFIX = "_bak"; 107 108 static constexpr const char *ID_CONNECTOR = "-"; 109 110 static constexpr const char *DELETE_KVSTORE_REMOVING = "_removing"; 111 static constexpr const char *DB_LOCK_POSTFIX = ".lock"; 112 113 static constexpr const char *SUBSCRIBE_QUERY_PREFIX = "subscribe_query_"; 114 115 static constexpr const char *TRIGGER_REFERENCES_NEW = "NEW."; 116 static constexpr const char *TRIGGER_REFERENCES_OLD = "OLD."; 117 118 static const std::string UPDATE_META_FUNC; 119 120 // Prefix Key in meta db 121 static constexpr const char *DEVICEID_PREFIX_KEY = "deviceId"; 122 static constexpr const char *QUERY_SYNC_PREFIX_KEY = "querySync"; 123 static constexpr const char *DELETE_SYNC_PREFIX_KEY = "deleteSync"; 124 125 static constexpr const size_t MAX_NORMAL_PACK_ITEM_SIZE = 4000; 126 // slide window mode to reduce last ack transfer time 127 static constexpr const size_t MAX_HPMODE_PACK_ITEM_SIZE = 2000; 128 129 static constexpr const uint32_t MIN_MTU_SIZE = 1024; // 1KB 130 static constexpr const uint32_t MAX_MTU_SIZE = 5242880; // 5MB 131 132 static constexpr const uint32_t MIN_TIMEOUT = 5000; // 5s 133 static constexpr const uint32_t MAX_TIMEOUT = 60000; // 60s 134 static constexpr const uint32_t MAX_SYNC_TIMEOUT = 300000; // 300s 135 static constexpr const int INFINITE_WAIT = -1; // -1 is infinite waiting 136 137 static constexpr const uint8_t DEFAULT_COMPTRESS_RATE = 100; 138 139 static constexpr const size_t MAX_SYNC_BLOCK_SIZE = 31457280; // 30MB 140 141 static constexpr const int DOUBLE_PRECISION = 15; 142 static constexpr const int MAX_DISTRIBUTED_TABLE_COUNT = 32; 143 144 static constexpr const uint64_t MAX_LOG_SIZE_HIGH = 0x400000000ULL; // 16GB 145 static constexpr const uint64_t MAX_LOG_SIZE_LOW = 0x400000ULL; // 4MB 146 static constexpr const uint64_t MAX_LOG_SIZE_DEFAULT = 0x40000000ULL; // 1GB 147 148 static constexpr const int DEF_LIFE_CYCLE_TIME = 60000; // 60S 149 150 static constexpr const int RELATIONAL_LOG_TABLE_FIELD_NUM = 7; // field num is relational distributed log table 151 152 static constexpr const uint64_t IGNORE_CONNECTION_ID = 0; 153 // Soft limit of a connection observer count. 154 static constexpr const int MAX_OBSERVER_COUNT = 8; 155 156 // For relational 157 static const std::string SYSTEM_TABLE_PREFIX; 158 static constexpr const char *RELATIONAL_PREFIX = "naturalbase_rdb_aux_"; 159 static constexpr size_t RELATIONAL_PREFIX_SIZE = 20; 160 static const std::string TIMESTAMP_ALIAS; 161 static constexpr const char *LOG_POSTFIX = "_log"; 162 static constexpr const char *META_TABLE_POSTFIX = "metadata"; 163 164 static constexpr const char *LOG_TABLE_VERSION_3 = "3.0"; 165 static constexpr const char *LOG_TABLE_VERSION_5_1 = "5.01"; 166 static constexpr const char *LOG_TABLE_VERSION_5_3 = "5.03"; // add sharing_resource field 167 static constexpr const char *LOG_TABLE_VERSION_5_5 = "5.05"; // add status field 168 static constexpr const char *LOG_TABLE_VERSION_5_8 = "5.08"; // migrate cursor to meta table 169 static constexpr const char *LOG_TABLE_VERSION_5_9 = "5.09"; // insert retains the old version 170 static constexpr const char *LOG_TABLE_VERSION_5_10 = "5.10"; // retain downloading asset in update trigger 171 static constexpr const char *LOG_TABLE_VERSION_CURRENT = LOG_TABLE_VERSION_5_10; 172 173 static const std::string LOG_TABLE_VERSION_KEY; 174 175 static constexpr const char *REMOTE_DEVICE_SCHEMA_KEY_PREFIX = "remote_device_schema_"; 176 177 static constexpr const uint32_t MAX_CONDITION_KEY_LEN = 128; 178 static constexpr const uint32_t MAX_CONDITION_VALUE_LEN = 128; 179 static constexpr const uint32_t MAX_CONDITION_COUNT = 32; 180 181 static constexpr const uint32_t REMOTE_QUERY_MAX_SQL_LEN = 1000000U; 182 183 static constexpr const int HASH_KEY_SIZE = 32; // size of SHA256_DIGEST_LENGTH 184 185 static constexpr const char *TABLE_IS_DROPPED = "table_is_dropped_"; 186 187 static constexpr const char *SQLITE_INNER_ROWID = "_rowid_"; 188 static constexpr const int32_t DEFAULT_ROW_ID = -1; 189 static constexpr const int STR_TO_LL_BY_DEVALUE = 10; 190 // key in meta_data 191 static constexpr const char *LOCALTIME_OFFSET_KEY = "localTimeOffset"; 192 193 static constexpr const uint64_t OBSERVER_CHANGES_MASK = 0XF00; 194 195 static constexpr const char *STORAGE_TYPE_LONG = "long"; 196 197 static constexpr const uint64_t INVALID_CURSOR = UINT64_MAX; 198 199 static constexpr const char *KV_SYNC_TABLE_NAME = "sync_data"; 200 static constexpr const char *KV_LOCAL_TABLE_NAME = "local_data"; 201 202 static constexpr const char *ROWID = "rowid"; 203 }; 204 } // namespace DistributedDB 205 #endif // DISTRIBUTEDDB_CONSTANT_H 206