Struct KalamLinkClient 

pub struct KalamLinkClient { /* private fields */ }

Main KalamDB client.

Use KalamLinkClientBuilder to construct instances with custom configuration.

Examples

use kalam_client::KalamLinkClient;

let client = KalamLinkClient::builder()
    .base_url("http://localhost:3000")
    .timeout(std::time::Duration::from_secs(30))
    .build()?;

let response = client.execute_query("SELECT 1", None, None, None).await?;
println!("Result: {:?}", response);

Implementations

impl KalamLinkClient

pub async fn login( &self, user: &str, password: &str, ) -> Result<LoginResponse, KalamLinkError>

Login with user and password to obtain a JWT token.

pub async fn refresh_access_token( &self, refresh_token: &str, ) -> Result<LoginResponse, KalamLinkError>

Refresh an access token using a refresh token.

impl KalamLinkClient

pub fn builder() -> KalamLinkClientBuilder

Create a new builder for configuring the client

pub async fn execute_query( &self, sql: &str, files: Option<Vec<(&str, &str, Vec<u8>, Option<&str>)>>, params: Option<Vec<Value>>, namespace_id: Option<&str>, ) -> Result<QueryResponse, KalamLinkError>

Execute a SQL query with optional files, parameters, and namespace context

Arguments

• sql - The SQL query string
• files - Optional file uploads for FILE(“name”) placeholders
• params - Optional query parameters for $1, $2, … placeholders
• namespace_id - Optional namespace for unqualified table names

Example

// Simple query
let result = client.execute_query("SELECT * FROM users", None, None, None).await?;

// Query with parameters
let params = vec![serde_json::json!(42)];
let result = client.execute_query("SELECT * FROM users WHERE id = $1", None, Some(params), None).await?;

// Query in specific namespace
let result = client.execute_query("SELECT * FROM messages", None, None, Some("chat")).await?;

pub async fn execute_query_with_progress( &self, sql: &str, files: Option<Vec<(&str, &str, Vec<u8>, Option<&str>)>>, params: Option<Vec<Value>>, namespace_id: Option<&str>, progress: Option<Arc<dyn Fn(UploadProgress) + Send + Sync>>, ) -> Result<QueryResponse, KalamLinkError>

Execute a SQL query with optional files and a progress callback for uploads.

pub async fn live_events( &self, query: &str, ) -> Result<SubscriptionManager, KalamLinkError>

Open a low-level live event stream.

Live streams are multiplexed over the shared WebSocket connection.

pub async fn live_events_with_config( &self, config: SubscriptionConfig, ) -> Result<SubscriptionManager, KalamLinkError>

Open a low-level live event stream with advanced configuration.

When [ConnectionOptions::ws_lazy_connect] is true (the default) and no shared connection exists yet, connect() is called automatically before opening the stream.

pub async fn live( &self, query: &str, ) -> Result<LiveRowsSubscription, KalamLinkError>

Open a SQL query and receive materialized row snapshots.

pub async fn live_with_config( &self, config: SubscriptionConfig, live_rows_config: LiveRowsConfig, ) -> Result<LiveRowsSubscription, KalamLinkError>

Open materialized live rows with advanced low-level and materialization configuration.

pub async fn connect(&self) -> Result<(), KalamLinkError>

Establish a shared WebSocket connection.

After calling this, all subsequent live_events() and live() calls will multiplex over the single connection.

pub async fn disconnect(&self)

Disconnect the shared WebSocket connection.

pub async fn cancel_subscription(&self, id: &str) -> Result<(), KalamLinkError>

Cancel / unsubscribe a subscription by ID on the shared connection.

pub async fn is_connected(&self) -> bool

Whether the shared connection is currently ready.

During reconnect with active subscriptions, this stays false until the subscription set has recovered, not merely until the socket handshake succeeds.

pub async fn subscriptions(&self) -> Vec<SubscriptionInfo>

List all active subscriptions on the shared connection.

pub fn event_handlers(&self) -> &EventHandlers

Get the current event handlers

pub fn timeouts(&self) -> &KalamLinkTimeouts

Get the configured timeouts

pub fn resolved_auth(&self) -> &ResolvedAuth

Return the resolved auth source (static or dynamic).

pub fn set_auth(&mut self, auth: AuthProvider)

Replace the static authentication credentials at runtime.

pub fn update_shared_auth(&self, auth: AuthProvider)

Update the shared authentication source without requiring &mut self.

pub async fn fresh_auth(&self) -> Result<AuthProvider, KalamLinkError>

Resolve fresh credentials from the auth source.

Trait Implementations

impl Clone for KalamLinkClient

fn clone(&self) -> KalamLinkClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.