elasticsearch/docs/reference/sql/language/syntax/commands/describe-table.asciidoc
Bogdan Pintea 13a0e420a3
SQL: Add CCS SQL documentation (#81545)
This adds the documentation for CCS SQL.

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
2022-01-05 20:01:01 +01:00

25 lines
645 B
Text

[role="xpack"]
[[sql-syntax-describe-table]]
=== DESCRIBE TABLE
.Synopsis:
[source, sql]
----
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 <<sql-syntax-show-columns>>.
[source, sql]
----
include-tagged::{sql-specs}/docs/docs.csv-spec[describeTable]
----