Struct opendal::services::Rocksdb

pub struct Rocksdb { /* private fields */ }

Available on crate feature services-rocksdb only.

RocksDB service support.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• scan
• presign
• blocking

Note

OpenDAL will build rocksdb from source by default.

To link with existing rocksdb lib, please set one of the following:

• ROCKSDB_LIB_DIR to the dir that contains librocksdb.so
• ROCKSDB_STATIC to the dir that contains librocksdb.a

If the version of RocksDB is below 6.0, you may encounter compatibility issues. It is advisable to follow the steps provided in the INSTALL file to build rocksdb, rather than relying on system libraries that may be outdated and incompatible.

Configuration

• root: Set the working directory of OpenDAL
• datadir: Set the path to the rocksdb data directory

You can refer to RocksdbBuilder’s docs for more information.

Example

Via Builder

use anyhow::Result;
use opendal::services::Rocksdb;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Rocksdb::default();
    builder.datadir("/tmp/opendal/rocksdb");

    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl RocksdbBuilder

pub fn datadir(&mut self, path: &str) -> &mut Self

Set the path to the rocksdb data directory. Will create if not exists.

pub fn root(&mut self, root: &str) -> &mut Self

set the working directory, all operations will be performed under it.

default: “/”

Trait Implementations

impl Builder for RocksdbBuilder

const SCHEME: Scheme = Scheme::Rocksdb

Associated scheme for this builder. It indicates what underlying service is.

type Accessor = Backend<Adapter>

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map which contains several parameters needed by underlying service.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

impl Clone for RocksdbBuilder

fn clone(&self) -> RocksdbBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for RocksdbBuilder

fn default() -> RocksdbBuilder

Returns the “default value” for a type.