Skip to content

ES|QL Add full-text search to the functions docs page #116024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 1, 2024
Merged

ES|QL Add full-text search to the functions docs page #116024

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f819cd8
add search to funcs docs
ChrisHegarty Oct 31, 2024
a233cde
itr
ChrisHegarty Oct 31, 2024
96ca7ed
update limitations
ChrisHegarty Nov 1, 2024
dc2239a
Refine full-text-search limitations
craigtaverner Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/reference/esql/esql-functions-operators.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ include::functions/ip-functions.asciidoc[tag=ip_list]
include::functions/math-functions.asciidoc[tag=math_list]
====

.*Search functions*
[%collapsible]
====
include::functions/search-functions.asciidoc[tag=search_list]
====

.*Spatial functions*
[%collapsible]
====
Expand Down Expand Up @@ -89,6 +95,7 @@ include::functions/conditional-functions-and-expressions.asciidoc[]
include::functions/date-time-functions.asciidoc[]
include::functions/ip-functions.asciidoc[]
include::functions/math-functions.asciidoc[]
include::functions/search-functions.asciidoc[]
include::functions/spatial-functions.asciidoc[]
include::functions/string-functions.asciidoc[]
include::functions/type-conversion-functions.asciidoc[]
Expand Down
14 changes: 11 additions & 3 deletions docs/reference/esql/esql-limitations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,19 @@ is currently experimental.

[discrete]
[[esql-limitations-full-text-search]]
=== Full-text search is not supported
=== Full-text search
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 🎉 🎉 !


experimental:[] {esql}'s support for <<esql-search-functions,full-text search>>
is currently in Technical Preview. A restriction of full-text search is that
the search function must come directly after, or very close to, the `FROM`
source command. Otherwise, the query will fail to execute.

Until such time that full-text search becomes final, one can follow this
advice.

Because of <<esql-limitations-text-fields,the way {esql} treats `text` values>>,
full-text search is not yet supported. Queries on `text` fields are like queries
on `keyword` fields: they are case-sensitive and need to match the full string.
queries on `text` fields are like queries on `keyword` fields: they are
case-sensitive and need to match the full string.

For example, after indexing a field of type `text` with the value `Elasticsearch
query language`, the following `WHERE` clause does not match because the `LIKE`
Expand Down
16 changes: 16 additions & 0 deletions docs/reference/esql/functions/search-functions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[[esql-search-functions]]
==== {esql} Full-text search functions

++++
<titleabbrev>Full-text Search functions</titleabbrev>
++++

{esql} supports these full-text search functions:

// tag::search_list[]
* experimental:[] <<esql-match>>
* experimental:[] <<esql-qstr>>
// end::search_list[]

include::layout/match.asciidoc[]
include::layout/qstr.asciidoc[]