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

[Docs] Add info on type system (DFSchema/Schema) to user guide #7724

Open
andygrove opened this issue Oct 2, 2023 · 3 comments
Open

[Docs] Add info on type system (DFSchema/Schema) to user guide #7724

andygrove opened this issue Oct 2, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@andygrove
Copy link
Member

Is your feature request related to a problem or challenge?

A source of confusion for new users is why we have Schema/SchemaRef as well as DFSchema/DFSchemaRef and how to convert between the two.

Here is a quick answer I gave to someone recently. Would be good to add a section about the type system to the user guide, perhaps before introducing TableProvider.

DFSchema is similar to Schema, but adds optional qualifiers (table names). You can convert from Schema by calling DFSchema::try_from_qualified_schema(Some("table_name"), arrow_schema). There is also DFField::from_qualified.

Describe the solution you'd like

More docs

Describe alternatives you've considered

No response

Additional context

No response

@andygrove andygrove added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Oct 2, 2023
@alamb
Copy link
Contributor

alamb commented Oct 5, 2023

Other things we should add:
doc examples of how to go back and forth between Schema. <--> DFSchema

@alamb
Copy link
Contributor

alamb commented Oct 5, 2023

(BTW I aspire to work on this ticket at some point soon)

@caicancai
Copy link
Member

take

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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants