From 4ed5f19fab7180c6bb02690facd936a9e8b530ac Mon Sep 17 00:00:00 2001 From: wuyongning Date: Mon, 28 Mar 2022 16:15:01 +0800 Subject: [PATCH] update docs Signed-off-by: wuyongning --- .../database-relational-guidelines.md | 2 +- .../reference/apis/js-apis-data-ability.md | 23 +++++++++++++++++++ .../reference/apis/js-apis-data-rdb.md | 12 +++++----- 3 files changed, 30 insertions(+), 7 deletions(-) diff --git a/zh-cn/application-dev/database/database-relational-guidelines.md b/zh-cn/application-dev/database/database-relational-guidelines.md index fa5b78f80e..ad2d787866 100644 --- a/zh-cn/application-dev/database/database-relational-guidelines.md +++ b/zh-cn/application-dev/database/database-relational-guidelines.md @@ -17,7 +17,7 @@ | -------- | -------- | |getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void | 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。
- config：与此RDB存储相关的数据库配置。
- version：数据库版本。
- callback：指定callback回调函数。返回一个RdbStore。 | |getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> | 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。
- config：与此RDB存储相关的数据库配置。
- version：数据库版本。 | -|deleteRdbStore(name: string, callback: AsyncCallback<void>): void | 删除数据库，结果以callback形式返回。
- name：数据库名称。
- callback：指定callback回调函数。如果数据库已删除，则为true；否则返回false。 | +|deleteRdbStore(name: string, callback: AsyncCallback<void>): void | 删除数据库，结果以callback形式返回。
- name：数据库名称。
- callback：指定callback回调函数。 | | deleteRdbStore(name: string): Promise<void> | 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。
- name：数据库名称。 | ### 数据库的增删改查 diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md index d05356f6b8..c4b2c0992f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-ability.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-ability.md @@ -729,8 +729,31 @@ groupBy(fields: Array<string>): DataAbilityPredicates predicates.groupBy(["AGE", "NAME"]) ``` +### indexedBy +indexedBy(field: string): DataAbilityPredicates + + +配置谓词以指定索引列。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | indexName | string | 是 | 索引列的名称。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [DataAbilityPredicates](#dataabilitypredicates) | 返回具有指定索引列的谓词。 | + +- 示例： + ``` + let predicates = new dataAbility.DataAbilityPredicates("EMPLOYEE") + predicates.indexedBy("SALARY_INDEX") + ``` + ### in diff --git a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md index df3026dea8..e456f07f9d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md +++ b/zh-cn/application-dev/reference/apis/js-apis-data-rdb.md @@ -14,7 +14,7 @@ import data_rdb from '@ohos.data.rdb' ## data_rdb.getRdbStore -getRdbStore(context?: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void +getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。 @@ -57,7 +57,7 @@ export default class MainAbility extends Ability { ## data_rdb.getRdbStore -getRdbStore(context?: Context, config: StoreConfig, version: number): Promise<RdbStore> +getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。 @@ -120,7 +120,7 @@ export default class MainAbility extends Ability { ## data_rdb.deleteRdbStore -deleteRdbStore(context?: Context, name: string, callback: AsyncCallback<void>): void +deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void 删除数据库，结果以callback形式返回。 @@ -131,7 +131,7 @@ deleteRdbStore(context?: Context, name: string, callback: AsyncCallback<void& | -------- | -------- | -------- | -------- | | context8+ | Context | 否 | 应用程序或功能的上下文 | | name | string | 是 | 数据库名称。 | -| callback | AsyncCallback<void> | 是 | 指定callback回调函数。如果数据库已删除，则为true；否则返回false。 | +| callback | AsyncCallback<void> | 是 | 指定callback回调函数。 | **示例**： ``` @@ -155,7 +155,7 @@ export default class MainAbility extends Ability { ## data_rdb.deleteRdbStore -deleteRdbStore(context?: Context, name: string): Promise<void> +deleteRdbStore(context: Context, name: string): Promise<void> 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 @@ -170,7 +170,7 @@ deleteRdbStore(context?: Context, name: string): Promise<void> **返回值**： | 类型 | 说明 | | -------- | -------- | -| Promise<void> | 指定Promise回调函数。如果数据库已删除，则为true；否则返回false。 | +| Promise<void> | 指定Promise回调函数。 | **示例**： ``` -- GitLab