qinjunjerry commented on a change in pull request #10502:
[FLINK-14825][state-processor-api][docs] Rework state processor api
documentation
URL: https://github.com/apache/flink/pull/10502#discussion_r357185528
##########
File path: docs/dev/libs/state_processor_api.md
##########
@@ -333,20 +318,165 @@ val keyedState = savepoint.readKeyedState("my-uid", new
ReaderFunction());
</div>
</div>
-{% panel **Note:** When using a `KeyedStateReaderFunction` all state
descriptors must be registered eagerly inside of open. Any attempt to call
`RuntimeContext#getState`, `RuntimeContext#getListState`, or
`RuntimeContext#getMapState` will result in a `RuntimeException`. %}
+Along with reading registered state values, each key has access to a `Context`
with metadata such as registered event time and processing time timers.
+
+{% panel **Note:** When using a `KeyedStateReaderFunction` all state
descriptors must be registered eagerly inside of open. Any attempt to call a
`RuntimeContext#get*State` will result in a `RuntimeException`. %}
## Writing New Savepoints
-State writers are based around the abstraction of `Savepoint`, where one
`Savepoint` may have many operators and the state for any particular operator
is created using a `BootstrapTransformation`.
+`Savepoint`'s may also be written, which allows such use cases as
bootstrapping state based on historical data.
+Each savepoint is made up of many `BootstrapTransformation`'s (explained
below), which define the state for an individual operator.
Review comment:
Maybe this?
>... Each savepoint is made up of some `BootstrapTransformation`'s
(explained below), each of which defines the state for an individual operator.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
