Struct Client

pub struct Client { /* private fields */ }

Main Supabase client for interacting with all services

Implementations

impl Client

pub fn new(url: &str, key: &str) -> Result<Self>

Create a new Supabase client with URL and API key

Arguments

• url - Your Supabase project URL (e.g., “https://your-project.supabase.co”)
• key - Your Supabase API key (anon key for client-side operations)

Example

use supabase::Client;

let client = Client::new("https://your-project.supabase.co", "your-anon-key")?;

pub fn new_with_service_role( url: &str, anon_key: &str, service_role_key: &str, ) -> Result<Self>

Create a new Supabase client with service role key for admin operations

Arguments

• url - Your Supabase project URL (e.g., “https://your-project.supabase.co”)
• anon_key - Your Supabase anon API key for client-side operations
• service_role_key - Your Supabase service role key for admin operations

Example

use supabase::Client;

let client = Client::new_with_service_role(
    "https://your-project.supabase.co",
    "your-anon-key",
    "your-service-role-key"
)?;

pub fn new_with_config(config: SupabaseConfig) -> Result<Self>

Create a new Supabase client with custom configuration

Arguments

• config - Custom Supabase configuration

Example

use supabase::{Client, types::*};

let config = SupabaseConfig {
    url: "https://your-project.supabase.co".to_string(),
    key: "your-anon-key".to_string(),
    service_role_key: None,
    http_config: HttpConfig::default(),
    auth_config: AuthConfig::default(),
    database_config: DatabaseConfig::default(),
    storage_config: StorageConfig::default(),
};

let client = Client::new_with_config(config)?;

pub fn auth(&self) -> &Auth

Get the authentication module

pub fn database(&self) -> &Database

Get the database module

pub fn storage(&self) -> &Storage

Get the storage module

pub fn functions(&self) -> &Functions

Get the functions module

pub fn realtime(&self) -> &Realtime

Get the realtime module

pub fn http_client(&self) -> Arc<HttpClient>

Get the HTTP client

pub fn config(&self) -> Arc<SupabaseConfig>

Get the client configuration

pub fn url(&self) -> &str

Get the base URL for the Supabase project

pub fn key(&self) -> &str

Get the API key

pub async fn set_auth(&self, token: &str) -> Result<()>

Set a custom authorization header (JWT token)

pub async fn clear_auth(&self) -> Result<()>

Clear the current authorization

pub fn is_authenticated(&self) -> bool

Check if client is authenticated

pub async fn current_user(&self) -> Result<Option<User>>

Get current user if authenticated

pub async fn health_check(&self) -> Result<bool>

Perform a health check on the Supabase instance

pub async fn version(&self) -> Result<HashMap<String, Value>>

Get the current API version information

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.