- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Logging configuration
- Auditing settings
- Cross-cluster replication settings
- Transforms settings
- Index lifecycle management settings
- License settings
- Machine learning settings
- Monitoring settings
- Security settings
- Snapshot lifecycle management settings
- SQL access settings
- Watcher settings
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Discovery configuration check
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Full-cluster restart and rolling restart
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- String Stats Aggregation
- Sum Aggregation
- Top Hits Aggregation
- Value Count Aggregation
- Median Absolute Deviation Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Auto-interval Date Histogram Aggregation
- Children Aggregation
- Composite aggregation
- Date histogram aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- GeoTile Grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Rare Terms Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Subtleties of bucketing range fields
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Moving Function Aggregation
- Cumulative Sum Aggregation
- Cumulative Cardinality Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Indexing aggregation results with transforms
- Metrics Aggregations
- Query DSL
- Search across clusters
- Scripting
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Char Group Tokenizer
- Classic Tokenizer
- Edge n-gram tokenizer
- Keyword Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- N-gram tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Pattern Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Standard Tokenizer
- Thai Tokenizer
- UAX URL Email Tokenizer
- Whitespace Tokenizer
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Enrich your data
- Processors
- Append Processor
- Bytes Processor
- Circle Processor
- Convert Processor
- CSV Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Enrich Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip Processor
- Inference Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Pipeline Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Set Security User Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- URL Decode Processor
- User Agent processor
- ILM: Manage the index lifecycle
- SQL access
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Security privileges
- Document level security
- Field level security
- Granting privileges for indices and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Alerting on cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- cat APIs
- Cluster APIs
- Cross-cluster replication APIs
- Document APIs
- Enrich APIs
- Explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete index template
- Flush
- Force merge
- Freeze index
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists
- Open index
- Put index template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Index lifecycle management API
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendar
- Create datafeeds
- Create filter
- Delete calendar
- Delete datafeeds
- Delete events from calendar
- Delete filter
- Delete forecast
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filter
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create inference trained model
- Delete data frame analytics jobs
- Delete inference trained model
- Evaluate data frame analytics
- Explain data frame analytics API
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get inference trained model
- Get inference trained model stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers
- Rollup APIs
- Search APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect Prepare Authentication API
- OpenID Connect authenticate API
- OpenID Connect logout API
- SAML prepare authentication API
- SAML authenticate API
- SAML logout API
- SAML invalidate API
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management API
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Release highlights
- Breaking changes
- Release notes
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
Search API
editSearch API
editReturns search hits that match the query defined in the request.
GET /twitter/_search
Description
editAllows you to execute a search query and get back search hits that match the
query. You can provide search queries using the q
query string parameter or request body.
Path parameters
edit-
<index>
- (Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.
Query parameters
edit-
allow_no_indices
-
(Optional, boolean) If
true
, the request does not return an error if a wildcard expression or_all
value retrieves only missing or closed indices.This parameter also applies to index aliases that point to a missing or closed index.
Defaults to
true
.
-
allow_partial_search_results
-
(Optional, boolean) If
true
, returns partial results if there are request timeouts or shard failures. Iffalse
, returns an error with no partial results. Defaults totrue
.To override the default for this field, set the
search.default_allow_partial_results
cluster setting tofalse
. -
batched_reduce_size
-
(Optional, integer) The number of shard results that should be reduced at once
on the coordinating node. This value should be used as a protection mechanism
to reduce the memory overhead per search request if the potential number of
shards in the request can be large. Defaults to
512
.
-
ccs_minimize_roundtrips
-
(Optional, boolean) If
true
, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. See How cross-cluster search handles network delays. Defaults totrue
. -
docvalue_fields
- (Optional, string) A comma-separated list of fields to return as the docvalue representation of a field for each hit.
-
expand_wildcards
-
(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Valid values are:
-
all
- Expand to open and closed indices.
-
open
- Expand only to open indices.
-
closed
- Expand only to closed indices.
-
none
- Wildcard expressions are not accepted.
Defaults to
open
. -
-
explain
-
(Optional, boolean) If
true
, returns detailed information about score computation as part of a hit. Defaults tofalse
.You can also specify this value using the
explain
request body parameter. If both parameters are specified, only the query parameter is used. -
from
-
(Optional, integer) Starting document offset. Defaults to
0
.You can also specify this value using the
from
request body parameter. If both parameters are specified, only the query parameter is used. -
ignore_throttled
-
(Optional, boolean) If
true
, concrete, expanded or aliased indices will be ignored when throttled. Defaults tofalse
. -
ignore_unavailable
-
(Optional, boolean) If
true
, missing or closed indices are not included in the response. Defaults tofalse
. -
max_concurrent_shard_requests
-
(Optional, integer) Defines the number of concurrent shard requests per node
this search executes concurrently. This value should be used to limit the
impact of the search on the cluster in order to limit the number of concurrent
shard requests. Defaults to
5
. -
pre_filter_shard_size
-
(Optional, integer) Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. When unspecified, the pre-filter phase is executed if any of these conditions is met:
-
The request targets more than
128
shards. - The request targets one or more read-only index.
- The primary sort of the query targets an indexed field.
-
The request targets more than
-
preference
- (Optional, string) Specifies the node or shard the operation should be performed on. Random by default.
-
q
-
(Optional, string) Query in the Lucene query string syntax.
You can use the
q
parameter to run a query parameter search. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.The
q
parameter overrides thequery
parameter in the request body. If both parameters are specified, documents matching thequery
request body parameter are not returned. -
request_cache
-
(Optional, boolean) If
true
, the caching of search results is enabled for requests wheresize
is0
. See Shard request cache. Defaults to index level settings. -
rest_total_hits_as_int
-
(Optional, boolean) Indicates whether hits.total should be rendered as an
integer or an object in the rest search response. Defaults to
false
. -
routing
- (Optional, time units) Specifies how long a consistent view of the index should be maintained for scrolled search.
-
search_type
-
(Optional, string) The type of the search operation. Available options:
-
query_then_fetch
-
dfs_query_then_fetch
-
-
seq_no_primary_term
-
(Optional, boolean) If
true
, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.You can also specify this value using the
seq_no_primary_term
request body parameter. If both parameters are specified, only the query parameter is used. -
size
-
(Optional, integer) Defines the number of hits to return. Defaults to
10
.You can also specify this value using the
size
request body parameter. If both parameters are specified, only the query parameter is used. -
sort
- (Optional, string) A comma-separated list of <field>:<direction> pairs.
-
_source
-
(Optional, boolean)
If
true
, the response includes the_source
of matching documents underhits
. Defaults totrue
. -
_source_excludes
-
(Optional, string) A list of fields to exclude from the returned
_source
field. -
_source_includes
-
(Optional, string) A list of fields to extract and return from the
_source
field. -
stats
-
(Optional, string) Specific
tag
of the request for logging and statistical purposes. -
stored_fields
- (Optional, string) A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response.
-
suggest_field
- (Optional, string) Specifies which field to use for suggestions.
-
suggest_text
- (Optional, string) The source text for which the suggestions should be returned.
-
terminate_after
-
(Optional, integer) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
Defaults to
0
, which does not terminate query execution early.You can also specify this value using the
terminate_after
request body parameter. If both parameters are specified, only the query parameter is used. -
timeout
-
(Optional, time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
You can also specify this value using the
timeout
request body parameter. If both parameters are specified, only the query parameter is used. -
track_scores
-
(Optional, boolean) If
true
, calculate and return document scores, even if the scores are not used for sorting. Defaults tofalse
. -
track_total_hits
-
(Optional, integer or boolean) Number of hits matching the query to count accurately. Defaults to
10000
.If
true
, the default value is used. Iffalse
, the response does not include the total number of hits matching the query. -
typed_keys
-
(Optional, boolean) If
true
, aggregation and suggester names are be prefixed by their respective types in the response. Defaults totrue
. -
version
-
(Optional, boolean) If
true
, returns document version as part of a hit. Defaults tofalse
.You can also specify this value using the
version
request body parameter. If both parameters are specified, only the query parameter is used.
Request body
edit-
explain
-
(Optional, boolean) If
true
, returns detailed information about score computation as part of a hit. Defaults tofalse
.You can also specify this value using the
explain
query parameter. If both parameters are specified, only the query parameter is used. -
from
-
(Optional, integer) Starting document offset. Defaults to
0
.You can also specify this value using the
from
query parameter. If both parameters are specified, only the query parameter is used.
-
query
- (Optional, query object) Defines the search definition using the Query DSL.
-
seq_no_primary_term
-
(Optional, boolean) If
true
, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control.You can also specify this value using the
seq_no_primary_term
query parameter. If both parameters are specified, only the query parameter is used. -
size
-
(Optional, integer) The number of hits to return. Defaults to
10
.You can also specify this value using the
size
query parameter. If both parameters are specified, only the query parameter is used. -
terminate_after
-
(Optional, integer) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
Defaults to
0
, which does not terminate query execution early.You can also specify this value using the
terminate_after
query parameter. If both parameters are specified, only the query parameter is used. -
timeout
-
(Optional, time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.
You can also specify this value using the
timeout
query parameter. If both parameters are specified, only the query parameter is used.
Response body
edit-
took
-
(integer) Milliseconds it took Elasticsearch to execute the request.
This value is calculated by measuring the time elapsed between receipt of a request on the coordinating node and the time at which the coordinating node is ready to send the response.
Took time includes:
- Communication time between the coordinating node and data nodes
-
Time the request spends in the
search
thread pool, queued for execution - Actual execution time
Took time does not include:
- Time needed to send the request to Elasticsearch
- Time needed to serialize the JSON response
- Time needed to send the response to a client
-
timed_out
-
(boolean)
If
true
, the request timed out before completion; returned results may be partial or empty. -
_shards
-
(object) Contains a count of shards used for the request.
Properties of
_shards
-
total
- (integer) Total number of shards that require querying, including unallocated shards.
-
successful
- (integer) Number of shards that executed the request successfully.
-
skipped
- (integer) Number of shards that skipped the request because a lightweight check helped realize that no documents could possibly match on this shard. This typically happens when a search request includes a range filter and the shard only has values that fall outside of that range.
-
failed
-
(integer)
Number of shards that failed to execute the request. Note that shards
that are not allocated will be considered neither successful nor failed.
Having
failed+successful
less thantotal
is thus an indication that some of the shards were not allocated.
-
-
hits
-
(object) Contains returned documents and metadata.
Properties of
hits
-
total
-
(object) Metadata about the number of returned documents.
Properties of
total
-
value
- (integer) Total number of returned documents.
-
relation
-
(string) Indicates whether the number of returned documents in the
value
parameter is accurate or a lower bound.Values of
relation
:-
eq
- Accurate
-
gte
- Lower bound, including returned documents
-
-
-
max_score
-
(float) Highest returned document
_score
.This value is
null
for requests that do not sort by_score
.
-
hits
-
(array of objects) Array of returned document objects.
Properties of
hits
objects-
_index
- (string) Name of the index containing the returned document.
-
_type
- [6.0.0] Deprecated in 6.0.0. Mapping types are deprecated and will be removed in 8.0. See Removal of mapping types. (string) Mapping type of the returned document.
-
_id
- (string) Unique identifier for the returned document. This ID is only unique within the returned index.
-
-
Examples
editSearch an index using the q
query parameter
editGET /twitter/_search?q=user:kimchy
The API returns the following response:
{ "took" : 5, "timed_out" : false, "_shards" : { "total" : 1, "successful" : 1, "skipped" : 0, "failed" : 0 }, "hits" : { "total" : { "value" : 1, "relation" : "eq" }, "max_score" : 1.3862942, "hits" : [ { "_index" : "twitter", "_type" : "_doc", "_id" : "0", "_score" : 1.3862942, "_source" : { "date" : "2009-11-15T14:12:12", "likes" : 0, "message" : "trying out Elasticsearch", "user" : "kimchy" } } ] } }
Search several indices using the q
query parameter
editGET /kimchy,elasticsearch/_search?q=user:kimchy
Search all indices using the q
query parameter
editTo search all indices in a cluster,
omit the <index>
parameter.
GET /_search?q=user:kimchy
Alternatively,
you can use the _all
or *
value in the <index>
parameter.
GET /_all/_search?q=user:kimchy
GET /*/_search?q=user:kimchy
Search an index using the query
request body parameter
editGET /twitter/_search { "query" : { "term" : { "user" : "kimchy" } } }
The API returns the following response:
{ "took": 1, "timed_out": false, "_shards":{ "total" : 1, "successful" : 1, "skipped" : 0, "failed" : 0 }, "hits":{ "total" : { "value": 1, "relation": "eq" }, "max_score": 1.3862942, "hits" : [ { "_index" : "twitter", "_type" : "_doc", "_id" : "0", "_score": 1.3862942, "_source" : { "user" : "kimchy", "message": "trying out Elasticsearch", "date" : "2009-11-15T14:12:12", "likes" : 0 } } ] } }
On this page