like-rlike.asciidoc 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[sql-like-rlike-operators]]
  4. === LIKE and RLIKE Operators
  5. `LIKE` and `RLIKE` operators are commonly used to filter data based on string patterns. They usually act on a field placed on the left-hand side of
  6. the operator, but can also act on a constant (literal) expression. The right-hand side of the operator represents the pattern.
  7. Both can be used in the `WHERE` clause of the `SELECT` statement, but `LIKE` can also be used in other places, such as defining an
  8. <<sql-index-patterns, index pattern>> or across various <<sql-commands, SHOW commands>>.
  9. This section covers only the `SELECT ... WHERE ...` usage.
  10. NOTE: One significant difference between `LIKE`/`RLIKE` and the <<sql-functions-search, full-text search predicates>> is that the former
  11. act on <<sql-multi-field, exact fields>> while the latter also work on <<text, analyzed>> fields. If the field used with `LIKE`/`RLIKE` doesn't
  12. have an exact not-normalized sub-field (of <<keyword, keyword>> type) {es-sql} will not be able to run the query. If the field is either exact
  13. or has an exact sub-field, it will use it as is, or it will automatically use the exact sub-field even if it wasn't explicitly specified in the statement.
  14. [[sql-like-operator]]
  15. ==== `LIKE`
  16. .Synopsis:
  17. [source, sql]
  18. --------------------------------------------------
  19. expression <1>
  20. LIKE constant_exp <2>
  21. --------------------------------------------------
  22. <1> typically a field, or a constant expression
  23. <2> pattern
  24. .Description:
  25. The SQL `LIKE` operator is used to compare a value to similar values using wildcard operators. There are two wildcards used in conjunction
  26. with the `LIKE` operator:
  27. * The percent sign (%)
  28. * The underscore (_)
  29. The percent sign represents zero, one or multiple characters. The underscore represents a single number or character. These symbols can be
  30. used in combinations.
  31. [source, sql]
  32. ----
  33. include-tagged::{sql-specs}/docs/docs.csv-spec[simpleLike]
  34. ----
  35. There is, also, the possibility of using an escape character if one needs to match the wildcard characters themselves. This can be done
  36. by using the `ESCAPE [escape_character]` statement after the `LIKE ...` operator:
  37. SELECT name, author FROM library WHERE name LIKE 'Dune/%' ESCAPE '/';
  38. In the example above `/` is defined as an escape character which needs to be placed before the `%` or `_` characters if one needs to
  39. match those characters in the pattern specifically. By default, there is no escape character defined.
  40. IMPORTANT: Even though `LIKE` is a valid option when searching or filtering in {es-sql}, full-text search predicates
  41. `MATCH` and `QUERY` are <<sql-like-prefer-full-text, faster and much more powerful and are the preferred alternative>>.
  42. [[sql-rlike-operator]]
  43. ==== `RLIKE`
  44. .Synopsis:
  45. [source, sql]
  46. --------------------------------------------------
  47. expression <1>
  48. RLIKE constant_exp <2>
  49. --------------------------------------------------
  50. <1> typically a field, or a constant expression
  51. <2> pattern
  52. .Description:
  53. This operator is similar to `LIKE`, but the user is not limited to search for a string based on a fixed pattern with the percent sign (`%`)
  54. and underscore (`_`); the pattern in this case is a regular expression which allows the construction of more flexible patterns.
  55. For more details about the regular expressions syntax, https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[Java's Pattern class javadoc]
  56. is a good starting point.
  57. [source, sql]
  58. ----
  59. include-tagged::{sql-specs}/docs/docs.csv-spec[simpleRLike]
  60. ----
  61. IMPORTANT: Even though `RLIKE` is a valid option when searching or filtering in {es-sql}, full-text search predicates
  62. `MATCH` and `QUERY` are <<sql-like-prefer-full-text, faster and much more powerful and are the preferred alternative>>.
  63. [[sql-like-prefer-full-text]]
  64. ==== Prefer full-text search predicates
  65. When using `LIKE`/`RLIKE`, do consider using <<sql-functions-search, full-text search predicates>> which are faster, much more powerful
  66. and offer the option of sorting by relevancy (results can be returned based on how well they matched).
  67. For example:
  68. [cols="<m,<m"]
  69. |===
  70. ^s|LIKE/RLIKE ^s|QUERY/MATCH
  71. |`foo LIKE 'bar'` |`MATCH(foo, 'bar')`
  72. |`foo LIKE 'bar' AND tar LIKE 'goo'` |`MATCH('foo^2, tar^5', 'bar goo', 'operator=and')`
  73. |`foo LIKE 'barr'` |`QUERY('foo: bar~')`
  74. |`foo LIKE 'bar' AND tar LIKE 'goo'` |`QUERY('foo: bar AND tar: goo')`
  75. |`foo RLIKE 'ba.*'` |`MATCH(foo, 'ba', 'fuzziness=AUTO:1,5')`
  76. |`foo RLIKE 'b.{1}r'` |`MATCH(foo, 'br', 'fuzziness=1')`
  77. |===