Skip to content

doc: Document DESCRIBE comman in ddl.md #16524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 23, 2025

Conversation

krikera
Copy link
Contributor

@krikera krikera commented Jun 23, 2025

Add documentation for DESCRIBE and DESC commands with syntax, examples, and output format explanation.

Fixes #16518

Which issue does this PR close?

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:

  • Syntax for both DESCRIBE and DESC aliases
  • Output format explanation (column_name, data_type, is_nullable)
  • Three examples: basic usage, DESC alias, and external tables
  • Compatibility note for all table types

Are these changes tested?

The DESCRIBE command functionality is already tested in datafusion/sqllogictest/test_files/describe.slt and information_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.

Add documentation for DESCRIBE and DESC commands with syntax, examples, and output format explanation.

Fixes apache#16518
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 23, 2025
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me -- thank you @krikera

FYI @comphead

@alamb
Copy link
Contributor

alamb commented Jun 23, 2025

I took the liberty of pushing a commit to get the CI to pass

Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @krikera for the nice first contribution!

@comphead comphead merged commit 26e27b0 into apache:main Jun 23, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: Document DESCRIBE command in ddl.md
3 participants