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 GRD_KV_API_H 17 #define GRD_KV_API_H 18 19 #include <cstdint> 20 21 #include "grd_base/grd_resultset_api.h" 22 #include "grd_base/grd_type_export.h" 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 GRD_API int32_t GRD_KVPut(GRD_DB *db, const char *collectionName, const GRD_KVItemT *key, const GRD_KVItemT *value); 28 29 GRD_API int32_t GRD_KVGet(GRD_DB *db, const char *collectionName, const GRD_KVItemT *key, const GRD_KVItemT *value); 30 31 GRD_API int32_t GRD_KVDel(GRD_DB *db, const char *collectionName, const GRD_KVItemT *key); 32 33 GRD_API int32_t GRD_KVScan(GRD_DB *db, const char *collectionName, const GRD_KVItemT *key, GRD_KvScanModeE mode, 34 GRD_ResultSet **resultSet); 35 36 GRD_API int32_t GRD_KVFilter(GRD_DB *db, const char *collectionName, const GRD_FilterOptionT *scanParams, 37 GRD_ResultSet **resultSet); 38 39 GRD_API int32_t GRD_KVGetSize(GRD_ResultSet *resultSet, uint32_t *keyLen, uint32_t *valueLen); 40 41 GRD_API int32_t GRD_GetItem(GRD_ResultSet *resultSet, void *key, void *value); 42 43 GRD_API int32_t GRD_KVFreeItem(GRD_KVItemT *item); 44 45 GRD_API int32_t GRD_KVBatchPrepare(uint16_t itemNum, GRD_KVBatchT **batch); 46 47 GRD_API int32_t GRD_KVBatchPushback(const void *key, uint32_t keyLen, const void *data, uint32_t dataLen, 48 GRD_KVBatchT *batch); 49 50 GRD_API int32_t GRD_KVBatchPut(GRD_DB *db, const char *collectionName, GRD_KVBatchT *batch); 51 52 GRD_API int32_t GRD_KVBatchDel(GRD_DB *db, const char *collectionName, GRD_KVBatchT *batch); 53 54 GRD_API int32_t GRD_KVBatchDestroy(GRD_KVBatchT *batch); 55 #ifdef __cplusplus 56 } 57 #endif 58 #endif // GRD_DOCUMENT_API_H