describe-table.asciidoc 607 B

1234567891011121314151617181920212223242526272829303132
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[sql-syntax-describe-table]]
  4. === DESCRIBE TABLE
  5. .Synopsis
  6. [source, sql]
  7. ----
  8. DESCRIBE [table identifier<1> | [LIKE pattern<2>]]
  9. ----
  10. <1> single table identifier or double quoted es multi index
  11. <2> SQL LIKE pattern
  12. or
  13. [source, sql]
  14. ----
  15. DESC [table identifier<1>|[LIKE pattern<2>]]
  16. ----
  17. <1> single table identifier or double quoted es multi index
  18. <2> SQL LIKE pattern
  19. .Description
  20. `DESC` and `DESCRIBE` are aliases to <<sql-syntax-show-columns>>.
  21. ["source","sql",subs="attributes,callouts,macros"]
  22. ----
  23. include-tagged::{sql-specs}/docs.csv-spec[describeTable]
  24. ----