Struct GraphqlClient

Source

pub struct GraphqlClient { /* private fields */ }

Expand description

HTTP client for the Supabase GraphQL endpoint (/graphql/v1).

Provides both raw query execution and fluent builder methods for collection queries and mutations.

§Example

use supabase_client_graphql::GraphqlClient;

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

// Raw query
let response = client.execute("query { blogCollection { edges { node { id } } } }", None, None).await?;

// Builder API
let connection = client.collection("blogCollection")
    .select(&["id", "title"])
    .first(10)
    .execute::<BlogRow>().await?;

Implementations§

Source §

impl GraphqlClient

Source

pub fn new(supabase_url: &str, api_key: &str) -> Result<Self, GraphqlError>

Create a new GraphQL client.

supabase_url is the project URL (e.g., https://your-project.supabase.co). api_key is the Supabase anon or service_role key.

Source

pub fn base_url(&self) -> &Url

Get the GraphQL endpoint URL.

Source

pub fn api_key(&self) -> &str

Get the API key used by this client.

Source

pub fn set_auth(&self, token: &str)

Update the default auth token for GraphQL requests.

Subsequent requests will use Bearer <token> instead of the API key.

Source

pub async fn execute<T: DeserializeOwned>( &self, query: &str, variables: Option<Value>, operation_name: Option<&str>, ) -> Result<GraphqlResponse<T>, GraphqlError>

Execute a raw GraphQL query/mutation.

§Arguments

query - The GraphQL query or mutation string.
variables - Optional variables as a JSON value.
operation_name - Optional operation name.

§Returns

The parsed GraphqlResponse<T> where T is the shape of the data field.

Source

pub async fn execute_raw( &self, query: &str, variables: Option<Value>, operation_name: Option<&str>, ) -> Result<GraphqlResponse<Value>, GraphqlError>

Execute a raw GraphQL query and return the full data JSON value.

This is a convenience wrapper around execute that returns the data as an untyped serde_json::Value.

Source

pub fn collection(&self, name: &str) -> QueryBuilder

Start building a collection query.

§Example

let connection = client.collection("blogCollection")
    .select(&["id", "title"])
    .first(10)
    .execute::<BlogRow>().await?;

Source

pub fn insert_into(&self, collection: &str) -> MutationBuilder

Start building an insert mutation.

§Example

let result = client.insert_into("blogCollection")
    .objects(vec![json!({"title": "New Post"})])
    .returning(&["id", "title"])
    .execute::<BlogRow>().await?;

Source

pub fn update(&self, collection: &str) -> MutationBuilder

Start building an update mutation.

§Example

let result = client.update("blogCollection")
    .set(json!({"title": "Updated"}))
    .filter(GqlFilter::eq("id", 1))
    .at_most(1)
    .returning(&["id", "title"])
    .execute::<BlogRow>().await?;

Source

pub fn delete_from(&self, collection: &str) -> MutationBuilder

Start building a delete mutation.

§Example

let result = client.delete_from("blogCollection")
    .filter(GqlFilter::eq("id", 1))
    .at_most(1)
    .returning(&["id"])
    .execute::<BlogRow>().await?;