describe-table.asciidoc 645 B

12345678910111213141516171819202122232425
  1. [role="xpack"]
  2. [[sql-syntax-describe-table]]
  3. === DESCRIBE TABLE
  4. .Synopsis:
  5. [source, sql]
  6. ----
  7. DESCRIBE | DESC
  8. [CATALOG identifier]? <1>
  9. [INCLUDE FROZEN]? <2>
  10. [table_identifier | <3>
  11. LIKE pattern] <4>
  12. ----
  13. <1> Catalog (cluster) identifier. Supports wildcards (`*`).
  14. <2> Whether or not to include frozen indices.
  15. <3> Single table (index or data stream) identifier or double-quoted multi-target pattern.
  16. <4> SQL LIKE pattern matching table names.
  17. *Description*: `DESC` and `DESCRIBE` are aliases to <<sql-syntax-show-columns>>.
  18. [source, sql]
  19. ----
  20. include-tagged::{sql-specs}/docs/docs.csv-spec[describeTable]
  21. ----