added explaination for Schema and DFSchema to documentation #15329
Conversation
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
github-actions
bot
added
the
documentation
…e are only introducing syntax
comphead
reviewed
Mar 20, 2025
comphead
reviewed
Mar 20, 2025
| From Schema to DFSchema: Use `DFSchema::try_from_qualified_schema` with a table name and original schema. See example below: | ||
|
|
||
| > let df_schema = DFSchema::try_from_qualified_schema("t1", &arrow_schema).unwrap(); | ||
Contributor
There was a problem hiding this comment.
For conversion it is worth to point to DFSchema link documentation https://docs.rs/datafusion/latest/datafusion/common/struct.DFSchema.html#converting-back-to-arrow-schema
Other conversion methods which are suitable for users it is nice to document in the rust doc
Contributor
Author
There was a problem hiding this comment.
Hi Comphead, thank you for your review! Your advice is really helpful, I've made changes based on your advice and pushed a new version for you to review.
comphead
reviewed
Mar 21, 2025
Jiashu-Hu
force-pushed
the
Dcoument/updateDFSchemaDescription
branch
from
d3b3c27 to
f54060e
Compare
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?
Rationale for this change
Added some description about DFSchema and Schema for make user easy to understanding and easy to use
What changes are included in this PR?
Updated documentation we a new section "Arrow Schema and DataFusion DFSchema"
Are these changes tested?
No need to test
Are there any user-facing changes?
Yes, documentation is user-facing changes