• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# oh_values_bucket.h
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**引用文件:** <database/rdb/oh_values_bucket.h>
14
15**库:** libnative_rdb_ndk.z.so
16
17**系统能力:** SystemCapability.DistributedDataManager.RelationalStore.Core
18
19**起始版本:** 10
20
21**相关模块:** [RDB](capi-rdb.md)
22
23## 汇总
24
25### 结构体
26
27| 名称                             | typedef关键字 | 描述                   |
28| -------------------------------- | ------------- | ---------------------- |
29| [OH_VBucket](capi-rdb-oh-vbucket.md) | OH_VBucket    | 用于存储键值对的类型。 |
30
31### 函数
32
33| 名称                                                         | 描述                                                         |
34| ------------------------------------------------------------ | ------------------------------------------------------------ |
35| [int OH_VBucket_PutAsset(OH_VBucket *bucket, const char *field, Data_Asset *value)](#oh_vbucket_putasset) | 将[Data_Asset](capi-rdb-data-asset.md) 类型的对象放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。 |
36| [int OH_VBucket_PutAssets(OH_VBucket *bucket, const char *field, Data_Asset **value, uint32_t count)](#oh_vbucket_putassets) | 将[Data_Asset](capi-rdb-data-asset.md) 类型的对象数组放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。 |
37| [int OH_VBucket_PutFloatVector(OH_VBucket *bucket, const char *field, const float *vec, size_t len)](#oh_vbucket_putfloatvector) | 将float数组类型对象放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。 |
38| [int OH_VBucket_PutUnlimitedInt(OH_VBucket *bucket, const char *field, int sign, const uint64_t *trueForm, size_t len)](#oh_vbucket_putunlimitedint) | 将任意长度的整数类型对象放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。 |
39
40## 函数说明
41
42### OH_VBucket_PutAsset()
43
44```
45int OH_VBucket_PutAsset(OH_VBucket *bucket, const char *field, Data_Asset *value)
46```
47
48**描述**
49
50将[Data_Asset](capi-rdb-data-asset.md) 类型的对象放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。
51
52**起始版本:** 11
53
54
55**参数:**
56
57| 参数项                                   | 描述                                                 |
58| ---------------------------------------- | ---------------------------------------------------- |
59| [OH_VBucket](capi-rdb-oh-vbucket.md) *bucket | 表示指向[OH_VBucket](capi-rdb-oh-vbucket.md)实例的指针。 |
60| const char *field                        | 数据库表中的列名。                                   |
61| [Data_Asset](capi-rdb-data-asset.md) *value  | 数据库表中指定列名对应的值。                         |
62
63**返回:**
64
65| 类型 | 说明                                                         |
66| ---- | ------------------------------------------------------------ |
67| int  | 返回操作是否成功,出错时返回对应的错误码。<br>RDB_OK 表示成功。<br>RDB_E_INVALID_ARGS 表示无效参数。 |
68
69### OH_VBucket_PutAssets()
70
71```
72int OH_VBucket_PutAssets(OH_VBucket *bucket, const char *field, Data_Asset **value, uint32_t count)
73```
74
75**描述**
76
77将[Data_Asset](capi-rdb-data-asset.md) 类型的对象数组放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。
78
79**起始版本:** 11
80
81
82**参数:**
83
84| 参数项                                   | 描述                                                         |
85| ---------------------------------------- | ------------------------------------------------------------ |
86| [OH_VBucket](capi-rdb-oh-vbucket.md) *bucket | 表示指向[OH_VBucket](capi-rdb-oh-vbucket.md)实例的指针。         |
87| const char *field                        | 数据库表中的列名。                                           |
88| [Data_Asset](capi-rdb-data-asset.md) **value | 数据库表中指定列名对应的值。                                 |
89| uint32_t count                           | 表示传入的[Data_Asset](capi-rdb-data-asset.md)对象数组元素的个数. |
90
91**返回:**
92
93| 类型 | 说明                                                         |
94| ---- | ------------------------------------------------------------ |
95| int  | 返回操作是否成功,出错时返回对应的错误码。<br>RDB_OK 表示成功。<br>RDB_E_INVALID_ARGS 表示无效参数。 |
96
97**参考:**
98
99OH_VBucket
100
101### OH_VBucket_PutFloatVector()
102
103```
104int OH_VBucket_PutFloatVector(OH_VBucket *bucket, const char *field, const float *vec, size_t len)
105```
106
107**描述**
108
109将float数组类型对象放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。
110
111**起始版本:** 18
112
113
114**参数:**
115
116| 参数项                                   | 描述                                                 |
117| ---------------------------------------- | ---------------------------------------------------- |
118| [OH_VBucket](capi-rdb-oh-vbucket.md) *bucket | 表示指向[OH_VBucket](capi-rdb-oh-vbucket.md)实例的指针。 |
119| const char *field                        | 数据库表中的列名。                                   |
120| const float *vec                         | 表示指向float数组的指针。                            |
121| size_t len                               | 表示float数组的大小。                                |
122
123**返回:**
124
125| 类型 | 说明                                                         |
126| ---- | ------------------------------------------------------------ |
127| int  | 返回操作是否成功,出错时返回对应的错误码。<br>RDB_OK 表示成功。<br>RDB_E_INVALID_ARGS 表示无效参数。 |
128
129**参考:**
130
131OH_VBucket
132
133### OH_VBucket_PutUnlimitedInt()
134
135```
136int OH_VBucket_PutUnlimitedInt(OH_VBucket *bucket, const char *field, int sign, const uint64_t *trueForm, size_t len)
137```
138
139**描述**
140
141将任意长度的整数类型对象放入给定列名的[OH_VBucket](capi-rdb-oh-vbucket.md)对象中。
142
143**起始版本:** 18
144
145
146**参数:**
147
148| 参数项                                   | 描述                                                   |
149| ---------------------------------------- | ------------------------------------------------------ |
150| [OH_VBucket](capi-rdb-oh-vbucket.md) *bucket | 表示指向[OH_VBucket](capi-rdb-oh-vbucket.md)实例的指针。   |
151| const char *field                        | 数据库表中的列名。                                     |
152| int sign                                 | 表示整数类型对象是正数还是负数,0表示正数,1表示负数。 |
153| const uint64_t *trueForm                 | 表示指向整数类型数组的指针。                           |
154| size_t len                               | 表示整数数组的大小。                                   |
155
156**返回:**
157
158| 类型 | 说明                                                         |
159| ---- | ------------------------------------------------------------ |
160| int  | 返回操作是否成功,出错时返回对应的错误码。<br>RDB_OK 表示成功。<br>RDB_E_INVALID_ARGS 表示无效参数。 |
161
162