Skip to content

Commit acb3c47

Browse files
authored
Update docs to reflect default location provider (#1724)
Update the docs to reflect the simple location provider as the default location provider. related to #1721, and #1722.
1 parent 1d24e71 commit acb3c47

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

mkdocs/docs/configuration.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Iceberg tables support table properties to configure table behavior.
6464
| `write.parquet.dict-size-bytes` | Size in bytes | 2MB | Set the dictionary page size limit per row group |
6565
| `write.metadata.previous-versions-max` | Integer | 100 | The max number of previous version metadata files to keep before deleting after commit. |
6666
| `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`. |
67-
| `write.object-storage.enabled` | Boolean | True | Enables the [`ObjectStoreLocationProvider`](configuration.md#object-store-location-provider) that adds a hash component to file paths. Note: the default value of `True` differs from Iceberg's Java implementation |
67+
| `write.object-storage.enabled` | Boolean | False | Enables the [`ObjectStoreLocationProvider`](configuration.md#object-store-location-provider) that adds a hash component to file paths. |
6868
| `write.object-storage.partitioned-paths` | Boolean | True | Controls whether [partition values are included in file paths](configuration.md#partition-exclusion) when object storage is enabled |
6969
| `write.py-location-provider.impl` | String of form `module.ClassName` | null | Optional, [custom `LocationProvider`](configuration.md#loading-a-custom-location-provider) implementation |
7070
| `write.data.path` | String pointing to location | `{metadata.location}/data` | Sets the location under which data is written. |
@@ -213,8 +213,7 @@ Both data file and metadata file locations can be customized by configuring the
213213

214214
For more granular control, you can override the `LocationProvider`'s `new_data_location` and `new_metadata_location` methods to define custom logic for generating file paths. See [`Loading a Custom Location Provider`](configuration.md#loading-a-custom-location-provider).
215215

216-
PyIceberg defaults to the [`ObjectStoreLocationProvider`](configuration.md#object-store-location-provider), which generates file paths for
217-
data files that are optimized for object storage.
216+
PyIceberg defaults to the [`SimpleLocationProvider`](configuration.md#simple-location-provider) for managing file paths.
218217

219218
### Simple Location Provider
220219

@@ -234,9 +233,6 @@ partitioned over a string column `category` might have a data file with location
234233
s3://bucket/ns/table/data/category=orders/0000-0-5affc076-96a4-48f2-9cd2-d5efbc9f0c94-00001.parquet
235234
```
236235

237-
The `SimpleLocationProvider` is enabled for a table by explicitly setting its `write.object-storage.enabled` table
238-
property to `False`.
239-
240236
### Object Store Location Provider
241237

242238
PyIceberg offers the `ObjectStoreLocationProvider`, and an optional [partition-exclusion](configuration.md#partition-exclusion)
@@ -255,8 +251,8 @@ For example, a table partitioned over a string column `category` might have a da
255251
s3://bucket/ns/table/data/0101/0110/1001/10110010/category=orders/0000-0-5affc076-96a4-48f2-9cd2-d5efbc9f0c94-00001.parquet
256252
```
257253

258-
The `write.object-storage.enabled` table property determines whether the `ObjectStoreLocationProvider` is enabled for a
259-
table. It is used by default.
254+
The `ObjectStoreLocationProvider` is enabled for a table by explicitly setting its `write.object-storage.enabled` table
255+
property to `True`.
260256

261257
#### Partition Exclusion
262258

0 commit comments

Comments
 (0)