Skip to content

Commit 1a9b069

Browse files
authored
Minor: Update DataFrame::write_table docs (#9169)
1 parent ec2daa6 commit 1a9b069

File tree

1 file changed

+9
-11
lines changed
  • datafusion/core/src/dataframe

1 file changed

+9
-11
lines changed

datafusion/core/src/dataframe/mod.rs

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,17 +1106,15 @@ impl DataFrame {
11061106
))
11071107
}
11081108

1109-
/// Write this DataFrame to the referenced table by name.
1110-
///
1111-
/// This method uses on the same underlying implementation
1112-
/// as the SQL Insert Into statement. Unlike most other DataFrame methods,
1113-
/// this method executes eagerly. Data is written to the table using an
1114-
/// execution plan returned by the [TableProvider]'s insert_into method.
1115-
/// Refer to the documentation of the specific [TableProvider] to determine
1116-
/// the expected data returned by the insert_into plan via this method.
1117-
/// For the built in ListingTable provider, a single [RecordBatch] containing
1118-
/// a single column and row representing the count of total rows written
1119-
/// is returned.
1109+
/// Execute this `DataFrame` and write the results to `table_name`.
1110+
///
1111+
/// Returns a single [RecordBatch] containing a single column and
1112+
/// row representing the count of total rows written.
1113+
///
1114+
/// Unlike most other `DataFrame` methods, this method executes eagerly.
1115+
/// Data is written to the table using the [`TableProvider::insert_into`]
1116+
/// method. This is the same underlying implementation used by SQL `INSERT
1117+
/// INTO` statements.
11201118
pub async fn write_table(
11211119
self,
11221120
table_name: &str,

0 commit comments

Comments
 (0)