Skip to content

[SPARK-26811][SQL][followup] fix some documentation #24285

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

[SPARK-26811][SQL][followup] fix some documentation #24285

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
2 changes: 1 addition & 1 deletion sql/core/src/main/java/org/apache/spark/sql/sources/v2/SupportsRead.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import org.apache.spark.sql.util.CaseInsensitiveStringMap;

/**
* An internal base interface of mix-in interfaces for readable {@link Table}. This adds
* A mix-in interface of {@link Table}, to indicate that it's readable. This adds
* {@link #newScanBuilder(CaseInsensitiveStringMap)} that is used to create a scan for batch,
* micro-batch, or continuous processing.
*/
Expand Down
2 changes: 1 addition & 1 deletion sql/core/src/main/java/org/apache/spark/sql/sources/v2/SupportsWrite.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import org.apache.spark.sql.util.CaseInsensitiveStringMap;

/**
* An internal base interface of mix-in interfaces for writable {@link Table}. This adds
* A mix-in interface of {@link Table}, to indicate that it's writable. This adds
* {@link #newWriteBuilder(CaseInsensitiveStringMap)} that is used to create a write
* for batch or streaming.
*/
Expand Down
8 changes: 5 additions & 3 deletions sql/core/src/main/java/org/apache/spark/sql/sources/v2/reader/Scan.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.spark.sql.sources.v2.SupportsContinuousRead;
import org.apache.spark.sql.sources.v2.SupportsMicroBatchRead;
import org.apache.spark.sql.sources.v2.Table;
import org.apache.spark.sql.sources.v2.TableCapability;

/**
* A logical representation of a data source scan. This interface is used to provide logical
Expand All @@ -32,8 +33,8 @@
* This logical representation is shared between batch scan, micro-batch streaming scan and
* continuous streaming scan. Data sources must implement the corresponding methods in this
* interface, to match what the table promises to support. For example, {@link #toBatch()} must be
* implemented, if the {@link Table} that creates this {@link Scan} returns BATCH_READ support in
* its {@link Table#capabilities()}.
* implemented, if the {@link Table} that creates this {@link Scan} returns
* {@link TableCapability#BATCH_READ} support in its {@link Table#capabilities()}.
* </p>
*/
@Evolving
Expand Down Expand Up @@ -61,7 +62,8 @@ default String description() {
/**
* Returns the physical representation of this scan for batch query. By default this method throws
* exception, data sources must overwrite this method to provide an implementation, if the
* {@link Table} that creates this returns batch read support in its {@link Table#capabilities()}.
* {@link Table} that creates this scan returns {@link TableCapability#BATCH_READ} in its
* {@link Table#capabilities()}.
*
* @throws UnsupportedOperationException
*/
Expand Down