IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« SQL APIs Delete async SQL search API »
Elastic Docs ›Elasticsearch Guide [8.18] ›REST APIs ›SQL APIs

Clear SQL cursor API

edit
A newer version is available. Check out the latest documentation.

Clear SQL cursor API

edit

New API reference

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

Clears an SQL search cursor.

resp = client.sql.clear_cursor(
    cursor="sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=",
)
print(resp)
const response = await client.sql.clearCursor({
  cursor:
    "sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8=",
});
console.log(response);
POST _sql/close
{
  "cursor": "sDXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAAEWYUpOYklQMHhRUEtld3RsNnFtYU1hQQ==:BAFmBGRhdGUBZgVsaWtlcwFzB21lc3NhZ2UBZgR1c2Vy9f///w8="
}

Request

edit

POST _sql/close

Limitations

edit

See SQL Limitations.

Request body

edit
cursor
(Required, string) Cursor to clear.
« SQL APIs Delete async SQL search API »