Skip to content

Commit 68b43a1

Browse files
committed
fix: clean OSS and COS configuration tables formatting and alignment
1 parent 0dda909 commit 68b43a1

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

mkdocs/docs/configuration.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -189,33 +189,31 @@ For the FileIO there are several configuration options available:
189189

190190
### Alibaba Cloud Object Storage Service (OSS)
191191

192-
| Key | Example | Description |
193-
| ---------------------------- | --------------------------------------------- | ----------- |
194-
| 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. |
195-
| s3.access-key-id | admin | Configure the static access key id used to access the FileIO. |
196-
| s3.secret-access-key | password | Configure the static secret access key used to access the FileIO. |
197-
| s3.session-token | AQoDYXdzEJr... | Configure the static session token used to access the FileIO. |
198-
| 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. |
199-
| s3.anonymous | True | Configure whether to use anonymous connection. If False (default), uses key/secret if configured or standard AWS configuration methods. |
200-
201-
<!-- markdown-link-check-disable -->
202-
203192
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.
204193

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

207205
Tencent Cloud Object Storage (COS) is S3-compatible and can be used with PyIceberg using the existing S3FileIO / PyArrowFileIO implementation.
208206

209207
No additional dependencies are required.
210208

211-
| Key | Example | Description |
212-
| -------------------- | ------------------------------ | ----------- |
213-
| s3.endpoint | <https://cos.ap-guangzhou.myqcloud.com> | Tencent COS S3-compatible endpoint |
214-
| s3.access-key-id | admin | Access key for COS |
215-
| s3.secret-access-key | password | Secret key for COS |
216-
| s3.session-token | AQoDYXdzEJr... | Optional session token |
209+
| Key | Example | Description |
210+
| -------------------- | ---------------------------------------- | ----------- |
211+
| s3.endpoint | <https://cos.ap-guangzhou.myqcloud.com> | Tencent COS S3-compatible endpoint |
212+
| s3.access-key-id | admin | Access key for COS |
213+
| s3.secret-access-key | password | Secret key for COS |
214+
| s3.session-token | AQoDYXdzEJr... | Optional session token |
217215

218-
### Example
216+
#### Example
219217

220218
```python
221219
catalog = load_catalog(
@@ -227,7 +225,7 @@ catalog = load_catalog(
227225
)
228226
```
229227

230-
<!-- markdown-link-check-enable-->
228+
<!-- markdown-link-check-disable -->
231229

232230
### Hugging Face
233231

0 commit comments

Comments
 (0)