harmony 鸿蒙relational_store.h

2025-06-12
浏览 (5)

relational_store.h

概述

提供管理关系数据库（RDB）方法的接口，未标注支持向量数据库的接口仅支持关系型数据库。

引用文件：

库： libnative_rdb_ndk.z.so

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

起始版本： 10

相关模块： RDB

汇总

结构体

枚举

函数

枚举类型说明

OH_Rdb_SecurityLevel

enum OH_Rdb_SecurityLevel

描述

数据库的安全级别枚举。

起始版本： 10

|枚举项|描述| |–|–| |S1 = 1|S1: 表示数据库的安全级别为低级别。当数据泄露时会产生较低影响。| |S2|S2: 表示数据库的安全级别为中级别。当数据泄露时会产生较大影响。| |S3|S3: 表示数据库的安全级别为高级别。当数据泄露时会产生重大影响。| |S4|S4: 表示数据库的安全级别为关键级别。当数据泄露时会产生严重影响。|

Rdb_SecurityArea

enum Rdb_SecurityArea

描述

描述数据库的安全区域等级。

起始版本： 11

Rdb_DBType

enum Rdb_DBType

描述

描述数据库的内核类型。

起始版本： 14

Rdb_Tokenizer

enum Rdb_Tokenizer

描述

描述数据库的分词器类型。

起始版本： 17

Rdb_DistributedType

enum Rdb_DistributedType

描述

描述表的分布式类型的枚举。

起始版本： 11

|枚举项|描述| |–|–| |RDB_DISTRIBUTED_CLOUD|表示在设备和云端之间分布式的数据库表。|

Rdb_ChangeType

enum Rdb_ChangeType

描述

描述数据变更类型。

起始版本： 11

|枚举项|描述| |–|–| |RDB_DATA_CHANGE|表示是数据发生变更。| |RDB_ASSET_CHANGE|表示是资产附件发生了变更。|

Rdb_SubscribeType

enum Rdb_SubscribeType

描述

描述订阅类型。

起始版本： 11

Rdb_SyncMode

enum Rdb_SyncMode

描述

表示数据库的同步模式

起始版本： 11

Rdb_Progress

enum Rdb_Progress

描述

Rdb_ProgressCode

enum Rdb_ProgressCode

描述

函数说明

OH_Rdb_CreateConfig()

OH_Rdb_ConfigV2 *OH_Rdb_CreateConfig()

描述

创建一个OH_Rdb_ConfigV2实例，并返回指向该实例的指针。

起始版本： 14

返回：

|类型|说明| |–|–| |OH_Rdb_ConfigV2|返回一个指向OH_Rdb_ConfigV2实例的指针。|

参考：

OH_Rdb_ConfigV2

OH_Rdb_DestroyConfig()

int OH_Rdb_DestroyConfig(OH_Rdb_ConfigV2 *config)

描述

销毁由OH_Rdb_CreateConfig创建的OH_Rdb_ConfigV2对象。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetDatabaseDir()

int OH_Rdb_SetDatabaseDir(OH_Rdb_ConfigV2 *config, const char *databaseDir)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置数据库文件路径。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |const char *dataBaseDir| 表示数据库文件路径。包含数据库名称在内的全路径长度不超过1024个字符。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetStoreName()

int OH_Rdb_SetStoreName(OH_Rdb_ConfigV2 *config, const char *storeName)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置数据库名称。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |const char *storeName|表示数据库名称。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetBundleName()

int OH_Rdb_SetBundleName(OH_Rdb_ConfigV2 *config, const char *bundleName)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置应用包名。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |const char *bundleName|表示数据库应用包名。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetModuleName()

int OH_Rdb_SetModuleName(OH_Rdb_ConfigV2 *config, const char *moduleName)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置应用模块名。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |const char *moduleName|表示数据库应用模块名。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetEncrypted()

int OH_Rdb_SetEncrypted(OH_Rdb_ConfigV2 *config, bool isEncrypted)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置数据库是否加密。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |bool isEncrypted|表示数据库是否加密。true表示加密，false表示不加密。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetSecurityLevel()

int OH_Rdb_SetSecurityLevel(OH_Rdb_ConfigV2 *config, int securityLevel)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置数据库安全级别OH_Rdb_SecurityLevel。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |int securityLevel|表示数据库安全级别OH_Rdb_SecurityLevel。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetArea()

int OH_Rdb_SetArea(OH_Rdb_ConfigV2 *config, int area)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置数据库安全区域等级Rdb_SecurityArea。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |int area|表示数据库安全区域等级Rdb_SecurityArea。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetDbType()

int OH_Rdb_SetDbType(OH_Rdb_ConfigV2 *config, int dbType)

描述

给指定的数据库文件配置OH_Rdb_ConfigV2，设置数据库类型Rdb_DBType。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |int dbType|表示数据库的数据库类型Rdb_DBType。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。
RDB_E_NOT_SUPPORTED表示不支持当前操作。|

OH_Rdb_SetCustomDir()

int OH_Rdb_SetCustomDir(OH_Rdb_ConfigV2 *config, const char *customDir)

描述

设置数据库的自定义目录。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示此关系型数据库相关的数据库配置OH_Rdb_ConfigV2的指针。| |const char *customDir|表示数据库的自定义目录，目录长度不能超过128字节。|

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_INVALID_ARGS表示输入参数无效。|

OH_Rdb_SetReadOnly()

int OH_Rdb_SetReadOnly(OH_Rdb_ConfigV2 *config, bool readOnly)

描述

设置关系型数据库是否为只读模式。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示此关系型数据库相关的数据库配置OH_Rdb_ConfigV2的指针。| |bool readOnly|表示关系型数据库存储是否为只读模式，true表示设置为只读模式，false表示设置为读写模式。|

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_INVALID_ARGS表示输入参数无效。|

OH_Rdb_SetPlugins()

int OH_Rdb_SetPlugins(OH_Rdb_ConfigV2 *config, const char **plugins, int32_t length)

描述

设置具有特定功能（如全文检索）的动态库。

起始版本： 20

参数：

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_INVALID_ARGS表示输入参数无效。|

OH_Rdb_SetCryptoParam()

int OH_Rdb_SetCryptoParam(OH_Rdb_ConfigV2 *config, const OH_Rdb_CryptoParam *cryptoParam)

描述

设置自定义加密参数。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示此关系型数据库相关的数据库配置OH_Rdb_ConfigV2的指针。| |const OH_Rdb_CryptoParam *cryptoParam|表示自定义加密参数。|

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_INVALID_ARGS表示输入参数无效。|

OH_Rdb_IsTokenizerSupported()

int OH_Rdb_IsTokenizerSupported(Rdb_Tokenizer tokenizer, bool *isSupported)

描述

判断当前平台是否支持传入的分词器。

起始版本： 18

参数：

|参数项|描述| |–|–| |Rdb_Tokenizer tokenizer|要校验是否支持的分词器。| |bool *isSupported|校验结果的指针，作为出参使用。true表示当前平台支持当前校验的分词器，false表示当前平台不支持当前校验的分词器。|

返回：

|类型|说明| |–|–| |int|返回接口操作执行的状态码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetTokenizer()

int OH_Rdb_SetTokenizer(OH_Rdb_ConfigV2 *config, Rdb_Tokenizer tokenizer)

描述

给指定的数据库文件配置设置分词器类型。

起始版本： 17

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向此RDB存储相关的数据库配置的指针。| |Rdb_Tokenizer tokenizer|表示数据库的分词器类型。|

返回：

|类型|说明| |–|–| |int|返回接口操作执行的状态码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。
RDB_E_NOT_SUPPORTED表示不支持当前操作。|

OH_Rdb_SetPersistent()

int OH_Rdb_SetPersistent(OH_Rdb_ConfigV2 *config, bool isPersistent)

描述

指定数据库是否需要持久化。

起始版本： 18

参数：

|参数项|描述| |–|–| |OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2实例的指针。
指示与此RDB存储相关的数据库的配置。| |bool isPersistent|指示数据库是否需要持久性。|

返回：

|类型|说明| |–|–| |int|返回执行的状态代码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_GetSupportedDbType()

const int *OH_Rdb_GetSupportedDbType(int *typeCount)

描述

获得支持的数据库类型Rdb_DBType。

起始版本： 14

参数：

|参数项|描述| |–|–| |int *typeCount|表示支持的数据库类型的数组的长度, 作为出参使用。|

返回：

|类型 |说明| |————|–| |const int *|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_CreateValueObject()

OH_VObject *OH_Rdb_CreateValueObject()

描述

创建OH_VObject实例。

起始版本： 10

返回：

|类型|说明| |–|–| |OH_VObject|创建成功则返回一个指向OH_VObject结构体实例的指针，否则返回NULL。|

参考：

OH_VObject

OH_Rdb_CreateValuesBucket()

OH_VBucket *OH_Rdb_CreateValuesBucket()

描述

创建OH_VBucket实例。

起始版本： 10

返回：

|类型|说明| |–|–| |OH_VBucket|创建成功则返回一个指向OH_VBucket结构体实例的指针，否则返回NULL。|

参考：

OH_VBucket

OH_Rdb_CreatePredicates()

OH_Predicates *OH_Rdb_CreatePredicates(const char *table)

描述

创建OH_Predicates实例。

起始版本： 10

参数：

|参数项|描述| |–|–| |const char *table|表示数据库表名。|

返回：

|类型|说明| |–|–| |OH_Predicates|创建成功则返回一个指向OH_Predicates结构体实例的指针，否则返回NULL。|

参考：

OH_Predicates

OH_Rdb_GetOrOpen()

OH_Rdb_Store *OH_Rdb_GetOrOpen(const OH_Rdb_Config *config, int *errCode)

描述

获得一个相关的OH_Rdb_Store实例，操作关系型数据库。

起始版本： 10

参数：

|参数项|描述| |–|–| |const OH_Rdb_Config *config|表示指向OH_Rdb_Config实例的指针，与此RDB存储相关的数据库配置。| |int *errCode|表示函数执行状态, 作为出参使用。|

返回：

|类型|说明| |–|–| |OH_Rdb_Store|创建成功则返回一个指向OH_Rdb_Store结构体实例的指针，否则返回NULL。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_CreateOrOpen()

OH_Rdb_Store *OH_Rdb_CreateOrOpen(const OH_Rdb_ConfigV2 *config, int *errCode)

描述

使用指定的数据库文件配置OH_Rdb_ConfigV2，获得一个对应的OH_Rdb_Store实例，用来操作关系型数据库。

起始版本： 14

参数：

|参数项|描述| |–|–| |const OH_Rdb_ConfigV2 *config|表示指向OH_Rdb_ConfigV2对象的指针，即与此RDB存储相关的数据库配置。| |int *errCode|表示函数执行状态，作为出参使用。|

返回：

|类型|说明| |–|–| |OH_Rdb_Store|创建成功则返回一个指向OH_Rdb_Store结构体实例的指针，否则返回NULL。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_CloseStore()

int OH_Rdb_CloseStore(OH_Rdb_Store *store)

描述

销毁OH_Rdb_Store对象，并回收该对象占用的内存。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_DeleteStore()

int OH_Rdb_DeleteStore(const OH_Rdb_Config *config)

描述

使用指定的数据库文件配置删除数据库。

起始版本： 10

参数：

|参数项|描述| |–|–| |const OH_Rdb_Config *config|表示数据库的配置。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_DeleteStoreV2()

int OH_Rdb_DeleteStoreV2(const OH_Rdb_ConfigV2 *config)

描述

使用指定的数据库文件配置OH_Rdb_ConfigV2删除数据库。
当使用向量数据库时，在调用接口前，应当确保向量数据库已经打开的OH_Rdb_Store和OH_Cursor均已成功关闭。

起始版本： 14

参数：

|参数项|描述| |–|–| |const OH_Rdb_ConfigV2 *config|表示数据库的配置。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_Insert()

int OH_Rdb_Insert(OH_Rdb_Store *store, const char *table, OH_VBucket *valuesBucket)

描述

向目标表中插入一行数据。

起始版本： 10

参数：

返回：

|类型|说明| |–|–| |int|如果插入成功，返回rowID，否则返回的结果小于0。
RDB_ERR表示插入失败。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_InsertWithConflictResolution()

int OH_Rdb_InsertWithConflictResolution(OH_Rdb_Store *store, const char *table, OH_VBucket *row,Rdb_ConflictResolution resolution, int64_t *rowId)

描述

向目标表中插入一行数据，并支持冲突解决。

起始版本： 20

参数：

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_ERROR表示数据库常见错误。
返回RDB_E_INVALID_ARGS表示输入参数无效。
返回RDB_E_ALREADY_CLOSED表示数据库已关闭。
返回RDB_E_WAL_SIZE_OVER_LIMIT表示WAL文件大小超过默认限制。
返回RDB_E_SQLITE_FULL表示SQLite错误：数据库已满。
返回RDB_E_SQLITE_CORRUPT表示数据库已损坏。
返回RDB_E_SQLITE_PERM表示SQLite错误：访问权限被拒绝。
返回RDB_E_SQLITE_BUSY表示SQLite错误：数据库文件被锁定。
返回RDB_E_SQLITE_LOCKED表示SQLite错误：数据库中的表被锁定。
返回RDB_E_SQLITE_NOMEM表示SQLite错误：数据库内存不足。
返回RDB_E_SQLITE_READONLY表示SQLite错误：尝试写入只读数据库。
返回RDB_E_SQLITE_IOERR表示SQLite错误：磁盘I/O错误。
返回RDB_E_SQLITE_TOO_BIG表示SQLite错误：TEXT或BLOB超出大小限制。
返回RDB_E_SQLITE_MISMATCH表示SQLite错误：数据类型不匹配。
返回RDB_E_SQLITE_CONSTRAINT表示SQLite错误：违反约束导致操作中止。|

OH_Rdb_BatchInsert()

int OH_Rdb_BatchInsert(OH_Rdb_Store *store, const char *table,const OH_Data_VBuckets *rows, Rdb_ConflictResolution resolution, int64_t *changes)

描述

将一批数据插入到目标表中。

起始版本： 18

参数：

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示成功。
返回RDB_E_ERROR表示数据库常见错误。
返回RDB_E_INVALID_ARGS表示无效参数。
返回RDB_E_ALREADY_CLOSED表示数据库已经关闭。
返回RDB_E_WAL_SIZE_OVER_LIMIT表示WAL日志文件大小超过默认值。
返回RDB_E_SQLITE_FULL表示SQLite错误码：数据库已满。
返回RDB_E_SQLITE_CORRUPT表示数据库损坏。
返回RDB_E_SQLITE_PERM表示SQLite错误码：访问权限被拒绝。
返回RDB_E_SQLITE_BUSY表示SQLite错误码：数据库文件被锁定。
返回RDB_E_SQLITE_LOCKED表示SQLite错误码：数据库中的表被锁定。
返回RDB_E_SQLITE_NOMEM表示SQLite错误码：数据库内存不足。
返回RDB_E_SQLITE_READONLY表示SQLite错误码：尝试写入只读数据库。
返回RDB_E_SQLITE_IOERR表示SQLite错误码：磁盘I/O错误。
返回RDB_E_SQLITE_TOO_BIG表示SQLite错误码：TEXT或BLOB超出大小限制。
返回RDB_E_SQLITE_MISMATCH表示SQLite错误码：数据类型不匹配。
返回RDB_E_SQLITE_CONSTRAINT表示SQLite错误码：SQLite约束。|

OH_Rdb_Update()

int OH_Rdb_Update(OH_Rdb_Store *store, OH_VBucket *valuesBucket, OH_Predicates *predicates)

描述

根据指定的条件更新数据库中的数据。

起始版本： 10

参数：

返回：

|类型|说明| |–|–| |int|如果更新成功，返回更新的行数，否则返回的结果小于0。
RDB_ERR表示更新失败。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_UpdateWithConflictResolution()

int OH_Rdb_UpdateWithConflictResolution(OH_Rdb_Store *store, OH_VBucket *row, OH_Predicates *predicates,Rdb_ConflictResolution resolution, int64_t *changes)

描述

根据指定条件更新数据库中的数据，并支持冲突解决。

起始版本： 20

参数：

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_ERROR 表示数据库常见错误。
返回RDB_E_INVALID_ARGS表示输入参数无效。
返回RDB_E_ALREADY_CLOSED表示数据库已关闭。
返回RDB_E_WAL_SIZE_OVER_LIMIT表示WAL文件大小超过默认限制。
返回RDB_E_SQLITE_FULL表示SQLite错误：数据库已满。
返回RDB_E_SQLITE_CORRUPT表示数据库已损坏。
返回RDB_E_SQLITE_PERM表示SQLite错误：访问权限被拒绝。
返回RDB_E_SQLITE_BUSY表示SQLite错误：数据库文件被锁定。
返回RDB_E_SQLITE_LOCKED表示SQLite错误：数据库中的表被锁定。
返回RDB_E_SQLITE_NOMEM表示SQLite错误：数据库内存不足。
返回RDB_E_SQLITE_READONLY表示SQLite错误：尝试写入只读数据库。
返回RDB_E_SQLITE_IOERR表示SQLite错误：磁盘I/O错误。
返回RDB_E_SQLITE_TOO_BIG表示SQLite错误：TEXT或BLOB超出大小限制。
返回RDB_E_SQLITE_MISMATCH表示SQLite错误：数据类型不匹配。
返回RDB_E_SQLITE_CONSTRAINT表示SQLite错误：违反约束导致操作中止。|

OH_Rdb_Delete()

int OH_Rdb_Delete(OH_Rdb_Store *store, OH_Predicates *predicates)

描述

根据指定的条件删除数据库中的数据。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |OH_Predicates *predicates|表示指向OH_Predicates实例的指针，指定删除条件。|

返回：

|类型|说明| |–|–| |int|如果删除成功，返回删除的行数；如果失败，则返回的结果小于0。
RDB_ERR表示删除失败。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_Query()

OH_Cursor *OH_Rdb_Query(OH_Rdb_Store *store, OH_Predicates *predicates, const char *const *columnNames, int length)

描述

根据指定条件查询数据库中的数据

起始版本： 10

参数：

返回：

|类型 |说明| |———————————-|–| |OH_Cursor *|如果查询成功则返回一个指向OH_Cursor结构体实例的指针，否则返回NULL。|

OH_Rdb_Execute()

int OH_Rdb_Execute(OH_Rdb_Store *store, const char *sql)

描述

执行无返回值的SQL语句。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |const char *sql|指定要执行的SQL语句。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

参考：

OH_Rdb_Store

OH_Rdb_ExecuteV2()

int OH_Rdb_ExecuteV2(OH_Rdb_Store *store, const char *sql, const OH_Data_Values *args, OH_Data_Value **result)

描述

执行有返回值的SQL语句，支持向量数据库。

起始版本： 18

参数：

参数项	描述
OH_Rdb_Store *store	表示指向OH_Rdb_Store实例的指针。
const char *sql	指定要执行的SQL语句。
const OH_Data_Values *args	可选参数，表示指向OH_Data_Values实例的指针。
OH_Data_Value **result	执行成功时指向OH_Data_Value实例的指针，作为出参使用。使用完成后，必须通过OH_Value_Destroy接口释放内存。

返回：

参考：

OH_Value_Destroy

OH_Rdb_ExecuteByTrxId()

int OH_Rdb_ExecuteByTrxId(OH_Rdb_Store *store, int64_t trxId, const char *sql)

描述

使用指定的事务ID执行无返回值的SQL语句，仅支持向量数据库。

起始版本： 14

参数：

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数，可能情况如下：
传入参数为空指针。
当前事务ID不是调用OH_Rdb_BeginTransWithTrxId获得的。
当前事务ID已经调用OH_Rdb_CommitByTrxId提交。
当前事务ID已经调用OH_Rdb_RollBackByTrxId回滚。
当store或者sql为NULL时。
RDB_E_NOT_SUPPORTED表示不支持当前操作。|

参考：

OH_Rdb_Store

OH_Rdb_ExecuteQuery()

OH_Cursor *OH_Rdb_ExecuteQuery(OH_Rdb_Store *store, const char *sql)

描述

根据指定SQL语句查询数据库中的数据，支持向量数据库。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |const char *sql|指定要执行的SQL语句。|

返回：

|类型|说明| |–|–| |OH_Cursor|如果查询成功则返回一个指向OH_Cursor结构体实例的指针，否则返回NULL。|

参考：

OH_Rdb_Store

OH_Rdb_ExecuteQueryV2()

OH_Cursor *OH_Rdb_ExecuteQueryV2(OH_Rdb_Store *store, const char *sql, const OH_Data_Values *args)

描述

根据指定SQL语句查询数据库中的数据，支持向量数据库。

起始版本： 18

参数：

返回：

类型	说明
OH_Cursor *	如果查询成功则返回一个指向OH_Cursor结构体实例的指针，使用完成后及时释放OH_Cursor。如果SQL语句无效或内存分配失败，则返回NULL。

参考：

OH_Rdb_Store

OH_Rdb_BeginTransaction()

int OH_Rdb_BeginTransaction(OH_Rdb_Store *store)

描述

在开始执行SQL语句之前，开始事务。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_RollBack()

int OH_Rdb_RollBack(OH_Rdb_Store *store)

描述

回滚已经执行的SQL语句。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_Commit()

int OH_Rdb_Commit(OH_Rdb_Store *store)

描述

提交已执行的SQL语句

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_BeginTransWithTrxId()

int OH_Rdb_BeginTransWithTrxId(OH_Rdb_Store *store, int64_t *trxId)

描述

在开始执行SQL语句之前，开始事务，并获得该事务的ID，仅支持向量数据库。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示一个指向OH_Rdb_Store实例的指针。| |int64_t *trxId|事务ID，作为出参使用。|

返回：

OH_Rdb_RollBackByTrxId()

int OH_Rdb_RollBackByTrxId(OH_Rdb_Store *store, int64_t trxId)

描述

使用指定的事务ID, 回滚已经执行的SQL语句，仅支持向量数据库。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示一个指向OH_Rdb_Store实例的指针。| |int64_t trxId|表示需要回滚的事务的ID。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数, 可能情况如下：
传入参数为空指针。
当前事务ID不是调用OH_Rdb_BeginTransWithTrxId获得的。
当前事务ID已经调用OH_Rdb_CommitByTrxId提交。
当前事务ID已经调用OH_Rdb_RollBackByTrxId回滚。
RDB_E_NOT_SUPPORTED表示不支持当前操作。|

OH_Rdb_CommitByTrxId()

int OH_Rdb_CommitByTrxId(OH_Rdb_Store *store, int64_t trxId)

描述

使用指定的事务ID, 提交已经执行的SQL语句，仅支持向量数据库。

起始版本： 14

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示一个指向OH_Rdb_Store实例的指针。| |int64_t trxId|表示需要提交的事务的ID。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK 表示成功.
RDB_E_INVALID_ARGS表示无效参数，可能情况如下：
传入参数为空指针。
当前事务ID不是调用OH_Rdb_BeginTransWithTrxId获得的。
当前事务ID已经调用OH_Rdb_CommitByTrxId提交。
当前事务ID已经调用OH_Rdb_RollBackByTrxId回滚。
RDB_E_NOT_SUPPORTED表示不支持当前操作。|

参考：

OH_Rdb_Store

OH_Rdb_Backup()

int OH_Rdb_Backup(OH_Rdb_Store *store, const char *databasePath)

描述

以指定路径备份数据库，支持向量数据库。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |const char *databasePath|指定数据库的备份文件路径。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

参考：

OH_Rdb_Store

OH_Rdb_Restore()

int OH_Rdb_Restore(OH_Rdb_Store *store, const char *databasePath)

描述

从指定的数据库备份文件恢复数据库，支持向量数据库。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |const char *databasePath|指定数据库的备份文件路径。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_GetVersion()

int OH_Rdb_GetVersion(OH_Rdb_Store *store, int *version)

描述

获取数据库版本。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |int *version|表示版本号，作为出参使用。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SetVersion()

int OH_Rdb_SetVersion(OH_Rdb_Store *store, int version)

描述

设置数据库版本。

起始版本： 10

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |int version|表示版本号。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

参考：

OH_Rdb_Store

OH_Rdb_SetDistributedTables()

int OH_Rdb_SetDistributedTables(OH_Rdb_Store *store, const char *tables[], uint32_t count, Rdb_DistributedType type,const Rdb_DistributedConfig *config)

描述

设置分布式数据库表。

起始版本： 11

参数：

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

参考：

OH_Rdb_Store

OH_Rdb_FindModifyTime()

OH_Cursor *OH_Rdb_FindModifyTime(OH_Rdb_Store *store, const char *tableName, const char *columnName,OH_VObject *values)

描述

获取数据库表中数据的最后修改时间。

起始版本： 11

参数：

返回：

|类型|说明| |–|–| |OH_Cursor|如果操作成功则返回一个指向OH_Rdb_Store结构体实例的指针，否则返回NULL。|

Rdb_BriefObserver()

typedef void (*Rdb_BriefObserver)(void *context, const char *values[], uint32_t count)

描述

端云数据更改事件的回调函数。

起始版本： 11

参数：

Rdb_DetailsObserver()

typedef void (*Rdb_DetailsObserver)(void *context, const Rdb_ChangeInfo **changeInfo, uint32_t count)

描述

端云数据更改事件的细节的回调函数。

起始版本： 11

参数：

OH_Rdb_Subscribe()

int OH_Rdb_Subscribe(OH_Rdb_Store *store, Rdb_SubscribeType type, const Rdb_DataObserver *observer)

描述

为数据库注册观察者。当分布式数据库或本地数据库中的数据发生更改时，将调用回调。

起始版本： 11

参数：

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_Unsubscribe()

int OH_Rdb_Unsubscribe(OH_Rdb_Store *store, Rdb_SubscribeType type, const Rdb_DataObserver *observer)

描述

从数据库中删除指定类型的指定观察者。

起始版本： 11

参数：

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_GetTableDetails()

Rdb_TableDetails *OH_Rdb_GetTableDetails(Rdb_ProgressDetails *progress, int32_t version)

描述

从端云同步任务的统计信息中获取数据库表的统计信息。

起始版本： 11

参数：

|参数项|描述 | |–|————————————————————| |Rdb_ProgressDetails *progress|表示指向OH_ProgressDetails实例的指针。 | |int32_t version|表示当前Rdb_ProgressDetails的版本。|

返回：

|类型|说明| |–|–| |Rdb_TableDetails|如果操作成功，会返回一个Rdb_TableDetails结构体的指针，否则返回NULL。|

参考：

Rdb_TableDetails

Rdb_ProgressCallback()

typedef void (*Rdb_ProgressCallback)(void *context, Rdb_ProgressDetails *progressDetails)

描述

端云同步进度的回调函数。

起始版本： 11

参数：

参数项	描述
void *context
Rdb_ProgressDetails *progressDetails	端云同步进度的详细信息。

Rdb_SyncCallback()

typedef void (*Rdb_SyncCallback)(Rdb_ProgressDetails *progressDetails)

描述

数据库端云同步的回调函数。

起始版本： 11

参数：

|参数项|描述| |–|–| |Rdb_ProgressDetails *progressDetails|数据库端云同步的统计信息。|

OH_Rdb_CloudSync()

int OH_Rdb_CloudSync(OH_Rdb_Store *store, Rdb_SyncMode mode, const char *tables[], uint32_t count,const Rdb_ProgressObserver *observer)

描述

进行端云同步。

起始版本： 11

参数：

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_SubscribeAutoSyncProgress()

int OH_Rdb_SubscribeAutoSyncProgress(OH_Rdb_Store *store, const Rdb_ProgressObserver *observer)

描述

订阅RDB存储的自动同步进度。
当收到自动同步进度的通知时，将调用回调。

起始版本： 11

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向目标OH_Rdb_Store实例的指针。| |const Rdb_ProgressObserver *observer|用于自动同步进度的观察者Rdb_ProgressObserver。表示调用返回自动同步进度的回调。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_UnsubscribeAutoSyncProgress()

int OH_Rdb_UnsubscribeAutoSyncProgress(OH_Rdb_Store *store, const Rdb_ProgressObserver *observer)

描述

取消订阅RDB存储的自动同步进程。

起始版本： 11

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向目标OH_Rdb_Store实例的指针。| |const Rdb_ProgressObserver *observer|表示自动同步进度的观察者Rdb_ProgressObserver。如果是空指针，则自动同步进程的所有回调都将被取消注册。|

返回：

|类型|说明| |–|–| |int|返回操作是否成功，出错时返回对应的错误码。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_LockRow()

int OH_Rdb_LockRow(OH_Rdb_Store *store, OH_Predicates *predicates)

描述

根据指定的条件锁定数据库中的数据，锁定数据不执行端云同步。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |OH_Predicates *predicates|表示指向OH_Predicates实例的指针，指定锁定条件。|

返回：

|类型|说明| |–|–| |int|返回锁定结果。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_UnlockRow()

int OH_Rdb_UnlockRow(OH_Rdb_Store *store, OH_Predicates *predicates)

描述

根据指定的条件锁解锁数据库中的数据。

起始版本： 12

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |OH_Predicates *predicates|表示指向OH_Predicates实例的指针，指定解锁条件。|

返回：

|类型|说明| |–|–| |int|返回解锁结果。
RDB_OK表示成功。
RDB_E_INVALID_ARGS表示无效参数。|

OH_Rdb_QueryLockedRow()

OH_Cursor *OH_Rdb_QueryLockedRow(OH_Rdb_Store *store, OH_Predicates *predicates, const char *const *columnNames, int length)

描述

根据指定条件查询数据库中锁定的数据。

起始版本： 12

参数：

返回：

|类型|说明| |–|–| |OH_Cursor|如果查询成功则返回一个指向OH_Cursor结构体实例的指针，否则返回NULL。|

OH_Rdb_CreateTransaction()

int OH_Rdb_CreateTransaction(OH_Rdb_Store *store, const OH_RDB_TransOptions *options, OH_Rdb_Transaction **trans)

描述

创建一个事务对象。

起始版本： 18

参数：

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示成功。
返回RDB_E_ERROR表示数据库常见错误。
返回RDB_E_INVALID_ARGS表示无效参数。
返回RDB_E_ALREADY_CLOSED表示数据库已关闭。
返回RDB_E_DATABASE_BUSY表示数据库无响应。
返回RDB_E_SQLITE_FULL表示SQLite错误: 数据库已满。
返回RDB_E_SQLITE_CORRUPT表示数据库已损坏。
返回RDB_E_SQLITE_PERM表示SQLite错误: 访问权限被拒绝。
返回RDB_E_SQLITE_BUSY表示SQLite错误: 数据库文件被锁定。
返回RDB_E_SQLITE_NOMEM表示SQLite错误: 数据库内存不足。
返回RDB_E_SQLITE_IOERR表示SQLite错误: 磁盘I/O错误。
返回RDB_E_SQLITE_CANT_OPEN表示SQLite错误: 无法打开数据库文件。|

OH_Rdb_Attach()

int OH_Rdb_Attach(OH_Rdb_Store *store, const OH_Rdb_ConfigV2 *config, const char *attachName, int64_t waitTime,size_t *attachedNumber)

描述

将数据库文件附加到当前连接的数据库。

起始版本： 20

参数：

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_E_ERROR 表示数据库常见错误。
返回RDB_E_INVALID_ARGS表示输入参数无效。
返回RDB_E_ALREADY_CLOSED表示数据库已关闭。
返回RDB_E_NOT_SUPPORTED表示不支持的操作。
返回RDB_E_DATABASE_BUSY表示数据库无响应。
返回RDB_E_SQLITE_FULL表示SQLite错误：数据库已满。
返回RDB_E_SQLITE_CORRUPT表示数据库已损坏。
返回RDB_E_SQLITE_PERM表示SQLite错误：访问权限被拒绝。
返回RDB_E_SQLITE_BUSY表示SQLite错误：数据库文件被锁定。
返回RDB_E_SQLITE_LOCKED表示SQLite错误：数据库中的表被锁定。
返回RDB_E_SQLITE_NOMEM表示SQLite错误：数据库内存不足。
返回RDB_E_SQLITE_READONLY表示SQLite错误：尝试写入只读数据库。
返回RDB_E_SQLITE_IOERR表示SQLite错误：磁盘I/O错误。
返回RDB_E_SQLITE_TOO_BIG表示SQLite错误：TEXT或BLOB超出大小限制。
返回RDB_E_SQLITE_MISMATCH表示SQLite错误：数据类型不匹配。
返回RDB_E_SQLITE_CONSTRAINT表示SQLite错误：违反约束导致操作中止。|

OH_Rdb_Detach()

int OH_Rdb_Detach(OH_Rdb_Store *store, const char *attachName, int64_t waitTime, size_t *attachedNumber)

描述

从当前数据库中分离指定的数据库。

起始版本： 20

参数：

返回：

OH_Rdb_SetLocale()

int OH_Rdb_SetLocale(OH_Rdb_Store *store, const char *locale)

描述

支持不同语言的排序规则。

起始版本： 20

参数：

|参数项|描述| |–|–| |OH_Rdb_Store *store|表示指向OH_Rdb_Store实例的指针。| |const char *locale|与语言相关的区域设置，例如 zh。该值符合 ISO 639 标准。|

返回：

|类型|说明| |–|–| |int|返回执行结果。
返回RDB_OK表示执行成功。
返回RDB_ERR表示函数执行异常。
返回RDB_E_INVALID_ARGS表示输入参数无效。
返回RDB_E_ALREADY_CLOSED表示数据库已关闭。
返回RDB_E_SQLITE_BUSY表示SQLite错误：数据库文件被锁定。
返回RDB_E_SQLITE_NOMEM表示SQLite错误：数据库内存不足。|

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkData（方舟数据管理）

harmony 鸿蒙Class (RdbPredicates)

harmony 鸿蒙arkts-apis-data-relationalStore-RdbStore

harmony 鸿蒙Interface (ResultSet)

harmony 鸿蒙Interface (Transaction)

harmony 鸿蒙Enums

harmony 鸿蒙Functions

harmony 鸿蒙Interfaces (其他)

harmony 鸿蒙Types

harmony 鸿蒙模块描述

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/HcFgcl