未验证 提交 e7a28560 编写于 作者: 葛亚芳 提交者: Gitee

RDB native api新增交付

Signed-off-by: N葛亚芳 <geyafang@huawei.com>
上级 94aa588d
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
- [NativeVsync](_native_vsync.md) - [NativeVsync](_native_vsync.md)
- [Image](image.md) - [Image](image.md)
- [Rawfile](rawfile.md) - [Rawfile](rawfile.md)
- [RDB](_r_d_b.md)
- [MindSpore](_mind_spore.md) - [MindSpore](_mind_spore.md)
- [NeuralNeworkRuntime](_neural_nework_runtime.md) - [NeuralNeworkRuntime](_neural_nework_runtime.md)
- [AudioDecoder](_audio_decoder.md) - [AudioDecoder](_audio_decoder.md)
...@@ -63,6 +64,12 @@ ...@@ -63,6 +64,12 @@
- [native_huks_api.h](native__huks__api_8h.md) - [native_huks_api.h](native__huks__api_8h.md)
- [native_huks_param.h](native__huks__param_8h.md) - [native_huks_param.h](native__huks__param_8h.md)
- [native_huks_type.h](native__huks__type_8h.md) - [native_huks_type.h](native__huks__type_8h.md)
- [oh_cursor.h](oh__cursor_8h.md)
- [oh_predicates.h](oh__predicates_8h.md)
- [oh_value_object.h](oh__value__object_8h.md)
- [oh_values_bucket.h](oh__values__bucket_8h.md)
- [relation_error_code.h](relation__error__code_8h.md)
- [relation_store.h](relation__store_8h.md)
- [syscap_ndk.h](syscap__ndk_8h.md) - [syscap_ndk.h](syscap__ndk_8h.md)
- 结构体 - 结构体
- [OH_Drawing_BitmapFormat](_o_h___drawing___bitmap_format.md) - [OH_Drawing_BitmapFormat](_o_h___drawing___bitmap_format.md)
...@@ -100,3 +107,9 @@ ...@@ -100,3 +107,9 @@
- [OH_Huks_ParamSet](_o_h___huks___param_set.md) - [OH_Huks_ParamSet](_o_h___huks___param_set.md)
- [OH_Huks_PubKeyInfo](_o_h___huks___pub_key_info.md) - [OH_Huks_PubKeyInfo](_o_h___huks___pub_key_info.md)
- [OH_Huks_Result](_o_h___huks___result.md) - [OH_Huks_Result](_o_h___huks___result.md)
- [OH_Cursor](_o_h___cursor.md)
- [OH_Predicates](_o_h___predicates.md)
- [OH_Rdb_Config](_o_h___rdb___config.md)
- [OH_Rdb_Store](_o_h___rdb___store.md)
- [OH_VBucket](_o_h___v_bucket.md)
- [OH_VObject](_o_h___v_object.md)
# OH_Cursor
## 概述
表示结果集。
提供通过查询数据库生成的数据库结果集的访问方法。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [id](_r_d_b.md) | OH_Cursor结构体的唯一标识符。 |
| [getColumnCount](_r_d_b.md#getcolumncount) | 函数指针,获取结果集中的列数。 |
| [getColumnType](_r_d_b.md#getcolumntype) | 函数指针,根据指定的列索引获取列名。 |
| [getColumnIndex](_r_d_b.md#getcolumnindex) | 函数指针,根据指定的列名获取列索引。 |
| [getColumnName](_r_d_b.md#getcolumnname) | 函数指针,根据指定的列索引获取列名。 |
| [getRowCount](_r_d_b.md#getrowcount) | 函数指针,获取结果集中的行数。 |
| [goToNextRow](_r_d_b.md#gotonextrow) | 函数指针,转到结果集的下一行。 |
| [getSize](_r_d_b.md#getsize) | 函数指针,当结果集中列的数据类型是BLOB或者TEXT时,获取其值所需的内存。 |
| [getText](_r_d_b.md#gettext) | 函数指针,以字符串形式获取当前行中指定列的值。 |
| [getInt64](_r_d_b.md#getint64) | 函数指针,以int64_t形式获取当前行中指定列的值。 |
| [getReal](_r_d_b.md#getreal) | 函数指针,以double形式获取当前行中指定列的值。 |
| [getBlob](_r_d_b.md#getblob) | 函数指针,以字节数组的形式获取当前行中指定列的值。 |
| [isNull](_r_d_b.md#isnull-12) | 函数指针,检查当前行中指定列的值是否为null。 |
| [close](_r_d_b.md#close) | 函数指针,关闭结果集。 |
# OH_Predicates
## 概述
表示谓词。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [id](_r_d_b.md#id-14) | OH_Predicates结构体的唯一标识符。 |
| [equalTo](_r_d_b.md#equalto) | 函数指针,配置谓词以匹配数据字段等于指定值的字段。 |
| [notEqualTo](_r_d_b.md#notequalto) | 函数指针,配置谓词以匹配数据字段不等于指定值的字段。 |
| [beginWrap](_r_d_b.md#beginwrap) | 函数指针,向谓词添加左括号。 |
| [endWrap](_r_d_b.md#endwrap) | 函数指针,向谓词添加右括号。 |
| [orOperate](_r_d_b.md#oroperate) | 函数指针,将或条件添加到谓词中。 |
| [andOperate](_r_d_b.md#andoperate) | 函数指针,向谓词添加和条件。 |
| [isNull](_r_d_b.md#isnull-22) | 函数指针,配置谓词以匹配值为null的字段。 |
| [isNotNull](_r_d_b.md#isnotnull) | 函数指针,配置谓词以匹配值不为null的指定字段。 |
| [like](_r_d_b.md#like) | 函数指针,配置谓词以匹配数据字段为field且值类似于指定字符串的字段。 |
| [between](_r_d_b.md#between) | 函数指针,将谓词配置为匹配数据字段为field且其值在给定范围内的指定字段。 |
| [notBetween](_r_d_b.md#notbetween) | 函数指针,将谓词配置为匹配数据字段为field且其值超出给定范围内的指定字段。 |
| [greaterThan](_r_d_b.md#greaterthan) | 函数指针,配置谓词以匹配数据字段为field且值大于指定值valueObject的字段。 |
| [lessThan](_r_d_b.md#lessthan) | 函数指针,配置谓词以匹配数据字段为field且值小于指定值valueObject的字段 |
| [greaterThanOrEqualTo](_r_d_b.md#greaterthanorequalto) | 函数指针,配置谓词以匹配数据字段为field且值大于或等于指定值valueObject的字段 |
| [lessThanOrEqualTo](_r_d_b.md#lessthanorequalto) | 函数指针,配置谓词以匹配数据字段为field且值小于或等于指定值valueObject的字段 |
| [orderBy](_r_d_b.md#orderby) | 函数指针,配置谓词以匹配其值按升序或降序排序的列。 |
| [distinct](_r_d_b.md#distinct) | 函数指针,配置谓词以过滤重复记录并仅保留其中一个。 |
| [limit](_r_d_b.md#limit) | 函数指针,设置最大数据记录数的谓词。 |
| [offset](_r_d_b.md#offset) | 函数指针,配置谓词以指定返回结果的起始位置。 |
| [groupBy](_r_d_b.md#groupby) | 函数指针,配置R谓词按指定列分组查询结果。 |
| [in](_r_d_b.md#in) | 函数指针,配置谓词以匹配数据字段为field且值在给定范围内的指定字段。 |
| [notIn](_r_d_b.md#notin) | 函数指针,配置谓词以匹配数据字段为field且值超出给定范围内的指定字段。 |
| [clear](_r_d_b.md#clear-12) | 函数指针,清空谓词。 |
| [destroyPredicates](_r_d_b.md#destroypredicates) | 销毁[OH_Predicates](zh-cn_topic_0000001614668493.xml)对象,并回收该对象占用的内存。 |
# OH_Rdb_Config
## 概述
管理关系数据库配置。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [path](_r_d_b.md#path) | 数据库文件路径。 |
| [isEncrypt](_r_d_b.md#isencrypt) | 指定数据库是否加密。 |
| [securityLevel](_r_d_b.md#securitylevel) | 设置数据库安全级别&nbsp;[OH_Rdb_SecurityLevel](_r_d_b.md#oh_rdb_securitylevel)。 |
# OH_Rdb_Store
## 概述
表示数据库类型。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [id](_r_d_b.md#id-44) | OH_Rdb_Store结构体的唯一标识符。 |
# OH_VBucket
## 概述
用于存储键值对的类型。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [id](_r_d_b.md#id-34) | OH_VBucket结构体的唯一标识符。 |
| [capability](_r_d_b.md#capability) | 表示结构体的存储键值对的数量。 |
| [putText](_r_d_b.md#puttext-12) | 将const&nbsp;char\*值放入给定列名的[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象中。 |
| [putInt64](_r_d_b.md#putint64-12) | 将int64_t值放入给定列名的[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象中。 |
| [putReal](_r_d_b.md#putreal) | 将double值放入给定列名的[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象中**。** |
| [putBlob](_r_d_b.md#putblob) | 将const&nbsp;uint8_t&nbsp;\*值放入给定列名的[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象中。 |
| [putNull](_r_d_b.md#putnull) | 将NULL值放入给定列名的[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象中。 |
| [clear](_r_d_b.md#clear-22) | 清空[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象。 |
| [destroyValuesBucket](_r_d_b.md#destroyvaluesbucket) | 销毁[OH_VBucket](zh-cn_topic_0000001564188350.xml)对象,并回收该对象占用的内存。 |
# OH_VObject
## 概述
表示允许的数据字段类型。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 成员变量
| 名称 | 描述 |
| -------- | -------- |
| [id](_r_d_b.md#id-24) | OH_VObject结构体的唯一标识符。 |
| [putInt64](_r_d_b.md#putint64-22) | 将int64类型的单个参数或者数组转换为[OH_VObject](zh-cn_topic_0000001564348258.xml)类型的值。 |
| [putDouble](_r_d_b.md#putdouble) | 将double类型的单个参数或者数组转换为[OH_VObject](zh-cn_topic_0000001564348258.xml)类型的值。 |
| [putText](_r_d_b.md#puttext-22) | 将char&nbsp;\*类型的字符数组转换为[OH_VObject](zh-cn_topic_0000001564348258.xml)类型的值。 |
| [putTexts](_r_d_b.md#puttexts) | 将char&nbsp;\*类型的字符串数组转换为[OH_VObject](zh-cn_topic_0000001564348258.xml)类型的值。 |
| [destroyValueObject](_r_d_b.md#destroyvalueobject) | 销毁[OH_VObject](zh-cn_topic_0000001564348258.xml)对象,并回收该对象占用的内存。 |
此差异已折叠。
# oh_cursor.h
## 概述
提供通过查询数据库生成的数据库结果集的访问方法。
结果集是指用户调用关系型数据库查询接口之后返回的结果集合,提供了多种灵活的数据访问方式,以便用户获取各项数据。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OH_Cursor](_o_h___cursor.md) | 表示结果集。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [OH_Cursor](_r_d_b.md#oh_cursor) | 表示结果集。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [OH_ColumnType](_r_d_b.md#oh_columntype)&nbsp;{<br/>TYPE_NULL&nbsp;=&nbsp;0,&nbsp;TYPE_INT64,&nbsp;TYPE_REAL,&nbsp;TYPE_TEXT,<br/>TYPE_BLOB<br/>} | 数据库字段类型. |
# oh_predicates.h
## 概述
表示关系型数据库(RDB)的谓词。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OH_Predicates](_o_h___predicates.md) | 表示谓词。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [OH_Predicates](_r_d_b.md#oh_predicates) | 表示谓词。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [OH_OrderType](_r_d_b.md#oh_ordertype)&nbsp;{&nbsp;ASC&nbsp;=&nbsp;0,&nbsp;DESC&nbsp;=&nbsp;1&nbsp;} | 排序方式。 |
# oh_value_object.h
## 概述
提供类型转换方法。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OH_VObject](_o_h___v_object.md) | 表示允许的数据字段类型。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [OH_VObject](_r_d_b.md#oh_vobject) | 表示允许的数据字段类型。 |
# oh_values_bucket.h
## 概述
用于存储键值对的类型。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OH_VBucket](_o_h___v_bucket.md) | 用于存储键值对的类型。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
| [OH_VBucket](_r_d_b.md#oh_vbucket) | 用于存储键值对的类型。 |
# relation_error_code.h
## 概述
声明关系型数据库(RDB)的错误码信息。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [OH_Rdb_ErrCode](_r_d_b.md#oh_rdb_errcode)&nbsp;{&nbsp;RDB_ERR_INVALID_ARGS&nbsp;=&nbsp;-2,&nbsp;RDB_ERR&nbsp;=&nbsp;-1,&nbsp;RDB_ERR_OK&nbsp;=&nbsp;0&nbsp;} | 表示错误码信息。 |
# relation_store.h
## 概述
提供管理关系数据库(RDB)方法的接口。
**起始版本:**
10
**相关模块:**
[RDB](_r_d_b.md)
## 汇总
### 结构体
| 名称 | 描述 |
| -------- | -------- |
| [OH_Rdb_Config](_o_h___rdb___config.md) | 管理关系数据库配置。 |
| [OH_Rdb_Store](_o_h___rdb___store.md) | 表示数据库类型。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
| [OH_Rdb_SecurityLevel](_r_d_b.md#oh_rdb_securitylevel)&nbsp;{&nbsp;S1&nbsp;=&nbsp;1,&nbsp;S2,&nbsp;S3,&nbsp;S4&nbsp;} | 数据库的安全级别枚举。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| [OH_Rdb_CreateValueObject](_r_d_b.md#oh_rdb_createvalueobject)&nbsp;() | 创建[OH_VObject](_o_h___v_object.md)实例。 |
| [OH_Rdb_CreateValuesBucket](_r_d_b.md#oh_rdb_createvaluesbucket)&nbsp;() | 创建[OH_VBucket](_o_h___v_bucket.md)实例。 |
| [OH_Rdb_CreatePredicates](_r_d_b.md#oh_rdb_createpredicates)&nbsp;(const&nbsp;char&nbsp;\*table) | 创建[OH_Predicates](_o_h___predicates.md)实例。 |
| [OH_Rdb_GetOrOpen](_r_d_b.md#oh_rdb_getoropen)&nbsp;(const&nbsp;[OH_Rdb_Config](_o_h___rdb___config.md)&nbsp;\*config,&nbsp;int&nbsp;\*errCode) | 获得一个相关的[OH_Rdb_Store](_o_h___rdb___store.md)实例,操作关系型数据库。 |
| [OH_Rdb_CloseStore](_r_d_b.md#oh_rdb_closestore)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store) | 销毁[OH_Rdb_Store](_o_h___rdb___store.md)对象,并回收该对象占用的内存。 |
| [OH_Rdb_DeleteStore](_r_d_b.md#oh_rdb_deletestore)&nbsp;(const&nbsp;char&nbsp;\*path) | 使用指定的数据库文件配置删除数据库。 |
| [OH_Rdb_Insert](_r_d_b.md#oh_rdb_insert)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;const&nbsp;char&nbsp;\*table,&nbsp;[OH_VBucket](_o_h___v_bucket.md)&nbsp;\*valuesBucket) | 向目标表中插入一行数据。 |
| [OH_Rdb_Update](_r_d_b.md#oh_rdb_update)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;[OH_VBucket](_o_h___v_bucket.md)&nbsp;\*valuesBucket,&nbsp;[OH_Predicates](_o_h___predicates.md)&nbsp;\*predicates) | 根据指定的条件更新数据库中的数据。 |
| [OH_Rdb_Delete](_r_d_b.md#oh_rdb_delete)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;[OH_Predicates](_o_h___predicates.md)&nbsp;\*predicates) | 根据指定的条件删除数据库中的数据。 |
| [OH_Rdb_Query](_r_d_b.md#oh_rdb_query)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;[OH_Predicates](_o_h___predicates.md)&nbsp;\*predicates,&nbsp;const&nbsp;char&nbsp;\*const&nbsp;\*columnNames,&nbsp;int&nbsp;length) | 根据指定条件查询数据库中的数据 |
| [OH_Rdb_Execute](_r_d_b.md#oh_rdb_execute)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;const&nbsp;char&nbsp;\*sql) | 执行无返回值的SQL语句。 |
| [OH_Rdb_ExecuteQuery](_r_d_b.md#oh_rdb_executequery)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;const&nbsp;char&nbsp;\*sql) | 根据指定SQL语句查询数据库中的数据。 |
| [OH_Rdb_BeginTransaction](_r_d_b.md#oh_rdb_begintransaction)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store) | 在开始执行SQL语句之前,开始事务。 |
| [OH_Rdb_RollBack](_r_d_b.md#oh_rdb_rollback)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store) | 回滚已经执行的SQL语句。 |
| [OH_Rdb_Commit](_r_d_b.md#oh_rdb_commit)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store) | 提交已执行的SQL语句 |
| [OH_Rdb_Backup](_r_d_b.md#oh_rdb_backup)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;const&nbsp;char&nbsp;\*databasePath) | 以指定路径备份数据库。 |
| [OH_Rdb_Restore](_r_d_b.md#oh_rdb_restore)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;const&nbsp;char&nbsp;\*databasePath) | 从指定的数据库备份文件恢复数据库。 |
| [OH_Rdb_GetVersion](_r_d_b.md#oh_rdb_getversion)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;int&nbsp;\*version) | 获取数据库版本。 |
| [OH_Rdb_SetVersion](_r_d_b.md#oh_rdb_setversion)&nbsp;([OH_Rdb_Store](_o_h___rdb___store.md)&nbsp;\*store,&nbsp;int&nbsp;version) | 设置数据库版本。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册