Skip to content

[SQL][DOC][MINOR] update documents for Table and WriteBuilder #24658

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

Closed
cloud-fan wants to merge 1 commit into from
Closed

[SQL][DOC][MINOR] update documents for Table and WriteBuilder #24658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions sql/catalyst/src/main/java/org/apache/spark/sql/sources/v2/Table.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
* implementation can be a directory on the file system, a topic of Kafka, or a table in the
* catalog, etc.
* <p>
* This interface can mixin the following interfaces to support different operations, like
* {@code SupportsRead}.
* This interface can mixin {@code SupportsRead} and {@code SupportsWrite} to provide data reading
* and writing ability.
* <p>
* The default implementation of {@link #partitioning()} returns an empty array of partitions, and
* the default implementation of {@link #properties()} returns an empty map. These should be
Expand Down
6 changes: 6 additions & 0 deletions sql/core/src/main/java/org/apache/spark/sql/sources/v2/writer/WriteBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ default BatchWrite buildForBatch() {
" does not support batch write");
}

/**
* Returns a {@link StreamingWrite} to write data to streaming source. By default this method
* throws exception, data sources must overwrite this method to provide an implementation, if the
* {@link Table} that creates this write returns {@link TableCapability#STREAMING_WRITE} support
* in its {@link Table#capabilities()}.
*/
default StreamingWrite buildForStreaming() {
throw new UnsupportedOperationException(getClass().getName() +
" does not support streaming write");
Expand Down