7111bcf5f4
* Fix the bug and update tests * update api docs * Fix tests # Conflicts: # api_docs/charts.mdx # api_docs/data.json # api_docs/data.mdx # api_docs/data_autocomplete.mdx # api_docs/data_field_formats.mdx # api_docs/data_index_patterns.mdx # api_docs/data_query.mdx # api_docs/data_search.json # api_docs/data_search.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/es_ui_shared.mdx # api_docs/fleet.mdx # api_docs/reporting.json # api_docs/rule_registry.mdx # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/visualizations.mdx
95 lines
2.4 KiB
Plaintext
95 lines
2.4 KiB
Plaintext
---
|
|
id: kibDataPluginApi
|
|
slug: /kibana-dev-docs/dataPluginApi
|
|
title: data
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the data plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
|
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
|
|
---
|
|
import dataObj from './data.json';
|
|
|
|
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
|
|
|
|
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 3735 | 59 | 3217 | 52 |
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[dataObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[dataObj.client.start]}/>
|
|
|
|
### Objects
|
|
<DocDefinitionList data={dataObj.client.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={dataObj.client.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={dataObj.client.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={dataObj.client.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={dataObj.client.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={dataObj.client.misc}/>
|
|
|
|
## Server
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[dataObj.server.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[dataObj.server.start]}/>
|
|
|
|
### Objects
|
|
<DocDefinitionList data={dataObj.server.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={dataObj.server.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={dataObj.server.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={dataObj.server.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={dataObj.server.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={dataObj.server.misc}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={dataObj.common.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={dataObj.common.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={dataObj.common.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={dataObj.common.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={dataObj.common.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={dataObj.common.misc}/>
|
|
|