diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___cursor.md b/zh-cn/application-dev/reference/native-apis/_o_h___cursor.md index f5f8d5d51951c7516fd39ab47be8e483edeb216b..e3316c9efed934b74a76b4ef8359e0bfd6ee37e1 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___cursor.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___cursor.md @@ -36,4 +36,4 @@ | [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) | 函数指针,关闭结果集。 | +| [destroy](_r_d_b.md#destroy-14) | 函数指针,关闭结果集。 | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___predicates.md b/zh-cn/application-dev/reference/native-apis/_o_h___predicates.md index e44eeba7c66cdd0e8f0999a78a60cbf332f968b6..bb3c7d99994d2e6d3210b760060e4da93753717b 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___predicates.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___predicates.md @@ -45,4 +45,4 @@ | [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对象,并回收该对象占用的内存。 | +| [destroy](_r_d_b.md#destroy-24) | 销毁OH_Predicates对象,并回收该对象占用的内存。 | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___rdb___config.md b/zh-cn/application-dev/reference/native-apis/_o_h___rdb___config.md index 6248376e3c64ef9b0d798d298a03c2fff5b4e686..008e7380959716b0c4ff0f2da829917e9c11883e 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___rdb___config.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___rdb___config.md @@ -21,6 +21,9 @@ | 名称 | 描述 | | -------- | -------- | -| [path](_r_d_b.md#path) | 数据库文件路径。 | +| [selfSize](_r_d_b.md#selfsize) | 该结构体的大小。 | +| [dataBaseDir](_r_d_b.md#databasedir) | 数据库文件路径。 | +| [bundleName](_r_d_b.md#bundlename) | 应用包名。 | +| [moduleName](_r_d_b.md#modulename) | 应用模块名。 | | [isEncrypt](_r_d_b.md#isencrypt) | 指定数据库是否加密。 | -| [securityLevel](_r_d_b.md#securitylevel) | 设置数据库安全级别 [OH_Rdb_SecurityLevel](_r_d_b.md#oh_rdb_securitylevel)。 | +| [securityLevel](_r_d_b.md#securitylevel) | 数据库安全级别。 | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___v_bucket.md b/zh-cn/application-dev/reference/native-apis/_o_h___v_bucket.md index e96aa86334ffecc6ecc1eab7e69520cbd5c6ec99..cb230a04f3fa5c1b87abd931f1fe2dc5707a08be 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___v_bucket.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___v_bucket.md @@ -29,4 +29,4 @@ | [putBlob](_r_d_b.md#putblob) | 将const uint8_t \*值放入给定列名的OH_VBucket对象中。 | | [putNull](_r_d_b.md#putnull) | 将NULL值放入给定列名的OH_VBucket对象中。 | | [clear](_r_d_b.md#clear-22) | 清空OH_VBucket对象。 | -| [destroyValuesBucket](_r_d_b.md#destroyvaluesbucket) | 销毁OH_VBucket对象,并回收该对象占用的内存。 | +| [destroy](_r_d_b.md#destroy-34) | 销毁OH_VBucket对象,并回收该对象占用的内存。 | diff --git a/zh-cn/application-dev/reference/native-apis/_o_h___v_object.md b/zh-cn/application-dev/reference/native-apis/_o_h___v_object.md index d0960d7ecb3e3340e7d8a6ad68efe4d5331f67ca..2ffde853814feb9d89e5b0a76d7e83edea5b420e 100644 --- a/zh-cn/application-dev/reference/native-apis/_o_h___v_object.md +++ b/zh-cn/application-dev/reference/native-apis/_o_h___v_object.md @@ -26,4 +26,4 @@ | [putDouble](_r_d_b.md#putdouble) | 将double类型的单个参数或者数组转换为OH_VObject类型的值。 | | [putText](_r_d_b.md#puttext-22) | 将char \*类型的字符数组转换为OH_VObject类型的值。 | | [putTexts](_r_d_b.md#puttexts) | 将char \*类型的字符串数组转换为OH_VObject类型的值。 | -| [destroyValueObject](_r_d_b.md#destroyvalueobject) | 销毁OH_VObject对象,并回收该对象占用的内存。 | +| [destroy](_r_d_b.md#destroy-44) | 销毁OH_VObject对象,并回收该对象占用的内存。 | diff --git a/zh-cn/application-dev/reference/native-apis/_r_d_b.md b/zh-cn/application-dev/reference/native-apis/_r_d_b.md index e87a794d4e48b026966caab641f1278ba2b72b43..c1108f5ae184a16910a7ffaa76c17d36713231af 100644 --- a/zh-cn/application-dev/reference/native-apis/_r_d_b.md +++ b/zh-cn/application-dev/reference/native-apis/_r_d_b.md @@ -5,7 +5,7 @@ 关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的 对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。 -\@syscap SystemCapability.DistributedDataManager.RelationalStore.Core +\@SystemCapability.DistributedDataManager.RelationalStore.Core **起始版本:** @@ -43,10 +43,13 @@ | 名称 | 描述 | | -------- | -------- | +| [OH_ColumnType](#oh_columntype) | 数据库字段类型。 | | [OH_Cursor](#oh_cursor) | 表示结果集。 | +| [OH_OrderType](#oh_ordertype) | 排序方式。 | | [OH_Predicates](#oh_predicates) | 表示谓词。 | | [OH_VObject](#oh_vobject) | 表示允许的数据字段类型。 | | [OH_VBucket](#oh_vbucket) | 用于存储键值对的类型。 | +| [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel) | 数据库的安全级别枚举。 | | [OH_Rdb_ErrCode](#oh_rdb_errcode) | 表示错误码信息。 | @@ -69,7 +72,7 @@ | [OH_Rdb_CreatePredicates](#oh_rdb_createpredicates) (const char \*table) | 创建[OH_Predicates](_o_h___predicates.md)实例。 | | [OH_Rdb_GetOrOpen](#oh_rdb_getoropen) (const [OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | 获得一个相关的[OH_Rdb_Store](_o_h___rdb___store.md)实例,操作关系型数据库。 | | [OH_Rdb_CloseStore](#oh_rdb_closestore) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store) | 销毁[OH_Rdb_Store](_o_h___rdb___store.md)对象,并回收该对象占用的内存。 | -| [OH_Rdb_DeleteStore](#oh_rdb_deletestore) (const char \*path) | 使用指定的数据库文件配置删除数据库。 | +| [OH_Rdb_DeleteStore](#oh_rdb_deletestore) (const [OH_Rdb_Config](_o_h___rdb___config.md) \*config) | 使用指定的数据库文件配置删除数据库。 | | [OH_Rdb_Insert](#oh_rdb_insert) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, const char \*table, [OH_VBucket](_o_h___v_bucket.md) \*valuesBucket) | 向目标表中插入一行数据。 | | [OH_Rdb_Update](#oh_rdb_update) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, [OH_VBucket](_o_h___v_bucket.md) \*valuesBucket, [OH_Predicates](_o_h___predicates.md) \*predicates) | 根据指定的条件更新数据库中的数据。 | | [OH_Rdb_Delete](#oh_rdb_delete) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, [OH_Predicates](_o_h___predicates.md) \*predicates) | 根据指定的条件删除数据库中的数据。 | @@ -102,7 +105,7 @@ | [OH_Cursor::getReal](#getreal) | 函数指针,以double形式获取当前行中指定列的值。 | | [OH_Cursor::getBlob](#getblob) | 函数指针,以字节数组的形式获取当前行中指定列的值。 | | [OH_Cursor::isNull](#isnull-12) | 函数指针,检查当前行中指定列的值是否为null。 | -| [OH_Cursor::close](#close) | 函数指针,关闭结果集。 | +| [OH_Cursor::destroy](#destroy-14) | 函数指针,关闭结果集。 | | [OH_Predicates::id](#id-14) | OH_Predicates结构体的唯一标识符。 | | [OH_Predicates::equalTo](#equalto) | 函数指针,配置谓词以匹配数据字段等于指定值的字段。 | | [OH_Predicates::notEqualTo](#notequalto) | 函数指针,配置谓词以匹配数据字段不等于指定值的字段。 | @@ -127,13 +130,13 @@ | [OH_Predicates::in](#in) | 函数指针,配置谓词以匹配数据字段为field且值在给定范围内的指定字段。 | | [OH_Predicates::notIn](#notin) | 函数指针,配置谓词以匹配数据字段为field且值超出给定范围内的指定字段。 | | [OH_Predicates::clear](#clear-12) | 函数指针,清空谓词。 | -| [OH_Predicates::destroyPredicates](#destroypredicates) | 销毁[OH_Predicates](_o_h___predicates.md)对象,并回收该对象占用的内存。 | +| [OH_Predicates::destroy](#destroy-24) | 销毁[OH_Predicates](_o_h___predicates.md)对象,并回收该对象占用的内存。 | | [OH_VObject::id](#id-24) | OH_VObject结构体的唯一标识符。 | | [OH_VObject::putInt64](#putint64-22) | 将int64类型的单个参数或者数组转换为[OH_VObject](_o_h___v_object.md)类型的值。 | | [OH_VObject::putDouble](#putdouble) | 将double类型的单个参数或者数组转换为[OH_VObject](_o_h___v_object.md)类型的值。 | | [OH_VObject::putText](#puttext-22) | 将char \*类型的字符数组转换为[OH_VObject](_o_h___v_object.md)类型的值。 | | [OH_VObject::putTexts](#puttexts) | 将char \*类型的字符串数组转换为[OH_VObject](_o_h___v_object.md)类型的值。 | -| [OH_VObject::destroyValueObject](#destroyvalueobject) | 销毁[OH_VObject](_o_h___v_object.md)对象,并回收该对象占用的内存。 | +| [OH_VObject::destroy](#destroy-44) | 销毁[OH_VObject](_o_h___v_object.md)对象,并回收该对象占用的内存。 | | [OH_VBucket::id](#id-34) | OH_VBucket结构体的唯一标识符。 | | [OH_VBucket::capability](#capability) | 表示结构体的存储键值对的数量 | | [OH_VBucket::putText](#puttext-12) | 将char\*值放入给定列名的[OH_VBucket](_o_h___v_bucket.md)对象中。 | @@ -142,8 +145,11 @@ | [OH_VBucket::putBlob](#putblob) | 将const uint8_t \*值放入给定列名的[OH_VBucket](_o_h___v_bucket.md)对象中。 | | [OH_VBucket::putNull](#putnull) | 将NULL值放入给定列名的[OH_VBucket](_o_h___v_bucket.md)对象中。 | | [OH_VBucket::clear](#clear-22) | 清空[OH_VBucket](_o_h___v_bucket.md)对象。 | -| [OH_VBucket::destroyValuesBucket](#destroyvaluesbucket) | 销毁[OH_VBucket](_o_h___v_bucket.md)对象,并回收该对象占用的内存。 | -| [OH_Rdb_Config::path](#path) | 数据库文件路径。 | +| [OH_VBucket::destroy](#destroy-34) | 销毁[OH_VBucket](_o_h___v_bucket.md)对象,并回收该对象占用的内存。 | +| [OH_Rdb_Config::selfSize](#selfsize) | 该结构体的大小。 | +| [OH_Rdb_Config::dataBaseDir](#databasedir) | 数据库文件路径。 | +| [OH_Rdb_Config::bundleName](#bundlename) | 应用包名。 | +| [OH_Rdb_Config::moduleName](#modulename) | 应用模块名。 | | [OH_Rdb_Config::isEncrypt](#isencrypt) | 指定数据库是否加密。 | | [OH_Rdb_Config::securityLevel](#securitylevel) | 设置数据库安全级别[OH_Rdb_SecurityLevel](#oh_rdb_securitylevel)。 | | [OH_Rdb_Store::id](#id-44) | OH_Rdb_Store结构体的唯一标识符。 | @@ -152,8 +158,18 @@ ## 类型定义说明 -### OH_Cursor +### OH_ColumnType + +``` +typedef enum OH_ColumnType OH_ColumnType +``` +**描述:** + +数据库字段类型. + + +### OH_Cursor ``` typedef struct OH_Cursor OH_Cursor @@ -166,9 +182,19 @@ typedef struct OH_Cursor OH_Cursor 提供通过查询数据库生成的数据库结果集的访问方法。 -### OH_Predicates +### OH_OrderType + +``` +typedef enum OH_OrderType OH_OrderType +``` + +**描述:** + +排序方式。 +### OH_Predicates + ``` typedef struct OH_Predicates OH_Predicates ``` @@ -180,7 +206,6 @@ typedef struct OH_Predicates OH_Predicates ### OH_Rdb_ErrCode - ``` typedef enum OH_Rdb_ErrCode OH_Rdb_ErrCode ``` @@ -190,8 +215,18 @@ typedef enum OH_Rdb_ErrCode OH_Rdb_ErrCode 表示错误码信息。 -### OH_VBucket +### OH_Rdb_SecurityLevel +``` +typedef enum OH_Rdb_SecurityLevel OH_Rdb_SecurityLevel +``` + +**描述:** + +数据库的安全级别枚举。 + + +### OH_VBucket ``` typedef struct OH_VBucket OH_VBucket @@ -204,7 +239,6 @@ typedef struct OH_VBucket OH_VBucket ### OH_VObject - ``` typedef struct OH_VObject OH_VObject ``` @@ -219,7 +253,6 @@ typedef struct OH_VObject OH_VObject ### OH_ColumnType - ``` enum OH_ColumnType ``` @@ -239,7 +272,6 @@ enum OH_ColumnType ### OH_OrderType - ``` enum OH_OrderType ``` @@ -256,7 +288,6 @@ enum OH_OrderType ### OH_Rdb_ErrCode - ``` enum OH_Rdb_ErrCode ``` @@ -323,7 +354,6 @@ enum OH_Rdb_ErrCode ### OH_Rdb_SecurityLevel - ``` enum OH_Rdb_SecurityLevel ``` @@ -345,7 +375,6 @@ enum OH_Rdb_SecurityLevel ### OH_Rdb_Backup() - ``` int OH_Rdb_Backup (OH_Rdb_Store * store, const char * databasePath ) ``` @@ -372,7 +401,6 @@ int OH_Rdb_Backup (OH_Rdb_Store * store, const char * databasePath ) ### OH_Rdb_BeginTransaction() - ``` int OH_Rdb_BeginTransaction (OH_Rdb_Store * store) ``` @@ -398,7 +426,6 @@ int OH_Rdb_BeginTransaction (OH_Rdb_Store * store) ### OH_Rdb_CloseStore() - ``` int OH_Rdb_CloseStore (OH_Rdb_Store * store) ``` @@ -424,7 +451,6 @@ int OH_Rdb_CloseStore (OH_Rdb_Store * store) ### OH_Rdb_Commit() - ``` int OH_Rdb_Commit (OH_Rdb_Store * store) ``` @@ -450,7 +476,6 @@ int OH_Rdb_Commit (OH_Rdb_Store * store) ### OH_Rdb_CreatePredicates() - ``` OH_Predicates* OH_Rdb_CreatePredicates (const char * table) ``` @@ -476,9 +501,8 @@ OH_Predicates* OH_Rdb_CreatePredicates (const char * table) ### OH_Rdb_CreateValueObject() - ``` -OH_VObject* OH_Rdb_CreateValueObject (void ) +OH_VObject* OH_Rdb_CreateValueObject (void) ``` **描述:** @@ -496,9 +520,8 @@ OH_VObject* OH_Rdb_CreateValueObject (void ) ### OH_Rdb_CreateValuesBucket() - ``` -OH_VBucket* OH_Rdb_CreateValuesBucket (void ) +OH_VBucket* OH_Rdb_CreateValuesBucket (void) ``` **描述:** @@ -516,7 +539,6 @@ OH_VBucket* OH_Rdb_CreateValuesBucket (void ) ### OH_Rdb_Delete() - ``` int OH_Rdb_Delete (OH_Rdb_Store * store, OH_Predicates * predicates ) ``` @@ -543,9 +565,8 @@ int OH_Rdb_Delete (OH_Rdb_Store * store, OH_Predicates * predicates ) ### OH_Rdb_DeleteStore() - ``` -int OH_Rdb_DeleteStore (const char * path) +int OH_Rdb_DeleteStore (const OH_Rdb_Config * config) ``` **描述:** @@ -565,7 +586,6 @@ int OH_Rdb_DeleteStore (const char * path) ### OH_Rdb_Execute() - ``` int OH_Rdb_Execute (OH_Rdb_Store * store, const char * sql ) ``` @@ -592,7 +612,6 @@ int OH_Rdb_Execute (OH_Rdb_Store * store, const char * sql ) ### OH_Rdb_ExecuteQuery() - ``` OH_Cursor* OH_Rdb_ExecuteQuery (OH_Rdb_Store * store, const char * sql ) ``` @@ -619,7 +638,6 @@ OH_Cursor* OH_Rdb_ExecuteQuery (OH_Rdb_Store * store, const char * sql ) ### OH_Rdb_GetOrOpen() - ``` OH_Rdb_Store* OH_Rdb_GetOrOpen (const OH_Rdb_Config * config, int * errCode ) ``` @@ -646,7 +664,6 @@ OH_Rdb_Store* OH_Rdb_GetOrOpen (const OH_Rdb_Config * config, int * errCode ) ### OH_Rdb_GetVersion() - ``` int OH_Rdb_GetVersion (OH_Rdb_Store * store, int * version ) ``` @@ -673,7 +690,6 @@ int OH_Rdb_GetVersion (OH_Rdb_Store * store, int * version ) ### OH_Rdb_Insert() - ``` int OH_Rdb_Insert (OH_Rdb_Store * store, const char * table, OH_VBucket * valuesBucket ) ``` @@ -701,7 +717,6 @@ int OH_Rdb_Insert (OH_Rdb_Store * store, const char * table, OH_VBucket * values ### OH_Rdb_Query() - ``` OH_Cursor* OH_Rdb_Query (OH_Rdb_Store * store, OH_Predicates * predicates, const char *const * columnNames, int length ) ``` @@ -730,7 +745,6 @@ OH_Cursor* OH_Rdb_Query (OH_Rdb_Store * store, OH_Predicates * predicates, const ### OH_Rdb_Restore() - ``` int OH_Rdb_Restore (OH_Rdb_Store * store, const char * databasePath ) ``` @@ -757,7 +771,6 @@ int OH_Rdb_Restore (OH_Rdb_Store * store, const char * databasePath ) ### OH_Rdb_RollBack() - ``` int OH_Rdb_RollBack (OH_Rdb_Store * store) ``` @@ -783,7 +796,6 @@ int OH_Rdb_RollBack (OH_Rdb_Store * store) ### OH_Rdb_SetVersion() - ``` int OH_Rdb_SetVersion (OH_Rdb_Store * store, int version ) ``` @@ -810,7 +822,6 @@ int OH_Rdb_SetVersion (OH_Rdb_Store * store, int version ) ### OH_Rdb_Update() - ``` int OH_Rdb_Update (OH_Rdb_Store * store, OH_VBucket * valuesBucket, OH_Predicates * predicates ) ``` @@ -841,7 +852,6 @@ int OH_Rdb_Update (OH_Rdb_Store * store, OH_VBucket * valuesBucket, OH_Predicate ### andOperate - ``` OH_Predicates*(* OH_Predicates::andOperate) (OH_Predicates *predicates) ``` @@ -869,7 +879,6 @@ OH_Predicates*(* OH_Predicates::andOperate) (OH_Predicates *predicates) ### beginWrap - ``` OH_Predicates*(* OH_Predicates::beginWrap) (OH_Predicates *predicates) ``` @@ -897,7 +906,6 @@ OH_Predicates*(* OH_Predicates::beginWrap) (OH_Predicates *predicates) ### between - ``` OH_Predicates*(* OH_Predicates::between) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -925,8 +933,18 @@ OH_Predicates*(* OH_Predicates::between) (OH_Predicates *predicates, const char [OH_Predicates](_o_h___predicates.md), [OH_VObject](_o_h___v_object.md). -### capability +### bundleName +``` +const char* OH_Rdb_Config::bundleName +``` + +**描述:** + +应用包名。 + + +### capability ``` uint16_t OH_VBucket::capability @@ -939,7 +957,6 @@ uint16_t OH_VBucket::capability ### clear [1/2] - ``` OH_Predicates*(* OH_Predicates::clear) (OH_Predicates *predicates) ``` @@ -965,7 +982,6 @@ OH_Predicates*(* OH_Predicates::clear) (OH_Predicates *predicates) ### clear [2/2] - ``` int(* OH_VBucket::clear) (OH_VBucket *bucket) ``` @@ -989,11 +1005,21 @@ int(* OH_VBucket::clear) (OH_VBucket *bucket) [OH_VBucket](_o_h___v_bucket.md). -### close +### dataBaseDir + +``` +const char* OH_Rdb_Config::dataBaseDir +``` + +**描述:** + +数据库文件路径。 + +### destroy [1/4] ``` -int(* OH_Cursor::close) (OH_Cursor *cursor) +int(* OH_Cursor::destroy) (OH_Cursor *cursor) ``` **描述:** @@ -1015,11 +1041,10 @@ int(* OH_Cursor::close) (OH_Cursor *cursor) [OH_Cursor](_o_h___cursor.md). -### destroyPredicates - +### destroy [2/4] ``` -int(* OH_Predicates::destroyPredicates) (OH_Predicates *predicates) +int(* OH_Predicates::destroy) (OH_Predicates *predicates) ``` **描述:** @@ -1041,22 +1066,21 @@ int(* OH_Predicates::destroyPredicates) (OH_Predicates *predicates) [OH_Predicates](_o_h___predicates.md). -### destroyValueObject - +### destroy [3/4] ``` -int(* OH_VObject::destroyValueObject) (OH_VObject *valueObject) +int(* OH_VBucket::destroy) (OH_VBucket *bucket) ``` **描述:** -销毁[OH_VObject](_o_h___v_object.md)对象,并回收该对象占用的内存。 +销毁[OH_VBucket](_o_h___v_bucket.md)对象,并回收该对象占用的内存。 **参数:** | 名称 | 描述 | | -------- | -------- | -| valueObject | 表示指向[OH_VObject](_o_h___v_object.md)实例的指针。 | +| bucket | 表示指向[OH_VBucket](_o_h___v_bucket.md)实例的指针。 | **返回:** @@ -1064,25 +1088,24 @@ int(* OH_VObject::destroyValueObject) (OH_VObject *valueObject) **参见:** -[OH_VObject](_o_h___v_object.md). - +[OH_VBucket](_o_h___v_bucket.md). -### destroyValuesBucket +### destroy [4/4] ``` -int(* OH_VBucket::destroyValuesBucket) (OH_VBucket *bucket) +int(* OH_VObject::destroy) (OH_VObject *valueObject) ``` **描述:** -销毁[OH_VBucket](_o_h___v_bucket.md)对象,并回收该对象占用的内存。 +销毁[OH_VObject](_o_h___v_object.md)对象,并回收该对象占用的内存。 **参数:** | 名称 | 描述 | | -------- | -------- | -| bucket | 表示指向[OH_VBucket](_o_h___v_bucket.md)实例的指针。 | +| valueObject | 表示指向[OH_VObject](_o_h___v_object.md)实例的指针。 | **返回:** @@ -1090,12 +1113,11 @@ int(* OH_VBucket::destroyValuesBucket) (OH_VBucket *bucket) **参见:** -[OH_VBucket](_o_h___v_bucket.md). +[OH_VObject](_o_h___v_object.md). ### distinct - ``` OH_Predicates*(* OH_Predicates::distinct) (OH_Predicates *predicates) ``` @@ -1123,7 +1145,6 @@ OH_Predicates*(* OH_Predicates::distinct) (OH_Predicates *predicates) ### endWrap - ``` OH_Predicates*(* OH_Predicates::endWrap) (OH_Predicates *predicates) ``` @@ -1151,7 +1172,6 @@ OH_Predicates*(* OH_Predicates::endWrap) (OH_Predicates *predicates) ### equalTo - ``` OH_Predicates*(* OH_Predicates::equalTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1181,7 +1201,6 @@ OH_Predicates*(* OH_Predicates::equalTo) (OH_Predicates *predicates, const char ### getBlob - ``` int(* OH_Cursor::getBlob) (OH_Cursor *cursor, int32_t columnIndex, unsigned char *value, int length) ``` @@ -1210,7 +1229,6 @@ int(* OH_Cursor::getBlob) (OH_Cursor *cursor, int32_t columnIndex, unsigned char ### getColumnCount - ``` int(* OH_Cursor::getColumnCount) (OH_Cursor *cursor, int *count) ``` @@ -1237,7 +1255,6 @@ int(* OH_Cursor::getColumnCount) (OH_Cursor *cursor, int *count) ### getColumnIndex - ``` int(* OH_Cursor::getColumnIndex) (OH_Cursor *cursor, const char *name, int *columnIndex) ``` @@ -1265,7 +1282,6 @@ int(* OH_Cursor::getColumnIndex) (OH_Cursor *cursor, const char *name, int *colu ### getColumnName - ``` int(* OH_Cursor::getColumnName) (OH_Cursor *cursor, int32_t columnIndex, char *name, int length) ``` @@ -1294,7 +1310,6 @@ int(* OH_Cursor::getColumnName) (OH_Cursor *cursor, int32_t columnIndex, char *n ### getColumnType - ``` int(* OH_Cursor::getColumnType) (OH_Cursor *cursor, int32_t columnIndex, OH_ColumnType *columnType) ``` @@ -1322,7 +1337,6 @@ int(* OH_Cursor::getColumnType) (OH_Cursor *cursor, int32_t columnIndex, OH_Colu ### getInt64 - ``` int(* OH_Cursor::getInt64) (OH_Cursor *cursor, int32_t columnIndex, int64_t *value) ``` @@ -1350,7 +1364,6 @@ int(* OH_Cursor::getInt64) (OH_Cursor *cursor, int32_t columnIndex, int64_t *val ### getReal - ``` int(* OH_Cursor::getReal) (OH_Cursor *cursor, int32_t columnIndex, double *value) ``` @@ -1378,7 +1391,6 @@ int(* OH_Cursor::getReal) (OH_Cursor *cursor, int32_t columnIndex, double *value ### getRowCount - ``` int(* OH_Cursor::getRowCount) (OH_Cursor *cursor, int *count) ``` @@ -1405,7 +1417,6 @@ int(* OH_Cursor::getRowCount) (OH_Cursor *cursor, int *count) ### getSize - ``` int(* OH_Cursor::getSize) (OH_Cursor *cursor, int32_t columnIndex, size_t *size) ``` @@ -1433,7 +1444,6 @@ int(* OH_Cursor::getSize) (OH_Cursor *cursor, int32_t columnIndex, size_t *size) ### getText - ``` int(* OH_Cursor::getText) (OH_Cursor *cursor, int32_t columnIndex, char *value, int length) ``` @@ -1462,7 +1472,6 @@ int(* OH_Cursor::getText) (OH_Cursor *cursor, int32_t columnIndex, char *value, ### goToNextRow - ``` int(* OH_Cursor::goToNextRow) (OH_Cursor *cursor) ``` @@ -1488,7 +1497,6 @@ int(* OH_Cursor::goToNextRow) (OH_Cursor *cursor) ### greaterThan - ``` OH_Predicates*(* OH_Predicates::greaterThan) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1518,7 +1526,6 @@ OH_Predicates*(* OH_Predicates::greaterThan) (OH_Predicates *predicates, const c ### greaterThanOrEqualTo - ``` OH_Predicates*(* OH_Predicates::greaterThanOrEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1548,7 +1555,6 @@ OH_Predicates*(* OH_Predicates::greaterThanOrEqualTo) (OH_Predicates *predicates ### groupBy - ``` OH_Predicates*(* OH_Predicates::groupBy) (OH_Predicates *predicates, char const *const *fields, int length) ``` @@ -1578,7 +1584,6 @@ OH_Predicates*(* OH_Predicates::groupBy) (OH_Predicates *predicates, char const ### id [1/4] - ``` int64_t OH_Predicates::id ``` @@ -1590,7 +1595,6 @@ OH_Predicates结构体的唯一标识符。 ### id [2/4] - ``` int64_t OH_VObject::id ``` @@ -1602,7 +1606,6 @@ OH_VObject结构体的唯一标识符。 ### id [3/4] - ``` int64_t OH_VBucket::id ``` @@ -1614,7 +1617,6 @@ OH_VBucket结构体的唯一标识符。 ### id [4/4] - ``` int64_t OH_Rdb_Store::id ``` @@ -1626,7 +1628,6 @@ OH_Rdb_Store结构体的唯一标识符。 ### in - ``` OH_Predicates*(* OH_Predicates::in) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1656,7 +1657,6 @@ OH_Predicates*(* OH_Predicates::in) (OH_Predicates *predicates, const char *fiel ### isEncrypt - ``` bool OH_Rdb_Config::isEncrypt ``` @@ -1668,7 +1668,6 @@ bool OH_Rdb_Config::isEncrypt ### isNotNull - ``` OH_Predicates*(* OH_Predicates::isNotNull) (OH_Predicates *predicates, const char *field) ``` @@ -1697,7 +1696,6 @@ OH_Predicates*(* OH_Predicates::isNotNull) (OH_Predicates *predicates, const cha ### isNull [1/2] - ``` int(* OH_Cursor::isNull) (OH_Cursor *cursor, int32_t columnIndex, bool *isNull) ``` @@ -1725,7 +1723,6 @@ int(* OH_Cursor::isNull) (OH_Cursor *cursor, int32_t columnIndex, bool *isNull) ### isNull [2/2] - ``` OH_Predicates*(* OH_Predicates::isNull) (OH_Predicates *predicates, const char *field) ``` @@ -1754,7 +1751,6 @@ OH_Predicates*(* OH_Predicates::isNull) (OH_Predicates *predicates, const char * ### lessThan - ``` OH_Predicates*(* OH_Predicates::lessThan) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1784,7 +1780,6 @@ OH_Predicates*(* OH_Predicates::lessThan) (OH_Predicates *predicates, const char ### lessThanOrEqualTo - ``` OH_Predicates*(* OH_Predicates::lessThanOrEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1814,7 +1809,6 @@ OH_Predicates*(* OH_Predicates::lessThanOrEqualTo) (OH_Predicates *predicates, c ### like - ``` OH_Predicates*(* OH_Predicates::like) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1844,7 +1838,6 @@ OH_Predicates*(* OH_Predicates::like) (OH_Predicates *predicates, const char *fi ### limit - ``` OH_Predicates*(* OH_Predicates::limit) (OH_Predicates *predicates, unsigned int value) ``` @@ -1871,9 +1864,19 @@ OH_Predicates*(* OH_Predicates::limit) (OH_Predicates *predicates, unsigned int [OH_Predicates](_o_h___predicates.md). -### notBetween +### moduleName + +``` +const char* OH_Rdb_Config::moduleName +``` + +**描述:** + +应用模块名。 +### notBetween + ``` OH_Predicates*(* OH_Predicates::notBetween) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1903,7 +1906,6 @@ OH_Predicates*(* OH_Predicates::notBetween) (OH_Predicates *predicates, const ch ### notEqualTo - ``` OH_Predicates*(* OH_Predicates::notEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1933,7 +1935,6 @@ OH_Predicates*(* OH_Predicates::notEqualTo) (OH_Predicates *predicates, const ch ### notIn - ``` OH_Predicates*(* OH_Predicates::notIn) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject) ``` @@ -1963,7 +1964,6 @@ OH_Predicates*(* OH_Predicates::notIn) (OH_Predicates *predicates, const char *f ### offset - ``` OH_Predicates*(* OH_Predicates::offset) (OH_Predicates *predicates, unsigned int rowOffset) ``` @@ -1992,7 +1992,6 @@ OH_Predicates*(* OH_Predicates::offset) (OH_Predicates *predicates, unsigned int ### orderBy - ``` OH_Predicates*(* OH_Predicates::orderBy) (OH_Predicates *predicates, const char *field, OH_OrderType type) ``` @@ -2022,7 +2021,6 @@ OH_Predicates*(* OH_Predicates::orderBy) (OH_Predicates *predicates, const char ### orOperate - ``` OH_Predicates*(* OH_Predicates::orOperate) (OH_Predicates *predicates) ``` @@ -2048,21 +2046,8 @@ OH_Predicates*(* OH_Predicates::orOperate) (OH_Predicates *predicates) [OH_Predicates](_o_h___predicates.md). -### path - - -``` -const char* OH_Rdb_Config::path -``` - -**描述:** - -数据库文件路径。 - - ### putBlob - ``` int(* OH_VBucket::putBlob) (OH_VBucket *bucket, const char *field, const uint8_t *value, uint32_t size) ``` @@ -2091,7 +2076,6 @@ int(* OH_VBucket::putBlob) (OH_VBucket *bucket, const char *field, const uint8_t ### putDouble - ``` int(* OH_VObject::putDouble) (OH_VObject *valueObject, double *value, uint32_t count) ``` @@ -2119,7 +2103,6 @@ int(* OH_VObject::putDouble) (OH_VObject *valueObject, double *value, uint32_t c ### putInt64 [1/2] - ``` int(* OH_VBucket::putInt64) (OH_VBucket *bucket, const char *field, int64_t value) ``` @@ -2147,7 +2130,6 @@ int(* OH_VBucket::putInt64) (OH_VBucket *bucket, const char *field, int64_t valu ### putInt64 [2/2] - ``` int(* OH_VObject::putInt64) (OH_VObject *valueObject, int64_t *value, uint32_t count) ``` @@ -2175,7 +2157,6 @@ int(* OH_VObject::putInt64) (OH_VObject *valueObject, int64_t *value, uint32_t c ### putNull - ``` int(* OH_VBucket::putNull) (OH_VBucket *bucket, const char *field) ``` @@ -2202,14 +2183,13 @@ int(* OH_VBucket::putNull) (OH_VBucket *bucket, const char *field) ### putReal - ``` int(* OH_VBucket::putReal) (OH_VBucket *bucket, const char *field, double value) ``` **描述:** -将double值放入给定列名的{**OH_VBucket}对象中。** +将double值放入给定列名的[OH_VBucket](_o_h___v_bucket.md)对象中。 **参数:** @@ -2230,7 +2210,6 @@ int(* OH_VBucket::putReal) (OH_VBucket *bucket, const char *field, double value) ### putText [1/2] - ``` int(* OH_VBucket::putText) (OH_VBucket *bucket, const char *field, const char *value) ``` @@ -2258,7 +2237,6 @@ int(* OH_VBucket::putText) (OH_VBucket *bucket, const char *field, const char *v ### putText [2/2] - ``` int(* OH_VObject::putText) (OH_VObject *valueObject, const char *value) ``` @@ -2285,7 +2263,6 @@ int(* OH_VObject::putText) (OH_VObject *valueObject, const char *value) ### putTexts - ``` int(* OH_VObject::putTexts) (OH_VObject *valueObject, const char **value, uint32_t count) ``` @@ -2313,11 +2290,21 @@ int(* OH_VObject::putTexts) (OH_VObject *valueObject, const char **value, uint32 ### securityLevel - ``` -enum OH_Rdb_SecurityLevel OH_Rdb_Config::securityLevel +int OH_Rdb_Config::securityLevel ``` **描述:** 设置数据库安全级别[OH_Rdb_SecurityLevel](#oh_rdb_securitylevel)。 + + +### selfSize + +``` +int OH_Rdb_Config::selfSize +``` + +**描述:** + +该结构体的大小。 diff --git a/zh-cn/application-dev/reference/native-apis/oh__cursor_8h.md b/zh-cn/application-dev/reference/native-apis/oh__cursor_8h.md index a26b98ca89b090de9683dec7cd566211193bb60e..0113d44ad78f81d64b299775f2c169a626351f33 100644 --- a/zh-cn/application-dev/reference/native-apis/oh__cursor_8h.md +++ b/zh-cn/application-dev/reference/native-apis/oh__cursor_8h.md @@ -30,6 +30,7 @@ | 名称 | 描述 | | -------- | -------- | +| [OH_ColumnType](_r_d_b.md#oh_columntype) | 数据库字段类型. | | [OH_Cursor](_r_d_b.md#oh_cursor) | 表示结果集。 | @@ -37,4 +38,4 @@ | 名称 | 描述 | | -------- | -------- | -| [OH_ColumnType](_r_d_b.md#oh_columntype) {
TYPE_NULL = 0, TYPE_INT64, TYPE_REAL, TYPE_TEXT,
TYPE_BLOB
} | 数据库字段类型. | +| [OH_ColumnType](_r_d_b.md#oh_columntype) {
TYPE_NULL = 0, TYPE_INT64, TYPE_REAL, TYPE_TEXT,
TYPE_BLOB
} | 数据库字段类型. | diff --git a/zh-cn/application-dev/reference/native-apis/oh__predicates_8h.md b/zh-cn/application-dev/reference/native-apis/oh__predicates_8h.md index c59b86d0fbf3b107ec7a65f13b6b3112030c8668..d1b8698d6f181474424e4ec1aa24076f3a9983a4 100644 --- a/zh-cn/application-dev/reference/native-apis/oh__predicates_8h.md +++ b/zh-cn/application-dev/reference/native-apis/oh__predicates_8h.md @@ -28,6 +28,7 @@ | 名称 | 描述 | | -------- | -------- | +| [OH_OrderType](_r_d_b.md#oh_ordertype) | 排序方式。 | | [OH_Predicates](_r_d_b.md#oh_predicates) | 表示谓词。 | @@ -35,4 +36,4 @@ | 名称 | 描述 | | -------- | -------- | -| [OH_OrderType](_r_d_b.md#oh_ordertype) { ASC = 0, DESC = 1 } | 排序方式。 | +| [OH_OrderType](_r_d_b.md#oh_ordertype) { ASC = 0, DESC = 1 } | 排序方式。 | diff --git a/zh-cn/application-dev/reference/native-apis/relational__store_8h.md b/zh-cn/application-dev/reference/native-apis/relational__store_8h.md index 5a435168e72b1f0c20f7009f5e0b0915771f5108..9d19fe056a4e8021e00c0e75d4690c76d244eb70 100644 --- a/zh-cn/application-dev/reference/native-apis/relational__store_8h.md +++ b/zh-cn/application-dev/reference/native-apis/relational__store_8h.md @@ -9,7 +9,7 @@ 10 -**相关模块:** +**相关模块:** [RDB](_r_d_b.md) @@ -25,6 +25,13 @@ | [OH_Rdb_Store](_o_h___rdb___store.md) | 表示数据库类型。 | +### 类型定义 + +| 名称 | 描述 | +| -------- | -------- | +| [OH_Rdb_SecurityLevel](_r_d_b.md#oh_rdb_securitylevel) | 数据库的安全级别枚举。 | + + ### 枚举 | 名称 | 描述 | @@ -41,7 +48,7 @@ | [OH_Rdb_CreatePredicates](_r_d_b.md#oh_rdb_createpredicates) (const char \*table) | 创建[OH_Predicates](_o_h___predicates.md)实例。 | | [OH_Rdb_GetOrOpen](_r_d_b.md#oh_rdb_getoropen) (const [OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | 获得一个相关的[OH_Rdb_Store](_o_h___rdb___store.md)实例,操作关系型数据库。 | | [OH_Rdb_CloseStore](_r_d_b.md#oh_rdb_closestore) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store) | 销毁[OH_Rdb_Store](_o_h___rdb___store.md)对象,并回收该对象占用的内存。 | -| [OH_Rdb_DeleteStore](_r_d_b.md#oh_rdb_deletestore) (const char \*path) | 使用指定的数据库文件配置删除数据库。 | +| [OH_Rdb_DeleteStore](_r_d_b.md#oh_rdb_deletestore) (const [OH_Rdb_Config](_o_h___rdb___config.md) \*config) | 使用指定的数据库文件配置删除数据库。 | | [OH_Rdb_Insert](_r_d_b.md#oh_rdb_insert) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, const char \*table, [OH_VBucket](_o_h___v_bucket.md) \*valuesBucket) | 向目标表中插入一行数据。 | | [OH_Rdb_Update](_r_d_b.md#oh_rdb_update) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, [OH_VBucket](_o_h___v_bucket.md) \*valuesBucket, [OH_Predicates](_o_h___predicates.md) \*predicates) | 根据指定的条件更新数据库中的数据。 | | [OH_Rdb_Delete](_r_d_b.md#oh_rdb_delete) ([OH_Rdb_Store](_o_h___rdb___store.md) \*store, [OH_Predicates](_o_h___predicates.md) \*predicates) | 根据指定的条件删除数据库中的数据。 |