Skip to content

docs: clean OSS and COS configuration tables #3452

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
Sidra-009 wants to merge 5 commits into
base: main
Choose a base branch
from
+26 −9
Open

docs: clean OSS and COS configuration tables #3452

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0dda909
docs: fix OSS/COS configuration tables
Sidra-009 Jun 3, 2026
68b43a1
fix: clean OSS and COS configuration tables formatting and alignment
Sidra-009 Jun 3, 2026
93fe4fd
docs: remove redundant COS example
Sidra-009 Jun 4, 2026
496ae0a
docs: fix markdown-link-check enable directive placement
Sidra-009 Jun 5, 2026
7d51630
docs: fix markdown-link-check enable directive placement
Sidra-009 Jun 5, 2026
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
45 changes: 34 additions & 11 deletions mkdocs/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,20 +189,43 @@ For the FileIO there are several configuration options available:

### Alibaba Cloud Object Storage Service (OSS)

<!-- markdown-link-check-disable -->
Copy link
Copy Markdown
Member

@ebyhr ebyhr Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove this line?


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",
}
)
Copy link
Copy Markdown
Member

@ebyhr ebyhr Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

@Sidra-009 Sidra-009 Jun 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the feedback i removed the example block

```

<!-- markdown-link-check-disable -->
Copy link
Copy Markdown
Member

@ebyhr ebyhr Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was <!-- markdown-link-check-enable-->. Why did you change it to -disable?


### Hugging Face

Expand Down