Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 e6859895 编写于 作者: W wuyongning
浏览文件
操作

update js-apis-data-rdb.md 

Signed-off-by: Nwuyongning <wuyongning@huawei.com>
上级 6ca257ac
显示空白变更内容
内联 并排
Showing with 58 addition and 126 deletion
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @ e6859895
...@@ -33,18 +33,16 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;Rdb ...@@ -33,18 +33,16 @@ getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback&lt;Rdb
const STORE_CONFIG = { name: "RdbTest.db"} const STORE_CONFIG = { name: "RdbTest.db"}
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
data_rdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) { data_rdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) {
rdbStore.executeSql(SQL_CREATE_TABLE, null, funtion() { rdbStore.executeSql(SQL_CREATE_TABLE, null, function() {
console.info('create table done.') console.info('create table done.')
}) })
}) })
``` ```
## data_rdb.getRdbStore
getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
## data_rdb.getRdbStore<sup>8+</sup> 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。
getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback&lt;RdbStore&gt;): void
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
...@@ -52,45 +50,39 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As ...@@ -52,45 +50,39 @@ getRdbStore(context: Context, config: StoreConfig, version: number, callback: As
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-service-extension-context.md)。|
| config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。 | | version | number | 是 | 数据库版本。 |
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回一个RdbStore。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | 指定Promise回调函数。返回一个RdbStore。 |
**示例**： **示例**：
```js ```js
const STORE_CONFIG = { name: "RdbTest.db"} const STORE_CONFIG = { name: "RdbTest.db" }
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) { let promisegetRdb = data_rdb.getRdbStore(STORE_CONFIG, 1);
rdbStore.executeSql(SQL_CREATE_TABLE, null, funtion() { promisegetRdb.then(async (rdbStore) => {
console.info('create table done.') let promiseExecSql = rdbStore.executeSql(SQL_CREATE_TABLE, null)
promiseExecSql.then(() => {
console.info('executeSql creat done.')
}).catch((err) => {
console.log("executeSql creat err.")
}) })
}).catch((err) => {
console.log("getRdbStore err.")
}) })
``` ```
<<<<<<< HEAD
=======
API 9的示例请参考如下代码：
```ts ## data_rdb.getRdbStore<sup>8+</sup>
export default class MainAbility extends Ability {
const STORE_CONFIG = { name: "RdbTest.db"}
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {
rdbStore.executeSql(SQL_CREATE_TABLE, null, funtion() {
console.info('create table done.')
})
})
}
```
>>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md)
## data_rdb.getRdbStore
getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt; getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback&lt;RdbStore&gt;): void
获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以Promise形式返回。 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
...@@ -98,35 +90,23 @@ getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt; ...@@ -98,35 +90,23 @@ getRdbStore(config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-ability-context.md)。|
| config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。 | | version | number | 是 | 数据库版本。 |
| callback | AsyncCallback&lt;[RdbStore](#rdbstore)&gt; | 是 | 指定callback回调函数，返回一个RdbStore。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[RdbStore](#rdbstore)&gt; | 指定Promise回调函数。返回一个RdbStore。 |
**示例**： **示例**：
```js ```js
const STORE_CONFIG = { name: "RdbTest.db" } const STORE_CONFIG = { name: "RdbTest.db"}
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
let promisegetRdb = data_rdb.getRdbStore(STORE_CONFIG, 1); data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {
promisegetRdb.then(async (rdbStore) => { rdbStore.executeSql(SQL_CREATE_TABLE, null, function() {
let promiseExecSql = rdbStore.executeSql(SQL_CREATE_TABLE, null) console.info('create table done.')
promiseExecSql.then(() => {
console.info('executeSql creat done.')
}).catch((err) => {
console.log("executeSql creat err.")
}) })
}).catch((err) => {
console.log("getRdbStore err.")
}) })
``` ```
<<<<<<< HEAD
=======
## data_rdb.getRdbStore<sup>8+</sup> ## data_rdb.getRdbStore<sup>8+</sup>
getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;RdbStore&gt; getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;RdbStore&gt;
...@@ -139,7 +119,7 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt; ...@@ -139,7 +119,7 @@ getRdbStore(context: Context, config: StoreConfig, version: number): Promise&lt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-service-extension-context.md)。 | | context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-ability-context.md)。 |
| config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 | | config | [StoreConfig](#storeconfig) | 是 | 与此RDB存储相关的数据库配置。 |
| version | number | 是 | 数据库版本。 | | version | number | 是 | 数据库版本。 |
...@@ -167,26 +147,6 @@ promisegetRdb.then(async (rdbStore) => { ...@@ -167,26 +147,6 @@ promisegetRdb.then(async (rdbStore) => {
}) })
``` ```
API 9的示例请参考如下代码：
```ts
export default class MainAbility extends Ability {
const STORE_CONFIG = { name: "RdbTest.db" }
const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)"
let promisegetRdb = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1);
promisegetRdb.then(async (rdbStore) => {
let promiseExecSql = rdbStore.executeSql(SQL_CREATE_TABLE, null)
promiseExecSql.then(() => {
console.info('executeSql creat done.')
}).catch((err) => {
console.log("executeSql creat err.")
})
}).catch((err) => {
console.log("getRdbStore err.")
})
}
```
>>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md)
## data_rdb.deleteRdbStore ## data_rdb.deleteRdbStore
deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void
...@@ -207,66 +167,53 @@ deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -207,66 +167,53 @@ deleteRdbStore(name: string, callback: AsyncCallback&lt;void&gt;): void
console.info('delete store done.') console.info('delete store done.')
}) })
``` ```
## data_rdb.deleteRdbStore
## data_rdb.deleteRdbStore<sup>8+</sup> deleteRdbStore(name: string): Promise&lt;void&gt;
deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void
删除数据库，结果以callback形式返回。 使用指定的数据库文件配置删除数据库，结果以Promise形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数**： **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-service-extension-context.md)。|
| name | string | 是 | 数据库名称。 | | name | string | 是 | 数据库名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 |
**示例**： **示例**：
```js ```js
data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db")
promisedeleteRdb.then(()=>{
console.info('delete store done.') console.info('delete store done.')
}).catch((err) => {
console.log("deleteRdbStore err.")
}) })
``` ```
<<<<<<< HEAD ## data_rdb.deleteRdbStore<sup>8+</sup>
=======
API 9的示例请参考如下代码：
```ts
export default class MainAbility extends Ability {
data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {
console.info('delete store done.')
})
}
```
>>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md)
## data_rdb.deleteRdbStore
deleteRdbStore(name: string): Promise&lt;void&gt; deleteRdbStore(context: Context, name: string, callback: AsyncCallback&lt;void&gt;): void
使用指定的数据库文件配置删除数据库，结果以Promise形式返回。 删除数据库，结果以callback形式返回。
**系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。 **系统能力**：SystemCapability.DistributedDataManager.RelationalStore.Core。
**参数** **参数**：
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-ability-context.md)。|
| name | string | 是 | 数据库名称。 | | name | string | 是 | 数据库名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
**返回值**：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 |
**示例**： **示例**：
```js ```js
let promisedeleteRdb = data_rdb.deleteRdbStore("RdbTest.db") data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {
promisedeleteRdb.then(()=>{
console.info('delete store done.') console.info('delete store done.')
}).catch((err) => {
console.log("deleteRdbStore err.")
}) })
``` ```
...@@ -281,7 +228,7 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt; ...@@ -281,7 +228,7 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-service-extension-context.md)。| | context<sup>8+</sup> | Context | 是 | 应用程序或功能的上下文 <br>API version 8的Context定义见[Context](js-apis-Context.md)。<br>API version 9的Context定义见[Context](js-apis-ability-context.md)。|
| name | string | 是 | 数据库名称。 | | name | string | 是 | 数据库名称。 |
**返回值**： **返回值**：
...@@ -299,22 +246,7 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt; ...@@ -299,22 +246,7 @@ deleteRdbStore(context: Context, name: string): Promise&lt;void&gt;
}) })
``` ```
<<<<<<< HEAD
=======
API 9的示例请参考如下代码：
```ts
export default class MainAbility extends Ability {
let promisedeleteRdb = data_rdb.deleteRdbStore(this.context, "RdbTest.db")
promisedeleteRdb.then(()=>{
console.info('delete store done.')
}).catch((err) => {
console.log("deleteRdbStore err.")
})
}
```
>>>>>>> 07c8f8b4 (modify js-apis-data-rdb.md)
## RdbPredicates ## RdbPredicates
表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。 表示关系型数据库（RDB）的谓词。该类确定RDB中条件表达式的值是true还是false。
...@@ -361,7 +293,7 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates ...@@ -361,7 +293,7 @@ inDevices(devices: Array&lt;string&gt;): RdbPredicates
**示例**： **示例**：
```js ```js
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicate.inDevices(['12345678abcde']) predicates.inDevices(['12345678abcde'])
``` ```
### inAllDevices<sup>8+</sup> ### inAllDevices<sup>8+</sup>
...@@ -1225,7 +1157,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba ...@@ -1225,7 +1157,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallba
let predicates = new data_rdb.RdbPredicates("EMPLOYEE") let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
rdbStore.update(valueBucket, predicates, function (err, ret) { rdbStore.update(valueBucket, predicates, function (err, ret) {
console.log("updated row count: " + changedRows)}) console.log("updated row count: " + ret)})
``` ```
...@@ -1260,7 +1192,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise&lt;number&gt; ...@@ -1260,7 +1192,7 @@ update(values: ValuesBucket, rdbPredicates: RdbPredicates):Promise&lt;number&gt;
predicates.equalTo("NAME", "Lisa") predicates.equalTo("NAME", "Lisa")
let promiseupdate = rdbStore.update(valueBucket, predicates) let promiseupdate = rdbStore.update(valueBucket, predicates)
promiseupdate.then(async (ret) => { promiseupdate.then(async (ret) => {
console.log("updated row count: " + changedRows) console.log("updated row count: " + ret)
}).catch((err) => { }).catch((err) => {
console.log("update err.") console.log("update err.")
}) })
...@@ -1764,7 +1696,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1764,7 +1696,7 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
```js ```js
function storeObserver(devices) { function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) { for (let i = 0; i < devices.length; i++) {
console.log('device=' + device[i] + ' data changed') console.log('device=' + devices[i] + ' data changed')
} }
} }
try { try {
...@@ -1795,7 +1727,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri ...@@ -1795,7 +1727,7 @@ off(event:'dataChange', type: SubscribeType, observer: Callback&lt;Array&lt;stri
```js ```js
function storeObserver(devices) { function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) { for (let i = 0; i < devices.length; i++) {
console.log('device=' + device[i] + ' data changed') console.log('device=' + devices[i] + ' data changed')
} }
} }
try { try {
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或