Skip to content

new feature: support configuration alias #6456

@jackye1995

Description

@jackye1995

Feature Description

Allow different config keys to mean the same thing so that users can more easily migrate from other system to OpenDAL. For example, aws_access_key_id and access_key_id can just be aliases to each other and configure the same access key ID of S3 client.

Problem and Solution

We are considering using OpenDAL as a replacement for the Arrow object_store. Currently this require a migration because the config keys are different, for example if the user set aws_access_key_id in object_store, we need to ask users to rename it to access_key_id, or we need to do some internal translation for the users.

The internal translation approach definitely can work, but I think it would be nice to support configuration alias so users can more easily migrate in similar situations.

Let me know if this is something we are interested in supporting, or if we think this should be handled fully from an external integration.

Additional Context

Arrow object_store currently already does something similar: https://github.com/apache/arrow-rs-object-store/blob/main/src/aws/builder.rs#L398-L440

Are you willing to contribute to the development of this feature?

  • Yes, I am willing to contribute to the development of this feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestreleases-note/featThe PR implements a new feature or has a title that begins with "feat"services/s3

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions