@@ -36,4 +36,4 @@ It provides APIs to access the result set obtained by querying the RDB store.
...
@@ -36,4 +36,4 @@ It provides APIs to access the result set obtained by querying the RDB store.
| [getReal](_r_d_b.md#getreal) | Pointer to the function used to obtain the value of the double type based on the specified column and the current row.|
| [getReal](_r_d_b.md#getreal) | Pointer to the function used to obtain the value of the double type based on the specified column and the current row.|
| [getBlob](_r_d_b.md#getblob) | Pointer to the function used to obtain the value in the form of a byte array based on the specified column and the current row.|
| [getBlob](_r_d_b.md#getblob) | Pointer to the function used to obtain the value in the form of a byte array based on the specified column and the current row.|
| [isNull](_r_d_b.md#isnull-12) | Pointer to the function used to check whether the value in the specified column is null.|
| [isNull](_r_d_b.md#isnull-12) | Pointer to the function used to check whether the value in the specified column is null.|
| [close](_r_d_b.md#close) | Pointer to the function used to close a result set.|
| [destroy](_r_d_b.md#destroy-14) | Pointer to the function used to close a result set.|
The relational database (RDB) store manages data based on relational models. The RDB store provides a complete mechanism for managing local databases based on the underlying SQLite. It provides a series of methods for performing operations, such as adding, deleting, modifying, and querying data, and supports direct execution of SQL statements to satisfy different needs in complicated scenarios.
The relational database (RDB) store manages data based on relational models. The RDB store provides a complete mechanism for managing local databases based on the underlying SQLite. It provides a series of methods for performing operations, such as adding, deleting, modifying, and querying data, and supports direct execution of SQL statements to satisfy different needs in complicated scenarios.
@@ -19,11 +19,11 @@ The relational database (RDB) store manages data based on relational models. The
...
@@ -19,11 +19,11 @@ The relational database (RDB) store manages data based on relational models. The
| Name| Description|
| Name| Description|
| -------- | -------- |
| -------- | -------- |
| [oh_cursor.h](oh__cursor_8h.md) | Provides APIs to access the result set obtained by querying the RDB store.<br>File to include: \<database/rdb/oh_cursor.h>|
| [oh_cursor.h](oh__cursor_8h.md) | Defines the APIs for accessing the result set obtained by querying the RDB store.<br>File to include: \<database/rdb/oh_cursor.h> |
| [oh_predicates.h](oh__predicates_8h.md) | Defines the predicates for RDB stores.<br>File to include: \<database/rdb/oh_predicates.h>|
| [oh_predicates.h](oh__predicates_8h.md) | Defines the predicates for RDB stores.<br>File to include: \<database/rdb/oh_predicates.h>|
| [oh_value_object.h](oh__value__object_8h.md) | Provides type conversion methods.<br>File to include: \<database/rdb/oh_value_object.h>|
| [oh_value_object.h](oh__value__object_8h.md) | Defines type conversion methods.<br>File to include: \<database/rdb/oh_value_object.h> |
| [oh_values_bucket.h](oh__values__bucket_8h.md) | Defines the types of the key and value in a key-value (KV) pair.<br>File to include: \<database/rdb/oh_values_bucket.h>|
| [oh_values_bucket.h](oh__values__bucket_8h.md) | Defines the types of the key and value in a key-value (KV) pair.<br>File to include: \<database/rdb/oh_values_bucket.h>|
| [relational_store.h](relational__store_8h.md) | Provides APIs to manage an RDB store.<br>File to include: \<database/rdb/relational_store.h>|
| [relational_store.h](relational__store_8h.md) | Defines the APIs for managing an RDB store.<br>File to include: \<database/rdb/relational_store.h> |
| [relational_store_error_code.h](relational__store__error__code_8h.md) | Declares the error codes used for RDB stores.<br>File to include: \<database/rdb/relational_error_code.h>|
| [relational_store_error_code.h](relational__store__error__code_8h.md) | Declares the error codes used for RDB stores.<br>File to include: \<database/rdb/relational_error_code.h>|
...
@@ -43,10 +43,13 @@ The relational database (RDB) store manages data based on relational models. The
...
@@ -43,10 +43,13 @@ The relational database (RDB) store manages data based on relational models. The
| Name| Description|
| Name| Description|
| -------- | -------- |
| -------- | -------- |
| [OH_ColumnType](#oh_columntype) | Enumerates the field types in an RDB store.|
| [OH_Cursor](#oh_cursor) | Indicates a result set.|
| [OH_Cursor](#oh_cursor) | Indicates a result set.|
| [OH_OrderType](#oh_ordertype) | Enumerates the sorting types.|
| [OH_Predicates](#oh_predicates) | Indicates a **predicates** object.|
| [OH_Predicates](#oh_predicates) | Indicates a **predicates** object.|
| [OH_VObject](#oh_vobject) | Indicates the allowed data field types.|
| [OH_VObject](#oh_vobject) | Indicates the allowed data field types.|
| [OH_VBucket](#oh_vbucket) | Indicates the types of the key and value in a KV pair.|
| [OH_VBucket](#oh_vbucket) | Indicates the types of the key and value in a KV pair.|
| [OH_Rdb_SecurityLevel](#oh_rdb_securitylevel) | Enumerates the RDB store security levels.|
@@ -69,7 +72,7 @@ The relational database (RDB) store manages data based on relational models. The
...
@@ -69,7 +72,7 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_Rdb_CreatePredicates](#oh_rdb_createpredicates)(const char \*table) | Creates an [OH_Predicates](_o_h___predicates.md) instance.|
| [OH_Rdb_CreatePredicates](#oh_rdb_createpredicates)(const char \*table) | Creates an [OH_Predicates](_o_h___predicates.md) instance.|
| [OH_Rdb_GetOrOpen](#oh_rdb_getoropen)(const[OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | Obtains an [OH_Rdb_Store](_o_h___rdb___store.md) instance for RDB store operations.|
| [OH_Rdb_GetOrOpen](#oh_rdb_getoropen)(const[OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | Obtains an [OH_Rdb_Store](_o_h___rdb___store.md) instance for RDB store operations.|
| [OH_Rdb_CloseStore](#oh_rdb_closestore)([OH_Rdb_Store](_o_h___rdb___store.md)\*store) | Destroys an [OH_Rdb_Store](_o_h___rdb___store.md) object and reclaims the memory occupied by the object.|
| [OH_Rdb_CloseStore](#oh_rdb_closestore)([OH_Rdb_Store](_o_h___rdb___store.md)\*store) | Destroys an [OH_Rdb_Store](_o_h___rdb___store.md) object and reclaims the memory occupied by the object.|
| [OH_Rdb_DeleteStore](#oh_rdb_deletestore)(constchar \*path) | Deletes an RDB store with the specified database file configuration.|
| [OH_Rdb_DeleteStore](#oh_rdb_deletestore)(const[OH_Rdb_Config](_o_h___rdb___config.md) \*config) | Deletes an RDB store with the specified database file configuration.|
| [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) | Inserts a row of data into a table.|
| [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) | Inserts a row of data into a table.|
| [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) | Updates data in an RDB store based on specified conditions.|
| [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) | Updates data in an RDB store based on specified conditions.|
| [OH_Rdb_Delete](#oh_rdb_delete)([OH_Rdb_Store](_o_h___rdb___store.md)\*store, [OH_Predicates](_o_h___predicates.md)\*predicates) | Deletes data from an RDB store based on specified conditions.|
| [OH_Rdb_Delete](#oh_rdb_delete)([OH_Rdb_Store](_o_h___rdb___store.md)\*store, [OH_Predicates](_o_h___predicates.md)\*predicates) | Deletes data from an RDB store based on specified conditions.|
...
@@ -102,7 +105,7 @@ The relational database (RDB) store manages data based on relational models. The
...
@@ -102,7 +105,7 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_Cursor::getReal](#getreal) | Pointer to the function used to obtain the value of the double type based on the specified column and the current row.|
| [OH_Cursor::getReal](#getreal) | Pointer to the function used to obtain the value of the double type based on the specified column and the current row.|
| [OH_Cursor::getBlob](#getblob) | Pointer to the function used to obtain the value in the form of a byte array based on the specified column and the current row.|
| [OH_Cursor::getBlob](#getblob) | Pointer to the function used to obtain the value in the form of a byte array based on the specified column and the current row.|
| [OH_Cursor::isNull](#isnull-12) | Pointer to the function used to check whether the value in the specified column is null.|
| [OH_Cursor::isNull](#isnull-12) | Pointer to the function used to check whether the value in the specified column is null.|
| [OH_Cursor::close](#close) | Pointer to the function used to close a result set. |
| [OH_Cursor::destroy](#destroy-14) | Pointer to the function used to close the result set.|
| [OH_Predicates::id](#id-14) | Unique identifier of the **OH_Predicates** struct.|
| [OH_Predicates::id](#id-14) | Unique identifier of the **OH_Predicates** struct.|
| [OH_Predicates::equalTo](#equalto) | Pointer to the function used to set a predicates object to match the field whose value is equal to the specified value.|
| [OH_Predicates::equalTo](#equalto) | Pointer to the function used to set a predicates object to match the field whose value is equal to the specified value.|
| [OH_Predicates::notEqualTo](#notequalto) | Pointer to the function used to set a predicates object to match the field whose value is not equal to the specified value.|
| [OH_Predicates::notEqualTo](#notequalto) | Pointer to the function used to set a predicates object to match the field whose value is not equal to the specified value.|
...
@@ -127,13 +130,13 @@ The relational database (RDB) store manages data based on relational models. The
...
@@ -127,13 +130,13 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_Predicates::in](#in) | Pointer to the function used to set a predicates object to match the field with the value within the specified range.|
| [OH_Predicates::in](#in) | Pointer to the function used to set a predicates object to match the field with the value within the specified range.|
| [OH_Predicates::notIn](#notin) | Pointer to the function used to set a predicates object to match the field with the value out of the specified range.|
| [OH_Predicates::notIn](#notin) | Pointer to the function used to set a predicates object to match the field with the value out of the specified range.|
| [OH_Predicates::clear](#clear-12) | Pointer to the function used to clear a predicates instance.|
| [OH_Predicates::clear](#clear-12) | Pointer to the function used to clear a predicates instance.|
| [OH_Predicates::destroyPredicates](#destroypredicates) | Destroys an [OH_Predicates](_o_h___predicates.md) object and reclaims the memory occupied.|
| [OH_Predicates::destroy](#destroy-24) | Destroys an [OH_Predicates](_o_h___predicates.md) object and reclaims the memory occupied.|
| [OH_VObject::id](#id-24) | Unique identifier of the **OH_VObject** struct.|
| [OH_VObject::id](#id-24) | Unique identifier of the **OH_VObject** struct.|
| [OH_VObject::putInt64](#putint64-22) | Converts a single parameter or an array of the int64 type into a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putInt64](#putint64-22) | Converts a single parameter or an array of the int64 type into a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putDouble](#putdouble) | Converts a single parameter or an array of the double type into a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putDouble](#putdouble) | Converts a single parameter or an array of the double type into a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putText](#puttext-22) | Converts a character array of the char type to a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putText](#puttext-22) | Converts a character array of the char type to a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putTexts](#puttexts) | Converts a string array of the char type to a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::putTexts](#puttexts) | Converts a string array of the char type to a value of the [OH_VObject](_o_h___v_object.md) type.|
| [OH_VObject::destroyValueObject](#destroyvalueobject) | Destroys an [OH_VObject](_o_h___v_object.md) object and reclaims the memory occupied.|
| [OH_VObject::destroy](#destroy-44) | Destroys an [OH_VObject](_o_h___v_object.md) object and reclaims the memory occupied.|
| [OH_VBucket::id](#id-34) | Unique identifier of the **OH_VBucket** struct.|
| [OH_VBucket::id](#id-34) | Unique identifier of the **OH_VBucket** struct.|
| [OH_VBucket::capability](#capability) | Number of the KV pairs in the struct.|
| [OH_VBucket::capability](#capability) | Number of the KV pairs in the struct.|
| [OH_VBucket::putText](#puttext-12) | Puts a char value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::putText](#puttext-12) | Puts a char value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
...
@@ -142,18 +145,31 @@ The relational database (RDB) store manages data based on relational models. The
...
@@ -142,18 +145,31 @@ The relational database (RDB) store manages data based on relational models. The
| [OH_VBucket::putBlob](#putblob) | Puts a const uint8_t value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::putBlob](#putblob) | Puts a const uint8_t value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::putNull](#putnull) | Puts a null value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::putNull](#putnull) | Puts a null value into the [OH_VBucket](_o_h___v_bucket.md) object in the given column.|
| [OH_VBucket::clear](#clear-22) | Clears an [OH_VBucket](_o_h___v_bucket.md) object.|
| [OH_VBucket::clear](#clear-22) | Clears an [OH_VBucket](_o_h___v_bucket.md) object.|
| [OH_VBucket::destroyValuesBucket](#destroyvaluesbucket) | Destroys an [OH_VBucket](_o_h___v_bucket.md) object and reclaims the memory occupied.|
| [OH_VBucket::destroy](#destroy-34) | Destroys an [OH_VBucket](_o_h___v_bucket.md) object and reclaims the memory occupied.|
| [OH_Rdb_Config::path](#path) | Path of the database file.|
| [OH_Rdb_Config::selfSize](#selfsize) | Size of the struct.|
| [OH_Rdb_Config::dataBaseDir](#databasedir) | Path of the database file.|
@@ -30,6 +30,7 @@ A result set is a set of results returned by **query()**.
...
@@ -30,6 +30,7 @@ A result set is a set of results returned by **query()**.
| Name| Description|
| Name| Description|
| -------- | -------- |
| -------- | -------- |
| [OH_ColumnType](_r_d_b.md#oh_columntype) | Enumerates the field types in an RDB store.|
| [OH_Cursor](_r_d_b.md#oh_cursor) | Indicates a result set.|
| [OH_Cursor](_r_d_b.md#oh_cursor) | Indicates a result set.|
...
@@ -37,4 +38,4 @@ A result set is a set of results returned by **query()**.
...
@@ -37,4 +38,4 @@ A result set is a set of results returned by **query()**.
| Name| Description|
| Name| Description|
| -------- | -------- |
| -------- | -------- |
| [OH_ColumnType](_r_d_b.md#oh_columntype) {<br>TYPE_NULL = 0, TYPE_INT64, TYPE_REAL, TYPE_TEXT,<br>TYPE_BLOB<br>} | Enumerates the field types in an RDB store.|
| [OH_ColumnType](_r_d_b.md#oh_columntype) {<br>TYPE_NULL = 0, TYPE_INT64, TYPE_REAL, TYPE_TEXT,<br>TYPE_BLOB<br>} | Enumerates the field types in an RDB store.|
@@ -25,6 +25,13 @@ Provides APIs to manage a relational database (RDB) store.
...
@@ -25,6 +25,13 @@ Provides APIs to manage a relational database (RDB) store.
| [OH_Rdb_Store](_o_h___rdb___store.md) | Defines the RDB store type.|
| [OH_Rdb_Store](_o_h___rdb___store.md) | Defines the RDB store type.|
### Types
| Name| Description|
| -------- | -------- |
| [OH_Rdb_SecurityLevel](_r_d_b.md#oh_rdb_securitylevel) | Defines the RDB store security levels. |
### Enums
### Enums
| Name| Description|
| Name| Description|
...
@@ -41,7 +48,7 @@ Provides APIs to manage a relational database (RDB) store.
...
@@ -41,7 +48,7 @@ Provides APIs to manage a relational database (RDB) store.
| [OH_Rdb_CreatePredicates](_r_d_b.md#oh_rdb_createpredicates)(const char \*table) | Creates an [OH_Predicates](_o_h___predicates.md) instance.|
| [OH_Rdb_CreatePredicates](_r_d_b.md#oh_rdb_createpredicates)(const char \*table) | Creates an [OH_Predicates](_o_h___predicates.md) instance.|
| [OH_Rdb_GetOrOpen](_r_d_b.md#oh_rdb_getoropen)(const[OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | Obtains an [OH_Rdb_Store](_o_h___rdb___store.md) instance for RDB store operations.|
| [OH_Rdb_GetOrOpen](_r_d_b.md#oh_rdb_getoropen)(const[OH_Rdb_Config](_o_h___rdb___config.md) \*config, int \*errCode) | Obtains an [OH_Rdb_Store](_o_h___rdb___store.md) instance for RDB store operations.|
| [OH_Rdb_CloseStore](_r_d_b.md#oh_rdb_closestore)([OH_Rdb_Store](_o_h___rdb___store.md)\*store) | Destroys an [OH_Rdb_Store](_o_h___rdb___store.md) object and reclaims the memory occupied by the object.|
| [OH_Rdb_CloseStore](_r_d_b.md#oh_rdb_closestore)([OH_Rdb_Store](_o_h___rdb___store.md)\*store) | Destroys an [OH_Rdb_Store](_o_h___rdb___store.md) object and reclaims the memory occupied by the object.|
| [OH_Rdb_DeleteStore](_r_d_b.md#oh_rdb_deletestore)(constchar \*path) | Deletes an RDB store with the specified database file configuration.|
| [OH_Rdb_DeleteStore](_r_d_b.md#oh_rdb_deletestore)(const[OH_Rdb_Config](_o_h___rdb___config.md) \*config) | Deletes an RDB store with the specified database file configuration.|
| [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) | Inserts a row of data into a table.|
| [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) | Inserts a row of data into a table.|
| [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) | Updates data in an RDB store based on specified conditions.|
| [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) | Updates data in an RDB store based on specified conditions.|
| [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) | Deletes data from an RDB store based on specified conditions.|
| [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) | Deletes data from an RDB store based on specified conditions.|
