summaryrefslogtreecommitdiff
path: root/docs/reference/query-dsl/queries/bool-query.asciidoc
diff options
context:
space:
mode:
authorHilko Bengen <bengen@debian.org>2014-06-07 12:02:12 +0200
committerHilko Bengen <bengen@debian.org>2014-06-07 12:02:12 +0200
commitd5ed89b946297270ec28abf44bef2371a06f1f4f (patch)
treece2d945e4dde69af90bd9905a70d8d27f4936776 /docs/reference/query-dsl/queries/bool-query.asciidoc
downloadelasticsearch-d5ed89b946297270ec28abf44bef2371a06f1f4f.tar.gz
Imported Upstream version 1.0.3upstream/1.0.3
Diffstat (limited to 'docs/reference/query-dsl/queries/bool-query.asciidoc')
-rw-r--r--docs/reference/query-dsl/queries/bool-query.asciidoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/reference/query-dsl/queries/bool-query.asciidoc b/docs/reference/query-dsl/queries/bool-query.asciidoc
new file mode 100644
index 0000000..a9b565c
--- /dev/null
+++ b/docs/reference/query-dsl/queries/bool-query.asciidoc
@@ -0,0 +1,54 @@
+[[query-dsl-bool-query]]
+=== Bool Query
+
+A query that matches documents matching boolean combinations of other
+queries. The bool query maps to Lucene `BooleanQuery`. It is built using
+one or more boolean clauses, each clause with a typed occurrence. The
+occurrence types are:
+
+[cols="<,<",options="header",]
+|=======================================================================
+|Occur |Description
+|`must` |The clause (query) must appear in matching documents.
+
+|`should` |The clause (query) should appear in the matching document. In
+a boolean query with no `must` clauses, one or more `should` clauses
+must match a document. The minimum number of should clauses to match can
+be set using the
+<<query-dsl-minimum-should-match,`minimum_should_match`>>
+parameter.
+
+|`must_not` |The clause (query) must not appear in the matching
+documents.
+|=======================================================================
+
+The bool query also supports `disable_coord` parameter (defaults to
+`false`). Basically the coord similarity computes a score factor based
+on the fraction of all query terms that a document contains. See Lucene
+`BooleanQuery` for more details.
+
+[source,js]
+--------------------------------------------------
+{
+ "bool" : {
+ "must" : {
+ "term" : { "user" : "kimchy" }
+ },
+ "must_not" : {
+ "range" : {
+ "age" : { "from" : 10, "to" : 20 }
+ }
+ },
+ "should" : [
+ {
+ "term" : { "tag" : "wow" }
+ },
+ {
+ "term" : { "tag" : "elasticsearch" }
+ }
+ ],
+ "minimum_should_match" : 1,
+ "boost" : 1.0
+ }
+}
+--------------------------------------------------