Interface (ResultSet)

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

ResultSet

提供通过查询数据库生成的数据库结果集的访问方法。结果集是指用户调用关系型数据库查询接口之后返回的结果集合，提供了多种灵活的数据访问方式，以便用户获取各项数据。

下列API示例中，都需先使用query、querySql、remoteQuery、queryLockedRow等query类方法中任一方法获取到ResultSet实例，再通过此实例调用对应方法。

属性

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

getColumnIndex

getColumnIndex(columnName: string): number

根据指定的列名获取列索引。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const id = (resultSet as relationalStore.ResultSet).getLong((resultSet as relationalStore.ResultSet).getColumnIndex("ID"));
  const name = (resultSet as relationalStore.ResultSet).getString((resultSet as relationalStore.ResultSet).getColumnIndex("NAME"));
  const age = (resultSet as relationalStore.ResultSet).getLong((resultSet as relationalStore.ResultSet).getColumnIndex("AGE"));
  const salary = (resultSet as relationalStore.ResultSet).getDouble((resultSet as relationalStore.ResultSet).getColumnIndex("SALARY"));
}

getColumnName

getColumnName(columnIndex: number): string

根据指定的列索引获取列名。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const id = (resultSet as relationalStore.ResultSet).getColumnName(0);
  const name = (resultSet as relationalStore.ResultSet).getColumnName(1);
  const age = (resultSet as relationalStore.ResultSet).getColumnName(2);
}

getColumnType¹⁸⁺

getColumnType(columnIdentifier: number|string): Promise<ColumnType>

根据指定的列索引或列名称获取列数据类型，使用Promise异步回调。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  let idType = await (resultSet as relationalStore.ResultSet).getColumnType("ID") as relationalStore.ColumnType;
  let nameType = await (resultSet as relationalStore.ResultSet).getColumnType("NAME") as relationalStore.ColumnType;
  let ageType = await (resultSet as relationalStore.ResultSet).getColumnType("AGE") as relationalStore.ColumnType;
  let salaryType = await (resultSet as relationalStore.ResultSet).getColumnType("SALARY") as relationalStore.ColumnType;
  let codesType = await (resultSet as relationalStore.ResultSet).getColumnType("CODES") as relationalStore.ColumnType;
  let identityType = await (resultSet as relationalStore.ResultSet).getColumnType(5) as relationalStore.ColumnType;
  let assetDataType = await (resultSet as relationalStore.ResultSet).getColumnType(6) as relationalStore.ColumnType;
  let assetsDataType = await (resultSet as relationalStore.ResultSet).getColumnType(7) as relationalStore.ColumnType;
  let floatArrayType = await (resultSet as relationalStore.ResultSet).getColumnType(8) as relationalStore.ColumnType;
}

getColumnTypeSync¹⁸⁺

getColumnTypeSync(columnIdentifier: number|string): ColumnType

根据指定的列索引或列名称获取列数据类型。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  let idType = (resultSet as relationalStore.ResultSet).getColumnTypeSync("ID") as relationalStore.ColumnType;
  let nameType = (resultSet as relationalStore.ResultSet).getColumnTypeSync("NAME") as relationalStore.ColumnType;
  let ageType = (resultSet as relationalStore.ResultSet).getColumnTypeSync("AGE") as relationalStore.ColumnType;
  let salaryType = (resultSet as relationalStore.ResultSet).getColumnTypeSync("SALARY") as relationalStore.ColumnType;
  let codesType = (resultSet as relationalStore.ResultSet).getColumnTypeSync("CODES") as relationalStore.ColumnType;
  let identityType = (resultSet as relationalStore.ResultSet).getColumnTypeSync(5) as relationalStore.ColumnType;
  let assetDataType = (resultSet as relationalStore.ResultSet).getColumnTypeSync(6) as relationalStore.ColumnType;
  let assetsDataType = (resultSet as relationalStore.ResultSet).getColumnTypeSync(7) as relationalStore.ColumnType;
  let floatArrayType = (resultSet as relationalStore.ResultSet).getColumnTypeSync(8) as relationalStore.ColumnType;
}

goTo

goTo(offset:number): boolean

指定相对当前结果集指针位置的偏移量，以移动结果集的指针位置。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).goTo(1);
}

goToRow

goToRow(position: number): boolean

转到结果集的指定行。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).goToRow(5);
}

goToFirstRow

goToFirstRow(): boolean

转到结果集的第一行。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

返回值：

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).goToFirstRow();
}

goToLastRow

goToLastRow(): boolean

转到结果集的最后一行。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

返回值：

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).goToLastRow();
}

goToNextRow

goToNextRow(): boolean

转到结果集的下一行。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

返回值：

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).goToNextRow();
}

goToPreviousRow

goToPreviousRow(): boolean

转到结果集的上一行。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

返回值：

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).goToPreviousRow();
}

getValue¹²⁺

getValue(columnIndex: number): ValueType

获取当前行中指定列的值，如果值类型是ValueType中指定的任意类型，返回指定类型的值，否则返回14800000。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const codes = (resultSet as relationalStore.ResultSet).getValue((resultSet as relationalStore.ResultSet).getColumnIndex("BIGINT_COLUMN"));
}

getBlob

getBlob(columnIndex: number): Uint8Array

以字节数组的形式获取当前行中指定列的值，如果当前列的数据类型为INTEGER、DOUBLE、TEXT、BLOB类型，会转成字节数组类型返回指定值，如果该列内容为空时，会返回空字节数组，其他类型则返回14800000。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const codes = (resultSet as relationalStore.ResultSet).getBlob((resultSet as relationalStore.ResultSet).getColumnIndex("CODES"));
}

getString

getString(columnIndex: number): string

以字符串形式获取当前行中指定列的值，如果当前列中的值为INTEGER、DOUBLE、TEXT、BLOB类型，会以字符串形式返回指定值，如果是当前列中的值为INTEGER，并且为空，则会返回空字符串”“，其他类型则返回14800000。如果当前列中的值为DOUBLE类型，可能存在精度的丢失，建议使用getDouble接口获取。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const name = (resultSet as relationalStore.ResultSet).getString((resultSet as relationalStore.ResultSet).getColumnIndex("NAME"));
}

getLong

getLong(columnIndex: number): number

以Long形式获取当前行中指定列的值，如果当前列的数据类型为INTEGER、DOUBLE、TEXT、BLOB类型，会转成Long类型返回指定值，如果该列内容为空时，会返回0，其他类型则返回14800000。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const age = (resultSet as relationalStore.ResultSet).getLong((resultSet as relationalStore.ResultSet).getColumnIndex("AGE"));
}

getDouble

getDouble(columnIndex: number): number

以double形式获取当前行中指定列的值，如果当前列的数据类型为INTEGER、DOUBLE、TEXT、BLOB类型，会转成double类型返回指定值，如果该列内容为空时，会返回0.0，其他类型则返回14800000。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const salary = (resultSet as relationalStore.ResultSet).getDouble((resultSet as relationalStore.ResultSet).getColumnIndex("SALARY"));
}

getAsset¹⁰⁺

getAsset(columnIndex: number): Asset

以Asset形式获取当前行中指定列的值，如果当前列的数据类型为Asset类型，会以Asset类型返回指定值，如果当前列中的值为null时，会返回null，其他类型则返回14800000。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const doc = (resultSet as relationalStore.ResultSet).getAsset((resultSet as relationalStore.ResultSet).getColumnIndex("DOC"));
}

getAssets¹⁰⁺

getAssets(columnIndex: number): Assets

以Assets形式获取当前行中指定列的值，如果当前列的数据类型为Assets类型，会以Assets类型返回指定值，如果当前列中的值为null时，会返回null，其他类型则返回14800000。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const docs = (resultSet as relationalStore.ResultSet).getAssets((resultSet as relationalStore.ResultSet).getColumnIndex("DOCS"));
}

getRow¹¹⁺

getRow(): ValuesBucket

获取当前行。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

返回值：

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const row = (resultSet as relationalStore.ResultSet).getRow();
}

getRows¹⁸⁺

getRows(maxCount: number, position?: number): Promise>

从结果集中获取指定数量的数据，使用Promise异步回调。禁止与ResultSet的其他接口并发调用，否则获取的数据可能非预期。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

// 以查到100条数据为例
async function proccessRows(resultSet: relationalStore.ResultSet) {
  // 示例1：仅指定maxCount
  if (resultSet != undefined) {
    let rows: Array<relationalStore.ValuesBucket>;
    let maxCount: number = 50;
    // 从结果集的当前行（默认首次获取数据时为当前结果集的第一行，后续为上次获取数据结束位置的下一行）开始获取数据
    // getRows会自动移动结果集当前行到上次getRows获取结束位置的下一行，无需使用goToFirstRow、goToNextRow等接口移动
    while ((rows = await (resultSet as relationalStore.ResultSet).getRows(maxCount)).length != 0) {
      console.info(JSON.stringify(rows[0]));
    }
  }

  // 示例2：指定maxCount和起始的position
  if (resultSet != undefined) {
    let rows: Array<relationalStore.ValuesBucket>;
    let maxCount: number = 50;
    let position: number = 50;
    while ((rows = await (resultSet as relationalStore.ResultSet).getRows(maxCount, position)).length != 0) {
      console.info(JSON.stringify(rows[0]));
      position += rows.length;
    }
  }
}

getSendableRow¹²⁺

getSendableRow(): sendableRelationalStore.ValuesBucket

获取当前行数据的sendable形式，用于跨线程传递。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

返回值：

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

import { window } from '@kit.ArkUI';
import { UIAbility } from '@kit.AbilityKit';
import { relationalStore } from '@kit.ArkData';
import { taskpool } from '@kit.ArkTS';
import type ctx from '@ohos.app.ability.common';
import { sendableRelationalStore } from '@kit.ArkData';

@Concurrent
async function getDataByName(name: string, context: ctx.UIAbilityContext) {
  const STORE_CONFIG: relationalStore.StoreConfig = {
    name: "RdbTest.db",
    securityLevel: relationalStore.SecurityLevel.S3
  };
  const store = await relationalStore.getRdbStore(context, STORE_CONFIG);
  const predicates = new relationalStore.RdbPredicates("EMPLOYEE");
  predicates.equalTo("NAME", name);
  const resultSet = store.querySync(predicates);

  if (resultSet.rowCount > 0) {
    resultSet.goToFirstRow();
    const sendableValuesBucket = resultSet.getSendableRow();
    return sendableValuesBucket;
  } else {
    return null;
  }
}

export default class EntryAbility extends UIAbility {
  async onWindowStageCreate(windowStage: window.WindowStage) {
    const task = new taskpool.Task(getDataByName, 'Lisa', this.context);
    const sendableValuesBucket = await taskpool.execute(task) as sendableRelationalStore.ValuesBucket;

    if (sendableValuesBucket) {
      const columnCount = sendableValuesBucket.size;
      const age = sendableValuesBucket.get('age');
      const name = sendableValuesBucket.get('name');
      console.info(`Query data in taskpool succeeded, name is "${name}", age is "${age}"`);
    }
  }
}

isColumnNull

isColumnNull(columnIndex: number): boolean

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

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见通用错误码和关系型数据库错误码。其中，14800011错误码处理可参考数据库备份与恢复。

示例：

if (resultSet != undefined) {
  const isColumnNull = (resultSet as relationalStore.ResultSet).isColumnNull((resultSet as relationalStore.ResultSet).getColumnIndex("CODES"));
}

close

close(): void

关闭结果集，若不关闭可能会引起fd泄露和内存泄露。

系统能力： SystemCapability.DistributedDataManager.RelationalStore.Core

示例：

if (resultSet != undefined) {
  (resultSet as relationalStore.ResultSet).close();
}

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkData（方舟数据管理）

harmony 鸿蒙Class (RdbPredicates)

harmony 鸿蒙arkts-apis-data-relationalStore-RdbStore

harmony 鸿蒙Interface (Transaction)

harmony 鸿蒙Enums

harmony 鸿蒙Functions

harmony 鸿蒙Interfaces (其他)

harmony 鸿蒙Types

harmony 鸿蒙模块描述

harmony 鸿蒙data_asset.h