Skip to main content

Module rfc_0627_split_capabilities

opendal_core::docs::rfcs

Module rfc_0627_split_capabilities 

Source
Expand description

Split capabilities

§Summary

Split basic operations into read, write, and list capabilities.

§Motivation

In RFC-0409: Accessor Capabilities, we introduce the ideas of Accessor Capabilities. Services could have different capabilities, and users can check them via:

let meta = op.metadata();
let _: bool = meta.can_presign();
let _: bool = meta.can_multipart();

If users call not supported capabilities, OpenDAL will return io::ErrorKind::Unsupported instead.

Along with that RFC, we also introduce an idea about Basic Operations: the operations that all services must support, including:

  • metadata
  • create
  • read
  • write
  • delete
  • list

However, not all storage services support them. In our existing services, exception includes:

  • HTTP services don’t support write, delete, and list.
  • IPFS HTTP gateway doesn’t support write and delete.
    • NOTE: ipfs has a writable HTTP gateway, but there is no available instance.
  • fs could be read-only if mounted as RO.
  • object storage like s3 and gcs could not have enough permission.
  • cache services may not support list.

So in this RFC, we want to remove the idea about Basic Operations and convert them into different capabilities:

  • read: read and stat
  • write: write and delete
  • list: list

§Guide-level explanation

No public API changes.

§Reference-level explanation

This RFC will add three new capabilities:

  • read: read and stat
  • write: write and delete
  • list: list

After this change, all services must declare the features they support.

Most of this RFCs work is to refactor the tests. This RFC will refactor the behavior tests into several parts based on capabilities.

§Drawbacks

None

§Rationale and alternatives

None

§Prior art

None

§Unresolved questions

None

§Future possibilities

§Read-only Services

OpenDAL can implement read-only services after this change:

  • HTTP Service
  • IPFS HTTP Gateway

§Add new capabilities with Layers

We can implement a layer that can add list capability for underlying storage services. For example, IndexLayer for HTTP services.