Skip to content

data

The data plugin provides common data access services, such as search and query, for solutions and application developers.

Autocomplete

The autocomplete service provides suggestions for field names and values.

It is wired into the TopNavMenu component, but can be used independently.

Fetch Query Suggestions

The getQuerySuggestions function helps to construct a query. 


    // `inputValue` is the user input
    const querySuggestions = await autocomplete.getQuerySuggestions({
        language: 'kuery',
        indexPatterns: [indexPattern],
        query: inputValue,
    });

Fetch Value Suggestions

The getValueSuggestions function returns suggestions for field values. This is helpful when you want to provide a user with options, for example when constructing a filter. 


    // `inputValue` is the user input
    const valueSuggestions = await autocomplete.getValueSuggestions({
      indexPattern,
      field,
      query: inputValue,
    });

Field Formats

Coming soon.

Index Patterns

Coming soon.

Query

The query service is responsible for managing the configuration of a search query (QueryState): filters, time range, query string, and settings such as the auto refresh behavior and saved queries.

It contains sub-services for each of those configurations: - data.query.filterManager - Manages the filters component of a QueryState. The global filter state (filters that are persisted between applications) are owned by this service. - data.query.timefilter - Responsible for the time range filter and the auto refresh behavior settings. - data.query.queryString - Responsible for the query string and query language settings. - data.query.savedQueries - Responsible for persisting a QueryState into a SavedObject, so it can be restored and used by other applications.

Any changes to the QueryState are published on the data.query.state$, which is useful when wanting to persist global state or run a search upon data changes.

A simple use case is:

```.ts function searchOnChange(indexPattern: IndexPattern, aggConfigs: AggConfigs) { data.query.state$.subscribe(() => {

    // Constuct the query portion of the search request
    const query = data.query.getOpenSearchQuery(indexPattern);

    // Construct a request
    const request = {
        params: {
            index: indexPattern.title,
            body: {
                aggs: aggConfigs.toDsl(),
                query,
            },
        },
    };

    // Search with the `data.query` config
    const search$ = data.search.search(request);

    ...
});

}

```

Provides access to OpenSearch using the high-level SearchSource API or low-level Search Strategies.

SearchSource

The SearchSource API is a convenient way to construct and run an OpenSearch search query.


    const searchSource = await data.search.searchSource.create();
    const searchResponse = await searchSource
      .setParent(undefined)
      .setField('index', indexPattern)
      .setField('filter', filters)
      .fetch();

Default Search Strategy

One benefit of using the low-level search API, is partial response support in X-Pack, allowing for a better and more responsive user experience. In OSS only the final result is returned. 

    import { isCompleteResponse } from '../plugins/data/public';

    const search$ = data.search.search(request)
        .subscribe({
        next: (response) => {
            if (isCompleteResponse(response)) {
                // Final result
                search$.unsubscribe();
            } else {
                // Partial result - you can update the UI, but data is still loading
            }
        },
        error: (e: Error) => {
            // Show customized toast notifications. 
            // You may choose to handle errors differently if you prefer. 
            data.search.showError(e);
        },
    });