Add a working, more complete example of using a catalog (docs)#1427
Open
toppyy wants to merge 4 commits intoapache:mainfrom
Open
Add a working, more complete example of using a catalog (docs)#1427toppyy wants to merge 4 commits intoapache:mainfrom
toppyy wants to merge 4 commits intoapache:mainfrom
Conversation
kevinjqliu
approved these changes
Mar 18, 2026
Contributor
kevinjqliu
left a comment
kevinjqliu
left a comment
There was a problem hiding this comment.
LGTM! a few minor nits
is there a way to render it locally to see if the formatting looks good?
| :py:class:`~datafusion.catalog.Schema`, and :py:class:`~datafusion.catalog.Table`. By default, | ||
| a :py:class:`~datafusion.context.SessionContext` comes with a single Catalog and a single Schema | ||
| with the names ``datafusion`` and ``default``, respectively. | ||
| with the names ``datafusion`` and ``public``, respectively. |
Contributor
There was a problem hiding this comment.
👍 verified locally
uv run --with datafusion python3 -c "
from datafusion import SessionContext
ctx = SessionContext()
print('Catalog names:', ctx.catalog_names())
catalog = ctx.catalog('datafusion')
print('Schema names:', catalog.names())
"
Catalog names: {'datafusion'}
Schema names: {'public'}
Author
|
I used |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Which issue does this PR close?
There's is no outstanding issue.
Rationale for this change
The docs have non-working/incomplete example for using the Catalog. SessionContext does not have a method
register_catalog. Also,ctxis not defined for example.The default schema name for SessionContext is not "default", but "public".
What changes are included in this PR?
A working example of using the catalog and accessing it is added. Some of the language is worked as the original statement is now evident in the example.
Changed the default schema name to "public" instead of "default".
Are there any user-facing changes?
The documentation is updated.