This is an automated email from the ASF dual-hosted git repository.
etudenhoefner pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/main by this push:
new 59d79e773d Docs: document view properties (#9961)
59d79e773d is described below
commit 59d79e773d0bc2061d8ced4cde6917eb4428dec6
Author: Eduard Tudenhoefner <[email protected]>
AuthorDate: Fri Mar 15 09:50:25 2024 +0100
Docs: document view properties (#9961)
---
docs/docs/view-configuration.md | 43 +++++++++++++++++++++++++++++++++++++++++
docs/mkdocs.yml | 2 ++
2 files changed, 45 insertions(+)
diff --git a/docs/docs/view-configuration.md b/docs/docs/view-configuration.md
new file mode 100644
index 0000000000..e8b02e32f2
--- /dev/null
+++ b/docs/docs/view-configuration.md
@@ -0,0 +1,43 @@
+---
+title: "Configuration"
+---
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# 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 e6b6a0052f..a8804ed04d 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
