Skip to content

Commit ce73868

Browse files
committed
Update DataFusion architecture documentation
1 parent d7ca977 commit ce73868

File tree

5 files changed

+228
-87
lines changed

5 files changed

+228
-87
lines changed

datafusion/core/src/datasource/empty.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! An empty plan that is usefull for testing and generating plans without mapping them to actual data.
18+
//! [`EmptyTable`] usefull for testing.
1919
2020
use std::any::Any;
2121
use std::sync::Arc;
@@ -30,7 +30,8 @@ use crate::logical_expr::Expr;
3030
use crate::physical_plan::project_schema;
3131
use crate::physical_plan::{empty::EmptyExec, ExecutionPlan};
3232

33-
/// A table with a schema but no data.
33+
/// An empty plan that is usefull for testing and generating plans
34+
/// without mapping them to actual data.
3435
pub struct EmptyTable {
3536
schema: SchemaRef,
3637
partitions: usize,

datafusion/core/src/datasource/memory.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! In-memory data source for presenting a `Vec<RecordBatch>` as a data source that can be
19-
//! queried by DataFusion. This allows data to be pre-loaded into memory and then
20-
//! repeatedly queried without incurring additional file I/O overhead.
18+
//! [`MemTable`] for querying `Vec<RecordBatch>` by DataFusion.
2119
2220
use futures::{StreamExt, TryStreamExt};
2321
use std::any::Any;
@@ -41,7 +39,10 @@ use crate::physical_plan::memory::MemoryExec;
4139
use crate::physical_plan::ExecutionPlan;
4240
use crate::physical_plan::{repartition::RepartitionExec, Partitioning};
4341

44-
/// In-memory table
42+
/// In-memory data source for presenting a `Vec<RecordBatch>` as a
43+
/// data source that can be queried by DataFusion. This allows data to
44+
/// be pre-loaded into memory and then repeatedly queried without
45+
/// incurring additional file I/O overhead.
4546
#[derive(Debug)]
4647
pub struct MemTable {
4748
schema: SchemaRef,

0 commit comments

Comments
 (0)