Skip to content
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

Add documentation for SHOW FUNCTIONS #13868

Merged
merged 1 commit into from
Dec 21, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Dec 21, 2024

Which issue does this PR close?

Rationale for this change

We should document features so users can more easily find them

Also, @comphead says #13799 (comment)

Thanks @goldmedal it would be really nice to update the user documentation

What changes are included in this PR?

  1. Add documentation (copy / paste from the description on Implement SHOW FUNCTIONS #13799 from @goldmedal )
  2. Add section headings for the SHOW / information_schema tables

Here is the new content rendered:

Screenshot 2024-12-20 at 9 50 27 PM

Are these changes tested?

CI

Are there any user-facing changes?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 21, 2024
@@ -22,7 +22,10 @@
DataFusion supports showing metadata about the tables and views available. This information can be accessed using the
views of the ISO SQL `information_schema` schema or the DataFusion specific `SHOW TABLES` and `SHOW COLUMNS` commands.

To show tables in the DataFusion catalog, use the `SHOW TABLES` command or the `information_schema.tables` view:
## `SHOW TABLES`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This makes the table of contents have headers so it is easier to find these items I think

Screenshot 2024-12-20 at 9 49 56 PM

@alamb alamb mentioned this pull request Dec 21, 2024
Copy link
Contributor

@goldmedal goldmedal left a comment

Choose a reason for hiding this comment

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

Thanks @alamb, It looks good to me

@comphead comphead merged commit 2639fe0 into apache:main Dec 21, 2024
7 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.

3 participants