Skip to content

Improve the docs for developers (Create a Developers / Hackers guide for DataFusion) #5501

@alamb

Description

@alamb

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)
  • DataSources (TableProvider trait, etc)

Specific tasks

Describe alternatives you've considered

Additional context
Part of a larger effort to improve documentation #3058

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions