You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@iceberg.apache.org by "Sidra-009 (via GitHub)" <gi...@apache.org> on 2026/06/03 07:21:59 UTC
[PR] docs: clean OSS and COS configuration tables [iceberg-python]
Sidra-009 opened a new pull request, #3452:
URL: https://github.com/apache/iceberg-python/pull/3452
## summary
fixed formatting issues in OSS and Tencent COS configuration documentation
## changes
- fixed broken markdown table alignment in OSS section
- cleaned and standardized OSS configuration table
- separated Tencent COS into its own properly formatted section
- ensured all configuration keys remain unchanged
- improved readability of documentation
## testing
- pre-commit checks passed
- markdown linting passed
- documentation-only change (no code behavior impact)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "ebyhr (via GitHub)" <gi...@apache.org>.
ebyhr commented on code in PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#discussion_r3356638452
##########
mkdocs/docs/configuration.md:
##########
@@ -189,20 +189,43 @@ For the FileIO there are several configuration options available:
### Alibaba Cloud Object Storage Service (OSS)
-<!-- markdown-link-check-disable -->
-
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 | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
+| Key | Example | Description |
+| ---------------------------- | -------------------------------------------------- | ----------- |
+| s3.endpoint | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
-<!-- markdown-link-check-enable-->
+### 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 | <https://cos.ap-guangzhou.myqcloud.com> | 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",
+ }
+)
Review Comment:
Does this example truly function without the `type` or `uri` properties?
I feel this example doesn't offer much benefit because it's almost a repeat of the table above. We could remove this example.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "Sidra-009 (via GitHub)" <gi...@apache.org>.
Sidra-009 commented on PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#issuecomment-4763866460
> Thanks for the PR @Sidra-009 and thanks everyone for the reviews
Appreciate all the feedback and reviews thanks for helping improve this contribution
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "Sidra-009 (via GitHub)" <gi...@apache.org>.
Sidra-009 commented on PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#issuecomment-4621476696
yes, #3452 replaces #3451
i closed the previous PR and kept this one focused only on the OSS/COS documentation changes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "Sidra-009 (via GitHub)" <gi...@apache.org>.
Sidra-009 commented on code in PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#discussion_r3357326396
##########
mkdocs/docs/configuration.md:
##########
@@ -189,20 +189,43 @@ For the FileIO there are several configuration options available:
### Alibaba Cloud Object Storage Service (OSS)
-<!-- markdown-link-check-disable -->
-
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 | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
+| Key | Example | Description |
+| ---------------------------- | -------------------------------------------------- | ----------- |
+| s3.endpoint | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
-<!-- markdown-link-check-enable-->
+### 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 | <https://cos.ap-guangzhou.myqcloud.com> | 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",
+ }
+)
Review Comment:
thanks for the feedback i removed the example block
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "rambleraptor (via GitHub)" <gi...@apache.org>.
rambleraptor commented on PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#issuecomment-4616413913
This is replacing #3451 right? Do you mind closing out that other PR?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu commented on PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#issuecomment-4763855032
Thanks for the PR @Sidra-009 and thanks everyone for the reviews
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "ebyhr (via GitHub)" <gi...@apache.org>.
ebyhr commented on code in PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#discussion_r3360364092
##########
mkdocs/docs/configuration.md:
##########
@@ -189,20 +189,31 @@ For the FileIO there are several configuration options available:
### Alibaba Cloud Object Storage Service (OSS)
-<!-- markdown-link-check-disable -->
-
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 | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
+| Key | Example | Description |
+| ---------------------------- | -------------------------------------------------- | ----------- |
+| s3.endpoint | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
-<!-- markdown-link-check-enable-->
+### 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 | <https://cos.ap-guangzhou.myqcloud.com> | 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 |
+
+<!-- markdown-link-check-disable -->
Review Comment:
It was `<!-- markdown-link-check-enable-->`. Why did you change it to `-disable`?
##########
mkdocs/docs/configuration.md:
##########
@@ -189,20 +189,31 @@ For the FileIO there are several configuration options available:
### Alibaba Cloud Object Storage Service (OSS)
-<!-- markdown-link-check-disable -->
Review Comment:
Why did you remove this line?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "rambleraptor (via GitHub)" <gi...@apache.org>.
rambleraptor commented on PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#issuecomment-4664856195
Fixes #3239
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "rambleraptor (via GitHub)" <gi...@apache.org>.
rambleraptor commented on code in PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#discussion_r3384368027
##########
mkdocs/docs/configuration.md:
##########
@@ -193,16 +193,33 @@ For the FileIO there are several configuration options available:
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 |
Review Comment:
nit: There's a bunch of extra formatting changes here that seem unnecessary?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "kevinjqliu (via GitHub)" <gi...@apache.org>.
kevinjqliu merged PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org
Re: [PR] docs: clean OSS and COS configuration tables [iceberg-python]
Posted by "rambleraptor (via GitHub)" <gi...@apache.org>.
rambleraptor commented on code in PR #3452:
URL: https://github.com/apache/iceberg-python/pull/3452#discussion_r3399400893
##########
mkdocs/docs/configuration.md:
##########
@@ -193,17 +193,32 @@ For the FileIO there are several configuration options available:
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 | <https://s3.oss-your-bucket-region.aliyuncs.com/> | 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. |
+| Key | Example | Description |
+| ---------------------------- | -------------------------------------------------- | ----------- |
+| s3.endpoint | <https://s3.oss-your-bucket-region.aliyuncs.com> | Configure an endpoint of the OSS service for the FileIO to access. Be sure to use S3 compatible endpoint as given in the example. |
Review Comment:
Looks like a '/' was deleted from this URL.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org