OpenSearch/docs/reference/sql/language/syntax/describe-table.asciidoc

[role="xpack"]
[testenv="basic"]
[[sql-syntax-describe-table]]
=== DESCRIBE TABLE

.Synopsis
[source, sql]
----
DESCRIBE [table identifier<1> | [LIKE pattern<2>]]
----

<1> single table identifier or double quoted es multi index
<2> SQL LIKE pattern

or 

[source, sql]
----
DESC [table identifier<1>|[LIKE pattern<2>]]
----

<1> single table identifier or double quoted es multi index
<2> SQL LIKE pattern

.Description

`DESC` and `DESCRIBE` are aliases to <<sql-syntax-show-columns>>.

["source","sql",subs="attributes,callouts,macros"]
----
include-tagged::{sql-specs}/docs.csv-spec[describeTable]
----
[DOCS] Move sql to docs (#31474) 2018-06-22 18:40:25 -04:00			`[role="xpack"]`
			`[testenv="basic"]`
[DOCS] Significantly improve SQL docs Introduce SQL commands Move reserved keywords into an appendix Add section on security Introduce concepts section 2018-06-20 14:40:13 -04:00			`[[sql-syntax-describe-table]]`
			`=== DESCRIBE TABLE`

			`.Synopsis`
			`[source, sql]`
			`----`
DOC: Add SQL section on client applications Add setup instructions for a number of GUI SQL applications 2018-09-08 09:23:43 -04:00			`DESCRIBE [table identifier<1> \| [LIKE pattern<2>]]`
[DOCS] Significantly improve SQL docs Introduce SQL commands Move reserved keywords into an appendix Add section on security Introduce concepts section 2018-06-20 14:40:13 -04:00			`----`

DOC: Add SQL section on client applications Add setup instructions for a number of GUI SQL applications 2018-09-08 09:23:43 -04:00			`<1> single table identifier or double quoted es multi index`
			`<2> SQL LIKE pattern`

[DOCS] Significantly improve SQL docs Introduce SQL commands Move reserved keywords into an appendix Add section on security Introduce concepts section 2018-06-20 14:40:13 -04:00			`or`

			`[source, sql]`
			`----`
SQL: Show/desc commands now support table ids (#33363) Extend SHOW TABLES, DESCRIBE and SHOW COLUMNS to support table identifiers not just SQL LIKE pattern. This allows both Elasticsearch-style multi-index patterns and SQL LIKE. To disambiguate between the two (as the " vs ' can be easy to miss), the grammar now requires LIKE keyword as a prefix for all LIKE-like patterns. Also added some docs comparing the two types of patterns. Fix #33294 2018-09-04 09:54:10 -04:00			`DESC [table identifier<1>\|[LIKE pattern<2>]]`
[DOCS] Significantly improve SQL docs Introduce SQL commands Move reserved keywords into an appendix Add section on security Introduce concepts section 2018-06-20 14:40:13 -04:00			`----`

DOC: Add SQL section on client applications Add setup instructions for a number of GUI SQL applications 2018-09-08 09:23:43 -04:00			`<1> single table identifier or double quoted es multi index`
			`<2> SQL LIKE pattern`
[DOCS] Significantly improve SQL docs Introduce SQL commands Move reserved keywords into an appendix Add section on security Introduce concepts section 2018-06-20 14:40:13 -04:00
			`.Description`

			`DESC` and `DESCRIBE` are aliases to <<sql-syntax-show-columns>>.
DOC: Add examples to the SQL docs (#31633) Significantly improve the example snippets in the documentation. The examples are part of the test suite and checked nightly. To help readability, the existing dataset was extended (test_emp renamed to emp plus library). Improve output of JDBC tests to be consistent with the CLI Add lenient flag to JDBC asserts to allow type widening (a long is equivalent to a integer as long as the value is the same). 2018-07-03 09:56:31 -04:00
			`["source","sql",subs="attributes,callouts,macros"]`
			`----`
			`include-tagged::{sql-specs}/docs.csv-spec[describeTable]`
			`----`