elasticsearch/docs/reference/query-languages/sql/sql-index-frozen.md
Craig Taverner 94cad286bc
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.
2025-03-17 17:58:58 +01:00

36 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
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](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-unfreeze). 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](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query) 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:
```sql
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
```
```sql
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.