elasticsearch/docs/reference/query-languages/sql/sql-syntax-describe-table.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

1.5 KiB

mapped_pages
https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-syntax-describe-table.html

DESCRIBE TABLE [sql-syntax-describe-table]

DESCRIBE | DESC
    [CATALOG identifier]? <1>
    [INCLUDE FROZEN]?     <2>
    [table_identifier |   <3>
     LIKE pattern]        <4>
  1. Catalog (cluster) identifier. Supports wildcards (*).
  2. Whether or not to include frozen indices.
  3. Single table (index or data stream) identifier or double-quoted multi-target pattern.
  4. SQL LIKE pattern matching table names.

Description: DESC and DESCRIBE are aliases to SHOW COLUMNS.

DESCRIBE emp;

       column       |     type      |    mapping
--------------------+---------------+---------------
birth_date          |TIMESTAMP      |datetime
dep                 |STRUCT         |nested
dep.dep_id          |VARCHAR        |keyword
dep.dep_name        |VARCHAR        |text
dep.dep_name.keyword|VARCHAR        |keyword
dep.from_date       |TIMESTAMP      |datetime
dep.to_date         |TIMESTAMP      |datetime
emp_no              |INTEGER        |integer
first_name          |VARCHAR        |text
first_name.keyword  |VARCHAR        |keyword
gender              |VARCHAR        |keyword
hire_date           |TIMESTAMP      |datetime
languages           |TINYINT        |byte
last_name           |VARCHAR        |text
last_name.keyword   |VARCHAR        |keyword
name                |VARCHAR        |keyword
salary              |INTEGER        |integer