Function reference • rOpenSci: elastic

elastic High level overview of package
`elastic`	elastic
`elastic-defunct`	Defunct functions in elastic
Connect
`connect()`	Set connection details to an Elasticsearch engine.
`ping()`	Ping an Elasticsearch server.
Cat
`cat_()` `cat_aliases()` `cat_allocation()` `cat_count()` `cat_segments()` `cat_health()` `cat_indices()` `cat_master()` `cat_nodes()` `cat_nodeattrs()` `cat_pending_tasks()` `cat_plugins()` `cat_recovery()` `cat_thread_pool()` `cat_shards()` `cat_fielddata()`	Use the cat Elasticsearch api.
Search Various search APIs
`Search()`	Full text search of Elasticsearch
`Search_template()` `Search_template_register()` `Search_template_get()` `Search_template_delete()` `Search_template_render()`	Search or validate templates
`Search_uri()`	Full text search of Elasticsearch with URI search
`search_shards()`	Search shards
`searchapis`	Overview of search functions
`msearch()`	Multi-search
`count()`	Get counts of the number of records per index.
`explain()`	Explain a search query.
`validate()`	Validate a search
`field_stats()`	Search field statistics
`field_caps()`	Field capabilities
`fielddata`	fielddata
`percolate_register()` `percolate_match()` `percolate_list()` `percolate_count()` `percolate_delete()`	Percolater
`scroll()` `scroll_clear()`	Scroll search function
`preference`	Preferences.
Documents Work with document APIs
`docs_bulk()`	Use the bulk API to create, index, update, or delete documents.
`docs_bulk_create()`	Use the bulk API to create documents
`docs_bulk_delete()`	Use the bulk API to delete documents
`docs_bulk_index()`	Use the bulk API to index documents
`docs_bulk_prep()`	Use the bulk API to prepare bulk format data
`docs_bulk_update()`	Use the bulk API to update documents
`docs_create()`	Create a document
`docs_delete()`	Delete a document
`docs_delete_by_query()`	Delete documents by query
`docs_get()`	Get documents
`docs_mget()`	Get multiple documents via the multiple get API
`docs_update()`	Update a document
`docs_update_by_query()`	Update documents by query
`documents`	Elasticsearch documents functions.
`termvectors()`	Termvectors
`mtermvectors()`	Multi Termvectors
Indices Index APIs
`index_template_put()` `index_template_get()` `index_template_exists()` `index_template_delete()`	Index templates
`index_get()` `index_exists()` `index_delete()` `index_create()` `index_recreate()` `index_close()` `index_open()` `index_stats()` `index_settings()` `index_settings_update()` `index_segments()` `index_recovery()` `index_optimize()` `index_forcemerge()` `index_upgrade()` `index_analyze()` `index_flush()` `index_clear_cache()` `index_shrink()`	Index API operations
`alias_get()` `aliases_get()` `alias_exists()` `alias_create()` `alias_rename()` `alias_delete()`	Elasticsearch alias APIs
`mapping_create()` `mapping_get()` `field_mapping_get()` `type_exists()`	Mapping management
`reindex()`	Reindex
Analysis Analysis APIs
`tokenizer_set()`	Tokenizer operations
Ingest Ingest APIs
`pipeline_create()` `pipeline_attachment()` `pipeline_get()` `pipeline_delete()` `pipeline_simulate()`	Ingest API operations
Cluster Cluster/Nodes APIs
`nodes_stats()` `nodes_info()` `nodes_hot_threads()`	Elasticsearch nodes endpoints.
`cluster_settings()` `cluster_health()` `cluster_state()` `cluster_stats()` `cluster_reroute()` `cluster_pending_tasks()`	Elasticsearch cluster endpoints
`tasks()` `tasks_cancel()`	Elasticsearch tasks endpoints
Utilities Various utility functions
`units-distance`	Distance units
`units-time`	Time units
`type_remover()`	Utility function to remove 'type' from bulk load files

Reference

elastic

Connect

Cat

Search

Documents

Indices

Analysis

Ingest

Cluster

Utilities

About

Community

Resources