• Elasticsearch Guide: other versions:
  • Getting Started
    • Basic Concepts
    • Installation
    • Exploring Your Cluster
      • Cluster Health
      • List All Indices
      • Create an Index
      • Index and Query a Document
      • Delete an Index
    • Modifying Your Data
      • Updating Documents
      • Deleting Documents
      • Batch Processing
    • Exploring Your Data
      • The Search API
      • Introducing the Query Language
      • Executing Searches
      • Executing Filters
      • Executing Aggregations
    • Conclusion
  • Setup
    • Configuration
    • Running as a Service on Linux
    • Running as a Service on Windows
    • Directory Layout
    • Repositories
    • Upgrading
      • Back Up Your Data!
      • Rolling upgrades
      • Full cluster restart upgrade
  • Breaking changes
    • Breaking changes in 2.3
    • Breaking changes in 2.2
      • Mapping APIs
    • Breaking changes in 2.1
      • Search changes
      • Update changes
      • Index APIs
      • Removed features
    • Breaking changes in 2.0
      • Removed features
      • Network changes
      • Multiple path.data striping
      • Mapping changes
      • CRUD and routing changes
      • Query DSL changes
      • Search changes
      • Aggregation changes
      • Parent/Child changes
      • Scripting changes
      • Index API changes
      • Snapshot and Restore changes
      • Plugin and packaging changes
      • Setting changes
      • Stats, info, and cat changes
      • Java API changes
  • API Conventions
    • Multiple Indices
    • Date math support in index names
    • Common options
    • URL-based access control
  • Document APIs
    • Index API
    • Get API
    • Delete API
    • Update API
    • Update By Query API
    • Multi Get API
    • Bulk API
    • Reindex API
    • Term Vectors
    • Multi termvectors API
  • Search APIs
    • Search
    • URI Search
    • Request Body Search
      • Query
      • From / Size
      • Sort
      • Source filtering
      • Fields
      • Script Fields
      • Field Data Fields
      • Post filter
      • Highlighting
      • Rescoring
      • Search Type
      • Scroll
      • Preference
      • Explain
      • Version
      • Index Boost
      • min_score
      • Named Queries
      • Inner hits
    • Search Template
    • Search Shards API
    • Suggesters
      • Term suggester
      • Phrase Suggester
      • Completion Suggester
      • Context Suggester
    • Multi Search API
    • Count API
    • Search Exists API
    • Validate API
    • Explain API
    • Profile API
      • query Section
      • collectors Section
      • rewrite Section
      • A more complex example
      • Performance Notes
      • Limitations
      • Understanding MultiTermQuery output
    • Percolator
    • Field stats API
  • Aggregations
    • Metrics Aggregations
      • 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
      • Sum Aggregation
      • Top hits Aggregation
      • Value Count Aggregation
    • Bucket Aggregations
      • Children Aggregation
      • Date Histogram Aggregation
      • Date Range Aggregation
      • Filter Aggregation
      • Filters Aggregation
      • Geo Distance Aggregation
      • GeoHash grid Aggregation
      • Global Aggregation
      • Histogram Aggregation
      • IPv4 Range Aggregation
      • Missing Aggregation
      • Nested Aggregation
      • Range Aggregation
      • Reverse nested Aggregation
      • Sampler Aggregation
      • Significant Terms Aggregation
      • Terms Aggregation
    • 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
      • Cumulative Sum Aggregation
      • Bucket Script Aggregation
      • Bucket Selector Aggregation
      • Serial Differencing Aggregation
    • Caching heavy aggregations
    • Returning only aggregation results
    • Aggregation Metadata
  • Indices APIs
    • Create Index
    • Delete Index
    • Get Index
    • Indices Exists
    • Open / Close Index API
    • Put Mapping
    • Get Mapping
    • Get Field Mapping
    • Types Exists
    • Index Aliases
    • Update Indices Settings
    • Get Settings
    • Analyze
      • Explain Analyze
    • Index Templates
    • Warmers
    • Shadow replica indices
      • Node level settings related to shadow replicas
    • Indices Stats
    • Indices Segments
    • Indices Recovery
    • Indices Shard Stores
    • Clear Cache
    • Flush
      • Synced Flush
    • Refresh
    • Force Merge
    • Optimize
    • Upgrade
  • cat APIs
    • cat aliases
    • cat allocation
    • cat count
    • cat fielddata
    • cat health
    • cat indices
    • cat master
    • cat nodeattrs
    • cat nodes
    • cat pending tasks
    • cat plugins
    • cat recovery
    • cat repositories
    • cat thread pool
    • cat shards
    • cat segments
    • cat snapshots
  • Cluster APIs
    • Cluster Health
    • Cluster State
    • Cluster Stats
    • Pending cluster tasks
    • Cluster Reroute
    • Cluster Update Settings
    • Nodes Stats
    • Nodes Info
    • Task Management API
    • Nodes hot_threads
  • Query DSL
    • Query and filter context
    • Match All Query
    • Full text queries
      • Match Query
      • Multi Match Query
      • Common Terms Query
      • Query String Query
      • Simple Query String Query
    • Term level queries
      • Term Query
      • Terms Query
      • Range Query
      • Exists Query
      • Missing Query
      • Prefix Query
      • Wildcard Query
      • Regexp Query
      • Fuzzy Query
      • Type Query
      • Ids Query
    • Compound queries
      • Constant Score Query
      • Bool Query
      • Dis Max Query
      • Function Score Query
      • Boosting Query
      • Indices Query
      • And Query
      • Not Query
      • Or Query
      • Filtered Query
      • Limit Query
    • Joining queries
      • Nested Query
      • Has Child Query
      • Has Parent Query
    • Geo queries
      • GeoShape Query
      • Geo Bounding Box Query
      • Geo Distance Query
      • Geo Distance Range Query
      • Geo Polygon Query
      • Geohash Cell Query
    • Specialized queries
      • More Like This Query
      • Template Query
      • Script Query
    • Span queries
      • Span Term Query
      • Span Multi Term Query
      • Span First Query
      • Span Near Query
      • Span Or Query
      • Span Not Query
      • Span Containing Query
      • Span Within Query
    • Minimum Should Match
    • Multi Term Query Rewrite
  • Mapping
    • Field datatypes
      • Array datatype
      • Binary datatype
      • Boolean datatype
      • Date datatype
      • Geo-point datatype
      • Geo-Shape datatype
      • IPv4 datatype
      • Nested datatype
      • Numeric datatypes
      • Object datatype
      • String datatype
      • Token count datatype
    • Meta-Fields
      • _all field
      • _field_names field
      • _id field
      • _index field
      • _meta field
      • _parent field
      • _routing field
      • _source field
      • _timestamp field
      • _ttl field
      • _type field
      • _uid field
    • Mapping parameters
      • analyzer
      • boost
      • coerce
      • copy_to
      • doc_values
      • dynamic
      • enabled
      • fielddata
      • format
      • geohash
      • geohash_precision
      • geohash_prefix
      • ignore_above
      • ignore_malformed
      • include_in_all
      • index
      • index_options
      • lat_lon
      • fields
      • norms
      • null_value
      • position_increment_gap
      • precision_step
      • properties
      • search_analyzer
      • similarity
      • store
      • term_vector
    • Dynamic Mapping
      • _default_ mapping
      • Dynamic field mapping
      • Dynamic templates
      • Override default template
    • Transform
      • Get Transformed
      • Immutable Transformation
  • Analysis
    • Analyzers
      • Standard Analyzer
      • Simple Analyzer
      • Whitespace Analyzer
      • Stop Analyzer
      • Keyword Analyzer
      • Pattern Analyzer
      • Language Analyzers
      • Snowball Analyzer
      • Custom Analyzer
    • Tokenizers
      • Standard Tokenizer
      • Edge NGram Tokenizer
      • Keyword Tokenizer
      • Letter Tokenizer
      • Lowercase Tokenizer
      • NGram Tokenizer
      • Whitespace Tokenizer
      • Pattern Tokenizer
      • UAX Email URL Tokenizer
      • Path Hierarchy Tokenizer
      • Classic Tokenizer
      • Thai Tokenizer
    • Token Filters
      • Standard Token Filter
      • ASCII Folding Token Filter
      • Length Token Filter
      • Lowercase Token Filter
      • Uppercase Token Filter
      • NGram Token Filter
      • Edge NGram Token Filter
      • Porter Stem Token Filter
      • Shingle Token Filter
      • Stop Token Filter
      • Word Delimiter Token Filter
      • Stemmer Token Filter
      • Stemmer Override Token Filter
      • Keyword Marker Token Filter
      • Keyword Repeat Token Filter
      • KStem Token Filter
      • Snowball Token Filter
      • Phonetic Token Filter
      • Synonym Token Filter
      • Compound Word Token Filter
      • Reverse Token Filter
      • Elision Token Filter
      • Truncate Token Filter
      • Unique Token Filter
      • Pattern Capture Token Filter
      • Pattern Replace Token Filter
      • Trim Token Filter
      • Limit Token Count Token Filter
      • Hunspell Token Filter
      • Common Grams Token Filter
      • Normalization Token Filter
      • CJK Width Token Filter
      • CJK Bigram Token Filter
      • Delimited Payload Token Filter
      • Keep Words Token Filter
      • Keep Types Token Filter
      • Classic Token Filter
      • Apostrophe Token Filter
      • Decimal Digit Token Filter
    • Character Filters
      • Mapping Char Filter
      • HTML Strip Char Filter
      • Pattern Replace Char Filter
  • Modules
    • Cluster
      • Cluster Level Shard Allocation
      • Disk-based Shard Allocation
      • Shard Allocation Awareness
      • Shard Allocation Filtering
      • Miscellaneous cluster settings
    • Discovery
      • Azure Discovery
      • EC2 Discovery
      • Google Compute Engine Discovery
      • Zen Discovery
    • Local Gateway
    • HTTP
    • Indices
      • Circuit Breaker
      • Fielddata
      • Node Query Cache
      • Indexing Buffer
      • Shard request cache
      • Indices Recovery
      • TTL interval
    • Network Settings
    • Node
    • Plugins
    • Scripting
      • Text scoring in scripts
      • Scripting and the Java Security Manager
    • Snapshot And Restore
    • Thread Pool
    • Transport
    • Tribe node
  • Index Modules
    • Analysis
    • Index Shard Allocation
      • Shard Allocation Filtering
      • Delaying allocation when a node leaves
      • Index recovery prioritization
      • Total Shards Per Node
    • Mapper
    • Merge
    • Similarity module
    • Slow Log
    • Store
    • Translog
  • Testing
    • Java Testing Framework
      • why randomized testing?
      • Using the elasticsearch test classes
      • unit tests
      • integration tests
      • Randomized testing
      • Assertions
  • Glossary of terms
  • Release Notes
    • 2.3.5 Release Notes
    • 2.3.4 Release Notes
    • 2.3.3 Release Notes
    • 2.3.2 Release Notes
    • 2.3.1 Release Notes
    • 2.3.0 Release Notes
    • 2.2.2 Release Notes
    • 2.2.1 Release Notes
    • 2.2.0 Release Notes
    • 2.1.2 Release Notes
    • 2.1.1 Release Notes
    • 2.1.0 Release Notes
    • 2.0.2 Release Notes
    • 2.0.1 Release Notes
    • 2.0.0 Release Notes
    • 2.0.0-rc1 Release Notes
    • 2.0.0-beta2 Release Notes
    • 2.0.0-beta1 Release Notes