diff --git a/zh-cn/application-dev/database/database-mdds-guidelines.md b/zh-cn/application-dev/database/database-mdds-guidelines.md index 29d48003a3a1fd8985c7b517b3bfb3b1cc74b1fb..d541d9c2f5e47537516e4817848df52c816f07f3 100644 --- a/zh-cn/application-dev/database/database-mdds-guidelines.md +++ b/zh-cn/application-dev/database/database-mdds-guidelines.md @@ -13,13 +13,13 @@ | 接口名称 | 描述 | | ------------------------------------------------------------ | ----------------------------------------------- | -| createKVManager(config:KVManagerConfig,callback:AsyncCallback<KVManager>):void
createKVManager(config:KVManagerConfig):Promise<KVManager> | 创建一个`KVManager`对象实例，用于管理数据库对象。 | -| getKVStore<TextendsKVStore>(storeId:string,options:Options,callback:AsyncCallback<T>):void
getKVStore<TextendsKVStore>(storeId:string,options:Options):Promise<T> | 指定`Options`和`storeId`，创建并获取`KVStore`数据库。 | -| put(key:string,value:Uint8Array\|string\|number\|boolean,callback:AsyncCallback<void>):void
put(key:string,value:Uint8Array\|string\|number\|boolean):Promise<void> | 插入和更新数据。 | -| delete(key:string,callback:AsyncCallback<void>):void
delete(key:string):Promise<void> | 删除数据。 | -| get(key:string,callback:AsyncCallback<Uint8Array\|string\|boolean\|number>):void
get(key:string):Promise<Uint8Array\|string\|boolean\|number> | 查询数据。 | -| on(event:'dataChange',type:SubscribeType,observer:Callback<ChangeNotification>):void
on(event:'syncComplete',syncCallback:Callback<Array<[string,number]>>):void | 订阅数据库中数据的变化。 | -| sync(deviceIdList:string[],mode:SyncMode,allowedDelayMs?:number):void | 在手动模式下，触发数据库同步。 | +| createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void
createKVManager(config: KVManagerConfig): Promise<KVManager> | 创建一个`KVManager`对象实例，用于管理数据库对象。 | +| getKVStore<TextendsKVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void
getKVStore<TextendsKVStore>(storeId: string, options: Options): Promise<T> | 指定`Options`和`storeId`，创建并获取`KVStore`数据库。 | +| put(key: string, value: Uint8Array\|string\|number\|boolean, callback: AsyncCallback<void>): void
put(key: string, value: Uint8Array\|string\|number\|boolean): Promise<void> | 插入和更新数据。 | +| delete(key: string, callback: AsyncCallback<void>): void
delete(key: string): Promise<void> | 删除数据。 | +| get(key: string, callback: AsyncCallback<Uint8Array\|string\|boolean\|number>): void
get(key: string): Promise<Uint8Array\|string\|boolean\|number> | 查询数据。 | +| on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void
on(event: 'syncComplete', syncCallback: Callback<Array<[string,number]>>): void | 订阅数据库中数据的变化。 | +| sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | 在手动模式下，触发数据库同步。 | ## 开发步骤 diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index 6faff74f2301251a65941e700b2b20012e539fd0..e0fe6e11d44020248081d63954be433bd2338489 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -32,7 +32,7 @@ | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | insert(table:string,values:ValuesBucket):Promise<number> | 向目标表中插入一行数据，使用Promise异步回调。
如果操作成功，返回行ID；否则返回-1。
-table：指定的目标表名。
-values：表示要插入到表中的数据行。 | + | RdbStore | insert(table: string, values: ValuesBucket): Promise<number> | 向目标表中插入一行数据，使用Promise异步回调。
如果操作成功，返回行ID；否则返回-1。
-table：指定的目标表名。
-values：表示要插入到表中的数据行。 | - **更新** @@ -42,7 +42,7 @@ | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | update(values:ValuesBucket,predicates:RdbPredicates):Promise<number> | 根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
返回受影响的行数。
-values：以ValuesBucket存储的要更新的数据。
-predicates：表示RdbPredicates的实例对象指定的更新条件。 | + | RdbStore | update(values: ValuesBucket, predicates: RdbPredicates): Promise<number> | 根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。
返回受影响的行数。
-values：以ValuesBucket存储的要更新的数据。
-predicates：表示RdbPredicates的实例对象指定的更新条件。 | - **删除** @@ -52,7 +52,7 @@ | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | delete(predicates:RdbPredicates):Promise<number> | 根据RdbPredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
返回受影响的行数。
-predicates：RdbPredicates的实例对象指定的删除条件。 | + | RdbStore | delete(predicates: RdbPredicates): Promise<number> | 根据RdbPredicates的指定实例对象从数据库中删除数据，使用Promise异步回调。
返回受影响的行数。
-predicates：RdbPredicates的实例对象指定的删除条件。 | - **查询** @@ -65,8 +65,8 @@ | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | query(predicates:RdbPredicates,columns?:Array<string>):Promise<ResultSet> | 根据指定条件查询数据库中的数据，使用Promise异步回调。
-predicates：表示RdbPredicates的实例对象指定的查询条件。
-columns：表示要查询的列。如果值为空，则查询应用于所有列。 | - | RdbStore | querySql(sql:string,bindArgs?:Array<ValueType>):Promise<ResultSet> | 根据指定SQL语句查询数据库中的数据，使用Promise异步回调。
-sql：指定要查询的SQL语句。
-bindArgs：SQL语句中参数的值。 | + | RdbStore | query(predicates: RdbPredicates, columns?: Array<string>): Promise<ResultSet> | 根据指定条件查询数据库中的数据，使用Promise异步回调。
-predicates：表示RdbPredicates的实例对象指定的查询条件。
-columns：表示要查询的列。如果值为空，则查询应用于所有列。 | + | RdbStore | querySql(sql: string, bindArgs?: Array<ValueType>): Promise<ResultSet> | 根据指定SQL语句查询数据库中的数据，使用Promise异步回调。
-sql：指定要查询的SQL语句。
-bindArgs：SQL语句中参数的值。 | | RdbStore | remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string>): Promise<ResultSet> | 根据指定条件查询指定远程设备数据库中的数据。使用Promise异步回调。
-device：指定远程查询的设备networkId。
-table：指定远程查询的表名。
-predicates：表示RdbPredicates的实例对象，指定查询的条件。
-columns：表示要查询的列。如果值为空，则查询应用于所有列。 | ### 数据库谓词的使用 @@ -79,11 +79,11 @@ | 类名 | 接口名 | 描述 | | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| RdbPredicates | equalTo(field:string,value:ValueType):RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
-field：数据库表中的列名。
-value：指示要与谓词匹配的值。
-RdbPredicates：返回与指定字段匹配的谓词。 | -| RdbPredicates | notEqualTo(field:string,value:ValueType):RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
-field：数据库表中的列名。
-value：指示要与谓词匹配的值。
-RdbPredicates：返回与指定字段匹配的谓词。 | -| RdbPredicates | or():RdbPredicates | 将或条件添加到谓词中。
-RdbPredicates：返回带有或条件的谓词。 | -| RdbPredicates | and():RdbPredicates | 向谓词添加和条件。
-RdbPredicates：返回带有和条件的谓词。 | -| RdbPredicates | contains(field:string,value:string):RdbPredicates | 配置谓词以匹配数据字段为String且value包含指定值的字段。
-field：数据库表中的列名。
-value：指示要与谓词匹配的值。
-RdbPredicates：返回带有包含条件的谓词。 | +| RdbPredicates | equalTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
-field：数据库表中的列名。
-value：指示要与谓词匹配的值。
-RdbPredicates：返回与指定字段匹配的谓词。 | +| RdbPredicates | notEqualTo(field: string, value: ValueType): RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
-field：数据库表中的列名。
-value：指示要与谓词匹配的值。
-RdbPredicates：返回与指定字段匹配的谓词。 | +| RdbPredicates | or(): RdbPredicates | 将或条件添加到谓词中。
-RdbPredicates：返回带有或条件的谓词。 | +| RdbPredicates | and(): RdbPredicates | 向谓词添加和条件。
-RdbPredicates：返回带有和条件的谓词。 | +| RdbPredicates | contains(field: string, value: string): RdbPredicates | 配置谓词以匹配数据字段为String且value包含指定值的字段。
-field：数据库表中的列名。
-value：指示要与谓词匹配的值。
-RdbPredicates：返回带有包含条件的谓词。 | ### 查询结果集的使用 @@ -99,12 +99,12 @@ | 类名 | 接口名 | 描述 | | --------- | ---------------------------------------------------- | ------------------------------------------ | -| ResultSet | goToFirstRow():boolean | 将结果集移动到第一行。 | -| ResultSet | getString(columnIndex:number):string | 获取当前行指定列的值，以String类型返回。 | -| ResultSet | getBlob(columnIndex:number):Uint8Array | 获取当前行指定列的值，以字节数组形式返回。 | -| ResultSet | getDouble(columnIndex:number):number | 获取当前行指定列的值，以double型返回。 | -| ResultSet | getLong(columnIndex:number):number | 获取当前行指定列的值，以Long形式返回。 | -| ResultSet | close():void | 关闭结果集。 | +| ResultSet | goToFirstRow(): boolean | 将结果集移动到第一行。 | +| ResultSet | getString(columnIndex: number): string | 获取当前行指定列的值，以String类型返回。 | +| ResultSet | getBlob(columnIndex: number): Uint8Array | 获取当前行指定列的值，以字节数组形式返回。 | +| ResultSet | getDouble(columnIndex: number): number | 获取当前行指定列的值，以double型返回。 | +| ResultSet | getLong(columnIndex: number): number | 获取当前行指定列的值，以Long形式返回。 | +| ResultSet | close(): void | 关闭结果集。 | @@ -162,7 +162,7 @@ | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| RdbStore | backup(destName:string): Promise<void> | 以指定名称备份数据库，使用Promise异步回调。
-destName：指定数据库的备份文件名。 | +| RdbStore | backup(destName: string): Promise<void> | 以指定名称备份数据库，使用Promise异步回调。
-destName：指定数据库的备份文件名。 | **恢复** @@ -170,7 +170,7 @@ | 类名 | 接口名 | 描述 | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| RdbStore | restore(srcName:string): Promise<void> | 从指定的数据库备份文件恢复数据库，使用Promise异步回调。
-srcName：指定数据库的备份文件名。 | +| RdbStore | restore(srcName: string): Promise<void> | 从指定的数据库备份文件恢复数据库，使用Promise异步回调。
-srcName：指定数据库的备份文件名。 | **事务** @@ -178,9 +178,9 @@ | 类名 | 接口名 | 描述 | | -------- | ----------------------- | --------------------------------- | -| RdbStore | beginTransaction():void | 在开始执行SQL语句之前，开始事务。 | -| RdbStore | commit():void | 提交已执行的SQL语句。 | -| RdbStore | rollBack():void | 回滚已经执行的SQL语句。 | +| RdbStore | beginTransaction(): void | 在开始执行SQL语句之前，开始事务。 | +| RdbStore | commit(): void | 提交已执行的SQL语句。 | +| RdbStore | rollBack(): void | 回滚已经执行的SQL语句。 | ## 开发步骤