Commit graph

16 commits

Author SHA1 Message Date
Costin Leau
bc785f5ca1
Esql/lookup join grammar (#116515)
First PR for adding LOOKUP JOIN in ESQL.
Introduces grammar and wires the main building blocks to execute a query; follow-ups are required (see #116208 for more details).

Co-authored-by: Nik Everett <nik9000@users.noreply.github.com>
2024-11-19 17:52:24 -08:00
Craig Taverner
c9c1765986
Remove duplicate 'the the' (#116023)
There were many places where `the the` was typed, in comments, docs and messages. All were incorrect and replaces with a single `the`
2024-10-31 19:14:58 +01:00
Michael Peterson
fd9d7335c8
CCS metadata is opt-in in ESQL JSON responses (#114437)
Since Kibana only needs CCS metadata in ESQL responses from certain well-defined locations,
we are making CCS metadata opt-in. This feature is patterned after ESQL profiling, where
you specify "profile": true in the ESQL body and if you asked for it will be present in the response
always (it will be written to the .async-search index and you can’t turn it off in later async-search
requests against this particular query ID) and if you didn’t ask for it at the beginning it will never
be present (it will NOT be written to the .async-search index when it is persisted).

The new option is "include_ccs_metadata": true/false.
2024-10-11 15:03:26 -04:00
Nik Everett
f4cb32991a
ESQL: change link to profile explanation (#114032)
Let's use a vendor neutral link.
2024-10-04 01:30:03 +10:00
Nik Everett
fe6f8d4b37
ESQL: Mention EXPLAIN ANALYZE in profile docs (#114025)
This mentions EXPLAIN ANALYZE and EXPLAIN PLAN in the docs for ESQL's
`profile` option. Those are things that folks from PostgreSQL and Oracle
are used to and might search for. And `profile` is the closest thing we
have to them.

EXPLAIN PLAN doesn't run the query - it just tells you what the plan is.
ESQL's `profile` always runs the query. So that's different. But it's
close!

EXPLAIN ANALYZE *does* run the query. It's pretty much the same.
2024-10-03 10:37:34 -04:00
Liam Thompson
d3fdb36852
[DOCS] Fix response value in esql-query-api.asciidoc (#111882) 2024-08-14 16:26:54 +02:00
Nik Everett
8f93bd00f9
ESQL: Document the profile option (#110727)
This adds some basic documentation for the `profile` option in ESQL but
doesn't really explain the results beyond "this is for human debugging."
We're not ready for any kind of specification for this thing, but it is
useful to look at.
2024-07-11 22:20:31 +10:00
Nik Everett
7916e6a231
ESQL: Implement LOOKUP, an "inline" enrich (#107987)
This adds support for `LOOKUP`, a command that implements a sort of
inline `ENRICH`, using data that is passed in the request:

```
$ curl -uelastic:password -HContent-Type:application/json -XPOST \
    'localhost:9200/_query?error_trace&pretty&format=txt' \
-d'{
    "query": "ROW a=1::LONG | LOOKUP t ON a",
    "tables": {
        "t": {
            "a:long":     [    1,     4,     2],
            "v1:integer": [   10,    11,    12],
            "v2:keyword": ["cat", "dog", "wow"]
        }
    },
    "version": "2024.04.01"
}'
      v1       |      v2       |       a       
---------------+---------------+---------------
10             |cat            |1
```

This required these PRs: * #107624 * #107634 * #107701 * #107762 *
#107923 * #107894 * #107982 * #108012 * #108020 * #108169 * #108191 *
#108334 * #108482 * #108696 * #109040 * #109045

Closes #107306
2024-06-07 11:38:51 +10:00
Alexander Spies
c5ac06a70c
Remove esql version from docs (#108933)
Follow-up to https://github.com/elastic/elasticsearch/pull/108919. The
latter needs to be merged first to have the docs tests pass, as it makes
the version parameter optional in requests.
2024-05-23 10:36:15 -04:00
Alexander Spies
71b276da90
ESQL: Add version to docs (#107225)
Docs for https://github.com/elastic/elasticsearch/pull/106824.

Does not cover the [REST API
specs](https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/esql.query.json)
as these don't cover the request body.
2024-04-15 10:50:00 -04:00
Liam Thompson
2c83881a0b
[DOCS][ESQL] Document locale rest parameter (#104985) 2024-02-06 10:36:51 +01:00
Nik Everett
919d282aa6
ESQL: Add option to drop null fields (#102428)
This adds an option to drop columns that are entirely null from the
results. Is this something we want?
2024-01-17 09:06:19 -05:00
Chris Hegarty
f14d87be58
Add ES|QL async query api docs (#104054)
This commit adds detailed API docs for the ES|QL async apis, as well as moving the narrative to the ES|QL specific REST docs. Additionally, a few top-level lists are reflowed to reflect that there are now multiple APIs.
2024-01-09 09:17:02 +00:00
Abdon Pijpelink
158ca9674f
[DOCS] More ES|QL limitations (#101972) 2023-11-14 17:49:40 +01:00
AlexB
931dcae41d
Add improvements to the ES|QL docs (#101195)
Content and structural improvements to the ES|QL docs

---------

Co-authored-by: Alexandros Batsakis <abatsakis@splunk.com>
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
2023-10-23 07:45:42 -07:00
Abdon Pijpelink
8ac4ba751e
Restructure ES|QL docs (#100806)
* Break out 'Limitations' into separate page

* Add REST API docs

* Restructure commands, functions, and operators refs

* Add placeholder for getting started guide

* Group 'Syntax', 'Metafields', and 'MV fields' under 'Language'

* Add placeholder for Kibana page

* Add link from landing page

* Apply uniform formatting to ACOS, CASE, and DATE_PARSE function refs

* Reword default LIMIT

* Add support for COUNT(*)

* Move 'Commands' and 'Functions and operators' to individual pages

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2023-10-17 17:36:14 +02:00