# DataShareExtensionAbility

**DataShareExtensionAbility**基于ExtensionAbility框架，提供支持数据共享业务的能力。

>**说明：** 
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>本模块接口均为系统接口，三方应用不支持调用。


## 导入模块

```ts
import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbility'
```

## onCreate

onCreate?(want: Want, callback: AsyncCallback<void>): void

DataShare客户端连接DataShareExtensionAbility服务端时，服务端回调此接口，执行初始化业务逻辑操作。该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| want | [Want](js-apis-application-Want.md#want) | 是  | Want类型信息，包括ability名称、bundle名称等。 |
| callback | AsyncCallback<void> | 是 | 回调函数。无返回值。 |

**示例：**

```ts
import rdb from '@ohos.data.rdb';

let DB_NAME = "DB00.db";
let TBL_NAME = "TBL00";
let DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS "
+ TBL_NAME
+ " (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, phoneNumber DOUBLE, isStudent BOOLEAN, Binary BINARY)";
let rdbStore;

onCreate(want: Want, callback: AsyncCallback<void>) {
    rdb.getRdbStore(this.context, {
        name: DB_NAME
    }, 1, function (err, data) {
        console.log('getRdbStore done, data : ' + data);
        rdbStore = data;
        rdbStore.executeSql(DDL_TBL_CREATE, [], function (err) {
            console.log('executeSql done, error message : ' + err);
        });
        callback();
    });
}
```

## insert

insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void

在数据库插入时回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri |string | 是  | 指示要插入的数据的路径。 |
| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。 |
| callback |AsyncCallback<number> | 是 | 回调函数。返回插入数据记录的索引。 |

**示例：**

```ts
insert(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>) {
    if (value == null) {
        console.info('invalid valueBuckets');
        return;
    }
    rdbStore.insert(TBL_NAME, value, function (err, ret) {
        console.info('callback ret:' + ret);
        if (callback != undefined) {
            callback(err, ret);
        }
    });
}
```

## update

update?(uri: string, predicates: DataSharePredicates, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void

在数据库更新时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是  | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是  | 指示筛选条件。 |
| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback<number> | 是 | 回调函数。返回更新的数据记录数。 |

**示例：**

```ts
update(uri: string, predicates: DataSharePredicates, valueBucket: ValuesBucket, callback: AsyncCallback<number>) {
    if (predicates == null || predicates == undefined) {
        return;
    }
    rdbStore.update(TBL_NAME, value, predicates, function (err, ret) {
        if (callback != undefined) {
            callback(err, ret);
        }
    });
}
```

## query

query?(uri: string, predicates: DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>): void

在查询数据库时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是  | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是  | 指示筛选条件。 |
| columns | Array<string> | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| callback | AsyncCallback<Object> | 是 | 回调函数。返回查询到的结果集。 |

**示例：**

```ts
query(uri: string, predicates: DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>) {
    if (predicates == null || predicates == undefined) {
        return;
    }
    rdbStore.query(TBL_NAME, predicates, columns, function (err, resultSet) {
        if (resultSet != undefined) {
            console.info('resultSet.rowCount: ' + resultSet.rowCount);
        }
        if (callback != undefined) {
            callback(err, resultSet);
        }
    });
}
```

## delete

delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback<number>): void

在删除数据库记录时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称       | 参数类型                                                     | 必填 | 说明                               |
| ---------- | ------------------------------------------------------------ | ---- | ---------------------------------- |
| uri        | string                                                       | 是   | 指示要删除的数据的路径。           |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。                     |
| callback   | AsyncCallback<number>                                  | 是   | 回调函数。返回已删除的数据记录数。 |

**示例：**

```ts
delete(uri: string, predicates: DataSharePredicates, callback: AsyncCallback<number>) {
    if (predicates == null || predicates == undefined) {
        return;
    }
    rdbStore.delete(TBL_NAME, predicates, function (err, ret) {
        if (callback != undefined) {
            callback(err, ret);
        }
    });
}
```

## BatchInsert

BatchInsert?(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>): void

在数据库批量插入时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称         | 参数类型                                                     | 必填 | 说明                             |
| ------------ | ------------------------------------------------------------ | ---- | -------------------------------- |
| uri          | string                                                       | 是   | 指示要批量插入的数据的路径。     |
| valueBuckets | Array<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | 是   | 指示要批量插入的数据。           |
| callback     | AsyncCallback<number>                                  | 是   | 回调函数。返回插入的数据记录数。 |

**示例：**

```ts
batchInsert(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>) {
    if (valueBuckets == null || valueBuckets.length == undefined) {
        console.info('invalid valueBuckets');
        return;
    }
    let resultNum = valueBuckets.length
    valueBuckets.forEach(vb => {
        rdbStore.insert(TBL_NAME, vb, function (err, ret) {
            if (callback != undefined) {
                callback(err, resultNum);
            }
        });
    });
}
```

## getType

getType?(uri: string, callback: AsyncCallback<string>): void

获取给定URI对应的MIME类型时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是  | 指示要获取MIME类型的数据的路径。 |
| callback | AsyncCallback<string> | 是 | 回调函数。返回与URI指定的数据匹配的MIME类型。 |

**示例：**

```ts
getType(uri: string, callback: AsyncCallback<string>) {
    let err = {"code":0};
    let ret = "image";
    callback(err, ret);
}
```

## getFileTypes

getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>): void

获取支持文件的MIME类型时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称           | 类型                                     | 必填 | 描述                               |
| -------------- | ---------------------------------------- | ---- | ---------------------------------- |
| uri            | string                                   | 是   | 指示要获取的文件的路径。           |
| mimeTypeFilter | string                                   | 是   | 指示要获取的文件的MIME类型。       |
| callback       | AsyncCallback<Array<string>> | 是   | 回调函数。返回匹配的MIME类型数组。 |

**示例：**

```ts
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>) {
    let err = {"code":0};
    let ret = new Array("type01", "type02", "type03");
    callback(err, ret);
}
```

## normalizeUri

normalizeUri?(uri: string, callback: AsyncCallback<string>): void

用户给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称     | 类型                  | 必填 | 描述                    |
| -------- | --------------------- | ---- | ----------------------- |
| uri      | string                | 是   | 指示用户传入的URI。 |
| callback | AsyncCallback<string> | 是   | 回调函数。如果支持URI规范化，则返回规范化URI，否则返回空。 |

**示例：**

```ts
normalizeUri(uri: string, callback: AsyncCallback<string>) {
    let err = {"code":0};
    let ret = "normalize+" + uri;
    callback(err, ret);
}
```

## denormalizeUri

denormalizeUri?(uri: string, callback: AsyncCallback<string>): void

服务端使用的URI转换为用户传入的初始URI时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称     | 类型                  | 必填 | 描述                    |
| -------- | --------------------- | ---- | ----------------------- |
| uri      | string                | 是   | 指示服务端使用的uri。 |
| callback | AsyncCallback<string> | 是   | 回调函数。如果反规范化成功，则返回反规范化的URI；如果无需进行反规范化，则返回原始URI；若不支持则返回空。 |

**示例：**

```ts
denormalizeUri(uri: string, callback: AsyncCallback<string>) {
    let err = {"code":0};
	let ret = "denormalize+" + uri;
	callback(err, ret);
}
```

## openFile

openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void

在打开文件时服务端回调此接口，该方法可以选择性重写。

**系统能力：**  SystemCapability.DistributedDataManager.DataShare.Provider

**参数：**

| 名称     | 类型                  | 必填 | 描述                                       |
| -------- | --------------------- | ---- | ------------------------------------------ |
| uri      | string                | 是   | 指示要打开的文件的路径。        |
| mode     | string                | 是   | 指示文件打开模式，包括只读模式，读写模式。 |
| callback | AsyncCallback<number> | 是   | 回调函数。返回文件描述符。        |

**示例：**

```ts
openFile(uri: string, mode: string, callback: AsyncCallback<number>) {
    let err = {"code":0};
    let fd = 0;
    callback(err,fd);
}
```