Struct opendal::services::Supabase

pub struct Supabase { /* private fields */ }

Available on crate feature services-supabase only.

Supabase service support

Capabilities

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

Configuration

• root: Set the work dir for backend.
• bucket: Set the container name for backend.
• endpoint: Set the endpoint for backend.
• key: Set the authorization key for the backend, do not set if you want to read public bucket

Authorization keys

There are two types of key in the Supabase, one is anon_key(Client key), another one is service_role_key(Secret key). The former one can only write public resources while the latter one can access all resources. Note that if you want to read public resources, do not set the key.

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Supabase::default();
    
    builder.root("/");
    builder.bucket("test_bucket");
    builder.endpoint("http://127.0.0.1:54321");
    // this sets up the anon_key, which means this operator can only write public resource
    builder.key("some_anon_key");

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

    Ok(())
}

Implementations

impl SupabaseBuilder

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

Set root of this backend.

All operations will happen under this root.

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

Set bucket name of this backend.

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

Set endpoint of this backend.

Endpoint must be full uri

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

Set the authorization key for this backend Do not set this key if you want to read public bucket

pub fn http_client(&mut self, client: HttpClient) -> &mut Self

Specify the http client that used by this service.

Notes

This API is part of OpenDAL’s Raw API. HttpClient could be changed during minor updates.

Trait Implementations

impl Builder for SupabaseBuilder

const SCHEME: Scheme = Scheme::Supabase

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

type Accessor = SupabaseBackend

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 Debug for SupabaseBuilder

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

Formats the value using the given formatter.

impl Default for SupabaseBuilder

fn default() -> SupabaseBuilder

Returns the “default value” for a type.