2018-06-23 06:40:25 +08:00
|
|
|
[role="xpack"]
|
2018-06-21 02:40:13 +08:00
|
|
|
[[sql-syntax-describe-table]]
|
|
|
|
=== DESCRIBE TABLE
|
|
|
|
|
2020-02-15 00:58:45 +08:00
|
|
|
.Synopsis:
|
2018-06-21 02:40:13 +08:00
|
|
|
[source, sql]
|
|
|
|
----
|
2022-01-06 03:01:01 +08:00
|
|
|
DESCRIBE | DESC
|
|
|
|
[CATALOG identifier]? <1>
|
|
|
|
[INCLUDE FROZEN]? <2>
|
|
|
|
[table_identifier | <3>
|
|
|
|
LIKE pattern] <4>
|
2018-06-21 02:40:13 +08:00
|
|
|
----
|
|
|
|
|
2022-01-06 03:01:01 +08:00
|
|
|
<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.
|
2018-06-21 02:40:13 +08:00
|
|
|
|
2020-02-15 00:58:45 +08:00
|
|
|
*Description*: `DESC` and `DESCRIBE` are aliases to <<sql-syntax-show-columns>>.
|
2018-07-03 21:56:31 +08:00
|
|
|
|
2019-06-01 01:03:41 +08:00
|
|
|
[source, sql]
|
2018-07-03 21:56:31 +08:00
|
|
|
----
|
2019-03-25 21:22:59 +08:00
|
|
|
include-tagged::{sql-specs}/docs/docs.csv-spec[describeTable]
|
2018-07-03 21:56:31 +08:00
|
|
|
----
|