RDB

OH_Rdb_ConfigV2, OH_Rdb_Store.

Rdb_SyncMode

typedef enum Rdb_SyncMode Rdb_SyncMode

Description

Defines an enum for RDB sync modes.

Since: 11

Rdb_TableDetails

typedef struct Rdb_TableDetails Rdb_TableDetails

Description

Defines a struct for statistics of device-cloud upload and download tasks of a database table.

Since: 11

Enum Description

Rdb_DBType

enum Rdb_DBType

Description

Enumerates the database kernel types.

Since: 14

Value	Description
RDB_SQLITE	SQLite is used as the database kernel.
RDB_CAYLEY	Cayley is used as the database kernel.
DBTYPE_BUTT	Maximum value of the database kernel type, which is an invalid value.

OH_ColumnType

enum OH_ColumnType

Description

Enumerates the field types in an RDB store.

Since: 10

Value	Description
TYPE_NULL	Null.
TYPE_INT64	INT64.
TYPE_REAL	REAL.
TYPE_TEXT	TEXT.
TYPE_BLOB	BLOB.
TYPE_ASSET¹¹⁺	ASSET (asset attachment). This value is supported since API version 11.
TYPE_ASSETS¹¹⁺	ASSETS (multiple asset attachments). This value is supported since API version 11.

OH_OrderType

enum OH_OrderType

Description

Enumerates the sorting types.

Since: 10

Value	Description
ASC	Ascending order.
DESC	Descending order.

OH_Rdb_ErrCode

enum OH_Rdb_ErrCode

Description

Enumerates the error codes.

Since: 10

Value	Description
RDB_ERR	Execution failed.
RDB_OK	Execution successful.
E_BASE	Base of the error code.
RDB_E_NOT_SUPPORTED	The RDB store does not have this capability.
RDB_E_ERROR	Common exception.
RDB_E_INVALID_ARGS	Invalid parameter.
RDB_E_CANNOT_UPDATE_READONLY	Failed to update data because the RDB store is read-only.
RDB_E_REMOVE_FILE	Failed to delete the file.
RDB_E_EMPTY_TABLE_NAME	The table name is empty.
RDB_E_EMPTY_VALUES_BUCKET	The content of the KV pair is empty.
RDB_E_EXECUTE_IN_STEP_QUERY	The SQL statement executed during the query is incorrect.
RDB_E_INVALID_COLUMN_INDEX	The column index is invalid.
RDB_E_INVALID_COLUMN_TYPE	The column type is invalid.
RDB_E_EMPTY_FILE_NAME	The file name is empty.
RDB_E_INVALID_FILE_PATH	The file path is invalid.
RDB_E_TRANSACTION_IN_EXECUTE	Failed to start the transaction.
RDB_E_INVALID_STATEMENT	Failed to precompile the SQL statements.
RDB_E_EXECUTE_WRITE_IN_READ_CONNECTION	Failed to perform a write operation in a read connection.
RDB_E_BEGIN_TRANSACTION_IN_READ_CONNECTION	Failed to start the transaction in a read connection.
RDB_E_NO_TRANSACTION_IN_SESSION	The transaction to start does not exist in the database session.
RDB_E_MORE_STEP_QUERY_IN_ONE_SESSION	Multiple queries are executed in a database session.
RDB_E_NO_ROW_IN_QUERY	The result set does not contain any record.
RDB_E_INVALID_BIND_ARGS_COUNT	The number of parameters bound in the SQL statement is invalid.
RDB_E_INVALID_OBJECT_TYPE	The object type is invalid.
RDB_E_INVALID_CONFLICT_FLAG	The conflict resolution type is invalid.
RDB_E_HAVING_CLAUSE_NOT_IN_GROUP_BY	The HAVING keyword can be used only after GROUP BY.
RDB_E_NOT_SUPPORTED_BY_STEP_RESULT_SET	The result set by step is not supported.
RDB_E_STEP_RESULT_SET_CROSS_THREADS	Failed to obtain the result set.
RDB_E_STEP_RESULT_QUERY_NOT_EXECUTED	The result set query statement is not executed.
RDB_E_STEP_RESULT_IS_AFTER_LAST	The cursor of the result set is already in the last row.
RDB_E_STEP_RESULT_QUERY_EXCEEDED	The number of result set query times exceeds the limit.
RDB_E_STATEMENT_NOT_PREPARED	The SQL statement is not precompiled.
RDB_E_EXECUTE_RESULT_INCORRECT	The database execution result is incorrect.
RDB_E_STEP_RESULT_CLOSED	The result set has been closed.
RDB_E_RELATIVE_PATH	The file path is a relative path.
RDB_E_EMPTY_NEW_ENCRYPT_KEY	The new encrypt key is empty.
RDB_E_CHANGE_UNENCRYPTED_TO_ENCRYPTED	The RDB store is non-encrypted and cannot be changed.
RDB_E_CHANGE_ENCRYPT_KEY_IN_BUSY	The database does not respond when the database key is updated.
RDB_E_STEP_STATEMENT_NOT_INIT	The precompiled SQL statement is not initialized.
RDB_E_NOT_SUPPORTED_ATTACH_IN_WAL_MODE	The WAL mode does not support the ATTACH operation.
RDB_E_CREATE_FOLDER_FAIL	Failed to create the folder.
RDB_E_SQLITE_SQL_BUILDER_NORMALIZE_FAIL	Failed to build the SQL statement.
RDB_E_STORE_SESSION_NOT_GIVE_CONNECTION_TEMPORARILY	The database session does not provide a connection.
RDB_E_STORE_SESSION_NO_CURRENT_TRANSACTION	The transaction does not exist in the database session.
RDB_E_NOT_SUPPORT	The current operation is not supported.
RDB_E_INVALID_PARCEL	The current PARCEL is invalid.
RDB_E_QUERY_IN_EXECUTE	Failed to execute query.
RDB_E_SET_PERSIST_WAL	Failed to set the persistence of the database file in WAL mode.
RDB_E_DB_NOT_EXIST	The database does not exist.
RDB_E_ARGS_READ_CON_OVERLOAD	The number of read connections to set is greater than the limit.
RDB_E_WAL_SIZE_OVER_LIMIT	The WAL log file size exceeds the default value.
RDB_E_CON_OVER_LIMIT	The number of database connections has reached the limit.

OH_Rdb_SecurityLevel

enum OH_Rdb_SecurityLevel

Description

Enumerates the RDB store security levels.

Since: 10

Value	Description
S1	The security level of the RDB store is low. If data leakage occurs, minor impact will be caused.
S2	The security level of the RDB store is medium. If data leakage occurs, moderate impact will be caused.
S3	The security level of the RDB store is high. If data leakage occurs, major impact will be caused.
S4	The security level of the RDB store is critical. If data leakage occurs, critical impact will be caused.

Rdb_ChangeType

enum Rdb_ChangeType

Description

Enumerates the data change types.

Since: 11

Value	Description
RDB_DATA_CHANGE	Data change.
RDB_ASSET_CHANGE	Asset change.

Rdb_DistributedType

enum Rdb_DistributedType

Description

Enumerates the distributed types.

Since: 11

Value	Description
RDB_DISTRIBUTED_CLOUD	Distributed database tables for device-cloud sync.

Rdb_Progress

enum Rdb_Progress

Description

Enumerates the device-cloud sync progresses.

Since: 11

Value	Description
RDB_SYNC_BEGIN	The device-cloud sync starts.
RDB_SYNC_IN_PROGRESS	The device-cloud sync is in progress.
RDB_SYNC_FINISH	The device-cloud sync is finished.

Rdb_ProgressCode

enum Rdb_ProgressCode

Description

Enumerates the device-cloud sync states.

Since: 11

Value	Description
RDB_SUCCESS	The device-cloud sync is successful.
RDB_UNKNOWN_ERROR	An unknown error occurs during the device-cloud sync.
RDB_NETWORK_ERROR	A network error occurs during the device-cloud sync.
RDB_CLOUD_DISABLED	The cloud is unavailable.
RDB_LOCKED_BY_OTHERS	The device-cloud sync of another device is being performed.
RDB_RECORD_LIMIT_EXCEEDED	The number of records or size of the data to be synced exceeds the maximum. The maximum value is configured on the cloud.
RDB_NO_SPACE_FOR_ASSET	The remaining cloud space is less than the size of the data to be synced.

Rdb_SecurityArea

enum Rdb_SecurityArea

Description

Enumerates the encryption levels of an RDB store.

Since: 11

Value	Description
RDB_SECURITY_AREA_EL1	Encryption level 1.
RDB_SECURITY_AREA_EL2	Encryption level 2.
RDB_SECURITY_AREA_EL3	Encryption level 3.
RDB_SECURITY_AREA_EL4	Encryption level 4.

Rdb_SubscribeType

enum Rdb_SubscribeType

Description

Enumerates the subscription types.

Since: 11

Value	Description
RDB_SUBSCRIBE_TYPE_CLOUD	Subscription of cloud data changes.
RDB_SUBSCRIBE_TYPE_CLOUD_DETAILS	Subscription of cloud data change details.
RDB_SUBSCRIBE_TYPE_LOCAL_DETAILS¹²⁺	Subscribe to details of the local data change. This value is available since API version 12.

Rdb_SyncMode

enum Rdb_SyncMode

Description

Enumerates the RDB sync modes.

Since: 11

Value	Description
RDB_SYNC_MODE_TIME_FIRST	Synchronize with the data with the latest modification time.
RDB_SYNC_MODE_NATIVE_FIRST	Synchronize data from a local device to the cloud.
RDB_SYNC_MODE_CLOUD_FIRST	Synchronize data from the cloud to a local device.

Function Description

OH_Rdb_CreateOrOpen()

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

Description

Creates or opens an OH_Rdb_Store instance based on the given OH_Rdb_ConfigV2.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
errCode	Pointer to the execution result of this API. RDB_OK indicates the operation is successful. RDB_E_INVALID_ARGS indicates invalid parameters are specified.

Returns

Returns the pointer to the OH_Rdb_Store instance created if the operation is successful; returns null otherwise.

See

OH_Rdb_BeginTransWithTrxId()

int OH_Rdb_BeginTransWithTrxId (OH_Rdb_Store *store, int64_t *trxId )

Description

Begins a transaction and obtains the transaction ID before executing an SQL statement.

Since: 14

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
trxId	Pointer to the transaction ID obtained.

Returns

See

OH_Rdb_CommitByTrxId()

int OH_Rdb_CommitByTrxId (OH_Rdb_Store *store, int64_t trxId )

Description

Commits the executed SQL statement based on the specified transaction ID.

Since: 14

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
trxId	Transaction ID.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.
RDB_OK indicates the operation is successful.
RDB_E_INVALID_ARGS indicates invalid parameters are specified.
Possible causes: A null pointer is passed in; the transaction ID is not obtained by OH_Rdb_BeginTransWithTrxId; the transaction ID has been used by OH_Rdb_CommitByTrxId; the transaction ID has been used by OH_Rdb_RollBackByTrxId.
RDB_E_NOT_SUPPORTED indicates that the current operation is not supported.

See

OH_Rdb_CreateConfig()

OH_Rdb_ConfigV2 *OH_Rdb_CreateConfig ()

Description

Creates an OH_Rdb_ConfigV2 instance.

Since: 14

Returns

Returns a pointer to the OH_Rdb_ConfigV2 instance created.

See

OH_Rdb_ConfigV2

OH_Rdb_DeleteStoreV2()

int OH_Rdb_DeleteStoreV2 (const OH_Rdb_ConfigV2 *config)

Description

Deletes an RDB store based on the given OH_Rdb_ConfigV2. If a vector store is used, ensure that the vector store has been correctly closed before calling the API.

Since: 14

Parameters

Name	Description
config	Pointer to the database configuration.

Returns

See

OH_Rdb_ErrCode.

OH_Rdb_DestroyConfig()

int OH_Rdb_DestroyConfig (OH_Rdb_ConfigV2 *config)

Description

Destroys an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.

Returns

OH_Rdb_ExecuteByTrxId()

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

Description

Executes an SQL statement that returns no value based on the specified transaction ID.

Since: 14

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
trxId	Transaction ID returned by OH_Rdb_BeginTransWithTrxId. The value 0 indicates that no transaction is enabled.
sql	Pointer to the SQL statement to execute.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise. RDB_OK indicates the operation is successful.
RDB_E_INVALID_ARGS indicates invalid parameters are specified. Possible causes: A null pointer is passed in; the transaction ID is not obtained by OH_Rdb_BeginTransWithTrxId; the transaction ID has been used by OH_Rdb_CommitByTrxId; the transaction ID has been used by OH_Rdb_RollBackByTrxId; store or sql is NULL.
RDB_E_NOT_SUPPORTED indicates that the current operation is not supported.

See

OH_Rdb_GetSupportedDbType()

const int *OH_Rdb_GetSupportedDbType (int *typeCount)

Description

Obtains the supported database types.

Since: 14

Parameters

Name	Description
typeCount	Pointer to the length of the array of the supported database types obtained.

Returns

OH_Rdb_RollBackByTrxId()

int OH_Rdb_RollBackByTrxId (OH_Rdb_Store *store, int64_t trxId )

Description

Rolls back the executed SQL statement based on the specified transaction ID.

Since: 14

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
trxId	ID of the transaction to be rolled back.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise. RDB_OK indicates the operation is successful.
RDB_E_INVALID_ARGS indicates invalid parameters are specified. Possible causes: A null pointer is passed in; the transaction ID is not obtained by OH_Rdb_BeginTransWithTrxId; the transaction ID has been used by OH_Rdb_CommitByTrxId; the transaction ID has been used by OH_Rdb_RollBackByTrxId.
RDB_E_NOT_SUPPORTED indicates that the current operation is not supported.

See

OH_Rdb_SetArea()

int OH_Rdb_SetArea (OH_Rdb_ConfigV2 *config, int area )

Description

Sets the security area level (Rdb_SecurityArea) for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
area	Security area level to set. For details, see Rdb_SecurityArea.

Returns

OH_Rdb_SetBundleName()

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

Description

Sets the application bundle name for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
bundleName	Pointer to the application bundle name to set.

Returns

OH_Rdb_SetDatabaseDir()

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

Description

Sets the database file path for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
dataBaseDir	Pointer to the database file path to set. The full path, including the RDB store name, cannot exceed a maximum of 1024 characters.

Returns

OH_Rdb_SetDbType()

int OH_Rdb_SetDbType (OH_Rdb_ConfigV2 *config, int dbType )

Description

Sets the database type (Rdb_DBType) for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
dbType	Database type to set. For details, see Rdb_DBType.

Returns

OH_Rdb_SetEncrypted()

int OH_Rdb_SetEncrypted (OH_Rdb_ConfigV2 *config, bool isEncrypted )

Description

Sets whether to encrypt the RDB store for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
isEncrypted	Whether to encrypt the RDB store. The value true means to encrypt the database, the value false means the opposite.

Returns

OH_Rdb_SetModuleName()

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

Description

Sets the module name for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
moduleName	Pointer to the module name to set.

Returns

OH_Rdb_SetSecurityLevel()

int OH_Rdb_SetSecurityLevel (OH_Rdb_ConfigV2 *config, int securityLevel )

Description

Sets the RDB store security level (OH_Rdb_SecurityLevel) for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
securityLevel	RDB store security level to set. For details, see OH_Rdb_SecurityLevel.

Returns

OH_Rdb_SetStoreName()

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

Description

Sets the RDB store name for an OH_Rdb_ConfigV2 instance.

Since: 14

Parameters

Name	Description
config	Pointer to the OH_Rdb_ConfigV2 instance, which is the configuration of the RDB store.
storeName	Pointer to the RDB store name to set.

Returns

OH_Rdb_Backup()

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

Description

Backs up an RDB store in the specified directory.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
databasePath	Pointer to the destination directory in which the RDB store is backed up.

Returns

See

OH_Rdb_BeginTransaction()

int OH_Rdb_BeginTransaction (OH_Rdb_Store *store)

Description

Starts the transaction before executing the SQL statement.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.

Returns

See

OH_Rdb_CloseStore()

int OH_Rdb_CloseStore (OH_Rdb_Store *store)

Description

Closes an OH_Rdb_Store object to reclaim the memory occupied.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.

Returns

See

OH_Rdb_CloudSync()

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

Description

Performs device-cloud sync.

Since: 11

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
mode	Sync mode Rdb_SyncMode.
tables	Pointer to the names of the tables to be synced.
count	Number of tables to sync. If the value is 0, all tables in the RDB store are synced.
observer	Observer Rdb_ProgressObserver of the device-cloud sync progress.

Returns

See

OH_Rdb_Commit()

int OH_Rdb_Commit (OH_Rdb_Store *store)

Description

Commits the executed SQL statement.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.

Returns

See

OH_Rdb_CreatePredicates()

OH_Predicates* OH_Rdb_CreatePredicates (const char *table)

Description

Creates an OH_Predicates instance.

Since: 10

Parameters

Name	Description
table	Pointer to the name of the database table.

Returns

Returns the pointer to the OH_Predicates instance created if the operation is successful; returns null otherwise.

See

OH_Rdb_CreateValueObject()

OH_VObject* OH_Rdb_CreateValueObject ()

Description

Creates an OH_VObject instance.

Since: 10

Returns

Returns the pointer to the OH_VObject instance created if the operation is successful; returns null otherwise.

See

OH_Rdb_CreateValuesBucket()

OH_VBucket* OH_Rdb_CreateValuesBucket ()

Description

Creates an OH_VBucket instance.

Since: 10

Returns

Returns the pointer to the OH_VBucket instance created if the operation is successful; returns null otherwise.

See

OH_Rdb_Delete()

int OH_Rdb_Delete (OH_Rdb_Store *store, OH_Predicates *predicates )

Description

Deletes data from an RDB store based on specified conditions.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
predicates	Pointer to the OH_Predicates instance, which specifies the deletion conditions.

Returns

Returns the number of deleted rows if the operation is successful; returns a number less than 0 otherwise.

See

OH_Rdb_Store, OH_Predicates.

OH_Rdb_DeleteStore()

int OH_Rdb_DeleteStore (const OH_Rdb_Config *config)

Description

Deletes an RDB store with the specified configuration.

Since: 10

Parameters

Name	Description
config	Pointer to the database configuration.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

OH_Rdb_Execute()

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

Description

Executes an SQL statement but returns no value.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
sql	Pointer to the SQL statement to execute.

Returns

See

OH_Rdb_ExecuteQuery()

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

Description

Queries data in an RDB store based on the SQL statements executed.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
sql	Pointer to the SQL statement to execute.

Returns

Returns the pointer to the OH_Cursor instance if the operation is successful; returns null otherwise.

See

OH_Rdb_FindModifyTime()

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

Description

Obtains the last modification time of a table in an RDB store.

Since: 11

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
tableName	Pointer to the target distributed database table.
columnName	Pointer to the column of the database table to query.
values	Pointer to the primary keys of the rows to query. If the database table has no primary key, rowid must be passed in through columnName. In this case, values specifies the row number of the database table to query.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

OH_Rdb_GetOrOpen()

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

Description

Obtains an OH_Rdb_Store instance for RDB store operations.

Since: 10

Parameters

Name	Description
config	Pointer to the OH_Rdb_Config instance, which specifies the database configuration.
errCode	Function execution status.

Returns

Returns the pointer to the OH_Rdb_Store instance created if the operation is successful; returns null otherwise.

See

OH_Rdb_Config, OH_Rdb_Store.

OH_Rdb_GetTableDetails()

Rdb_TableDetails* OH_Rdb_GetTableDetails (Rdb_ProgressDetails *progress, int32_t version )

Description

Obtains the device-cloud sync statistics of a table.

Since: 11

Parameters

Name	Description
progress	Pointer to the OH_ProgressDetails instance.
version	Version of Rdb_ProgressDetails.

Returns

Returns a pointer to Rdb_TableDetails if the operation is successful; returns null otherwise.

See

Rdb_ProgressDetails

Rdb_TableDetails

OH_Rdb_GetVersion()

int OH_Rdb_GetVersion (OH_Rdb_Store *store, int *version )

Description

Obtains the RDB store version.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
version	Pointer to the version obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

OH_Rdb_Insert()

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

Description

Inserts a row of data into a table.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
table	Pointer to the target table.
valuesBucket	Pointer to the data OH_VBucket to insert.

Returns

Returns rowID if the operation is successful; returns a number less than 0 otherwise.

See

OH_Rdb_Store, OH_VBucket.

OH_Rdb_LockRow()

int OH_Rdb_LockRow (OH_Rdb_Store *store, OH_Predicates *predicates )

Description

Locks data in an RDB store based on specified conditions. The locked data will be blocked from the device-cloud sync.

Since: 12

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
predicates	Pointer to the OH_Predicates instance, which specifies the lock conditions.

Returns

Result of the lock operation.

See

OH_Rdb_Store, OH_Predicates.

OH_Rdb_Query()

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

Description

Queries data in an RDB store based on specified conditions.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
predicates	Pointer to the OH_Predicates instance, which specifies the query conditions.
columnNames	Pointer to the columns to query. If this parameter is not specified, data of columns will be queried.
length	Length of the columnNames array. If length is greater than the length of columnNames array, out-of-bounds access occurs.

Returns

Returns the pointer to the OH_Cursor instance if the operation is successful; returns null otherwise.

See

OH_Rdb_Store, OH_Predicates, OH_Cursor.

OH_Rdb_QueryLockedRow()

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

Description

Queries the locked data in an RDB store.

Since: 12

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
predicates	Pointer to the OH_Predicates instance, which specifies the query conditions.
columnNames	Pointer to the columns to query. If this parameter is not specified, data of columns will be queried.
length	Length of the columnNames array. If length is greater than the length of columnNames array, out-of-bounds access occurs.

Returns

Returns the pointer to the OH_Cursor instance if the operation is successful; returns null otherwise.

See

OH_Rdb_Store, OH_Predicates, OH_Cursor.

OH_Rdb_Restore()

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

Description

Restores an RDB store from the specified database backup file.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
databasePath	Pointer to the destination directory in which the RDB store is backed up.

Returns

See

OH_Rdb_RollBack()

int OH_Rdb_RollBack (OH_Rdb_Store *store)

Description

Rolls back the SQL statement executed.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.

Returns

See

OH_Rdb_SetDistributedTables()

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

Description

Sets distributed database tables.

Since: 11

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
tables	Pointer to the names of the distributed tables to set.
count	Number of distributed database tables to be set.
type	Rdb_DistributedType.
config	Configuration of the distributed mode. For details, see Rdb_DistributedConfig.

Returns

See

OH_Rdb_SetVersion()

int OH_Rdb_SetVersion (OH_Rdb_Store *store, int version )

Description

Sets the RDB store version.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
version	Version to set.

Returns

See

OH_Rdb_Subscribe()

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

Description

Registers an observer for an RDB store. When data in the RDB store changes, a callback will be invoked to return the data changes.

Since: 11

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
type	Subscription type defined in Rdb_SubscribeType.
observer	Pointer to the Rdb_DataObserver instance.

Returns

See

Rdb_DataObserver.

OH_Rdb_SubscribeAutoSyncProgress()

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

Description

Subscribes to the automatic sync progress of an RDB store. The registered callback will be invoked to return the automatic sync progress. RDB_OK indicates the operation is successful. RDB_E_INVALID_ARGS indicates invalid parameters are specified.

Since: 11

Parameters

Name	Description
store	Pointer to the target OH_Rdb_Store instance.
observer	Pointer to the Rdb_ProgressObserver instance, which invokes the callback to return the automatic sync progress.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

Rdb_ProgressObserver.

OH_Rdb_UnlockRow()

int OH_Rdb_UnlockRow (OH_Rdb_Store *store, OH_Predicates *predicates )

Description

Unlocks data in an RDB store based on the specified conditions.

Since: 12

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
predicates	Pointer to the OH_Predicates instance, which specifies the unlock conditions.

Returns

Result of the unlock operation.

See

OH_Rdb_Store, OH_Predicates.

OH_Rdb_Unsubscribe()

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

Description

Unregisters the observer of the specified type.

Since: 11

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
type	Subscription type defined in Rdb_SubscribeType.
observer	Pointer to the Rdb_DataObserver instance. If this parameter is nullptr, all observers of this type will be unregistered.

Returns

See

Rdb_DataObserver.

OH_Rdb_UnsubscribeAutoSyncProgress()

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

Description

Unsubscribes from the automatic sync process of an RDB store.

Since: 11

Parameters

Name	Description
store	Pointer to the target OH_Rdb_Store instance.
observer	Pointer to Rdb_ProgressObserver. If the pointer is null, all callbacks for the automatic sync process will be unregistered.

Returns

See

Rdb_ProgressObserver.

OH_Rdb_Update()

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

Description

Updates data in an RDB store based on specified conditions.

Since: 10

Parameters

Name	Description
store	Pointer to the OH_Rdb_Store instance.
valuesBucket	Pointer to the new data OH_VBucket to be updated to the table.
predicates	Pointer to the OH_Predicates instance, specifying the update conditions.

Returns

Returns the number of updated rows if the operation is successful; returns a number less than 0 otherwise.

See

OH_Rdb_Store, OH_Bucket, OH_Predicates.

OH_VBucket_PutAsset()

int OH_VBucket_PutAsset (OH_VBucket *bucket, const char *field, OH_Asset *value )

Description

Puts an OH_Asset object into an OH_VBucket object in the given column.

Since: 11

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.
value	Pointer to the value to put.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

OH_VBucket_PutAssets()

int OH_VBucket_PutAssets (OH_VBucket *bucket, const char *field, OH_Asset **value, int count )

Description

Puts an array of OH_Asset objects into an OH_VBucket object in the given column.

Since: 11

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.
value	Pointer to the value to put.
count	Number of elements in the OH_Asset object array.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

Variable Description

andOperate

OH_Predicates *(*andOperate) (OH_Predicates *predicates)

Description

Pointer to the function used to add the AND operator to the predicates.

This method is equivalent to AND in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns the predicates with the AND operator.

See

area

int OH_Rdb_Config::area

Description

Pointer to the function used to set Rdb_SecurityArea.

Since: 11

beginWrap

OH_Predicates *(*beginWrap) (OH_Predicates *predicates)

Description

Pointer to the function used to add a left parenthesis to the predicates.

This method is equivalent to "(" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns the predicates with a left parenthesis.

See

between

OH_Predicates *(*between) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field whose value is within the specified range.

This method is equivalent to BETWEEN in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

briefObserver

Rdb_BriefObserver Rdb_SubscribeCallback::briefObserver

Description

Callback used to return the device-cloud data change event.

bundleName

const char* OH_Rdb_Config::bundleName

Description

Bundle name.

callback [1/2]

Rdb_SubscribeCallback Rdb_DataObserver::callback

Description

Callback of the data observer.

callback [2/2]

Rdb_ProgressCallback Rdb_ProgressObserver::callback

Description

Callback used to return the device-cloud sync progress.

capability

uint16_t OH_VBucket::capability

Description

Number of the KV pairs in the struct.

ChangeType

int Rdb_ChangeInfo::ChangeType

Description

Type of the data changed, which can be data or asset.

clear [1/2]

OH_Predicates *(*clear) (OH_Predicates *predicates)

Description

Pointer to the function used to clear a predicates instance.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns the cleared predicates.

See

clear [2/2]

int(*clear) (OH_VBucket *bucket)

Description

Pointer to the function used to clear an OH_VBucket object.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

code

int Rdb_ProgressDetails::code

Description

Device-cloud sync state.

context [1/2]

void* Rdb_DataObserver::context

Description

Context of the data observer.

context [2/2]

void* Rdb_ProgressObserver::context

Description

Context of the device-cloud sync progress observer.

count

int Rdb_KeyInfo::count

Description

Number of the changed primary keys or row numbers.

dataBaseDir

const char* OH_Rdb_Config::dataBaseDir

Description

Path of the database file.

deleted

Rdb_KeyInfo Rdb_ChangeInfo::deleted

Description

Location where data is deleted. If the primary key of the table is of the string type, the value is the value of the primary key. Otherwise, the value is the row number of the deleted data.

destroy [1/4]

int(*destroy) (OH_Cursor *cursor)

Description

Pointer to the function used to destroy a result set.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

destroy [2/4]

int(*destroy) (OH_Predicates *predicates)

Description

Pointer to the function used to destroy an OH_Predicates object to reclaim the memory occupied.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

destroy [3/4]

int(*destroy) (OH_VBucket *bucket)

Description

Pointer to the function used to destroy an OH_VBucket object to reclaim the memory occupied.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

destroy [4/4]

int(*destroy) (OH_VObject *valueObject)

Description

Pointer to the function used to destroy an OH_VObject object to reclaim the memory occupied.

Since: 10

Parameters

Name	Description
valueObject	Pointer to the OH_VObject instance.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

detailsObserver

Rdb_DetailsObserver Rdb_SubscribeCallback::detailsObserver

Description

Callback used to return the details about the device-cloud data change.

distinct

OH_Predicates *(*distinct) (OH_Predicates *predicates)

Description

Pointer to the function used to set a predicates object to filter out duplicate records.

This method is equivalent to DISTINCT in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns the predicates created.

See

download

Rdb_Statistic Rdb_TableDetails::download

Description

Statistics of the device-cloud download tasks.

endWrap

OH_Predicates *(*endWrap) (OH_Predicates *predicates)

Description

Pointer to the function used to add a right parenthesis to the predicates.

This method is equivalent to ")" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns the predicates object with a right parenthesis.

See

equalTo

OH_Predicates *(*equalTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field whose value is equal to the specified value.

This method is equivalent to "=" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

failed

int Rdb_Statistic::failed

Description

Number of rows that failed to be synced between the device and cloud in the database table.

getAsset

int(*getAsset) (OH_Cursor *cursor, int32_t columnIndex, Data_Asset *value)

Description

Pointer to the function used to obtain the value of the asset type based on the specified column and the current row.

Since: 11

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
value	Pointer to the value obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getAssets

int(*getAssets) (OH_Cursor *cursor, int32_t columnIndex, Data_Asset **value, uint32_t length)

Description

Pointer to the function used to obtain the values in the form of an asset array based on the specified column and the current row.

Since: 11

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
value	Pointer to the value obtained.
length	Length of an asset array.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getBlob

int(*getBlob) (OH_Cursor *cursor, int32_t columnIndex, unsigned char *value, int length)

Description

Pointer to the function used to obtain the values in the form of a byte array based on the specified column and the current row.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
value	Pointer to the values in the form of a byte array obtained.
length	Length of the value, which can be obtained by getSize().

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getColumnCount

int(*getColumnCount) (OH_Cursor *cursor, int *count)

Description

Pointer to the function used to obtain the number of columns in the result set.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
count	Pointer to the number of columns in the result set obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getColumnIndex

int(*getColumnIndex) (OH_Cursor *cursor, const char *name, int *columnIndex)

Description

Pointer to the function used to obtain the column index based on the specified column name.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
name	Pointer to the column name in the result set.
columnIndex	Pointer to the column index obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getColumnName

int(*getColumnName) (OH_Cursor *cursor, int32_t columnIndex, char *name, int length)

Description

Pointer to the function used to obtain the column name based on the specified column index.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
name	Pointer to the column name obtained.
length	Length of a column name.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getColumnType

int(*getColumnType) (OH_Cursor *cursor, int32_t columnIndex, OH_ColumnType *columnType)

Description

Pointer to the function used to obtain the column type based on the specified column index.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
columnType	Pointer to the OH_ColumnType obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

OH_Cursor, OH_ColumnType.

getInt64

int(*getInt64) (OH_Cursor *cursor, int32_t columnIndex, int64_t *value)

Description

Pointer to the function used to obtain the value of the int64_t type based on the specified column and the current row.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
value	Pointer to the value obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getReal

int(*getReal) (OH_Cursor *cursor, int32_t columnIndex, double *value)

Description

Pointer to the function used to obtain the value of the double type based on the specified column and the current row.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
value	Pointer to the value obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getRowCount

int(*getRowCount) (OH_Cursor *cursor, int *count)

Description

Pointer to the function used to obtain the number of rows in the result set.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
count	Pointer to the number of columns in the result set obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getSize

int(*getSize) (OH_Cursor *cursor, int32_t columnIndex, size_t *size)

Description

Pointer to the function used to obtain information about the memory required when the column data type in the result set is BLOB or TEXT.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
size	Pointer to the memory size obtained.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

getText

int(*getText) (OH_Cursor *cursor, int32_t columnIndex, char *value, int length)

Description

Pointer to the function used to obtain the value of the string type based on the specified column and the current row.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
value	Pointer to the value of the string type obtained.
length	Length of the value, which can be obtained by getSize().

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

goToNextRow

int(*goToNextRow) (OH_Cursor *cursor)

Description

Pointer to the function used to go to the next row of the result set.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

greaterThan

OH_Predicates *(*greaterThan) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field with value greater than the specified value.

This method is equivalent to ">" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

greaterThanOrEqualTo

OH_Predicates *(*greaterThanOrEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field with value greater than or equal to the specified value.

This method is equivalent to ">=" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

groupBy

OH_Predicates *(*groupBy) (OH_Predicates *predicates, char const *const *fields, int length)

Description

Pointer to the function used to set a predicates object to group rows that have the same value into summary rows.

This method is equivalent to GROUP BY in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
fields	Pointer to the names of the columns by which the records are grouped.
length	Length of the fields value.

Returns

Returns the predicates created.

See

id [1/5]

int64_t OH_Cursor::id

Description

Unique identifier of the OH_Cursor struct.

id [2/5]

int64_t OH_Predicates::id

Description

Unique identifier of the OH_Predicates struct.

id [3/5]

int64_t OH_VObject::id

Description

Unique identifier of the OH_VObject struct.

id [4/5]

int64_t OH_VBucket::id

Description

Unique identifier of the OH_VBucket struct.

id [5/5]

int64_t OH_Rdb_Store::id

Description

Unique identifier of the OH_Rdb_Store struct.

in

OH_Predicates *(*in) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field with the value within the specified range.

This method is equivalent to IN in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

inserted

Rdb_KeyInfo Rdb_ChangeInfo::inserted

Description

Location where data is inserted. If the primary key of the table is of the string type, the value is the value of the primary key. Otherwise, the value is the row number of the inserted data.

integer

uint64_t Rdb_KeyInfo::Rdb_KeyData::integer

Description

Data of the uint64_t type.

isAutoSync

bool Rdb_DistributedConfig::isAutoSync

Description

Whether the table supports automatic sync.

isEncrypt

bool OH_Rdb_Config::isEncrypt

Description

Whether to encrypt the RDB store.

isNotNull

OH_Predicates *(*isNotNull) (OH_Predicates *predicates, const char *field)

Description

Pointer to the function used to set a predicates object to match the field whose value is not null.

This method is equivalent to IS NOT NULL in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.

Returns

Returns the predicates created.

See

isNull [1/2]

int(*isNull) (OH_Cursor *cursor, int32_t columnIndex, bool *isNull)

Description

Pointer to the function used to check whether the value in the specified column is null.

Since: 10

Parameters

Name	Description
cursor	Pointer to the OH_Cursor instance.
columnIndex	Index of the column. The index value starts from 0.
isNull	Pointer to the value returned. The value true means the value is null; the value false means the opposite.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

isNull [2/2]

OH_Predicates *(*isNull) (OH_Predicates *predicates, const char *field)

Description

Pointer to the function used to set a predicates object to match the field whose value is null.

This method is equivalent to IS NULL in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.

Returns

Returns the predicates created.

See

lessThan

OH_Predicates *(*lessThan) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field with value less than the specified value.

This method is equivalent to "<" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

lessThanOrEqualTo

OH_Predicates *(*lessThanOrEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field with value less than or equal to the specified value.

This method is equivalent to "<=" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

like

OH_Predicates *(*like) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match a string that is similar to the specified value.

This method is equivalent to LIKE in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

limit

OH_Predicates *(*limit) (OH_Predicates *predicates, unsigned int value)

Description

Pointer to the function used to set a predicates object to specify the maximum number of records.

This method is equivalent to LIMIT in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
value	Maximum number of data records.

Returns

Returns the predicates created.

See

moduleName

const char* OH_Rdb_Config::moduleName

Description

Module name.

notBetween

OH_Predicates *(*notBetween) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field whose value is out of the specified range.

This method is equivalent to NOT BETWEEN in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

notEqualTo

OH_Predicates *(*notEqualTo) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field whose value is not equal to the specified value.

This method is equivalent to "!=" in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

notIn

OH_Predicates *(*notIn) (OH_Predicates *predicates, const char *field, OH_VObject *valueObject)

Description

Pointer to the function used to set a predicates object to match the field with the value out of the specified range.

This method is equivalent to NOT IN in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
valueObject	Pointer to the OH_VObject instance, which specifies the start and end values.

Returns

Returns the predicates created.

See

offset

OH_Predicates *(*offset) (OH_Predicates *predicates, unsigned int rowOffset)

Description

Pointer to the function used to set a predicates object to specify the start position of the returned result.

This method is equivalent to OFFSET in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
rowOffset	Start position of the returned result. The value is a positive integer.

Returns

Returns the predicates created.

See

orderBy

OH_Predicates *(*orderBy) (OH_Predicates *predicates, const char *field, OH_OrderType type)

Description

Pointer to the function used to set a predicates object to sort the values in a column in ascending or descending order.

This method is equivalent to ORDER BY in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.
field	Pointer to the column name in the database table.
type	Sorting type OH_OrderType.

Returns

Returns the predicates created.

See

OH_Predicates, OH_OrderType.

orOperate

OH_Predicates *(*orOperate) (OH_Predicates *predicates)

Description

Pointer to the function used to add the OR operator to the predicates.

This method is equivalent to OR in SQL statements.

Since: 10

Parameters

Name	Description
predicates	Pointer to the OH_Predicates instance.

Returns

Returns the predicates with the OR operator.

See

putBlob

int(*putBlob) (OH_VBucket *bucket, const char *field, const uint8_t *value, uint32_t size)

Description

Pointer to the function used to put a const uint8_t value into an OH_VBucket object in the given column.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.
value	Pointer to the value to put.
size	Length of the value.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putDouble

int(*putDouble) (OH_VObject *valueObject, double *value, uint32_t count)

Description

Pointer to the function used to convert a single parameter or an array of the double type into a value of the OH_VObject type.

Since: 10

Parameters

Name	Description
valueObject	Pointer to the OH_VObject instance.
value	Pointer to the data to covert.
count	If value points to a single parameter, count is 1. If value points to an array, count specifies the length of the array.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putInt64 [1/2]

int(*putInt64) (OH_VBucket *bucket, const char *field, int64_t value)

Description

Pointer to the function used to put an int64_t value into an OH_VBucket object in the given column.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.
value	Pointer to the value to put.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putInt64 [2/2]

int(*putInt64) (OH_VObject *valueObject, int64_t *value, uint32_t count)

Description

Pointer to the function used to convert a single parameter or an array of the int64 type into a value of the OH_VObject type.

Since: 10

Parameters

Name	Description
valueObject	Pointer to the OH_VObject instance.
value	Pointer to the data to covert.
count	If value points to a single parameter, count is 1. If value points to an array, count specifies the length of the array.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putNull

int(*putNull) (OH_VBucket *bucket, const char *field)

Description

Pointer to the function used to put a null value into an OH_VBucket object in the given column.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putReal

int(*putReal) (OH_VBucket *bucket, const char *field, double value)

Description

Pointer to the function used to put a double value into an OH_VBucket object in the given column.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.
value	Pointer to the value to put.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putText [1/2]

int(*putText) (OH_VBucket *bucket, const char *field, const char *value)

Description

Pointer to the function used to put a char value into an OH_VBucket object in the given column.

Since: 10

Parameters

Name	Description
bucket	Pointer to the OH_VBucket instance.
field	Pointer to the column name in the database table.
value	Pointer to the value to put.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putText [2/2]

int(*putText) (OH_VObject *valueObject, const char *value)

Description

Pointer to the function used to convert a character array of the char type to a value of the OH_VObject type.

Since: 10

Parameters

Name	Description
valueObject	Pointer to the OH_VObject instance.
value	Pointer to the character array to convert.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See

putTexts

int(*putTexts) (OH_VObject *valueObject, const char **value, uint32_t count)

Description

Pointer to the function used to convert a string array of the char type to a value of the OH_VObject type.

Since: 10

Parameters

Name	Description
valueObject	Pointer to the OH_VObject instance.
value	Pointer to the string array to convert.
count	Length of the string array to convert.

Returns

Returns RDB_OK if the operation is successful; returns an error code otherwise.

See