Skip to content

Fix most esql.query request types #2671

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 6 commits into from
Jul 10, 2024
Merged

Fix most esql.query request types #2671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
46eee2f
Add drop_null_columns parameter to /_query
pquentin Jul 10, 2024
3646cd6
Add undocumented profile parameter
pquentin Jul 10, 2024
9771a0b
Fix params to accept any values
pquentin Jul 10, 2024
7a98c64
Document /_query locale parameter
pquentin Jul 10, 2024
ab8dd7d
Run make contrib
pquentin Jul 10, 2024
6f442ea
Switch params to FieldValue[]
pquentin Jul 10, 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
15 changes: 14 additions & 1 deletion output/openapi/elasticsearch-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 14 additions & 1 deletion output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 26 additions & 2 deletions output/schema/schema-serverless.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 26 additions & 2 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions output/schema/validation-errors.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ eql-syntax,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-
eql,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html
esql-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html
esql-query-params,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-rest-params
esql-returning-localized-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/esql-rest.html#esql-locale-param
evaluate-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/evaluate-dfanalytics.html
execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/execute-enrich-policy-api.html
expected-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_expected_reciprocal_rank_err
Expand Down
15 changes: 13 additions & 2 deletions specification/esql/query/QueryRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

import { RequestBase } from '@_types/Base'
import { QueryContainer } from '@_types/query_dsl/abstractions'
import { ScalarValue } from '@_types/common'
import { FieldValue } from '@_types/common'

/**
* Executes an ES|QL request
Expand All @@ -38,6 +38,12 @@ export interface Request extends RequestBase {
* The character to use between values within a CSV row. Only valid for the CSV format.
*/
delimiter?: string
/**
* Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
* Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns.
* @server_default false
*/
drop_null_columns?: boolean
}
/**
* Use the `query` element to start a query. Use `time_zone` to specify an execution time zone and `columnar` to format the answer.
Expand All @@ -51,12 +57,17 @@ export interface Request extends RequestBase {
* Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.
*/
filter?: QueryContainer
/*
* Returns results (especially dates) formatted per the conventions of the locale.
* @doc_id esql-returning-localized-results
*/
locale?: string
/**
* To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
* @doc_id esql-query-params
*/
params?: Array<ScalarValue>
params?: Array<FieldValue>
profile?: boolean
Copy link
Member Author

Choose a reason for hiding this comment

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

This one is undocumented but used in the YAML tests, which is why I'm adding without details.

/**
* The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results.
*/
Expand Down
Loading