Skip to content

Documentation for s3.profile-name and client.profile-name is potentially misleading / vague #3066

@thomas-pfeiffer

Description

@thomas-pfeiffer

Apache Iceberg version

0.11.0

Please describe the bug 🐞

Issue:
In #2948 s3.profile-name and client.profile-name were introduced as new configuration parameters. These 2 parameters are only implemented for Fsspec backend so far. In the documentation (see mkdocs/docs/configuration.md) it gives the impression that these 2 parameters are supported generally (or more specifically also for PyArrow backend, where it is not implemented yet - see #3065 ).

Suggested fix:
There should be a remark in the documentation (see mkdocs/docs/configuration.md ) of s3.profile-name and client.profile-name stating the Fsspec backend must be used (or py-io-impl must be set to pyiceberg.io.fsspec.FsspecFileIO) for them to work.

Willingness to contribute

  • I can contribute a fix for this bug independently
  • I would be willing to contribute a fix for this bug with guidance from the Iceberg community
  • I cannot contribute a fix for this bug at this time

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions