some docs

apache · Jan 15, 2024 · be991c9 · be991c9
1 parent 15be1ea
commit be991c9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/datafusion/core/src/datasource/cte.rs → ...sion/core/src/datasource/cte_worktable.rs b/datafusion/core/src/datasource/cte.rs → ...sion/core/src/datasource/cte_worktable.rs
@@ -35,14 +35,17 @@ use datafusion_common::DataFusionError;
 use crate::datasource::{TableProvider, TableType};
 use crate::execution::context::SessionState;
 
-/// TODO: add docs
+/// The temporary working table where the previous iteration of a recursive query is stored
+/// Naming is based on PostgreSQL's implementation.
+/// See here for more details: www.postgresql.org/docs/11/queries-with.html#id-1.5.6.12.5.4
 pub struct CteWorkTable {
     name: String,
+    /// This schema must be shared across both the static and recursive terms of a recursive query
     table_schema: SchemaRef,
 }
 
 impl CteWorkTable {
-    /// TODO: add doc
+    /// construct a new CteWorkTable with the given name and schema
     pub fn new(name: &str, table_schema: SchemaRef) -> Self {
         Self {
             name: name.to_owned(),

diff --git a/datafusion/core/src/datasource/mod.rs b/datafusion/core/src/datasource/mod.rs
@@ -20,7 +20,7 @@
 //! [`ListingTable`]: crate::datasource::listing::ListingTable
 
 pub mod avro_to_arrow;
-pub mod cte;
+pub mod cte_worktable;
 pub mod default_table_source;
 pub mod empty;
 pub mod file_format;

diff --git a/datafusion/core/src/execution/context/mod.rs b/datafusion/core/src/execution/context/mod.rs
@@ -26,7 +26,7 @@ mod parquet;
 use crate::{
     catalog::{CatalogList, MemoryCatalogList},
     datasource::{
-        cte::CteWorkTable,
+        cte_worktable::CteWorkTable,
         function::{TableFunction, TableFunctionImpl},
         listing::{ListingOptions, ListingTable},
         provider::TableProviderFactory,