SQL translate API

SQL translate API

New API reference

For the most up-to-date API details, refer to SQL APIs.

Translates an SQL search into a search API request containing Query DSL. See SQL Translate API.

resp = client.sql.translate(
    query="SELECT * FROM library ORDER BY page_count DESC",
    fetch_size=10,
)
print(resp)

const response = await client.sql.translate({
  query: "SELECT * FROM library ORDER BY page_count DESC",
  fetch_size: 10,
});
console.log(response);

POST _sql/translate
{
  "query": "SELECT * FROM library ORDER BY page_count DESC",
  "fetch_size": 10
}

Request

GET _sql/translate

POST _sql/translate

Prerequisites

• If the Elasticsearch security features are enabled, you must have the read index privilege for the data stream, index, or alias you search.

Limitations

See SQL Limitations.

Request body

The SQL translate API accepts the same request body parameters as the SQL search API, excluding cursor.

Response body

The SQL translate API returns the same response body as the search API.