Struct ClawDB 

pub struct ClawDB { /* private fields */ }

The primary ClawDB client.

Implementations

impl ClawDB

pub fn builder() -> ClawDBBuilder

Create a builder to configure and construct a ClawDB client.

pub async fn from_env() -> SdkResult<Self>

Create a client from environment variables.

pub async fn auto_provision() -> SdkResult<Self>

Automatically provision a usable endpoint following the SDK fallback order.

pub async fn from_api_key( api_key: impl Into<String>, endpoint: impl Into<String>, ) -> SdkResult<Self>

Create a client from an API key and endpoint.

pub async fn health(&self) -> SdkResult<HealthResponse>

Check server health.

pub async fn ping(&self) -> SdkResult<()>

Ping the server (returns Ok if reachable).

pub async fn create_session( &self, role: &str, scopes: &[&str], ttl_secs: u64, ) -> SdkResult<SessionInfo>

Create a new session token.

pub async fn validate_session(&self) -> SdkResult<SessionInfo>

Validate the current session.

pub async fn revoke_session(&self, session_id: &str) -> SdkResult<bool>

Revoke a session by ID.

pub async fn active_session_count(&self) -> SdkResult<u64>

Get the count of active sessions.

pub async fn remember(&self, content: impl Into<String>) -> SdkResult<String>

Store a plain memory and return its ID.

pub async fn remember_typed( &self, content: impl Into<String>, opts: RememberOptions, ) -> SdkResult<String>

Store a typed memory and return its ID.

pub async fn update_memory( &self, memory_id: &str, content: impl Into<String>, ) -> SdkResult<bool>

Update an existing memory’s content.

pub async fn search( &self, query: impl Into<String>, opts: SearchOptions, ) -> SdkResult<Vec<SearchHit>>

Semantic search over memories.

pub async fn recall(&self, ids: &[&str]) -> SdkResult<Vec<MemoryRecord>>

Recall specific memories by ID.

pub async fn list_memories( &self, memory_type: Option<&str>, limit: Option<u32>, ) -> SdkResult<Vec<MemoryRecord>>

List memories with optional type filter.

pub async fn delete_memory(&self, memory_id: &str) -> SdkResult<bool>

Delete a memory by ID.

pub async fn branch( &self, name: &str, from: Option<&str>, ) -> SdkResult<BranchInfo>

Fork a new branch.

pub async fn list_branches(&self) -> SdkResult<Vec<BranchInfo>>

List all branches.

pub async fn get_branch(&self, branch_id: &str) -> SdkResult<BranchInfo>

Get a branch by ID.

pub async fn get_branch_by_name(&self, name: &str) -> SdkResult<BranchInfo>

Get a branch by name.

pub async fn get_trunk_branch(&self) -> SdkResult<BranchInfo>

Get the trunk (main) branch.

pub async fn diff( &self, source_branch_id: &str, target_branch_id: &str, ) -> SdkResult<DiffResult>

Diff a branch against a target.

pub async fn merge( &self, source_branch_id: &str, target_branch_id: &str, strategy: &str, ) -> SdkResult<MergeResult>

Merge source branch into target.

pub async fn discard_branch(&self, branch_id: &str) -> SdkResult<bool>

Discard (delete) a branch.

pub async fn archive_branch(&self, branch_id: &str) -> SdkResult<bool>

Archive a branch.

pub async fn sync(&self) -> SdkResult<SyncResult>

Full bidirectional sync.

pub async fn push_sync(&self) -> SdkResult<SyncActionResult>

Push local memories to remote.

pub async fn pull_sync(&self) -> SdkResult<SyncActionResult>

Pull remote memories to local.

pub async fn reconcile_sync(&self) -> SdkResult<SyncActionResult>

Reconcile divergent sync state.

pub async fn sync_status(&self) -> SdkResult<SyncStatusResult>

Get current sync status.

pub async fn reflect(&self) -> SdkResult<ReflectJob>

Trigger a new reflection job.

pub async fn reflect_list_jobs( &self, agent_id: &str, ) -> SdkResult<Vec<ReflectJob>>

List reflection jobs.

pub async fn reflect_get_job(&self, job_id: &str) -> SdkResult<ReflectJob>

Get a specific reflection job.

pub async fn reflect_get_facts(&self, agent_id: &str) -> SdkResult<Value>

Get extracted facts for an agent.

pub async fn reflect_get_preferences(&self, agent_id: &str) -> SdkResult<Value>

Get preferences for an agent.

pub async fn reflect_get_contradictions( &self, agent_id: &str, ) -> SdkResult<Value>

Get contradictions for an agent.

pub async fn reflect_resolve_contradiction( &self, agent_id: &str, contradiction_id: &str, strategy: &str, merged_value_json: Option<&str>, ) -> SdkResult<Value>

Resolve a specific contradiction.

pub async fn begin_tx(&self) -> SdkResult<TxInfo>

Begin a new transaction.

pub async fn tx_remember( &self, tx_id: &str, content: impl Into<String>, ) -> SdkResult<String>

Add a plain memory to a transaction.

pub async fn tx_remember_typed( &self, tx_id: &str, content: impl Into<String>, opts: RememberOptions, ) -> SdkResult<String>

Add a typed memory to a transaction.

pub async fn commit_tx(&self, tx_id: &str) -> SdkResult<bool>

Commit a transaction.

pub async fn rollback_tx(&self, tx_id: &str) -> SdkResult<bool>

Roll back a transaction.

pub fn close(&self)

Close the client (no-op for HTTP).

pub fn endpoint(&self) -> &str

Return the configured endpoint.

pub fn agent_id(&self) -> &str

Return the configured agent_id.

Trait Implementations

impl Clone for ClawDB

fn clone(&self) -> ClawDB

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClawDB

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

Formats the value using the given formatter.