- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- 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
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- API conventions
- Document APIs
- Search APIs
- 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
- 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
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text 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
- Moving Function Aggregation
- Cumulative Sum 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
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Split Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Scripting
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Standard Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- Whitespace Tokenizer
- UAX URL Email Tokenizer
- Classic Tokenizer
- Thai Tokenizer
- NGram Tokenizer
- Edge NGram Tokenizer
- Keyword Tokenizer
- Pattern Tokenizer
- Char Group Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Token Filters
- ASCII Folding Token Filter
- Flatten Graph 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
- Word Delimiter Graph Token Filter
- Multiplexer Token Filter
- Conditional Token Filter
- Predicate Token Filter Script
- 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
- Parsing synonym files
- Synonym Graph Token Filter
- Compound Word Token Filters
- 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
- Exclude mode settings example
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- Minhash Token Filter
- Remove Duplicates Token Filter
- Character Filters
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Bytes Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub 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
- Managing the index lifecycle
- Getting started with index lifecycle management
- Policy phases and actions
- Set up index lifecycle management policy
- Using policies to manage index rollover
- Update policy
- Index lifecycle error handling
- Restoring snapshots of managed indices
- Start and stop index lifecycle management
- Using ILM with existing indices
- SQL access
- Monitor a cluster
- Rolling up historical data
- Frozen indices
- Set up a cluster for high availability
- X-Pack APIs
- Info API
- Cross-cluster replication APIs
- Explore API
- Freeze index
- Index lifecycle management API
- Licensing APIs
- Migration APIs
- Machine learning APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create calendar
- Create datafeeds
- Create filter
- Create jobs
- 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 calendars
- Get buckets
- Get overall buckets
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- 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
- Rollup 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
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- SSL certificate
- Unfreeze index
- Watcher APIs
- Definitions
- Secure a cluster
- Overview
- Configuring security
- Encrypting communications in Elasticsearch
- Encrypting communications in an Elasticsearch Docker Container
- Enabling cipher suites for stronger encryption
- Separating node-to-node and client traffic
- Configuring an Active Directory realm
- Configuring a file realm
- Configuring an LDAP realm
- Configuring a native realm
- Configuring a PKI realm
- Configuring a SAML realm
- Configuring a Kerberos realm
- FIPS 140-2
- Security files
- How security works
- 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
- 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
- User authorization
- Auditing security events
- 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
- Testing
- Glossary of terms
- Release highlights
- Breaking changes
- Release notes
SELECT
editSELECT
editSynopsis.
SELECT select_expr [, ...] [ FROM table_name ] [ WHERE condition ] [ GROUP BY grouping_element [, ...] ] [ HAVING condition] [ ORDER BY expression [ ASC | DESC ] [, ...] ] [ LIMIT [ count ] ]
DescriptionRetrieves rows from zero or more tables.
The general execution of SELECT
is as follows:
-
All elements in the
FROM
list are computed (each element can be base or alias table). CurrentlyFROM
supports exactly one table. Do note however that the table name can be a pattern (see FROM Clause below). -
If the
WHERE
clause is specified, all rows that do not satisfy the condition are eliminated from the output. (See WHERE Clause below.) -
If the
GROUP BY
clause is specified, or if there are aggregate function calls, the output is combined into groups of rows that match on one or more values, and the results of aggregate functions are computed. If theHAVING
clause is present, it eliminates groups that do not satisfy the given condition. (See GROUP BY Clause and HAVING Clause below.) -
The actual output rows are computed using the
SELECT
output expressions for each selected row or row group. -
If the
ORDER BY
clause is specified, the returned rows are sorted in the specified order. IfORDER BY
is not given, the rows are returned in whatever order the system finds fastest to produce. (See ORDER BY Clause below.) -
If the
LIMIT
is specified, theSELECT
statement only returns a subset of the result rows. (See LIMIT Clause below.)
SELECT
List
editSELECT
list, namely the expressions between SELECT
and FROM
, represent the output rows of the SELECT
statement.
As with a table, every output column of a SELECT
has a name which can be either specified per column through the AS
keyword :
SELECT 1 + 1 AS result; result --------------- 2
Note: AS
is an optional keyword however it helps with the readability and in some case ambiguity of the query
which is why it is recommended to specify it.
assigned by Elasticsearch SQL if no name is given:
SELECT 1 + 1; 1 + 1 -------------- 2
or if it’s a simple column reference, use its name as the column name:
SELECT emp_no FROM emp LIMIT 1; emp_no --------------- 10001
Wildcard
editTo select all the columns in the source, one can use *
:
SELECT * FROM emp LIMIT 1; birth_date | emp_no | first_name | gender | hire_date | languages | last_name | salary --------------------+---------------+---------------+---------------+--------------------+---------------+---------------+--------------- 1953-09-02T00:00:00Z|10001 |Georgi |M |1986-06-26T00:00:00Z|2 |Facello |57305
which essentially returns all(top-level fields, sub-fields, such as multi-fields are ignored] columns found.
FROM Clause
editThe FROM
clause specifies one table for the SELECT
and has the following syntax:
FROM table_name [ [ AS ] alias ]
where:
-
table_name
- Represents the name (optionally qualified) of an existing table, either a concrete or base one (actual index) or alias.
If the table name contains special SQL characters (such as .
,-
,*
,etc…) use double quotes to escape them:
SELECT * FROM "emp" LIMIT 1; birth_date | emp_no | first_name | gender | hire_date | languages | last_name | salary --------------------+---------------+---------------+---------------+--------------------+---------------+---------------+--------------- 1953-09-02T00:00:00Z|10001 |Georgi |M |1986-06-26T00:00:00Z|2 |Facello |57305
The name can be a pattern pointing to multiple indices (likely requiring quoting as mentioned above) with the restriction that all resolved concrete tables have exact mapping.
SELECT emp_no FROM "e*p" LIMIT 1; emp_no --------------- 10001
-
alias
-
A substitute name for the
FROM
item containing the alias. An alias is used for brevity or to eliminate ambiguity. When an alias is provided, it completely hides the actual name of the table and must be used in its place.
SELECT e.emp_no FROM emp AS e LIMIT 1; emp_no ------------- 10001
WHERE Clause
editThe optional WHERE
clause is used to filter rows from the query and has the following syntax:
WHERE condition
where:
-
condition
-
Represents an expression that evaluates to a
boolean
. Only the rows that match the condition (totrue
) are returned.
SELECT last_name FROM emp WHERE emp_no = 10001; last_name --------------- Facello
GROUP BY
editThe GROUP BY
clause is used to divide the results into groups of rows on matching values from the designated columns. It has the following syntax:
GROUP BY grouping_element [, ...]
where:
-
grouping_element
- Represents an expression on which rows are being grouped on. It can be a column name, alias or ordinal number of a column or an arbitrary expression of column values.
A common, group by column name:
SELECT gender AS g FROM emp GROUP BY gender; g --------------- null F M
Grouping by output ordinal:
SELECT gender FROM emp GROUP BY 1; gender --------------- null F M
Grouping by alias:
SELECT gender AS g FROM emp GROUP BY g; g --------------- null F M
And grouping by column expression (typically used along-side an alias):
SELECT languages + 1 AS l FROM emp GROUP BY l; l --------------- null 2 3 4 5 6
Or a mixture of the above:
SELECT gender g, languages l, COUNT(*) c FROM "emp" GROUP BY g, l ORDER BY languages ASC, gender DESC; g | l | c ---------------+---------------+--------------- M |null |7 F |null |3 M |1 |9 F |1 |4 null |1 |2 M |2 |11 F |2 |5 null |2 |3 M |3 |11 F |3 |6 M |4 |11 F |4 |6 null |4 |1 M |5 |8 F |5 |9 null |5 |4
When a GROUP BY
clause is used in a SELECT
, all output expressions must be either aggregate functions or expressions used for grouping or derivatives of (otherwise there would be more than one possible value to return for each ungrouped column).
To wit:
SELECT gender AS g, COUNT(*) AS c FROM emp GROUP BY gender; g | c ---------------+--------------- null |10 F |33 M |57
Expressions over aggregates used in output:
SELECT gender AS g, ROUND((MIN(salary) / 100)) AS salary FROM emp GROUP BY gender; g | salary ---------------+--------------- null |253 F |260 M |259
Multiple aggregates used:
SELECT gender AS g, KURTOSIS(salary) AS k, SKEWNESS(salary) AS s FROM emp GROUP BY gender; g | k | s ---------------+------------------+------------------- null |2.2215791166941923|-0.03373126000214023 F |1.7873117044424276|0.05504995122217512 M |2.280646181070106 |0.44302407229580243
Implicit Grouping
editWhen an aggregation is used without an associated GROUP BY
, an implicit grouping is applied, meaning all selected rows are considered to form a single default, or implicit group.
As such, the query emits only a single row (as there is only a single group).
A common example is counting the number of records:
SELECT COUNT(*) AS count FROM emp; count --------------- 100
Of course, multiple aggregations can be applied:
SELECT MIN(salary) AS min, MAX(salary) AS max, AVG(salary) AS avg, COUNT(*) AS count FROM emp; min:i | max:i | avg:d | count:l ---------------+---------------+---------------+--------------- 25324 |74999 |48248.55 |100
HAVING
editThe HAVING
clause can be used only along aggregate functions (and thus GROUP BY
) to filter what groups are kept or not and has the following syntax:
GROUP BY condition
where:
-
condition
-
Represents an expression that evaluates to a
boolean
. Only groups that match the condition (totrue
) are returned.
Both WHERE
and HAVING
are used for filtering however there are several significant differences between them:
-
WHERE
works on individual rows,HAVING
works on the groups created by ``GROUP BY`` -
WHERE
is evaluated before grouping,HAVING
is evaluated after grouping
SELECT languages AS l, COUNT(*) AS c FROM emp GROUP BY l HAVING c BETWEEN 15 AND 20; l | c ---------------+--------------- 1 |15 2 |19 3 |17 4 |18
Further more, one can use multiple aggregate expressions inside HAVING
even ones that are not used in the output (SELECT
):
SELECT MIN(salary) AS min, MAX(salary) AS max, MAX(salary) - MIN(salary) AS diff FROM emp GROUP BY languages HAVING diff - max % min > 0 AND AVG(salary) > 30000; min | max | diff ---------------+---------------+--------------- 28336 |74999 |46663 25976 |73717 |47741 29175 |73578 |44403 26436 |74970 |48534 27215 |74572 |47357 25324 |66817 |41493
Implicit Grouping
editAs indicated above, it is possible to have a HAVING
clause without a GROUP BY
. In this case, the so-called implicit grouping is applied, meaning all selected rows are considered to form a single group and HAVING
can be applied on any of the aggregate functions specified on this group.
As such, the query emits only a single row (as there is only a single group) and HAVING
condition returns either one row (the group) or zero if the condition fails.
In this example, HAVING
matches:
SELECT MIN(salary) AS min, MAX(salary) AS max FROM emp HAVING min > 25000; min | max ---------------+--------------- 25324 |74999
ORDER BY
editThe ORDER BY
clause is used to sort the results of SELECT
by one or more expressions:
ORDER BY expression [ ASC | DESC ] [, ...]
where:
-
expression
-
Represents an input column, an output column or an ordinal number of the position (starting from one) of an output column. Additionally, ordering can be done based on the results score.
The direction, if not specified, is by default
ASC
(ascending). Regardless of the ordering specified, null values are ordered last (at the end).
When used along-side, GROUP BY
expression can point only to the columns used for grouping or aggregate functions.
For example, the following query sorts by an arbitrary input field (page_count
):
SELECT * FROM library ORDER BY page_count DESC LIMIT 5; author | name | page_count | release_date -----------------+--------------------+---------------+-------------------- Peter F. Hamilton|Pandora's Star |768 |2004-03-02T00:00:00Z Vernor Vinge |A Fire Upon the Deep|613 |1992-06-01T00:00:00Z Frank Herbert |Dune |604 |1965-06-01T00:00:00Z Alastair Reynolds|Revelation Space |585 |2000-03-15T00:00:00Z James S.A. Corey |Leviathan Wakes |561 |2011-06-02T00:00:00Z
Order By and Grouping
editFor queries that perform grouping, ordering can be applied either on the grouping columns (by default ascending) or on aggregate functions.
With GROUP BY
, make sure the ordering targets the resulting group - applying it to individual elements inside the group will have no impact on the results since regardless of the order, values inside the group are aggregated.
For example, to order groups simply indicate the grouping key:
SELECT gender AS g, COUNT(*) AS c FROM emp GROUP BY gender ORDER BY g DESC; g | c ---------------+--------------- M |57 F |33 null |10
Multiple keys can be specified of course:
SELECT gender g, languages l, COUNT(*) c FROM "emp" GROUP BY g, l ORDER BY languages ASC, gender DESC; g | l | c ---------------+---------------+--------------- M |null |7 F |null |3 M |1 |9 F |1 |4 null |1 |2 M |2 |11 F |2 |5 null |2 |3 M |3 |11 F |3 |6 M |4 |11 F |4 |6 null |4 |1 M |5 |8 F |5 |9 null |5 |4
Further more, it is possible to order groups based on aggregations of their values:
SELECT gender AS g, MIN(salary) AS salary FROM emp GROUP BY gender ORDER BY salary DESC; g | salary ---------------+--------------- F |25976 M |25945 null |25324
Ordering by aggregation is possible for up to 512 entries for memory consumption reasons.
In cases where the results pass this threshold, use <<LIMIT
, sql-syntax-limit>> to reduce the number
of results.
Order By Score
editWhen doing full-text queries in the WHERE
clause, results can be returned based on their
score or relevance to the given query.
When doing multiple text queries in the WHERE
clause then, their scores will be
combined using the same rules as Elasticsearch’s
bool query.
To sort based on the score
, use the special function SCORE()
:
SELECT SCORE(), * FROM library WHERE MATCH(name, 'dune') ORDER BY SCORE() DESC; SCORE() | author | name | page_count | release_date ---------------+---------------+-------------------+---------------+-------------------- 2.2886353 |Frank Herbert |Dune |604 |1965-06-01T00:00:00Z 1.8893257 |Frank Herbert |Dune Messiah |331 |1969-10-15T00:00:00Z 1.6086556 |Frank Herbert |Children of Dune |408 |1976-04-21T00:00:00Z 1.4005898 |Frank Herbert |God Emperor of Dune|454 |1981-05-28T00:00:00Z
Note that you can return SCORE()
by using a full-text search predicate in the WHERE
clause.
This is possible even if SCORE()
is not used for sorting:
SELECT SCORE(), * FROM library WHERE MATCH(name, 'dune') ORDER BY page_count DESC; SCORE() | author | name | page_count | release_date ---------------+---------------+-------------------+---------------+-------------------- 2.2886353 |Frank Herbert |Dune |604 |1965-06-01T00:00:00Z 1.4005898 |Frank Herbert |God Emperor of Dune|454 |1981-05-28T00:00:00Z 1.6086556 |Frank Herbert |Children of Dune |408 |1976-04-21T00:00:00Z 1.8893257 |Frank Herbert |Dune Messiah |331 |1969-10-15T00:00:00Z
NOTE:
Trying to return score
from a non full-text query will return the same value for all results, as
all are equally relevant.
LIMIT
editThe LIMIT
clause restricts (limits) the number of rows returns using the format:
LIMIT ( count | ALL )
where
- count
-
is a positive integer or zero indicating the maximum possible number of results being returned (as there might be less matches than the limit). If
0
is specified, no results are returned. - ALL
- indicates there is no limit and thus all results are being returned.
To return
SELECT first_name, last_name, emp_no FROM emp LIMIT 1; first_name | last_name | emp_no ---------------+---------------+--------------- Georgi |Facello |10001
On this page