You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem or challenge? Please describe what you are trying to do.
DataFusion is primarily aimed at developers, as explained in https://github.com/apache/arrow-datafusion#use-cases
Thus, it will help if provide documentation that helps developers understand what DataFusion offers and if it is appropriate for their project or not.
Describe the solution you'd like
I would like a DataFusion Architecture guide – aimed at other developers, that contains high level information about how DataFusion is organized (for example, with the content described in #5499)
The trick will be to keep the guide helpful but general enough that it doesn't get out of date too quickly
Topics:
Basic flow
Important structures (LogicalPlan, Exprs, SessionContext, PhysicalExpr, ExecutionPlan)
In general I think keeping the architecture / code documentation as close to the code as possible is a good idea, so I am leaning towards keeping in in doc comments
alamb
changed the title
Create a Developers / Hackers guide for DataFusion
Improve the docs for developers (Create a Developers / Hackers guide for DataFusion)
Apr 8, 2023
Is your feature request related to a problem or challenge? Please describe what you are trying to do.
DataFusion is primarily aimed at developers, as explained in https://github.com/apache/arrow-datafusion#use-cases
Thus, it will help if provide documentation that helps developers understand what DataFusion offers and if it is appropriate for their project or not.
Describe the solution you'd like
I would like a DataFusion Architecture guide – aimed at other developers, that contains high level information about how DataFusion is organized (for example, with the content described in #5499)
The trick will be to keep the guide helpful but general enough that it doesn't get out of date too quickly
Topics:
Specific tasks
TableProvider
CatalogProvider
SessionContext
SessionContext
,SessionState
andTaskContext
Describe alternatives you've considered
Additional context
Part of a larger effort to improve documentation #3058
The text was updated successfully, but these errors were encountered: