Skip to content

docs: Document missing write table properties in configuration #3879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
damansingh1313 wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −1
Open

docs: Document missing write table properties in configuration #3879

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion mkdocs/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,21 @@ Iceberg tables support table properties to configure table behavior.

| Key | Options | Default | Description |
|------------------------------------------|------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| `write.parquet.compression-codec` | `{uncompressed,zstd,gzip,snappy}` | zstd | Sets the Parquet compression coddec. |
| `write.parquet.compression-codec` | `{uncompressed,zstd,gzip,snappy}` | zstd | Sets the Parquet compression codec. |
| `write.parquet.compression-level` | Integer | null | Parquet compression level for the codec. If not set, it is up to PyIceberg |
| `write.parquet.row-group-size-bytes` | Size in bytes | 128MB | Target size of a Parquet row group when writing data files |
| `write.parquet.row-group-limit` | Number of rows | 1048576 | The upper bound of the number of entries within a single row group |
| `write.parquet.page-size-bytes` | Size in bytes | 1MB | Set a target threshold for the approximate encoded size of data pages within a column chunk |
| `write.parquet.page-row-limit` | Number of rows | 20000 | Set a target threshold for the maximum number of rows within a column chunk |
| `write.parquet.dict-size-bytes` | Size in bytes | 2MB | Set the dictionary page size limit per row group |
| `write.parquet.bloom-filter-max-bytes` | Size in bytes | 1MB | Maximum number of bytes for a Parquet bloom filter bitset per column |
| `write.parquet.bloom-filter-enabled.column.{column-name}` | Boolean | False | Enables writing a Parquet bloom filter for the given column |
| `write.target-file-size-bytes` | Size in bytes | 536870912 (512MB) | Target size of generated data files; larger inputs are split across multiple files |
| `write.format.default` | `{parquet}` | parquet | Default file format for data files written by PyIceberg |
| `write.avro.compression-codec` | `{gzip,zstd,snappy}` | gzip | Compression codec used when writing Avro files (for example, manifests) |
| `write.metadata.metrics.default` | `{none,counts,truncate(N),full}` | truncate(16) | Default column metrics mode recorded in manifests for data files |
| `write.metadata.metrics.column.{column-name}` | `{none,counts,truncate(N),full}` | (value of `write.metadata.metrics.default`) | Per-column override of the metrics mode |
| `write.summary.partition-limit` | Integer | 0 | Maximum number of partitions to include in a snapshot summary before the partition summary is omitted |
| `write.metadata.previous-versions-max` | Integer | 100 | The max number of previous version metadata files to keep before deleting after commit. |
| `write.metadata.delete-after-commit.enabled` | Boolean | False | Whether to automatically delete old *tracked* metadata files after each table commit. It will retain a number of the most recent metadata files, which can be set using property `write.metadata.previous-versions-max`. |
| `write.object-storage.enabled` | Boolean | False | Enables the [`ObjectStoreLocationProvider`](configuration.md#object-store-location-provider) that adds a hash component to file paths. |
Expand Down
Loading