root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/query-languages/esql/_snippets/functions/layout/qstr.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

36 lines
809 B
Markdown
Raw Normal View History

Split ESQL functions/operators docs files (#123904) * Port from asciidocalypse * Fix links for operator lists * Remove unused image files after moving/editing them * Fix lists links * Fix like/rlike links * Fix remaining bad references to /elasticsearch/docs * Fix logstash and beats references * Fix logstash and beats references * Fix image links
2025-03-04 21:59:31 +08:00
% This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
## `QSTR` [esql-qstr]
Additional support for docs for ES|QL operators and version-specific differentiation (#125251) This PR was originally focused on improving support for Kibana docs, in particular the missing operator docs, but it has expanded to cover a bunch of related things: * Primarily the main work was to improve operators support. ESQL generated docs cover all functions and most operators for which their is a clear operator class and test class. However, some are built-in behaviour and need additional support. This PR adds more generated content for those operators. * Various specific operators requested by Kibana: Cast & null-predicates, and in particular the addition of examples * Two functions without examples: mv_append and to_date_nanos * Many small visual document cleanups (spelling, grammar, capitalization, etc.) * Initial support for `applies_to` for multi-version differentiation. This last point requires more work, as it is not yet agreed on just how we want this to look. We'll probably need to do refinements in followup PR. Consider the version in this PR as a first step into how this could look.
2025-03-24 16:56:45 +08:00
:::{warning}
###### COMING 9.1.0
ESQL autogenerate docs v3 (#124312) Building on the work started in https://github.com/elastic/elasticsearch/pull/123904, we now want to auto-generate most of the small subfiles from the ES|QL functions unit tests. This work also investigates any remaining discrepancies between the original asciidoc version and the new markdown, and tries to minimize differences so the docs do not look too different. The kibana json and markdown files are moved to a new location, and the operator docs are a little more generated than before (although still largely manual).
2025-03-13 21:16:46 +08:00
Do not use on production environments. This functionality is in technical preview and
may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview
are not subject to the support SLA of official GA features.
Additional support for docs for ES|QL operators and version-specific differentiation (#125251) This PR was originally focused on improving support for Kibana docs, in particular the missing operator docs, but it has expanded to cover a bunch of related things: * Primarily the main work was to improve operators support. ESQL generated docs cover all functions and most operators for which their is a clear operator class and test class. However, some are built-in behaviour and need additional support. This PR adds more generated content for those operators. * Various specific operators requested by Kibana: Cast & null-predicates, and in particular the addition of examples * Two functions without examples: mv_append and to_date_nanos * Many small visual document cleanups (spelling, grammar, capitalization, etc.) * Initial support for `applies_to` for multi-version differentiation. This last point requires more work, as it is not yet agreed on just how we want this to look. We'll probably need to do refinements in followup PR. Consider the version in this PR as a first step into how this could look.
2025-03-24 16:56:45 +08:00
Support for optional named parameters is only available from 9.1.0
:::
Split ESQL functions/operators docs files (#123904) * Port from asciidocalypse * Fix links for operator lists * Remove unused image files after moving/editing them * Fix lists links * Fix like/rlike links * Fix remaining bad references to /elasticsearch/docs * Fix logstash and beats references * Fix logstash and beats references * Fix image links
2025-03-04 21:59:31 +08:00
**Syntax**
:::{image} ../../../images/functions/qstr.svg
:alt: Embedded
:class: text-center
:::
:::{include} ../parameters/qstr.md
:::
:::{include} ../description/qstr.md
:::
:::{include} ../types/qstr.md
:::
ESQL autogenerate docs v3 (#124312) Building on the work started in https://github.com/elastic/elasticsearch/pull/123904, we now want to auto-generate most of the small subfiles from the ES|QL functions unit tests. This work also investigates any remaining discrepancies between the original asciidoc version and the new markdown, and tries to minimize differences so the docs do not look too different. The kibana json and markdown files are moved to a new location, and the operator docs are a little more generated than before (although still largely manual).
2025-03-13 21:16:46 +08:00
:::{include} ../functionNamedParams/qstr.md
:::
Split ESQL functions/operators docs files (#123904) * Port from asciidocalypse * Fix links for operator lists * Remove unused image files after moving/editing them * Fix lists links * Fix like/rlike links * Fix remaining bad references to /elasticsearch/docs * Fix logstash and beats references * Fix logstash and beats references * Fix image links
2025-03-04 21:59:31 +08:00
:::{include} ../examples/qstr.md
:::