Struct Client

Source
pub struct Client { /* private fields */ }
Expand description

A client to interact with the Supabase Management API.

Implementations§

Source§

impl Client

Source

pub async fn get_postgres_config( &self, project_id: &str, ) -> Result<PostgresConfig, Error>

Get the Postgres configs for a project

Source

pub async fn set_postgres_config( &self, project_id: &str, config: &PostgresConfig, ) -> Result<PostgresConfig, Error>

Source§

impl Client

Source

pub async fn list_projects(&self) -> Result<Vec<Project>, Error>

List all projects this user has created

Source

pub async fn pause_project(&self, project_id: &str) -> Result<(), Error>

Pause an active project. Returns 400 if the project is already paused.

Source

pub async fn restore_project(&self, project_id: &str) -> Result<(), Error>

Restore a paused/inactive project.

Source

pub async fn get_project_health( &self, project_id: &str, ) -> Result<Vec<ServiceHealth>, Error>

Gets project’s service health status.

Source§

impl Client

Source

pub async fn query<T: DeserializeOwned>( &self, project_id: &str, query: &str, ) -> Result<T, Error>

[Beta endpoint] Executes a Postgres query using the Supabase Management API.



#[derive(Deserialize, PartialEq, Debug)]
struct Row {
    id: i32,
    hash_value: String,
}

let rows: Vec<Row> = client
    .query(
        project_id,
        "SELECT generate_series(1, 3) AS id, \
        md5(generate_series(1, 3)::text) AS hash_value",
    )
    .await?;

assert_eq!(
    rows,
    [
        Row {
            id: 1,
            hash_value: "c4ca4238a0b923820dcc509a6f75849b".into(),
        },
        Row {
            id: 2,
            hash_value: "c81e728d9d4c2f636f067f89cc14862c".into(),
        },
        Row {
            id: 3,
            hash_value: "eccbc87e4b5ce2fe28308fd9f2a7baf3".into(),
        },
    ]
);
Source§

impl Client

Source

pub async fn get_storage_config( &self, project_id: &str, ) -> Result<StorageConfig, Error>

Gets project’s storage config

Source

pub async fn list_buckets(&self, project_id: &str) -> Result<Vec<Bucket>, Error>

Source§

impl Client

Source

pub async fn get_supavisor_details( &self, project_id: &str, ) -> Result<Vec<SupavisorConfig>, Error>

Source§

impl Client

Source

pub fn new(api_key: String) -> Self

Creates a new client with the given API key.

See the docs to learn how to obtain an API key.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,