stevenzwu commented on code in PR #5967:
URL: https://github.com/apache/iceberg/pull/5967#discussion_r1040195457
##########
docs/flink-getting-started.md:
##########
@@ -683,7 +683,58 @@ env.execute("Test Iceberg DataStream");
OVERWRITE and UPSERT can't be set together. In UPSERT mode, if the table is
partitioned, the partition fields should be included in equality fields.
{{< /hint >}}
-## Write options
+## Options
+### Read options
+
+Flink read options are passed when configuring the Flink IcebergSource, like
this:
+
+```
+IcebergSource.forRowData()
+ .tableLoader(TableLoader.fromCatalog(...))
+ .assignerFactory(new SimpleSplitAssignerFactory())
+ .streaming(true)
+
.streamingStartingStrategy(StreamingStartingStrategy.INCREMENTAL_FROM_LATEST_SNAPSHOT)
+ .startSnapshotId(3821550127947089987L)
+ .monitorInterval(Duration.ofMillis(10L)) // or .set("monitor-interval",
"10s")
+ .build()
+```
+For Flink SQL, read options can be passed in via SQL hints like this:
+```
+SELECT * FROM tableName /*+ OPTIONS('monitor-interval'='10s') */
+...
+```
+
+Options can be passed in via Flink configuration, which will be applied to
current session. Note that not all options support this mode.
+
+```
+env.getConfig()
+ .getConfiguration()
+ .set(FlinkReadOptions.SPLIT_FILE_OPEN_COST, 1000L);
+...
+```
+
+`Read option` has the highest priority, followed by `Flink configuration` and
then `Table property`.
+
+| Read option | Flink configuration
| Table property | Default
| Description |
+| --------------------------------------------- |
--------------------------------------------- | ---------------------------- |
---------------------------------- |
------------------------------------------------------------ |
+| snapshot-id | N/A
| N/A | N/A
| For time travel in batch mode. Read data from the specified snapshot-id.
|
Review Comment:
Default should be `null` (not `N/A`)
--
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.
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org
