From 59d79e773d0bc2061d8ced4cde6917eb4428dec6 Mon Sep 17 00:00:00 2001 From: Eduard Tudenhoefner Date: Fri, 15 Mar 2024 09:50:25 +0100 Subject: [PATCH] Docs: document view properties (#9961) --- docs/docs/view-configuration.md | 43 +++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 2 ++ 2 files changed, 45 insertions(+) create mode 100644 docs/docs/view-configuration.md diff --git a/docs/docs/view-configuration.md b/docs/docs/view-configuration.md new file mode 100644 index 000000000000..e8b02e32f23c --- /dev/null +++ b/docs/docs/view-configuration.md @@ -0,0 +1,43 @@ +--- +title: "Configuration" +--- + + +# Configuration + +## View properties + +Iceberg views support properties to configure view behavior. Below is an overview of currently available view properties. + + +| Property | Default | Description | +|--------------------------------------------|---------|------------------------------------------------------------------------------------| +| write.metadata.compression-codec | gzip | Metadata compression codec: `none` or `gzip` | +| version.history.num-entries | 10 | Controls the number of `versions` to retain | +| replace.drop-dialect.allowed | false | Controls whether a SQL dialect is allowed to be dropped during a replace operation | + + +### View behavior properties + + +| Property | Default | Description | +|-------------------------------------|---------------------|--------------------------------------------------------------------| +| commit.retry.num-retries | 4 | Number of times to retry a commit before failing | +| commit.retry.min-wait-ms | 100 | Minimum time in milliseconds to wait before retrying a commit | +| commit.retry.max-wait-ms | 60000 (1 min) | Maximum time in milliseconds to wait before retrying a commit | +| commit.retry.total-timeout-ms | 1800000 (30 min) | Total retry timeout period in milliseconds for a commit | diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e6b6a0052f16..a8804ed04dc4 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -31,6 +31,8 @@ nav: - performance.md - reliability.md - schemas.md + - Views: + - view-configuration.md - Spark: - spark-getting-started.md - spark-configuration.md