IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

SQL translate API

edit

SQL translate API

edit

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

edit

GET _sql/translate

POST _sql/translate

Prerequisites

edit

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

Limitations

edit

See SQL Limitations.

Request body

edit

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

Response body

edit

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

« SQL search API Synonyms APIs »