Skip to content

[community] Volumes API: minimal Python client reference implementation #11

Open

Description

@Yoshiki0705

Proposal

The README notes that connector support for Volumes is in progress. We'd like to
contribute a minimal Python client for the Volumes API as a reference for other
implementors working with the protocol.

Scope

A lightweight, dependency-minimal client that:

  1. Loads a credential profile (.share JSON file)
  2. Discovers shares, schemas, and volumes via the REST API
  3. Calls temporary-volume-credentials and returns usable cloud credentials
  4. Includes a CLI entry point for quick E2E validation

No framework dependencies beyond requests and standard library.

Questions before contributing

  1. Should this live in the existing delta-sharing Python package or as a standalone?
  2. Any preferred conventions for the client API surface (e.g., sync-only, class-based)?
  3. Where in the repo structure would a community connector belong?

Context

We validated this pattern against an S3-compatible backend (FSx for ONTAP S3 Access
Points). The client performs the full flow: authenticate → list volumes → vend
credentials → access files via boto3. Source (Apache 2.0):
https://github.com/Yoshiki0705/fsxn-lakehouse-integrations/tree/main/integrations/opensharing-server/scripts

Activity

  1. Akramio commented on Jul 20, 2026

    @Akramio
    Collaborator

    Hi Yoshiki, thanks for submitting this. We definitely want to add volume support on the client side. We are taking a look at your questions and will get back to you shortly on how best to contribute this PR.

  2. littlegrasscao commented on Nov 18, 2026

    @littlegrasscao
    Collaborator

    Hi @Yoshiki0705 , thanks for opening the issue. To clarify, this is just a documentation update, right?

    The volume ARN and IAM are owned by catalog. OpenSharing only knows storage location and name.

    The user needs to create a IAM role with correct policy in S3, then import the IAM in catalog, and link to the storage location.

    Feel free to send a PR for updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions