elasticsearch/docs/reference/query-languages/sql/sql-index-frozen.md
Craig Taverner a8b2428dd1
9.0 backport docs query languages (#125113)
* Restructure query-languages docs files for clarity (#124797)

In a few previous PR's we restructured the ES|QL docs to make it possible to generate them dynamically.

This PR just moves a few files around to make the query languages docs easier to work with, and a little more organized like the ES|QL docs.

A bit part of this was setting up redirects to the new locations, so other repo's could correctly link to the elasticsearch docs.

* After running tests, we revert a few features

* Fix build.gradle and improved some generating code

* After running tests

* Update x-pack/plugin/esql/build.gradle
2025-03-19 04:24:11 +11:00

1.5 KiB
Raw Blame History

mapped_pages
https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-index-frozen.html

Frozen Indices [sql-index-frozen]

By default, Elasticsearch SQL doesnt search frozen indices. To search frozen indices, use one of the following features:

dedicated configuration parameter
Set to true properties index_include_frozen in the SQL search API or index.include.frozen in the drivers to include frozen indices.
dedicated keyword
Explicitly perform the inclusion through the dedicated FROZEN keyword in the FROM clause or INCLUDE FROZEN in the SHOW commands:
SHOW TABLES INCLUDE FROZEN;

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |archive        |TABLE     |FROZEN INDEX
javaRestTest      |emp            |TABLE     |INDEX
javaRestTest      |employees      |VIEW      |ALIAS
javaRestTest      |library        |TABLE     |INDEX
SELECT * FROM FROZEN archive LIMIT 1;

     author      |        name        |  page_count   |    release_date
-----------------+--------------------+---------------+--------------------
James S.A. Corey |Leviathan Wakes     |561            |2011-06-02T00:00:00Z

Unless enabled, frozen indices are completely ignored; it is as if they do not exist and as such, queries ran against them are likely to fail.