Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor/Doc: Clarify DataFrame::write_table Documentation #8519

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Minor/Doc: Clarify DataFrame::write_table Documentation #8519

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4c7b37
update write_table doc
devinjdangelo Dec 12, 2023
e51eb05
fmt
devinjdangelo Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions datafusion/core/src/dataframe/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1013,11 +1013,16 @@ impl DataFrame {
))
}

/// Write this DataFrame to the referenced table
/// 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, writing data, and returning the count of rows written.
/// 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.
pub async fn write_table(
self,
table_name: &str,
Expand Down