Struct opendal::services::Lakefs

pub struct Lakefs { /* private fields */ }

Available on crate feature services-lakefs only.

Lakefs’s API support. This service will visit the Lakefs API to access the Lakefs File System. Currently, we only support the model and dataset types of repositories, and operations are limited to reading and listing/stating.

Lakefs doesn’t host official HTTP API docs. Detailed HTTP request API information can be found on the Lakefs_hub Source Code.

Capabilities

This service can be used to:

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

Configurations

• endpoint: The endpoint of the Lakefs repository.
• repository: The id of the repository.
• branch: The branch of the repository.
• root: Set the work directory for backend.
• username: The username for accessing the repository.
• password: The password for accessing the repository.

Refer to LakefsBuilder’s public API docs for more information.

Examples

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    // Create Lakefs backend builder
    let mut builder = Lakefs::default()
        // set the type of Lakefs endpoint
        .endpoint("https://whole-llama-mh6mux.us-east-1.lakefscloud.io")
        // set the id of Lakefs repository
        .repository("sample-repo")
        // set the branch of Lakefs repository
        .branch("main")
        // set the username for accessing the repository
        .username("xxx")
        // set the password for accessing the repository
        .password("xxx");

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

    let stat = op.stat("README.md").await?;
    println!("{:?}", stat);
    Ok(())
}

Implementations

impl LakefsBuilder

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

Set the endpoint of this backend.

endpoint must be full uri.

This is required.

• http://127.0.0.1:8000 (lakefs daemon in local)
• https://my-lakefs.example.com (lakefs server)

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

Set username of this backend. This is required.

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

Set password of this backend. This is required.

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

Set branch of this backend or a commit ID. Default is main.

Branch can be a branch name.

For example, branch can be:

• main
• 1d0c4eb

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

Set root of this backend.

All operations will happen under this root.

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

Set the repository of this backend.

This is required.

Trait Implementations

impl Builder for LakefsBuilder

fn build(self) -> Result<impl Access>

Build a LakefsBackend.

const SCHEME: Scheme = Scheme::Lakefs

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

type Config = LakefsConfig

Associated configuration for this builder.

impl Clone for LakefsBuilder

fn clone(&self) -> LakefsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LakefsBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LakefsBuilder

fn default() -> LakefsBuilder

Returns the “default value” for a type.