From 0dda9093a282bff02de304d3b688f22512ca41ef Mon Sep 17 00:00:00 2001 From: Sidra-009 Date: Wed, 3 Jun 2026 11:12:18 +0500 Subject: [PATCH 1/5] docs: fix OSS/COS configuration tables --- mkdocs/docs/configuration.md | 41 +++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 3f82f78895..ca142a14de 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -189,18 +189,43 @@ For the FileIO there are several configuration options available: ### Alibaba Cloud Object Storage Service (OSS) +| Key | Example | Description | +| ---------------------------- | --------------------------------------------- | ----------- | +| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | +| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. | +| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. | +| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. | +| s3.force-virtual-addressing | True | Whether to use virtual addressing of buckets. This is set to `True` by default as OSS can only be accessed with virtual hosted style address. | +| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. | + PyIceberg uses [S3FileSystem](https://arrow.apache.org/docs/python/generated/pyarrow.fs.S3FileSystem.html) class to connect to OSS bucket as the service is [compatible with S3 SDK](https://www.alibabacloud.com/help/en/oss/developer-reference/use-amazon-s3-sdks-to-access-oss) as long as the endpoint is addressed with virtual hosted style. -| Key | Example | Description | -| -------------------- | ------------------- | ------------------------------------------------ | -| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | -| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. | -| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. | -| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. | -| s3.force-virtual-addressing | True | Whether to use virtual addressing of buckets. This is set to `True` by default as OSS can only be accessed with virtual hosted style address. | -| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. | +### Tencent Cloud Object Storage (COS) + +Tencent Cloud Object Storage (COS) is S3-compatible and can be used with PyIceberg using the existing S3FileIO / PyArrowFileIO implementation. + +No additional dependencies are required. + +| Key | Example | Description | +| -------------------- | ------------------------------ | ----------- | +| s3.endpoint | | Tencent COS S3-compatible endpoint | +| s3.access-key-id | admin | Access key for COS | +| s3.secret-access-key | password | Secret key for COS | +| s3.session-token | AQoDYXdzEJr... | Optional session token | + +### Example + +```python +catalog = load_catalog( + **{ + "s3.endpoint": "https://cos.ap-guangzhou.myqcloud.com", + "s3.access-key-id": "admin", + "s3.secret-access-key": "password", + } +) +``` From 68b43a1023598ee978cf6ee93de71ac92b0b4bfe Mon Sep 17 00:00:00 2001 From: Sidra-009 Date: Wed, 3 Jun 2026 12:17:06 +0500 Subject: [PATCH 2/5] fix: clean OSS and COS configuration tables formatting and alignment --- mkdocs/docs/configuration.md | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index ca142a14de..acd62678b1 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -189,33 +189,31 @@ For the FileIO there are several configuration options available: ### Alibaba Cloud Object Storage Service (OSS) -| Key | Example | Description | -| ---------------------------- | --------------------------------------------- | ----------- | -| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | -| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. | -| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. | -| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. | -| s3.force-virtual-addressing | True | Whether to use virtual addressing of buckets. This is set to `True` by default as OSS can only be accessed with virtual hosted style address. | -| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. | - - - PyIceberg uses [S3FileSystem](https://arrow.apache.org/docs/python/generated/pyarrow.fs.S3FileSystem.html) class to connect to OSS bucket as the service is [compatible with S3 SDK](https://www.alibabacloud.com/help/en/oss/developer-reference/use-amazon-s3-sdks-to-access-oss) as long as the endpoint is addressed with virtual hosted style. +| Key | Example | Description | +| ---------------------------- | -------------------------------------------------- | ----------- | +| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | +| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. | +| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. | +| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. | +| s3.force-virtual-addressing | True | Whether to use virtual addressing of buckets. This is set to `True` by default as OSS can only be accessed with virtual hosted style address. | +| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. | + ### Tencent Cloud Object Storage (COS) Tencent Cloud Object Storage (COS) is S3-compatible and can be used with PyIceberg using the existing S3FileIO / PyArrowFileIO implementation. No additional dependencies are required. -| Key | Example | Description | -| -------------------- | ------------------------------ | ----------- | -| s3.endpoint | | Tencent COS S3-compatible endpoint | -| s3.access-key-id | admin | Access key for COS | -| s3.secret-access-key | password | Secret key for COS | -| s3.session-token | AQoDYXdzEJr... | Optional session token | +| Key | Example | Description | +| -------------------- | ---------------------------------------- | ----------- | +| s3.endpoint | | Tencent COS S3-compatible endpoint | +| s3.access-key-id | admin | Access key for COS | +| s3.secret-access-key | password | Secret key for COS | +| s3.session-token | AQoDYXdzEJr... | Optional session token | -### Example +#### Example ```python catalog = load_catalog( @@ -227,7 +225,7 @@ catalog = load_catalog( ) ``` - + ### Hugging Face From 93fe4fd3094955cc3190ebd59ba509e6bd7bb875 Mon Sep 17 00:00:00 2001 From: Sidra-009 Date: Thu, 4 Jun 2026 20:58:22 +0500 Subject: [PATCH 3/5] docs: remove redundant COS example --- mkdocs/docs/configuration.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index acd62678b1..5aced275d8 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -213,18 +213,6 @@ No additional dependencies are required. | s3.secret-access-key | password | Secret key for COS | | s3.session-token | AQoDYXdzEJr... | Optional session token | -#### Example - -```python -catalog = load_catalog( - **{ - "s3.endpoint": "https://cos.ap-guangzhou.myqcloud.com", - "s3.access-key-id": "admin", - "s3.secret-access-key": "password", - } -) -``` - ### Hugging Face From 7839429a9ed59ec2545b4fe8ab72af1f37c45781 Mon Sep 17 00:00:00 2001 From: Sidra-009 Date: Thu, 11 Jun 2026 11:05:54 +0500 Subject: [PATCH 4/5] docs: update configuration --- mkdocs/docs/configuration.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 5aced275d8..27033798db 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -189,22 +189,26 @@ For the FileIO there are several configuration options available: ### Alibaba Cloud Object Storage Service (OSS) + + PyIceberg uses [S3FileSystem](https://arrow.apache.org/docs/python/generated/pyarrow.fs.S3FileSystem.html) class to connect to OSS bucket as the service is [compatible with S3 SDK](https://www.alibabacloud.com/help/en/oss/developer-reference/use-amazon-s3-sdks-to-access-oss) as long as the endpoint is addressed with virtual hosted style. | Key | Example | Description | | ---------------------------- | -------------------------------------------------- | ----------- | -| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | +| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | | s3.access-key-id | admin | Configure the static access key id used to access the FileIO. | | s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. | | s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. | | s3.force-virtual-addressing | True | Whether to use virtual addressing of buckets. This is set to `True` by default as OSS can only be accessed with virtual hosted style address. | | s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. | + + ### Tencent Cloud Object Storage (COS) -Tencent Cloud Object Storage (COS) is S3-compatible and can be used with PyIceberg using the existing S3FileIO / PyArrowFileIO implementation. + -No additional dependencies are required. +Tencent Cloud Object Storage (COS) is S3-compatible and can be used with PyIceberg using the existing S3FileIO / PyArrowFileIO implementation. | Key | Example | Description | | -------------------- | ---------------------------------------- | ----------- | @@ -213,7 +217,7 @@ No additional dependencies are required. | s3.secret-access-key | password | Secret key for COS | | s3.session-token | AQoDYXdzEJr... | Optional session token | - + ### Hugging Face From ce381f33e93c98450fa2f62ad481cb7c8592ed38 Mon Sep 17 00:00:00 2001 From: Sidra-009 Date: Fri, 12 Jun 2026 21:02:47 +0500 Subject: [PATCH 5/5] docs: restore OSS endpoint trailing slash --- mkdocs/docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/configuration.md b/mkdocs/docs/configuration.md index 27033798db..e791d076be 100644 --- a/mkdocs/docs/configuration.md +++ b/mkdocs/docs/configuration.md @@ -195,7 +195,7 @@ PyIceberg uses [S3FileSystem](https://arrow.apache.org/docs/python/generated/pya | Key | Example | Description | | ---------------------------- | -------------------------------------------------- | ----------- | -| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | +| s3.endpoint | | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. | | s3.access-key-id | admin | Configure the static access key id used to access the FileIO. | | s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. | | s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. |