Struct Supabase

pub struct Supabase {
    pub url: String,
    pub key: String,
    pub http_client: Client,
    pub auth: Auth,
    pub options: ClientOptions,
}

The main entry point for the Supabase Rust client

Fields

url: String

The base URL for the Supabase project

key: String

The anonymous API key for the Supabase project

http_client: Client

HTTP client used for requests

auth: Auth

Auth client for user management and authentication

options: ClientOptions

Client options

Implementations

impl Supabase

pub fn new(supabase_url: &str, supabase_key: &str) -> Self

Create a new Supabase client

Arguments

• supabase_url - The base URL for your Supabase project
• supabase_key - The anonymous API key for your Supabase project

Example

use supabase_rust::Supabase;

let supabase = Supabase::new("https://your-project-url.supabase.co", "your-anon-key");

pub fn new_with_options( supabase_url: &str, supabase_key: &str, options: ClientOptions, ) -> Self

Create a new Supabase client with custom options

Arguments

• supabase_url - The base URL for your Supabase project
• supabase_key - The anonymous API key for your Supabase project
• options - Custom client options

Example

use supabase_rust::{Supabase, ClientOptions};

let options = ClientOptions::default().with_auto_refresh_token(true);
let supabase = Supabase::new_with_options(
    "https://your-project-url.supabase.co",
    "your-anon-key",
    options
);

pub fn auth(&self) -> &Auth

Get a reference to the auth client for user management and authentication

pub fn from(&self, table: &str) -> PostgrestClient

Create a new PostgrestClient for database operations on a specific table or view

Arguments

• table - The name of the table or view

Example

use supabase_rust::Supabase;

let supabase = Supabase::new("https://your-project-url.supabase.co", "your-anon-key");
let query = supabase.from("users");

pub fn storage(&self)

Create a client for the Storage API

pub fn realtime(&self)

Create a client for the Realtime API

pub fn functions(&self)

Create a client for the Edge Functions API

pub fn rpc(&self, function_name: &str, params: Value) -> PostgrestClient

Execute a Postgres function via RPC

Arguments

• function_name - The name of the function to call
• params - Parameters to pass to the function

Example

use supabase_rust::Supabase;
use serde_json::json;

let supabase = Supabase::new("https://your-project-url.supabase.co", "your-anon-key");
let result = supabase.rpc("calculate_total", json!({"user_id": 123}));