This is an automated email from the ASF dual-hosted git repository.
comphead pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 1a9b0693c3 Minor: Update DataFrame::write_table docs (#9169)
1a9b0693c3 is described below
commit 1a9b0693c3c2cc79190e03fb5befe2a7887751a9
Author: Andrew Lamb <[email protected]>
AuthorDate: Fri Feb 9 13:16:41 2024 -0500
Minor: Update DataFrame::write_table docs (#9169)
---
datafusion/core/src/dataframe/mod.rs | 20 +++++++++-----------
1 file changed, 9 insertions(+), 11 deletions(-)
diff --git a/datafusion/core/src/dataframe/mod.rs
b/datafusion/core/src/dataframe/mod.rs
index 2397d011d4..237f14d2c0 100644
--- a/datafusion/core/src/dataframe/mod.rs
+++ b/datafusion/core/src/dataframe/mod.rs
@@ -1106,17 +1106,15 @@ impl DataFrame {
))
}
- /// Write this DataFrame to the referenced table by name.
- ///
- /// This method uses on the same underlying implementation
- /// as the SQL Insert Into statement. Unlike most other DataFrame methods,
- /// this method executes eagerly. Data is written to the table using an
- /// execution plan returned by the [TableProvider]'s insert_into method.
- /// Refer to the documentation of the specific [TableProvider] to determine
- /// the expected data returned by the insert_into plan via this method.
- /// For the built in ListingTable provider, a single [RecordBatch]
containing
- /// a single column and row representing the count of total rows written
- /// is returned.
+ /// Execute this `DataFrame` and write the results to `table_name`.
+ ///
+ /// Returns a single [RecordBatch] containing a single column and
+ /// row representing the count of total rows written.
+ ///
+ /// Unlike most other `DataFrame` methods, this method executes eagerly.
+ /// Data is written to the table using the [`TableProvider::insert_into`]
+ /// method. This is the same underlying implementation used by SQL `INSERT
+ /// INTO` statements.
pub async fn write_table(
self,
table_name: &str,
