doc: Document DESCRIBE comman in ddl.md #16524
Merged
+77
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for DESCRIBE and DESC commands with syntax, examples, and output format explanation.
Fixes #16518
Which issue does this PR close?
DESCRIBE
command inddl.md
#16518.Rationale for this change
The
DESCRIBE
command was not documented in the user guide, making it difficult for users to discover and use this feature.What changes are included in this PR?
Adds documentation to
docs/source/user-guide/sql/ddl.md
including:DESCRIBE
andDESC
aliasesAre these changes tested?
The
DESCRIBE
command functionality is already tested indatafusion/sqllogictest/test_files/describe.slt
andinformation_schema.slt
. This PR only adds documentation.Are there any user-facing changes?
Yes - users can now find
DESCRIBE
command documentation in the official user guide with clear usage examples and expected output format.