Match Query - ignacio-alorre/ElasticSearch GitHub Wiki
match queries accept text/numerics/dates*, analyses them, and constructs a query. For example:
GET /_search
{
"query": {
"match" : {
"message" : "this is a test"
}
}
}
Note, message is the name of a field, you can substitute the name of any field instead.
match
The match query is of type boolean. It means that the text provided is analysed and the analysis process constructs a boolean query from the provided text. The operator flag can be set to or or and to control the boolean clauses (defaults to or). The minimum number of optional should clauses to match can be set using the minimum_should_match parameter.
The analyser can be set to control which analyser will perform the analysis process on the text. It defaults to the field explicit mapping definition, or the default search analyser.
The lenient parameter can be set to true to ignore exceptions caused by data-type mismatches, such as trying to query a numeric field with a text query string. Defaults to false.
fuzziness
fuzziness allows fuzzy matching based on the type of field being queried. See Fuzziness for allowed settings.
The prefix_length and max_expansions can be set in this case to control the fuzzy process. If the fuzzy option is set the query will use top_terms_blended_freqs_${max_expansions} as its rewrite method the fuzzy_rewrite parameter allows to control how the query will get rewritten.
Fuzzy transpositions (ab → ba) are allowed by default but can be disabled by setting fuzzy_transpositions to false.
Note that fuzzy matching is not applied to terms with synonyms, as under the hood these terms are expanded to a special synonym query that blends term frequencies, which does not support fuzzy expansion.
GET /_search
{
"query": {
"match" : {
"message" : {
"query" : "this is a test",
"operator" : "and"
}
}
}
}
Zero terms query
If the analyser used removes all tokens in a query like a stop filter does, the default behaviour is to match no documents at all. In order to change that the zero_terms_query option can be used, which accepts none (default) and all which corresponds to a match_all query.
GET /_search
{
"query": {
"match" : {
"message" : {
"query" : "to be or not to be",
"operator" : "and",
"zero_terms_query": "all"
}
}
}
}
Cutoff frequency
The match query supports a cutoff_frequency that allows specifying an absolute or relative document frequency where high frequency terms are moved into an optional subquery and are only scored if one of the low frequency (below the cutoff) terms in the case of an or operator or all of the low frequency terms in the case of an and operator match.
This query allows handling stopwords dynamically at runtime, is domain independent and doesn’t require a stopword file. It prevents scoring / iterating high frequency terms and only takes the terms into account if a more significant / lower frequency term matches a document. Yet, if all of the query terms are above the given cutoff_frequency the query is automatically transformed into a pure conjunction (and) query to ensure fast execution.
The cutoff_frequency can either be relative to the total number of documents if in the range [0..1) or absolute if greater or equal to 1.0.
Here is an example showing a query composed of stopwords exclusively:
GET /_search
{
"query": {
"match" : {
"message" : {
"query" : "to be or not to be",
"cutoff_frequency" : 0.001
}
}
}
}
###Examples
- 1- match
Query to display/retrieve all documents with name contains gibson:
Desktop curl -XGET 'localhost:9200/customers/_search?pretty -d
{
"query": {
"match" : {
"name" : "gibson"
}
}
}
Result:
-H Content-Type: application/json
{
"took" : 21,
"timed_out" : false,
"_shards" : {
"total" : 5,
"successful" : 5,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : 2,
"max_score" : 4.9511213,
"hits" : [
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "xn_g6mABB3_D7Pc85hFv",
"_score" : 4.9511213,
"_source" : {
"name" : "Sue Gibson",
"age" : 60,
"gender" : "female",
"email" : "[email protected]",
"phone" : "+1 (919) 450-2888",
"street" : "166 Newel Street",
"city" : "Jacksonwald",
"state" : "Northern Mariana Islands, 9865"
}
},
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "2X_g6mABB3_D7Pc85hNx",
"_score" : 4.804021,
"_source" : {
"name" : "Gibson Velasquez",
"age" : 57,
"gender" : "male",
"email" : "[email protected]",
"phone" : "+1 (906) 436-3683",
"street" : "362 Beverly Road",
"city" : "Dalton",
"state" : "Texas, 8682"
}
}
]
}
}
Note: match keyword suggest request query to retrieve all docs with name as "gibson" (with g in lower case). Elasticsearch brings two documents:
- First document (with highest score) has second name as "gibson"
- Second document has first name "Gibson".
Generally, Elasticsearch gives more preference (a higher score) to First name. However in this case the first name of the second record is in capitals, when family name of the second document is lower case. For this reason Sue gibson is more relevant than Gibson valasquez)
- 2.1- Match with OR operator
Retrieve all documents where name contains either "Tyler" or "Macdonald":
Desktop curl -XGET 'localhost:9200/customers/_search?pretty -d{
"query": {
"match" : {
"name" : {
"query" : "tyler macdonald",
"operator" : "or"
}
}
}
}
Result:
-H Content-Type: application/json
{
"took" : 11,
"timed_out" : false,
"_shards" : {
"total" : 5,
"successful" : 5,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : 3,
"max_score" : 4.9416423,
"hits" : [
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "IX_g6mABB3_D7Pc85hRy",
"_score" : 4.9416423,
"_source" : {
"name" : "Macdonald Perkins",
"age" : 49,
"gender" : "male",
"email" : "[email protected]",
"phone" : "+1 (863) 559-2182",
"street" : "687 Bayview Avenue",
"city" : "Ola",
"state" : "South Carolina, 2216"
}
},
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "pH_g6mABB3_D7Pc85hRy",
"_score" : 4.9416423,
"_source" : {
"name" : "Tyler Flores",
"age" : 25,
"gender" : "male",
"email" : "[email protected]",
"phone" : "+1 (977) 433-3222",
"street" : "974 Sedgwick Place",
"city" : "Vallonia",
"state" : "Kansas, 1804"
}
},
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "eH_g6mABB3_D7Pc85hNx",
"_score" : 4.804021,
"_source" : {
"name" : "Kimberly Tyler",
"age" : 50,
"gender" : "female",
"email" : "[email protected]",
"phone" : "+1 (867) 568-3457",
"street" : "679 Rugby Road",
"city" : "Walton",
"state" : "Alabama, 3785"
}
}
]
}
}
Note: By default match keyword uses OR operator
- 2.2- match with or operator and _source:false
Below query retrieves all document where name contains both "arnold"and "knowles". _source: false is added in request to shorten response, so it will just display doc with id. This is useful when we interested just in the number of documents retrieved.
Query:
Desktop curl -XGET 'localhost:9200/customers/_search?pretty -d
{
"query": {
"match" : {
"name" : {
"query" : "arnold knowles",
"operator" : "and"
}
}
},"_source":false
}
Response
-H Content-Type: application/json
{
"took" : 3,
"timed_out" : false,
"_shards" : {
"total" : 5,
"successful" : 5,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : 1,
"max_score" : 9.902243,
"hits" : [
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "ln_g6mABB3_D7Pc85hRy",
"_score" : 9.902243
}
]
}
}
- 3- match_phrase
Retrieve all documents which matches a given phrase (whole text). Below query retrieves all documents where south carolina is found as whole. The response indicate total 17 matches, but only 1 is displayed due to the parameter size: 1:
Desktop curl -XGET 'localhost:9200/customers/_search?pretty -d
{
"query": {
"match_phrase" : {
"state" : "south carolina"
}
},
"size":1
}
Result
-H Content-Type: application/json
{
"took" : 1,
"timed_out" : false,
"_shards" : {
"total" : 5,
"successful" : 5,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : 17,
"max_score" : 6.3648453,
"hits" : [
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "F3_g6mABB3_D7Pc85hJw",
"_score" : 6.3648453,
"_source" : {
"name" : "Horton Mcclure",
"age" : 59,
"gender" : "male",
"email" : "[email protected]",
"phone" : "+1 (860) 507-2823",
"street" : "991 Oakland Place",
"city" : "Northchase",
"state" : "South Carolina, 8608"
}
}
]
}
}
- 4.1 - match_phrase_prefix
Retrieve all documents where state starts with "mi", for example: Michigan, Minnesota, Mississippi, Missouri... Note this request made 86 hits, but since we set "size": 3 we will retrieve just 3 documents. Besides we set "_source" : "st", so we will only retrieve those fields which start with "st", in this case "street" and "state":
Desktop curl -XGET localhost:9200/customers/_search?pretty -d
{
"query": {
"match_phrase_prefix" : {
"state" : "mi"
}
},
"size": 3,
"_source" :"st*"
}
Response
-H Content-Type: application/json
{
"took" : 4,
"timed_out" : false,
"_shards" : {
"total" : 5,
"successful" : 5,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : 86,
"max_score" : 4.7598696,
"hits" : [
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "nn_g6mABB3_D7Pc85hNx",
"_score" : 4.7598696,
"_source" : {
"street" : "457 Thomas Street",
"state" : "Michigan, 2490"
}
},
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "NH_g6mABB3_D7Pc85hVy",
"_score" : 4.7598696,
"_source" : {
"street" : "106 Tompkins Place",
"state" : "Michigan, 3205"
}
},
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "P3_g6mABB3_D7Pc85hNx",
"_score" : 4.6157947,
"_source" : {
"street" : "921 Judge Street",
"state" : "Minnesota, 6838"
}
}
]
}
}
- 4.2 - match_phrase_prefix followed by a white space
Below query retrieves all doc with street name start with "Sunnyside" and it displays two documents with street name "Sunnyside Avenue" and "Sunnyside Court".
Desktop curl -XGET localhost:9200/customers/_search?pretty -d
{
"query": {
"match_phrase_prefix" : {
"street" : "Sunnyside "
}
},
"_source" :"st*"
}
Response:
-H Content-Type: application/json
{
"took" : 1,
"timed_out" : false,
"_shards" : {
"total" : 5,
"successful" : 5,
"skipped" : 0,
"failed" : 0
},
"hits" : {
"total" : 2,
"max_score" : 4.9511213,
"hits" : [
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "G3_g6mABB3_D7Pc85hJw",
"_score" : 4.9511213,
"_source" : {
"street" : "733 Sunnyside Avenue",
"state" : "Oklahoma, 9311"
}
},
{
"_index" : "customers",
"_type" : "vendors",
"_id" : "CH_g6mABB3_D7Pc85hNx",
"_score" : 4.800417,
"_source" : {
"street" : "864 Sunnyside Court",
"state" : "New York, 1549"
}
}
]
}
}
Sources: