Skip to content

Commit c66d8b5

Browse files
authored
docs: clean OSS and COS configuration tables (#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)
1 parent df71d2a commit c66d8b5

1 file changed

Lines changed: 23 additions & 8 deletions

File tree

mkdocs/docs/configuration.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -193,17 +193,32 @@ For the FileIO there are several configuration options available:
193193

194194
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.
195195

196-
| Key | Example | Description |
197-
| -------------------- | ------------------- | ------------------------------------------------ |
198-
| 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. |
199-
| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. |
200-
| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. |
201-
| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. |
202-
| 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. |
203-
| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. |
196+
| Key | Example | Description |
197+
| ---------------------------- | -------------------------------------------------- | ----------- |
198+
| 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. |
199+
| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. |
200+
| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. |
201+
| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. |
202+
| 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. |
203+
| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. |
204204

205205
<!-- markdown-link-check-enable-->
206206

207+
### Tencent Cloud Object Storage (COS)
208+
209+
<!-- markdown-link-check-disable -->
210+
211+
Tencent Cloud Object Storage (COS) is S3-compatible and can be used with PyIceberg using the existing S3FileIO / PyArrowFileIO implementation.
212+
213+
| Key | Example | Description |
214+
| -------------------- | ---------------------------------------- | ----------- |
215+
| s3.endpoint | <https://cos.ap-guangzhou.myqcloud.com> | Tencent COS S3-compatible endpoint |
216+
| s3.access-key-id | admin | Access key for COS |
217+
| s3.secret-access-key | password | Secret key for COS |
218+
| s3.session-token | AQoDYXdzEJr... | Optional session token |
219+
220+
<!-- markdown-link-check-enable -->
221+
207222
### Hugging Face
208223

209224
<!-- markdown-link-check-disable -->

0 commit comments

Comments
 (0)