harmony 鸿蒙Accessing a DataAbility

  • 2023-02-03
  • 浏览 (1057)

Accessing a DataAbility

To access a DataAbility, import the basic dependency packages and obtain the URI string for communicating with the DataAbility.

The basic dependency packages include:

  • @ohos.ability.featureAbility

  • @ohos.data.dataAbility

The sample code for accessing a DataAbility is as follows:

  1. Create a DataAbilityHelper instance.

    import featureAbility from '@ohos.ability.featureAbility';
import ohos_data_ability from '@ohos.data.dataAbility';
import ability from '@ohos.ability.ability';
// Different from the URI defined in the config.json file, the URI passed in the parameter has an extra slash (/), three slashes in total.
let uri: string = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
let DAHelper: ability.DataAbilityHelper = featureAbility.acquireDataAbilityHelper(uri);

  2. Construct RDB data.

    import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
let valuesBucket_insert: rdb.ValuesBucket = { name: 'Rose', introduction: 'insert' };
let valuesBucket_update: rdb.ValuesBucket = { name: 'Rose', introduction: 'update' };
let crowd = new Array({ name: 'Rose', introduction: 'batchInsert_one' } as rdb.ValuesBucket,
  { name: 'Rose', introduction: 'batchInsert_two' } as rdb.ValuesBucket);
let columnArray = new Array('id', 'name', 'introduction');
let predicates = new ohos_data_ability.DataAbilityPredicates();

    For details about DataAbilityPredicates, see DataAbility Predicates.

  3. Use insert to insert data to the DataAbility.

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';


// Callback mode:
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private valuesBucket_insert: rdb.ValuesBucket = { name: 'Rose', introduction: 'insert' };
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Callback mode:
              this.DAHelper.insert(this.uri, this.valuesBucket_insert, (error: BusinessError, data: number) => {
                if (error && error.code !== 0) {
                  promptAction.showToast({
                    message: 'insert_failed_toast'
                  });
                } else {
                  promptAction.showToast({
                    message: 'insert_success_toast'
                  });
                }
                hilog.info(domain, TAG, 'DAHelper insert result: ' + data + ', error: ' + JSON.stringify(error));
              }
              );
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private valuesBucket_insert: rdb.ValuesBucket = { name: 'Rose', introduction: 'insert' };
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Promise mode (await needs to be used in the asynchronous method):
              this.DAHelper.insert(this.uri, this.valuesBucket_insert).then((datainsert) => {
                promptAction.showToast({
                  message: 'insert_success_toast'
                });
                hilog.info(domain, TAG, 'DAHelper insert result: ' + datainsert);
              }).catch((error: BusinessError) => {
                promptAction.showToast({
                  message: 'insert_failed_toast'
                });
                hilog.error(domain, TAG, `DAHelper insert failed. Cause: ${error.message}`);
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

  4. Use delete to delete data from the DataAbility.

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Callback mode:
              this.DAHelper.delete(this.uri, this.predicates, (error, data) => {
                if (error && error.code !== 0) {
                  promptAction.showToast({
                    message: 'delete_failed_toast'
                  });
                } else {
                  promptAction.showToast({
                    message: 'delete_success_toast'
                  });
                }
                hilog.info(domain, TAG, 'DAHelper delete result: ' + data + ', error: ' + JSON.stringify(error));
              }
              );
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Promise mode (await needs to be used in the asynchronous method):
              this.DAHelper.delete(this.uri, this.predicates).then((datadelete) => {
                promptAction.showToast({
                  message: 'delete_success_toast'
                });
                hilog.info(domain, TAG, 'DAHelper delete result: ' + datadelete);
              }).catch((error: BusinessError) => {
                promptAction.showToast({
                  message: 'delete_failed_toast'
                });
                hilog.error(domain, TAG, `DAHelper delete failed. Cause: ${error.message}`);
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

  5. Use update to update data in the DataAbility.

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private valuesBucket_update: rdb.ValuesBucket = { name: 'Rose', introduction: 'update' };
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Callback mode:
              this.predicates.equalTo('name', 'Rose');
              this.DAHelper.update(this.uri, this.valuesBucket_update, this.predicates, (error, data) => {
                if (error && error.code !== 0) {
                  promptAction.showToast({
                    message: 'update_failed_toast'
                  });
                } else {
                  promptAction.showToast({
                    message: 'update_success_toast'
                  });
                }
                hilog.info(domain, TAG, 'DAHelper update result: ' + data + ', error: ' + JSON.stringify(error));
              }
              );
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private valuesBucket_update: rdb.ValuesBucket = { name: 'Rose', introduction: 'update' };
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Promise mode (await needs to be used in the asynchronous method):
              this.predicates.equalTo('name', 'Rose');
              this.DAHelper.update(this.uri, this.valuesBucket_update, this.predicates).then((dataupdate) => {
                promptAction.showToast({
                  message: 'update_success_toast'
                });
                hilog.info(domain, TAG, 'DAHelper update result: ' + dataupdate);
              }).catch((error: BusinessError) => {
                promptAction.showToast({
                  message: 'update_failed_toast'
                });
                hilog.error(domain, TAG, `DAHelper update failed. Cause: ${error.message}`);
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

  6. Use query to query data in the DataAbility.

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private columnArray = new Array('id', 'name', 'introduction');
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Callback mode:
              this.predicates.equalTo('name', 'Rose');
              this.DAHelper.query(this.uri, this.columnArray, this.predicates, (error, data) => {
                if (error && error.code !== 0) {
                  promptAction.showToast({
                    message: 'query_failed_toast'
                  });
                  hilog.error(domain, TAG, `DAHelper query failed. Cause: ${error.message}`);
                } else {
                  promptAction.showToast({
                    message: 'query_success_toast'
                  });
                }
                // ResultSet is a cursor of a data set. By default, the cursor points to the -1st record. Valid data starts from 0.
                while (data.goToNextRow()) {
                  const id = data.getLong(data.getColumnIndex('id'));
                  const name = data.getString(data.getColumnIndex('name'));
                  const introduction = data.getString(data.getColumnIndex('introduction'));
                  hilog.info(domain, TAG, `DAHelper query result:id = [${id}], name = [${name}], introduction = [${introduction}]`);
                }
                // Release the data set memory.
                data.close();
              }
              );
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private columnArray = new Array('id', 'name', 'introduction');
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Promise mode (await needs to be used in the asynchronous method):
              this.predicates.equalTo('name', 'Rose');
              this.DAHelper.query(this.uri, this.columnArray, this.predicates).then((dataquery) => {
                promptAction.showToast({
                  message: 'query_success_toast'
                });
                // ResultSet is a cursor of a data set. By default, the cursor points to the -1st record. Valid data starts from 0.
                while (dataquery.goToNextRow()) {
                  const id = dataquery.getLong(dataquery.getColumnIndex('id'));
                  const name = dataquery.getString(dataquery.getColumnIndex('name'));
                  const introduction = dataquery.getString(dataquery.getColumnIndex('introduction'));
                  hilog.info(domain, TAG, `DAHelper query result:id = [${id}], name = [${name}], introduction = [${introduction}]`);
                }
                // Release the data set memory.
                dataquery.close();
              }).catch((error: BusinessError) => {
                promptAction.showToast({
                  message: 'query_failed_toast'
                });
                hilog.error(domain, TAG, `DAHelper query failed. Cause: ${error.message}`);
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

  7. Use batchInsert to insert data in batches to the DataAbility.

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private crowd = new Array({ name: 'Rose', introduction: 'batchInsert_one' } as rdb.ValuesBucket,
    { name: 'Rose', introduction: 'batchInsert_two' } as rdb.ValuesBucket);
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Callback mode:
              this.DAHelper.batchInsert(this.uri, this.crowd, (error, data) => {
                if (error && error.code !== 0) {
                  promptAction.showToast({
                    message: 'batchInsert_failed_toast'
                  });
                } else {
                  promptAction.showToast({
                    message: 'batchInsert_success_toast'
                  });
                }
                hilog.info(domain, TAG, 'DAHelper batchInsert result: ' + data + ', error: ' + JSON.stringify(error));
              }
              );
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private crowd = new Array({ name: 'Rose', introduction: 'batchInsert_one' } as rdb.ValuesBucket,
    { name: 'Rose', introduction: 'batchInsert_two' } as rdb.ValuesBucket);
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Promise mode (await needs to be used in the asynchronous method):
              this.DAHelper.batchInsert(this.uri, this.crowd).then((databatchInsert) => {
                promptAction.showToast({
                  message: 'batchInsert_success_toast'
                });
                hilog.info(domain, TAG, 'DAHelper batchInsert result: ' + databatchInsert);
              }).catch((error: BusinessError) => {
                promptAction.showToast({
                  message: 'batchInsert_failed_toast'
                });
                hilog.error(domain, TAG, `DAHelper batchInsert failed. Cause: ${error.message}`);
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

  8. Use executeBatch to process data in batches in the DataAbility.

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Callback mode:
              let operations: Array<ability.DataAbilityOperation> = [{
                uri: this.uri,
                type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
                valuesBucket: { name: 'Rose', introduction: 'executeBatch' },
                predicates: this.predicates,
                expectedCount: 0,
                predicatesBackReferences: undefined,
                interrupted: true,
              }];
              this.DAHelper.executeBatch(this.uri, operations, (error, data) => {
                if (error && error.code !== 0) {
                  promptAction.showToast({
                    message: 'executeBatch_failed_toast'
                  });
                } else {
                  promptAction.showToast({
                    message: 'executeBatch_success_toast'
                  });
                }
                hilog.info(domain, TAG, `DAHelper executeBatch, result: ` + JSON.stringify(data) + ', error: ' + JSON.stringify(error));
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
    }
  }

    import ability from '@ohos.ability.ability';
import featureAbility from '@ohos.ability.featureAbility';
import { BusinessError } from '@ohos.base';
import ohos_data_ability from '@ohos.data.dataAbility';
import rdb from '@ohos.data.rdb';
import promptAction from '@ohos.promptAction';
import hilog from '@ohos.hilog';


const TAG: string = 'PageDataAbility';
const domain: number = 0xFF00;


@Entry
@Component
struct PageDataAbility {
  private predicates = new ohos_data_ability.DataAbilityPredicates();
  private uri = 'dataability:///com.samples.famodelabilitydevelop.DataAbility';
  private DAHelper = featureAbility.acquireDataAbilityHelper(this.uri);


  build() {
    Column() {
      // ...
      List({ initialIndex: 0 }) {
        // ...
        ListItemGroup() {
          ListItem() {
            Flex({ justifyContent: FlexAlign.SpaceBetween, alignContent: FlexAlign.Center }) {
              // ...
            }
            .onClick(() => {
              // Promise mode (await needs to be used in the asynchronous method):
              let operations: Array<ability.DataAbilityOperation> = [{
                uri: this.uri,
                type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
                valuesBucket: { name: 'Rose', introduction: 'executeBatch' },
                predicates: this.predicates,
                expectedCount: 0,
                predicatesBackReferences: undefined,
                interrupted: true,
              }];
              this.DAHelper.executeBatch(this.uri, operations).then((dataquery) => {
                promptAction.showToast({
                  message: 'executeBatch_success_toast'
                });
                hilog.info(domain, TAG, 'DAHelper executeBatch result: ' + JSON.stringify(dataquery));
              }).catch((error: BusinessError) => {
                promptAction.showToast({
                  message: 'executeBatch_failed_toast'
                });
                hilog.error(domain, TAG, `DAHelper executeBatch failed. Cause: ${error.message}`);
              });
            })
          }
          // ...
        }
        // ...
      }
      // ...
    }
    // ...
  }
}

The APIs for operating a DataAbility are provided by DataAbilityHelper. For details about the APIs, see DataAbilityHelper.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Ability Kit

harmony 鸿蒙Obtaining Reasons for Abnormal Application Exits

harmony 鸿蒙UIAbility Backup and Restore

harmony 鸿蒙Using Explicit Want to Start an Application Component

harmony 鸿蒙Introduction to Ability Kit

harmony 鸿蒙AbilityStage Component Container

harmony 鸿蒙Accessing a DataShareExtensionAbility from the FA Model

harmony 鸿蒙Common action and entities Values (Not Recommended)

harmony 鸿蒙API Switching Overview

harmony 鸿蒙Switching of app and deviceConfig

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/c611fb73a425402789e865f3811da412
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录