Skip to content

Commit

Permalink
improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
eason-yuchen-liu committed Jun 11, 2024
1 parent 4ebd078 commit 1656580
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,8 @@ trait StateStoreProvider {
new WrappedReadStateStore(getStore(version))

/**
* This is an optional method, used by snapshotBatchId option when reading state as data source.
*
* Return an instance of [[ReadStateStore]] representing state data of the given version.
* The State Store will be constructed from the batch at startVersion, and applying delta files
* up to the endVersion. If there is no snapshot file of batch startVersion, an exception will
Expand All @@ -389,7 +391,7 @@ trait StateStoreProvider {
*/
def getReadStore(startVersion: Long, endVersion: Long): ReadStateStore =
throw new SparkUnsupportedOperationException("getReadStore with startVersion and endVersion " +
"is not supported by this StateStoreProvider")
s"is not supported by ${this.getClass.toString}")

/** Optional method for providers to allow for background maintenance (e.g. compactions) */
def doMaintenance(): Unit = { }
Expand Down

0 comments on commit 1656580

Please sign in to comment.