harmony 鸿蒙RDB

OH_Rdb_BeginTransaction()

int OH_Rdb_BeginTransaction (OH_Rdb_Store * store)

描述:

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

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_CloseStore()

int OH_Rdb_CloseStore (OH_Rdb_Store * store)

描述:

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

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_Commit()

int OH_Rdb_Commit (OH_Rdb_Store * store)

描述:

提交已执行的SQL语句

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_CreatePredicates()

OH_Predicates* OH_Rdb_CreatePredicates (const char * table)

描述:

创建OH_Predicates实例。

参数:

名称	描述
table	表示数据库表名。

返回:

创建成功则返回一个指向OH_Predicates结构体实例的指针，否则返回NULL。

参见:

OH_Rdb_CreateValueObject()

OH_VObject* OH_Rdb_CreateValueObject (void)

描述:

创建OH_VObject实例。

返回:

创建成功则返回一个指向OH_VObject结构体实例的指针，否则返回NULL。

参见:

OH_Rdb_CreateValuesBucket()

OH_VBucket* OH_Rdb_CreateValuesBucket (void)

描述:

创建OH_VBucket实例。

返回:

创建成功则返回一个指向OH_VBucket结构体实例的指针，否则返回NULL。

参见:

OH_Rdb_Delete()

int OH_Rdb_Delete (OH_Rdb_Store * store, OH_Predicates * predicates )

描述:

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

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
predicates	表示指向OH_Predicates实例的指针，指定删除条件。

返回:

如果更新成功，返回受影响的行数，否则返回特定的错误码。

参见:

OH_Rdb_Store, OH_Predicates.

OH_Rdb_DeleteStore()

int OH_Rdb_DeleteStore (const OH_Rdb_Config * config)

描述:

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

参数:

名称	描述
path	表示数据库路径。

返回:

返回操作是否成功，出错时返回对应的错误码。

OH_Rdb_Execute()

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

描述:

执行无返回值的SQL语句。

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
sql	指定要执行的SQL语句。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_ExecuteQuery()

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

描述:

根据指定SQL语句查询数据库中的数据。

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
sql	指定要执行的SQL语句。

返回:

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

参见:

OH_Rdb_GetOrOpen()

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

描述:

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

参数:

名称	描述
config	表示指向OH_Rdb_Config实例的指针，与此RDB存储相关的数据库配置。
errCode	该参数是输出参数，函数执行状态写入该变量。

返回:

创建成功则返回一个指向OH_Rdb_Store结构体实例的指针，否则返回NULL。

参见:

OH_Rdb_Config, OH_Rdb_Store.

OH_Rdb_GetVersion()

int OH_Rdb_GetVersion (OH_Rdb_Store * store, int * version )

描述:

获取数据库版本。

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
version	表示版本号。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_Insert()

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

描述:

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

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
table	表示指定的目标表名。
valuesBucket	表示要插入到表中的数据行OH_VBucket。

返回:

如果插入成功，返回行ID。否则返回特定的错误码。

参见:

OH_Rdb_Store, OH_VBucket.

OH_Rdb_Query()

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

描述:

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

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
predicates	表示指向OH_Predicates实例的指针，指定查询条件。
columnNames	表示要查询的列。如果值为空，则查询应用于所有列。
length	表示columnNames数组的长度。若length大于columnNames数组的实际长度，则会访问越界。

返回:

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

参见:

OH_Rdb_Store, OH_Predicates, OH_Cursor.

OH_Rdb_Restore()

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

描述:

从指定的数据库备份文件恢复数据库。

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
databasePath	指定数据库的备份文件路径。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_RollBack()

int OH_Rdb_RollBack (OH_Rdb_Store * store)

描述:

回滚已经执行的SQL语句。

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_SetVersion()

int OH_Rdb_SetVersion (OH_Rdb_Store * store, int version )

描述:

设置数据库版本。

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
version	表示版本号。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Rdb_Update()

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

描述:

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

参数:

名称	描述
store	表示指向OH_Rdb_Store实例的指针。
valuesBucket	表示要更新到表中的数据行OH_VBucket。
predicates	表示指向OH_Predicates实例的指针，指定更新条件。

返回:

如果更新成功，返回受影响的行数，否则返回特定的错误码。

参见:

OH_Rdb_Store, OH_Bucket, OH_Predicates.

变量说明

andOperate

OH_Predicates*(* OH_Predicates::andOperate) (OH_Predicates *predicates)

描述:

函数指针，向谓词添加和条件。

该方法等同于SQL语句中的“AND”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回带有和条件的谓词。

参见:

beginWrap

OH_Predicates*(* OH_Predicates::beginWrap) (OH_Predicates *predicates)

描述:

函数指针，向谓词添加左括号。

该方法等同于SQL语句中的“(”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回带有左括号的谓词。

参见:

between

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

描述:

函数指针，将谓词配置为匹配数据字段为field且其值在给定范围内的指定字段。

该方法等同于SQL语句中的“BETWEEN”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

storeName

const char* OH_Rdb_Config::storeName

描述:

数据库名称。

bundleName

const char* OH_Rdb_Config::bundleName

描述:

应用包名。

capability

uint16_t OH_VBucket::capability

描述:

表示结构体的存储键值对的数量

clear [¹⁄₂]

OH_Predicates*(* OH_Predicates::clear) (OH_Predicates *predicates)

描述:

函数指针，清空谓词。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回清空后的谓词

参见:

clear [²⁄₂]

int(* OH_VBucket::clear) (OH_VBucket *bucket)

描述:

清空OH_VBucket对象。

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

dataBaseDir

const char* OH_Rdb_Config::dataBaseDir

描述:

数据库文件路径。

destroy [¹⁄₄]

int(* OH_Cursor::destroy) (OH_Cursor *cursor)

描述:

函数指针，关闭结果集。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

destroy [²⁄₄]

int(* OH_Predicates::destroy) (OH_Predicates *predicates)

描述:

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

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

destroy [³⁄₄]

int(* OH_VBucket::destroy) (OH_VBucket *bucket)

描述:

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

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

destroy [⁴⁄₄]

int(* OH_VObject::destroy) (OH_VObject *valueObject)

描述:

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

参数:

名称	描述
valueObject	表示指向OH_VObject实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

distinct

OH_Predicates*(* OH_Predicates::distinct) (OH_Predicates *predicates)

描述:

函数指针，配置谓词以过滤重复记录并仅保留其中一个。

该方法等同于SQL语句中的“DISTINCT”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回可用于过滤重复记录的谓词。

参见:

endWrap

OH_Predicates*(* OH_Predicates::endWrap) (OH_Predicates *predicates)

描述:

函数指针，向谓词添加右括号。

该方法等同于SQL语句中的“)”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回带有右括号的谓词。

参见:

equalTo

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

描述:

函数指针，配置谓词以匹配数据字段等于指定值的字段。

该方法等同于SQL语句中的“=”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

getBlob

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

描述:

函数指针，以字节数组的形式获取当前行中指定列的值。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
value	该参数是输出参数，结果集中指定列的值会以字节数组形式写入该变量。
length	表示value的长度，该值可通过getSize获取。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getColumnCount

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

描述:

函数指针，获取结果集中的列数。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
count	该参数是输出参数，结果集中的列数会写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getColumnIndex

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

描述:

函数指针，根据指定的列名获取列索引。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
name	表示结果集中指定列的名称。
columnIndex	该参数是输出参数，结果集中指定列的索引会写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getColumnName

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

描述:

函数指针，根据指定的列索引获取列名。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
name	该参数是输出参数，结果集中指定列的名称会写入该变量。
length	表示列名的长度。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getColumnType

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

描述:

函数指针，根据指定的列索引获取列类型。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
columnType	该参数是输出参数，结果集中指定列的数据类型OH_ColumnType会写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

OH_Cursor, OH_ColumnType.

getInt64

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

描述:

函数指针，以int64_t形式获取当前行中指定列的值。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
value	该参数是输出参数，结果集中指定列的值会以int64_t形式写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getReal

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

描述:

函数指针，以double形式获取当前行中指定列的值。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
value	该参数是输出参数，结果集中指定列的值会以double形式写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getRowCount

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

描述:

函数指针，获取结果集中的行数。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
count	该参数是输出参数，结果集中的行数会写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getSize

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

描述:

函数指针，当结果集中列的数据类型是BLOB或者TEXT时，获取其值所需的内存。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
size	该参数是输出参数，BLOB或者TEXT数据所需内存大小会写入该变量。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

getText

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

描述:

函数指针，以字符串形式获取当前行中指定列的值。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
value	该参数是输出参数，结果集中指定列的值会以字符串形式写入该变量。
length	表示value的长度，该值可通过getSize获取。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

goToNextRow

int(* OH_Cursor::goToNextRow) (OH_Cursor *cursor)

描述:

函数指针，转到结果集的下一行。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

greaterThan

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

描述:

函数指针，配置谓词以匹配数据字段为field且值大于指定值valueObject的字段。

该方法等同于SQL语句中的“>”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词

参见:

greaterThanOrEqualTo

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

描述:

函数指针，配置谓词以匹配数据字段为field且值大于或等于指定值valueObject的字段

该方法等同于SQL语句中的“>=”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

groupBy

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

描述:

函数指针，配置R谓词按指定列分组查询结果。

该方法等同于SQL语句中的“GROUP BY”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
fields	指定分组依赖的列名。
length	表示fields数值的长度。

返回:

返回分组查询列的谓词。

参见:

id [¹⁄₄]

int64_t OH_Predicates::id

描述:

OH_Predicates结构体的唯一标识符。

id [²⁄₄]

int64_t OH_VObject::id

描述:

OH_VObject结构体的唯一标识符。

id [³⁄₄]

int64_t OH_VBucket::id

描述:

OH_VBucket结构体的唯一标识符。

id [⁴⁄₄]

int64_t OH_Rdb_Store::id

描述:

OH_Rdb_Store结构体的唯一标识符。

in

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

描述:

函数指针，配置谓词以匹配数据字段为field且值在给定范围内的指定字段。

该方法等同于SQL语句中的“IN”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	表示数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

isEncrypt

bool OH_Rdb_Config::isEncrypt

描述:

指定数据库是否加密。

isNotNull

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

描述:

函数指针，配置谓词以匹配值不为null的指定字段。

该方法等同于SQL语句中的“IS NOT NULL”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。

返回:

返回与指定字段匹配的谓词

参见:

isNull [¹⁄₂]

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

描述:

函数指针，检查当前行中指定列的值是否为null。

参数:

名称	描述
cursor	表示指向OH_Cursor实例的指针。
columnIndex	表示结果集中指定列的索引。
isNull	该参数是输出参数，如果当前行中指定列的值为null，该值为true，否则为false。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

isNull [²⁄₂]

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

描述:

函数指针，配置谓词以匹配值为null的字段。

该方法等同于SQL语句中的“IS NULL”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。

返回:

返回与指定字段匹配的谓词。

参见:

lessThan

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

描述:

函数指针，配置谓词以匹配数据字段为field且值小于指定值valueObject的字段

该方法等同于SQL语句中的“<”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

lessThanOrEqualTo

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

描述:

函数指针，配置谓词以匹配数据字段为field且值小于或等于指定值valueObject的字段

该方法等同于SQL语句中的“<=”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

like

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

描述:

函数指针，配置谓词以匹配数据字段为field且值类似于指定字符串的字段。

该方法等同于SQL语句中的“LIKE”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

limit

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

描述:

函数指针，设置最大数据记录数的谓词。

该方法等同于SQL语句中的“LIMIT”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
value	表示最大数据记录数。

返回:

返回可用于设置最大数据记录数的谓词。

参见:

moduleName

const char* OH_Rdb_Config::moduleName

描述:

应用模块名。

notBetween

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

描述:

函数指针，将谓词配置为匹配数据字段为field且其值超出给定范围内的指定字段。

该方法等同于SQL语句中的“NOT BETWEEN”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

notEqualTo

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

描述:

函数指针，配置谓词以匹配数据字段不等于指定值的字段。

该方法等同于SQL语句中的“!=”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

notIn

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

描述:

函数指针，配置谓词以匹配数据字段为field且值超出给定范围内的指定字段。

该方法等同于SQL语句中的“NOT IN”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	表示数据库表中的列名。
valueObject	表示指向OH_VObject实例的指针，指示要与谓词匹配的值。

返回:

返回与指定字段匹配的谓词。

参见:

offset

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

描述:

函数指针，配置谓词以指定返回结果的起始位置。

该方法等同于SQL语句中的“OFFSET”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
rowOffset	返回结果的起始位置，取值为正整数。

返回:

返回具有指定返回结果起始位置的谓词。

参见:

orderBy

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

描述:

函数指针，配置谓词以匹配其值按升序或降序排序的列。

该方法等同于SQL语句中的“ORDER BY”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。
field	数据库表中的列名。
type	表示排序类型 OH_OrderType.

返回:

返回与指定字段匹配的谓词。

参见:

OH_Predicates, OH_OrderType.

orOperate

OH_Predicates*(* OH_Predicates::orOperate) (OH_Predicates *predicates)

描述:

函数指针，将或条件添加到谓词中。

该方法等同于SQL语句中的“OR”。

参数:

名称	描述
predicates	表示指向OH_Predicates实例的指针。

返回:

返回带有或条件的谓词。

参见:

putBlob

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

描述:

将const uint8_t *值放入给定列名的OH_VBucket对象中。

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。
field	数据库表中的列名。
value	数据库表中指定列名对应的值。
size	表示value的长度。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putDouble

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

描述:

将double类型的单个参数或者数组转换为OH_VObject类型的值。

参数:

名称	描述
valueObject	表示指向OH_VObject实例的指针。
value	表示指向double类型的单个参数或者数组的指针。
count	如果value是指向单个数值的指针，则count = 1；如果value是指向数组的指针，则count是数组的长度。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putInt64 [¹⁄₂]

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

描述:

将int64_t值放入给定列名的OH_VBucket对象中。

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。
field	数据库表中的列名。
value	数据库表中指定列名对应的值。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putInt64 [²⁄₂]

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

描述:

将int64类型的单个参数或者数组转换为OH_VObject类型的值。

参数:

名称	描述
valueObject	表示指向OH_VObject实例的指针。
value	表示指向int64_t类型的单个参数或者数组的指针。
count	如果value是指向单个数值的指针，则count = 1；如果value是指向数组的指针，则count是数组的长度。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putNull

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

描述:

将NULL值放入给定列名的OH_VBucket对象中。

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。
field	数据库表中的列名。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putReal

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

描述:

将double值放入给定列名的OH_VBucket对象中。

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。
field	数据库表中的列名。
value	数据库表中指定列名对应的值。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putText [¹⁄₂]

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

描述:

将char*值放入给定列名的OH_VBucket对象中。

参数:

名称	描述
bucket	表示指向OH_VBucket实例的指针。
field	数据库表中的列名。
value	数据库表中指定列名对应的值。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putText [²⁄₂]

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

描述:

将char *类型的字符数组转换为OH_VObject类型的值。

参数:

名称	描述
valueObject	表示指向OH_VObject实例的指针。
value	表示字符数组参数。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见:

putTexts

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

描述:

将char *类型的字符串数组转换为OH_VObject类型的值。

参数:

名称	描述
valueObject	表示指向OH_VObject实例的指针。
value	表示字符串数组参数。
count	表示字符串数组参数value的长度。

返回:

返回操作是否成功，出错时返回对应的错误码。

参见: