SearchAbility

java.lang.Object
- ohos.data.search.SearchAbility

```
public class SearchAbility
extends Object
```
Provides access to the search service.
The fusion search service provides the index and search capabilities. Applications can customize index attributes and index data structures.
This class provides methods for connecting to the fusion search service, setting the index attributes, adding, deleting, updating, and clearing indexes, listening to index changes, and obtaining search sessions.
Before using the fusion search service, an application must create a SearchAbility instance and call connect(ohos.data.search.connect.ServiceConnectCallback) to connect to the service. The application must call disconnect() to disconnect from the service to release resources.

从以下版本开始:

3

SystemCapability

SystemCapability.Data#DATA_SEARCH

构造器概要

构造器
构造器说明

SearchAbility(Context context)
A parameterized constructor used to create a SearchAbility instance.

构造器
构造器	说明
`SearchAbility(Context context)`	A parameterized constructor used to create a `SearchAbility` instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`SearchSession`	`beginSearch(String groupId, String bundleName)`	Starts a search session in the index library with a specified group ID and bundle name.
`int`	`clearIndex(String groupId, String bundleName, Map<String,List<String>> deviceIds)`	Clears indexes that match a device ID list from the index library with a specified bundle name and group ID.
`int`	`clearIndexForm(String bundleName)`	Clears the index attributes configured for a specified bundle name.
`boolean`	`connect(ServiceConnectCallback callback)`	Asynchronously connects to the fusion search service.
`List<IndexData>`	`delete(String groupId, String bundleName, List<IndexData> indexDataList)`	Deletes a list of indexes from the index library with a specified bundle name and group ID.
`int`	`deleteByQuery(String groupId, String bundleName, String queryJsonStr)`	Deletes indexes that match a specified query string from the index library with a specified bundle name and group ID.
`List<String>`	`deleteByTerm(String groupId, String bundleName, String indexFieldName, List<String> indexFieldValueList)`	Deletes indexes that match any given field value in a specified field from the index library with a specified bundle name and group ID.
`boolean`	`disconnect()`	Disconnects from the fusion search service.
`void`	`endSearch(String groupId, String bundleName, SearchSession searchSession)`	Ends a search session to release resources.
`List<IndexForm>`	`getIndexForm(String bundleName)`	Obtains the index attributes configured for a specified bundle name.
`int`	`getIndexFormVersion(String bundleName)`	Obtains the version of the index attributes configured for a specified bundle name.
`SearchableEntity`	`getSearchableEntity(String bundleName)`	Obtains the `SearchableEntity` of a specified search-source application.
`List<SearchableEntity>`	`getSearchableEntityList()`	Obtains the list of `SearchableEntity` objects that have been set.
`boolean`	`hasConnected()`	Checks whether the fusion search service is connected.
`List<IndexData>`	`insert(String groupId, String bundleName, List<IndexData> indexDataList)`	Inserts a list of indexes into the index library with a specified bundle name and group ID.
`void`	`registerIndexChangeListener(String groupId, String bundleName, IIndexChangeListener listener)`	Registers an index change listener.
`int`	`setIndexForm(String bundleName, int version, List<IndexForm> indexFormList)`	Sets index field attributes.
`int`	`setIndexForm(String bundleName, int version, List<IndexForm> indexFormList, IndexSchemaType schemaType)`	Sets index field attributes.
`SearchResult`	`setSearchableEntity(SearchableEntity searchableEntity)`	Sets a `SearchableEntity`.
`void`	`unRegisterIndexChangeListener(String groupId, String bundleName, IIndexChangeListener listener)`	Deregisters an index change listener.
`List<IndexData>`	`update(String groupId, String bundleName, List<IndexData> indexDataList)`	Updates a list of indexes in the index library with a specified bundle name and group ID.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SearchAbility
```
public SearchAbility(Context context)
```
    A parameterized constructor used to create a SearchAbility instance.
    To use the fusion search service, an application must instantiate the class and connect to the service.
    
    参数:
    
    context - Indicates the application context.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - connect
```
public boolean connect(ServiceConnectCallback callback)
```
    Asynchronously connects to the fusion search service.
    Before using the fusion search service, an application must call this method. After the connection is set up, the application receives a callback through the passed callback.
    
    参数:
    
    callback - Indicates the callback for receiving the connection status.
    
    返回:
    
    Returns true if the connection is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - disconnect
```
public boolean disconnect()
```
    Disconnects from the fusion search service.
    When an application does not need to use the fusion search service any longer, the application should call this method to disconnect from the service to release resources.
    
    返回:
    
    Returns true if the disconnection is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - hasConnected
```
public boolean hasConnected()
```
    Checks whether the fusion search service is connected.
    
    返回:
    
    Returns true if the service is connected; returns false otherwise.
    
    从以下版本开始:
    
    3
  - setIndexForm
```
public int setIndexForm(String bundleName,
                        int version,
                        List<IndexForm> indexFormList)
```
    Sets index field attributes.
    Index attributes must be set before an application performs indexing and search.
    
    参数:
    
    bundleName - Indicates the bundle name of the index library.
    
    version - Indicates the version of the index attribute. The initial value is 1. The value should be incremented each time an attribute is set.
    
    indexFormList - Indicates the index attribute list of index fields.
    
    返回:
    
    Returns SearchErrorCode#SUCCESS if the operation is successful; returns SearchErrorCode#FAIL otherwise.
    
    从以下版本开始:
    
    3
  - getIndexForm
```
public List<IndexForm> getIndexForm(String bundleName)
```
    Obtains the index attributes configured for a specified bundle name.
    
    参数:
    
    bundleName - Indicates the bundle name of the index library.
    
    返回:
    
    Returns the index attributes.
    
    从以下版本开始:
    
    3
  - getIndexFormVersion
```
public int getIndexFormVersion(String bundleName)
```
    Obtains the version of the index attributes configured for a specified bundle name.
    
    参数:
    
    bundleName - Indicates the bundle name of the index library.
    
    返回:
    
    Returns the version of the index attributes.
    
    从以下版本开始:
    
    3
  - clearIndexForm
```
public int clearIndexForm(String bundleName)
```
    Clears the index attributes configured for a specified bundle name.
    
    参数:
    
    bundleName - Indicates the bundle name of the index library.
    
    返回:
    
    Returns SearchErrorCode#SUCCESS if the operation is successful; returns SearchErrorCode#FAIL otherwise.
    
    从以下版本开始:
    
    3
  - insert
```
public List<IndexData> insert(String groupId,
                              String bundleName,
                              List<IndexData> indexDataList)
```
    Inserts a list of indexes into the index library with a specified bundle name and group ID.
    Use SearchParameter#DEFAULT_GROUP as the group ID when inserting local indexes. The list of indexes that fail to insert is returned. If all indexes are successfully inserted, an empty list is returned.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    indexDataList - Indicates the indexes to insert.
    
    返回:
    
    Returns the list of indexes that fail to insert; returns an empty list if all indexes are successfully inserted.
    
    从以下版本开始:
    
    3
  - update
```
public List<IndexData> update(String groupId,
                              String bundleName,
                              List<IndexData> indexDataList)
```
    Updates a list of indexes in the index library with a specified bundle name and group ID.
    Use SearchParameter#DEFAULT_GROUP as the group ID when updating local indexes. The list of indexes that fail to update is returned. If all indexes are successfully updated, an empty list is returned.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    indexDataList - Indicates the indexes to update.
    
    返回:
    
    Returns the list of indexes that fail to update; returns an empty list if all indexes are successfully updated.
    
    从以下版本开始:
    
    3
  - delete
```
public List<IndexData> delete(String groupId,
                              String bundleName,
                              List<IndexData> indexDataList)
```
    Deletes a list of indexes from the index library with a specified bundle name and group ID.
    Use SearchParameter#DEFAULT_GROUP as the group ID when deleting local indexes. The list of indexes that fail to delete is returned. If all indexes are successfully deleted, an empty list is returned.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    indexDataList - Indicates the indexes to delete.
    
    返回:
    
    Returns the list of indexes that fail to delete; returns an empty list if all indexes are successfully deleted.
    
    从以下版本开始:
    
    3
  - deleteByTerm
```
public List<String> deleteByTerm(String groupId,
                                 String bundleName,
                                 String indexFieldName,
                                 List<String> indexFieldValueList)
```
    Deletes indexes that match any given field value in a specified field from the index library with a specified bundle name and group ID.
    Use SearchParameter#DEFAULT_GROUP as the group ID when deleting local indexes. If any matched index fails to delete, the passed indexFieldValueList is returned. If all matched indexes are successfully deleted, an empty list is returned.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    indexFieldName - Indicates the index field name.
    
    indexFieldValueList - Indicates the index field value list.
    
    返回:
    
    Returns the passed indexFieldValueList if the deletion fails; returns an empty list otherwise.
    
    从以下版本开始:
    
    3
  - deleteByQuery
```
public int deleteByQuery(String groupId,
                         String bundleName,
                         String queryJsonStr)
```
    Deletes indexes that match a specified query string from the index library with a specified bundle name and group ID.
    Use SearchParameter#DEFAULT_GROUP as the group ID when deleting local indexes.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    queryJsonStr - Indicates the query string.
    
    返回:
    
    Returns SearchErrorCode#SUCCESS if the operation is successful; returns SearchErrorCode#FAIL otherwise.
    
    从以下版本开始:
    
    3
  - clearIndex
```
public int clearIndex(String groupId,
                      String bundleName,
                      Map<String,List<String>> deviceIds)
```
    Clears indexes that match a device ID list from the index library with a specified bundle name and group ID. If deviceIds is null, all indexes in the specified index library are cleared.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    deviceIds - Indicates the list of devices. For each key-value pair in deviceIds, the key is the field name of the device ID and the value is the list of device IDs for which indexes are to delete.
    
    返回:
    
    Returns SearchErrorCode#SUCCESS if the operation is successful; returns SearchErrorCode#FAIL otherwise.
    
    从以下版本开始:
    
    3
  - beginSearch
```
public SearchSession beginSearch(String groupId,
                                 String bundleName)
```
    Starts a search session in the index library with a specified group ID and bundle name.
    An application can use the returned search session to perform a search. Search sessions are thread-safe. If no index exists in the specified index library, null is returned. Therefore, the application should check whether the returned search session is null before using it. If the returned search session is not null, the application should call the endSearch method to release resources when the session is no longer needed.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    返回:
    
    Returns a search session if an index exists in the index library; returns null otherwise.
    
    从以下版本开始:
    
    3
  - endSearch
```
public void endSearch(String groupId,
                      String bundleName,
                      SearchSession searchSession)
```
    Ends a search session to release resources.
    When an application does not need to use a search session any longer, the application should call this method to release resources.
    Note: This method must be used each time the SearchAbility#beginSearch(String, String) method is called. Generally, the try-finally block is used.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    searchSession - Indicates the search session to end.
    
    从以下版本开始:
    
    3
  - registerIndexChangeListener
```
public void registerIndexChangeListener(String groupId,
                                        String bundleName,
                                        IIndexChangeListener listener)
```
    Registers an index change listener.
    Note: An application can listen for only index changes in its own bundle.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    listener - Indicates the index change callback.
    
    从以下版本开始:
    
    3
  - unRegisterIndexChangeListener
```
public void unRegisterIndexChangeListener(String groupId,
                                          String bundleName,
                                          IIndexChangeListener listener)
```
    Deregisters an index change listener. A deregistered listener no longer receives any change notification.
    Note: An application can listen for only index changes in its own bundle.
    
    参数:
    
    groupId - Indicates the group ID.
    
    bundleName - Indicates the bundle name of the index library.
    
    listener - Indicates the index change callback.
    
    从以下版本开始:
    
    3
  - setSearchableEntity
```
public SearchResult setSearchableEntity(SearchableEntity searchableEntity)
```
    Sets a SearchableEntity.
    This method is called by the search-source application. The search application can use the SearchableEntity to search indexes of the search-source application and display the search result for users.
    
    参数:
    
    searchableEntity - Indicates the SearchableEntity to set.
    
    返回:
    
    Returns SearchResult#SUCCESS if the setting is successful; returns SearchResult#FILE_RW_EXCEPTION if a file exception occurs; returns SearchResult#ILLEGAL_ARGUMENT if searchableEntity is invalid; returns SearchResult#PERMISSION_DENIED if the search-source application has no permission to set the SearchableEntity; returns SearchResult#IPC_EXCEPTION if an IPC exception occurs.
    
    从以下版本开始:
    
    3
  - getSearchableEntity
```
public SearchableEntity getSearchableEntity(String bundleName)
```
    Obtains the SearchableEntity of a specified search-source application.
    
    参数:
    
    bundleName - Indicates the bundle name of the search-source application.
    
    返回:
    
    Returns the SearchableEntity if obtained; returns null otherwise.
    
    从以下版本开始:
    
    3
  - getSearchableEntityList
```
public List<SearchableEntity> getSearchableEntityList()
```
    Obtains the list of SearchableEntity objects that have been set.
    
    返回:
    
    Returns the list of SearchableEntity objects.
    
    从以下版本开始:
    
    3
  - setIndexForm
```
public int setIndexForm(String bundleName,
                        int version,
                        List<IndexForm> indexFormList,
                        IndexSchemaType schemaType)
```
    Sets index field attributes.
    You must set index field attributes prior to indexing and search operations. Call this method when you need to set an index field attribute for the first time or update an index field attribute. Before calling this method, you can use the SearchAbility#getIndexFormVersion(String) method to check whether an index field attribute has been set for the application and whether the version of the index field attribute to set is incremented based on that of the previous index field attribute.
    参数:
    
    bundleName - Indicates the name of the index library, which is the application bundle name.
    
    version - Indicates the version of the index field attribute. The initial value is 1. The value should be incremented each time an attribute is set.
    indexFormList - Indicates the list of index field attributes. This parameter works with schemaType and its value could be any of the following:
    
    Empty list. Only index field attributes provided by a specified index schema type (defined by schemaType) are used.
    
    Custom index field attributes, which are used together with the index field attributes provided by a specified index schema type (defined by schemaType). IndexForm.isPrimaryKey cannot be set to true in any of the custom index attributes.
    
    (Not recommended) Only custom index field attributes. schemaType is set to IndexSchemaType#CUSTOM.
    schemaType - Indicates the index schema type, as described in schema.IndexSchemaType.
    
    返回:
    
    Returns SearchErrorCode#SUCCESS if the operation is successful; returns SearchErrorCode#FAIL otherwise.
    
    从以下版本开始:
    
    5

类 SearchAbility

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SearchAbility

方法详细资料

connect

disconnect

hasConnected

setIndexForm

getIndexForm

getIndexFormVersion

clearIndexForm

insert

update

delete

deleteByTerm

deleteByQuery

clearIndex

beginSearch

endSearch

registerIndexChangeListener

unRegisterIndexChangeListener

setSearchableEntity

getSearchableEntity

getSearchableEntityList

setIndexForm