Repository navigation
Conversation
`use_path_style` is the property that enables path-style access for S3 in Doris, and `s3.path-style-access` is accepted as its alias. The docs listed `s3.use_path_style`, which is not a recognized property name and therefore had no effect, so users following the docs could not switch to path-style access. - Update the S3 parameter table and add a note on the valid spellings. - Fix the legacy/alias column of the OSS, OBS and MinIO parameter tables. - Fix the SeaweedFS examples, which require path-style access. Fixes apache/doris#69137
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Versions
Languages
Docs Checklist
What's wrong
Fixes apache/doris#69137
The documentation says path-style access is enabled with
s3.use_path_style, which is not a recognized property name in Doris, so users following the docs cannot switch to path-style access (for example when they access MinIO, SeaweedFS or other S3-compatible services).In the FE property definitions the accepted names are:
use_path_style— canonical name, accepted by every S3-compatible dialect.s3.path-style-access— accepted alias for the S3 / Iceberg-style spelling.<service>.use_path_style(oss.,obs.,minio.,cos.,ozone.,gs.) — accepted for the matching service.s3.use_path_styledoes not exist in any of them.What changed
lakehouse/storages/s3.md: the parameter table now listsuse_path_style(withs3.path-style-accessas the alias), plus a short note thats3.use_path_styleis invalid and that S3-compatible services accept their own prefixed spelling.lakehouse/storages/aliyun-oss.md,huawei-obs.md,minio.md: the legacy/alias column listeds3.use_path_style; it now listsuse_path_style.lakehouse/storages/seaweedfs.md: SeaweedFS requires path-style access, but the parameter table, the exampleCREATE CATALOGsnippet and the usage recommendations all useds3.use_path_style; they now useuse_path_style.dev(docs/) and4.x(versioned_docs/version-4.x/), in both English andzh-CN.3.x/2.1are frozen snapshots outside the version sync gate and are intentionally left untouched.Validation
S3FileSystemPropertiesdeclares@ConnectorProperty(names = {USE_PATH_STYLE, "s3.path-style-access"})whereUSE_PATH_STYLE = "use_path_style", andOssFileSystemProperties/ObsFileSystemProperties/MinioFileSystemProperties/OzoneFileSystemPropertiesdeclare their own<service>.use_path_styleplususe_path_styleands3.path-style-access. No FE/external-table/StorageVault property parser acceptss3.use_path_style(grep -rn "s3\.use_path_style"over the Doris repository returns no match).s3.use_path_styleoccurrences in the touched trees except the intentional "is not valid" note.