README.md

Apache OpenDAL™ Ruby Binding

OpenDAL's Ruby gem: access S3, GCS, Azure Blob, the local filesystem, and 50+ more services through one API.

We release the OpenDAL Ruby binding independently of the opendal crate (Rust core). For updates and compatibility, use the Ruby binding version instead of the opendal crate version.

Useful Links

• User guide
• Services & configuration
• API reference
• Rust core documentation

Installation

gem install opendal

Or add it to your Gemfile:

# Gemfile
gem "opendal"

Quickstart

require "opendal"

op = OpenDal::Operator.new("memory", {})
op.write("hello.txt", "Hello, World!")
puts op.read("hello.txt") # => "Hello, World!"

op.list("").each do |entry|
  puts entry.path
end

op.delete("hello.txt")

Point it at a real backend by changing the scheme and passing its configuration:

op = OpenDal::Operator.new("s3", {
  "bucket" => "my-bucket",
  "region" => "us-east-1",
})

See the user guide for connecting to storage, common tasks, middlewares, and error handling.

Contributing

Development setup and contribution instructions live in CONTRIBUTING.md.

License and Trademarks

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation.