• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# OH_VBucket
2<!--Kit: ArkData-->
3<!--Subsystem: DistributedDataManager-->
4<!--Owner: @baijidong-->
5<!--Designer: @widecode; @htt1997-->
6<!--Tester: @yippo; @logic42-->
7<!--Adviser: @ge-yafang-->
8
9## 概述
10
11用于存储键值对的类型。
12
13**起始版本：** 10
14
15**相关模块：** [RDB](capi-rdb.md)
16
17**所在头文件：** [oh_values_bucket.h](capi-oh-values-bucket-h.md)
18
19### 成员变量
20
21| 名称                | 描述                           |
22| ------------------- | ------------------------------ |
23| int64_t id          | OH_VBucket结构体的唯一标识符。 |
24| uint16_t capability | 表示结构体的存储键值对的数量。 |
25
26
27### 成员函数
28
29| 名称                                                         | 描述                                                |
30| ------------------------------------------------------------ | --------------------------------------------------- |
31| [int (*putText)(OH_VBucket *bucket, const char *field, const char *value)](#puttext) | 将char*值放入给定列名的OH_VBucket对象中。           |
32| [int (*putInt64)(OH_VBucket *bucket, const char *field, int64_t value)](#putint64) | 将int64_t值放入给定列名的OH_VBucket对象中。         |
33| [int (*putReal)(OH_VBucket *bucket, const char *field, double value)](#putreal) | 将double值放入给定列名的OH_VBucket对象中。          |
34| [int (*putBlob)(OH_VBucket *bucket, const char *field, const uint8_t *value, uint32_t size)](#putblob) | 将const uint8_t *值放入给定列名的OH_VBucket对象中。 |
35| [int (*putNull)(OH_VBucket *bucket, const char *field)](#putnull) | 将NULL值放入给定列名的OH_VBucket对象中。            |
36| [int (*clear)(OH_VBucket *bucket)](#clear)                   | 清空OH_VBucket对象。                                |
37| [int (*destroy)(OH_VBucket *bucket)](#destroy)               | 销毁OH_VBucket对象，并回收该对象占用的内存。        |
38
39
40### 成员函数说明
41
42### putText()
43
44```
45int (*putText)(OH_VBucket *bucket, const char *field, const char *value)
46```
47
48**描述**
49
50将char*值放入给定列名的OH_VBucket对象中。
51
52**起始版本：** 10
53
54**参数：**
55
56| 参数项             | 描述                           |
57| ------------------ | ------------------------------ |
58| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
59| const char *field  | 数据库表中的列名               |
60| const char *value  | 数据库表中指定列名对应的值。   |
61
62**返回：**
63
64| 类型 | 说明                                       |
65| ---- | ------------------------------------------ |
66| int  | 返回操作是否成功，出错时返回对应的错误码。 |
67
68### putInt64()
69
70```
71int (*putInt64)(OH_VBucket *bucket, const char *field, int64_t value)
72```
73
74**描述**
75
76将int64_t值放入给定列名的OH_VBucket对象中。
77
78**起始版本：** 10
79
80**参数：**
81
82| 参数项             | 描述                           |
83| ------------------ | ------------------------------ |
84| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
85| const char *field  | 数据库表中的列名               |
86| int64_t value      | 数据库表中指定列名对应的值。   |
87
88**返回：**
89
90| 类型 | 说明                                       |
91| ---- | ------------------------------------------ |
92| int  | 返回操作是否成功，出错时返回对应的错误码。 |
93
94### putReal()
95
96```
97int (*putReal)(OH_VBucket *bucket, const char *field, double value)
98```
99
100**描述**
101
102将double值放入给定列名的OH_VBucket对象中。
103
104**起始版本：** 10
105
106**参数：**
107
108| 参数项             | 描述                           |
109| ------------------ | ------------------------------ |
110| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
111| const char *field  | 数据库表中的列名               |
112| double value       | 数据库表中指定列名对应的值。   |
113
114**返回：**
115
116| 类型 | 说明                                       |
117| ---- | ------------------------------------------ |
118| int  | 返回操作是否成功，出错时返回对应的错误码。 |
119
120### putBlob()
121
122```
123int (*putBlob)(OH_VBucket *bucket, const char *field, const uint8_t *value, uint32_t size)
124```
125
126**描述**
127
128将const uint8_t *值放入给定列名的OH_VBucket对象中。
129
130**起始版本：** 10
131
132**参数：**
133
134| 参数项             | 描述                           |
135| ------------------ | ------------------------------ |
136| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
137| const char *field  | 数据库表中的列名               |
138| const uint8_t *value | 数据库表中指定列名对应的值。 |
139| uint32_t size      | 表示value的长度。              |
140
141**返回：**
142
143| 类型 | 说明                                       |
144| ---- | ------------------------------------------ |
145| int  | 返回操作是否成功，出错时返回对应的错误码。 |
146
147### putNull()
148
149```
150int (*putNull)(OH_VBucket *bucket, const char *field)
151```
152
153**描述**
154
155将NULL值放入给定列名的OH_VBucket对象中。
156
157**起始版本：** 10
158
159**参数：**
160
161| 参数项             | 描述                           |
162| ------------------ | ------------------------------ |
163| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
164| const char *field  | 数据库表中的列名               |
165
166**返回：**
167
168| 类型 | 说明                                       |
169| ---- | ------------------------------------------ |
170| int  | 返回操作是否成功，出错时返回对应的错误码。 |
171
172### clear()
173
174```
175int (*clear)(OH_VBucket *bucket)
176```
177
178**描述**
179
180将char*值放入给定列名的OH_VBucket对象中。
181
182**起始版本：** 10
183
184**参数：**
185
186| 参数项             | 描述                           |
187| ------------------ | ------------------------------ |
188| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
189
190**返回：**
191
192| 类型 | 说明                                       |
193| ---- | ------------------------------------------ |
194| int  | 返回操作是否成功，出错时返回对应的错误码。 |
195
196### destroy()
197
198```
199int (*destroy)(OH_VBucket *bucket)
200```
201
202**描述**
203
204将char*值放入给定列名的OH_VBucket对象中。
205
206**起始版本：** 10
207
208**参数：**
209
210| 参数项             | 描述                           |
211| ------------------ | ------------------------------ |
212| OH_VBucket *bucket | 表示指向OH_VBucket实例的指针。 |
213
214**返回：**
215
216| 类型 | 说明                                       |
217| ---- | ------------------------------------------ |
218| int  | 返回操作是否成功，出错时返回对应的错误码。 |
219
220