Struct RemoteDatabase 

pub struct RemoteDatabase { /* private fields */ }

A client connection to a remote Akar server.

Created via RemoteDatabase::connect_tcp (or crate::Database::connect_tcp). Executes queries over a length-prefixed JSON protocol; the server holds the database open, so the client never touches the database directory or its file locks.

Implementations

impl RemoteDatabase

pub fn connect_tcp(addr: impl Into<String>) -> Result<Self, String>

Connect to an Akar server listening at addr (e.g. "127.0.0.1:9876").

pub fn connect_with_token( addr: impl Into<String>, token: String, ) -> Result<Self, String>

Connect with an authentication token. The token is sent with every request; the server rejects connections without a valid token.

pub fn address(&self) -> &str

The address this client is connected to.

pub fn set_token(&mut self, token: String)

Set the auth token for subsequent requests.

pub fn query(&self, query_str: &str) -> Result<WireResponse, String>

Execute a Cypher query on the remote database.

Mirrors crate::Connection::query: returns the response on success and an error message when the query failed (including OCC WriteConflicts).

pub fn query_with_params( &self, query_str: &str, params: HashMap<String, Value>, ) -> Result<WireResponse, String>

Execute a parameterized Cypher query.

params is a map of parameter names (without the $ prefix) to JSON values. The server binds them via the prepared-statement pipeline.

pub fn ping_op(&self) -> Result<WireResponse, String>

Send a liveness check (op: "ping").

pub fn flush(&self) -> Result<WireResponse, String>

Force a CHECKPOINT to persist all data to disk (op: "flush").

pub fn stats(&self) -> Result<WireResponse, String>

Request server statistics (op: "stats").

pub fn export_db(&self, path: &str) -> Result<WireResponse, String>

Export the database to path (op: "export").

pub fn shutdown_server(&self) -> Result<WireResponse, String>

Request graceful server shutdown (op: "shutdown").

pub fn dream_control(&self, action: &str) -> Result<WireResponse, String>

Send a dream_control request (op: "dream_control").

pub fn ping(&self) -> Result<(), String>

Verify the connection is alive by round-tripping a trivial query.

pub fn close(&self)

Close the connection. The server notices the disconnect and reclaims the session resources.