File: //opt/alt/python311/lib/python3.11/site-packages/elasticsearch/_sync/client/esql.py
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import typing as t
from elastic_transport import ObjectApiResponse
from ._base import NamespacedClient
from .utils import _rewrite_parameters
class EsqlClient(NamespacedClient):
@_rewrite_parameters(
body_fields=("query", "columnar", "filter", "locale", "params"),
ignore_deprecated_options={"params"},
)
def query(
self,
*,
query: t.Optional[str] = None,
columnar: t.Optional[bool] = None,
delimiter: t.Optional[str] = None,
error_trace: t.Optional[bool] = None,
filter: t.Optional[t.Mapping[str, t.Any]] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
format: t.Optional[str] = None,
human: t.Optional[bool] = None,
locale: t.Optional[str] = None,
params: t.Optional[t.Sequence[t.Union[None, bool, float, int, str]]] = None,
pretty: t.Optional[bool] = None,
body: t.Optional[t.Dict[str, t.Any]] = None,
) -> ObjectApiResponse[t.Any]:
"""
Executes an ESQL request
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/esql-rest.html>`_
:param query: The ES|QL query API accepts an ES|QL query string in the query
parameter, runs it, and returns the results.
:param columnar: By default, ES|QL returns results as rows. For example, FROM
returns each individual document as one row. For the JSON, YAML, CBOR and
smile formats, ES|QL can return the results in a columnar fashion where one
row represents all the values of a certain column in the results.
:param delimiter: The character to use between values within a CSV row. Only
valid for the CSV format.
:param filter: Specify a Query DSL query in the filter parameter to filter the
set of documents that an ES|QL query runs on.
:param format: A short version of the Accept header, e.g. json, yaml.
:param locale:
:param params: 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.
"""
if query is None and body is None:
raise ValueError("Empty value passed for parameter 'query'")
__path_parts: t.Dict[str, str] = {}
__path = "/_query"
__query: t.Dict[str, t.Any] = {}
__body: t.Dict[str, t.Any] = body if body is not None else {}
if delimiter is not None:
__query["delimiter"] = delimiter
if error_trace is not None:
__query["error_trace"] = error_trace
if filter_path is not None:
__query["filter_path"] = filter_path
if format is not None:
__query["format"] = format
if human is not None:
__query["human"] = human
if pretty is not None:
__query["pretty"] = pretty
if not __body:
if query is not None:
__body["query"] = query
if columnar is not None:
__body["columnar"] = columnar
if filter is not None:
__body["filter"] = filter
if locale is not None:
__body["locale"] = locale
if params is not None:
__body["params"] = params
__headers = {"accept": "application/json", "content-type": "application/json"}
return self.perform_request( # type: ignore[return-value]
"POST",
__path,
params=__query,
headers=__headers,
body=__body,
endpoint_id="esql.query",
path_parts=__path_parts,
)