Repository navigation
Client rust
github-actions[bot] edited this page Sep 28, 2026
·
25 revisions
Navigation: Home > SDKs > Client
Official Rust SDK for ThemisDB - A high-performance multi-model database with ACID transaction support.
- β
Full ACID Transaction Support with
BEGIN,COMMIT, andROLLBACK - β LLM Integration - Native support for LLM interactions (v1.4.0+) π
- β Multi-Model Operations - Relational, Document, Graph, Vector, Time-Series
- β Async/Await - Built on Tokio for high-performance async operations
- β
Isolation Levels -
READ_COMMITTEDandSNAPSHOTisolation - β Type-Safe - Leverages Rust's type system with generics and serde
- β Automatic Topology Discovery - Client-side sharding and routing
- β Batch Operations - Optimized batch get/put operations
- β Vector Search - Native vector similarity search support
- β Retry Logic - Built-in retry with exponential backoff
Add this to your Cargo.toml:
[dependencies]
themisdb-client = "0.1.0-beta.1"
tokio = { version = "1.40", features = ["macros", "rt-multi-thread"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"use themisdb_sdk::{ThemisClient, ThemisClientConfig, TransactionOptions, IsolationLevel};
use serde::{Deserialize, Serialize};
#[derive(Debug, Serialize, Deserialize)]
struct Account {
balance: i64,
}
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// Create client
let config = ThemisClientConfig {
endpoints: vec!["http://localhost:8080".to_string()],
..Default::default()
};
let client = ThemisClient::new(config)?;
// Basic operations
let account = Account { balance: 1000 };
client.put("relational", "accounts", "acc1", &account).await?;
let result: Option<Account> = client.get("relational", "accounts", "acc1").await?;
println!("Account: {:?}", result);
Ok(())
}use themisdb_sdk::{TransactionOptions, IsolationLevel};
async fn transfer_money(client: &ThemisClient) -> Result<(), Box<dyn std::error::Error>> {
// Start transaction with SNAPSHOT isolation
let options = TransactionOptions {
isolation_level: IsolationLevel::Snapshot,
timeout_ms: Some(10000),
};
let tx = client.begin_transaction(options).await?;
// Perform operations within transaction
let acc1: Option<Account> = tx.get("relational", "accounts", "acc1").await?;
let acc2: Option<Account> = tx.get("relational", "accounts", "acc2").await?;
if let (Some(mut from), Some(mut to)) = (acc1, acc2) {
from.balance -= 100;
to.balance += 100;
tx.put("relational", "accounts", "acc1", &from).await?;
tx.put("relational", "accounts", "acc2", &to).await?;
tx.commit().await?;
println!("Transfer successful!");
} else {
tx.rollback().await?;
println!("Account not found, rolled back");
}
Ok(())
}async fn safe_transaction(client: &ThemisClient) -> Result<(), Box<dyn std::error::Error>> {
let tx = client.begin_transaction(TransactionOptions::default()).await?;
match perform_operations(&tx).await {
Ok(_) => {
tx.commit().await?;
println!("Transaction committed");
}
Err(e) => {
tx.rollback().await?;
eprintln!("Transaction rolled back: {}", e);
}
}
Ok(())
}
async fn perform_operations(tx: &themisdb_sdk::Transaction) -> Result<(), Box<dyn std::error::Error>> {
let data = serde_json::json!({ "value": 42 });
tx.put("relational", "data", "key1", &data).await?;
tx.put("relational", "data", "key2", &data).await?;
Ok(())
}// Create/Update
client.put("relational", "users", "uuid", &user).await?;
// Read
let user: Option<User> = client.get("relational", "users", "uuid").await?;
// Delete
let deleted: bool = client.delete("relational", "users", "uuid").await?;
// Batch Get
let uuids = vec!["id1".to_string(), "id2".to_string()];
let result = client.batch_get::<User>("relational", "users", &uuids).await?;
println!("Found: {:?}", result.found);
println!("Missing: {:?}", result.missing);use themisdb_sdk::QueryOptions;
let options = QueryOptions::default();
let result = client.query::<User>(
"SELECT * FROM users WHERE age > 18",
options
).await?;
for user in result.items {
println!("User: {:?}", user);
}let embedding = vec![0.1, 0.2, 0.3, 0.4]; // 4D vector
let filter = Some(serde_json::json!({ "category": "products" }));
let results = client.vector_search(&embedding, filter, Some(10)).await?;
println!("Search results: {}", results);// READ_COMMITTED (default)
let options = TransactionOptions {
isolation_level: IsolationLevel::ReadCommitted,
timeout_ms: None,
};
// SNAPSHOT isolation with timeout
let options = TransactionOptions {
isolation_level: IsolationLevel::Snapshot,
timeout_ms: Some(5000), // 5 seconds
};let tx = client.begin_transaction(options).await?;
// CRUD operations
tx.put("relational", "accounts", "acc1", &account).await?;
let acc: Option<Account> = tx.get("relational", "accounts", "acc1").await?;
tx.delete("relational", "accounts", "acc2").await?;
// Query within transaction
let query_opts = QueryOptions::default();
let results = tx.query::<Account>("SELECT * FROM accounts", query_opts).await?;
// Commit or rollback
tx.commit().await?;
// or
tx.rollback().await?;use themisdb_sdk::ThemisClientConfig;
let config = ThemisClientConfig {
endpoints: vec![
"http://shard1:8080".to_string(),
"http://shard2:8080".to_string(),
],
namespace: "production".to_string(),
timeout_ms: 30_000,
metadata_endpoint: Some("/_admin/cluster/topology".to_string()),
max_retries: 3,
};
let client = ThemisClient::new(config)?;use themisdb_sdk::ThemisError;
match client.get::<User>("relational", "users", "uuid").await {
Ok(Some(user)) => println!("Found user: {:?}", user),
Ok(None) => println!("User not found"),
Err(ThemisError::Http { status, body }) => {
eprintln!("HTTP error {}: {}", status, body);
}
Err(ThemisError::Transport(e)) => {
eprintln!("Network error: {}", e);
}
Err(ThemisError::Transaction(msg)) => {
eprintln!("Transaction error: {}", msg);
}
Err(e) => eprintln!("Error: {}", e),
}Run unit tests:
cargo testRun integration tests (requires ThemisDB server running on localhost:8080):
cargo test -- --ignored#[derive(Debug, Serialize, Deserialize)]
struct Account {
id: String,
balance: i64,
}
async fn transfer(
client: &ThemisClient,
from_id: &str,
to_id: &str,
amount: i64,
) -> Result<(), Box<dyn std::error::Error>> {
let options = TransactionOptions {
isolation_level: IsolationLevel::Snapshot,
timeout_ms: Some(10000),
};
let tx = client.begin_transaction(options).await?;
// Read accounts
let from: Account = tx.get("relational", "accounts", from_id).await?
.ok_or("From account not found")?;
let to: Account = tx.get("relational", "accounts", to_id).await?
.ok_or("To account not found")?;
// Validate
if from.balance < amount {
tx.rollback().await?;
return Err("Insufficient funds".into());
}
// Update balances
let new_from = Account {
id: from.id.clone(),
balance: from.balance - amount,
};
let new_to = Account {
id: to.id.clone(),
balance: to.balance + amount,
};
tx.put("relational", "accounts", from_id, &new_from).await?;
tx.put("relational", "accounts", to_id, &new_to).await?;
// Commit transaction
tx.commit().await?;
println!("Transferred {} from {} to {}", amount, from_id, to_id);
Ok(())
}async fn batch_create_users(client: &ThemisClient, users: Vec<User>) -> Result<(), Box<dyn std::error::Error>> {
for user in users {
client.put("relational", "users", &user.id, &user).await?;
}
Ok(())
}
async fn batch_read_users(client: &ThemisClient, ids: Vec<String>) -> Result<(), Box<dyn std::error::Error>> {
let result = client.batch_get::<User>("relational", "users", &ids).await?;
println!("Found {} users", result.found.len());
println!("Missing {} users", result.missing.len());
for (id, user) in result.found {
println!("User {}: {:?}", id, user);
}
Ok(())
}Apache-2.0
ThemisDB 1.9.0-beta Β· Home Β· Module-Index Β· GitHub Β· Issues
ThemisDB 1.9.0-beta Β· Home Β· Wiki-Index Β· Module-Index Β· FAQ Β· Quick-Reference Β· GitHub Β· Issues Β· Discussions Β· License
- Home
- Hero Articles
- All Wiki Pages
- FAQ
- Edition Comparison
- Repository README
- Changelog
- Roadmap
- Versioning
- Integration Mapping
- Overview
- Readme
- Appendix D Feature Status
- Appendix E Incident Runbooks
- Appendix F AQL Cheatsheet
- Appendix G Configuration
- Appendix H Glossary
- Appendix I Troubleshooting
- Appendix Literatur
- Chapter 00 Genesis
- Chapter 01 Introduction
- Chapter 02 Architecture
- Chapter 03 Multimodel
- Chapter 04 Installation
- Chapter 05 Relational
- Chapter 06 Graph
- Chapter 07 Document
- Chapter 08 Storage Layer
- Chapter 08 Vector
- Chapter 09 Timeseries
- Chapter 10 Enterprise
- Chapter 11 Realtime
- Chapter 12 Computervision
- Chapter 13 Fulltext
- Chapter 14 Geospatial
- Chapter 15 Analytics
- Chapter 16 Ml
- Chapter 16 Sharding
- Chapter 17 LLM Integration
- Chapter 17 Scaling
- Chapter 18 HA
- Chapter 18 Ml
- Chapter 19 Monitoring
- Chapter 19 Monitoring Observability
- Chapter 20 Backup
- Chapter 20 Performance
- Chapter 21 Auth
- Chapter 21 Performance
- Chapter 22 Clients
- Chapter 22 Encryption
- Chapter 23 Testing Qa
- Chapter 24 Ai Ethics
- Chapter 25 Devops Infrastructure
- Chapter 26 Migration Legacy
- Chapter 27 Troubleshooting
- Chapter 28 AQL Reference
- Chapter 29 Analytics Process Mining
- Chapter 30 Deployment Operations
- Chapter 31 API Protocols
- Chapter 32 API Design Rest Principles
- Chapter 32 AQL Oop Implementation
- Chapter 33 Best Practices
- Chapter 34 Query Optimization
- Chapter 35 Data Modeling Patterns
- Chapter 36 Security Hardening
- Chapter 37 Ecosystem Integration
- Chapter 38 Observability Sre
- Chapter 39 Performance Tuning Cookbook
- Chapter 40 Data Governance Compliance
- Chapter 41 Hands On Labs
- Chapter 42 Docs Assistant Usage
- Chapter MVCC Hlc
- Cover
- Cover Book
- Index
- Preface
- Test Links Example
- Batch Operations
- Best Practices
- CRUD Tutorial
- Custom Document Ingestion
- Getting Started Tutorial
- Interactive Examples
- Schema Design
- Video Tutorials
- AQL Reference
- AQL Examples
- AQL Overview
- AQL Feature Roadmap
- AQL Geospatial Guide
- AQL LLM Migration Guide
- AQL API
- AQL Grammar (EBNF)
- AQL Root Overview
- AQL Examples (root)
- API Reference
- API Module README
- OpenAPI Overview
- Client SDK Overview
- SDK Overview
- Operations
- Operations Overview
- Operations Runbook
- Operations Handbook
- ThemisCtl Admin Guide
- Pipeline E2E SOPs
- Docker Overview
- Docker Hub README
- Helm Overview
- Packaging Overview
- Operator Overview
- Security Policy
- Production Hardening Checklist
- Security Hardening Guide
- Encryption Key Management
- Access Control Framework
- Zero Trust Policy
- API Authentication & Authorization
- HSM Production Setup
- PKCS11 Integration
- DSGVO / SOC2 Checklist
- Access Model Runbooks
- Access Model Dashboard
- Maturity Automation Runbook
- Access Review Automation
- Access Model Dashboard
- Access Model Runbooks
- Rights Revocation
- Dr Checklists
- Dr Testing
- Incident Response Playbook
- Incident Response Testing
- GPU Oom Recovery
- Grammar Debugging
- Metrics Scrape Troubleshooting
- Model Swap Procedure
- Quota Tuning
- Subagent Deployment
- Logging Configuration
- Content Model
- Crypto & Keys
- Feature Flags Reference
- Modular Architecture Roadmap
- Modularization Guide
- Module Architecture Index
- PostgreSQL Wire Protocol
- Query Scheduling
- Raft Consensus Design
- Resource Pooling
- Source Directory Guide
- Unified Access Model
- E1 001 Layered Retrieval Design
- E1 002 Ann Abstraction Strategy
- E1 003 Tensor Summary Types
- E1 004 Lora Package Distinction
- E1 005 Model Switch Compatibility
- E1 006 Federated Tensor Summaries
- E2 001 Evaluation Framework Design
- E2 002 Hardware Profile Strategy
- E2 003 Query Planner Routing Model
- E2 004 Approximation Governance Rules
- E2 005 Cross Layer Fallback Confidence Policy
- E3 001 Distributed Tensor Design
- E3 002 Manifest Coordination Strategy
- E3 003 Recovery And Erasure Choice
- E3 004 Tensor Fabric Infrastructure
- Contributing
- Contributing (root)
- Code of Conduct
- Support
- Maintainers
- CTest Guide
- Build Quick Reference
- Developer Wiki Index
- Build / Test / CI
- Module Index
- Branching Strategy
- Release Strategy
- CI Policy Gates Wave C
- Disabled Stub Policy
- Docs PR Policy
- GA Promotion Sign Off
- Github Milestones Setup
- Governance Policies Phase1
- GPU Self Hosted Runner Requirements
- Hardening Phase 1 2 Summary 2026 09 23
- Maturity Claim Verification Checklist
- Maturity Evidence Registry
- Merge Gate Bot Config
- Merge Gate Status Live
- Phase 1 Closure Report
- Phase 1 Infrastructure Deployment
- Phase 1 Infrastructure Deployment Complete
- Phase 3 Baseline Capture
- Phase 3 Refinement Spec
- Phase 4 Sign Off And Closure
- Phase Closure Policy
- Phase Dependency Graph
- Phase3 Enforcement Runbook
- Plugin Submodule Rollback
- PR Version Targeting
- PR Version Targeting Backfill
- Production Ready 2026 Delivery Plan
- Publish Workflow Audit 2026 09 23
- Query Module Status
- Readme
- Release Governance
- Release Promotion Gate Policy
- Release Validation Checklist
- Root Hygiene Policy
- SBOM Approved Versions
- Security Compliance Audit Report 2026 08 10
- Security Module 5671 Evidence Summary
- Sharding P6 Residual Risk Acceptance
- Sourcecode Compliance Governance
- Src Module Documentation Compliance 2026 09 20
- Updates Development Status Sign Off
- Wave C Implementation Complete
- Wave C Implementation Plan
- Wave C Ml Exit Gate Sign Off
- Wave C Policy Gate Evidence
- Wiki Publish Tracking Guide
- Blob Storage
- Cuda
- Ethics Ai
- Exporters
- Huggingface
- Image Analysis
- Importers
- RPC
- Scraper
- Themisdb Ai Watermark Detector
- User Storage Encrypted
- Chimera Architecture
- Chimera Future
- Chimera Readme
- Chimera Roadmap
- Covina Fastapi Ingestion Architecture
- Covina Fastapi Ingestion Future
- Covina Fastapi Ingestion Roadmap
- Vcc Base Architecture
- Vcc Base Future
- Vcc Base Roadmap
- Vcc Clara Ingestion Architecture
- Vcc Clara Ingestion Future
- Vcc Clara Ingestion Roadmap
- Vcc Veritas Architecture
- Vcc Veritas Future
- Vcc Veritas Roadmap
- 01 Hello World
- 02 Todo App
- 03 Contact Manager
- 04 Inventory System
- 05 Time Series Monitor
- 06 Graph Social Network
- 07 Vector Search Documents
- 08 Dms Erp System
- 09 Iot Sensor Network
- 10 Drone Image Analysis
- 11 Blog Wiki
- 12 Expense Tracker
- 13 Recipe Manager
- 14 Ecommerce Catalog
- 15 Event Management
- 16 Kanban Board
- 17 Crm
- 18 Realtime Chat
- 19 Recommendation Engine
- 20 Smart Home
- 21 Coding Platform
- 22 AQL Diagram Tool
- 23 Traveling Salesman
- 24 Moral Philosophy Debates
- API Versioning
- Distributed Sharding
- Feedback Plugins
- Geo
- Gnn
- Image Analysis
- Legal Lora Training
- LLM
- Lora Sync
- Migration
- Nlp
- Performance
- Railway
- Replication
- Rope Visualization
- Sample Product Config
- Security
- Client SDK Overview
- Quickstart
- Sdk Enhancements
- Sdk Implementation Summary
- Test Suite Readme
- Go
- Java
- Javascript
- Php
- Python
- Ruby
- Rust
- Typescript
- 01 Grundlegende Operationen
- 02 AQL Queries
- 03 Graph Daten
- 04 Multimodell Anwendung
- 01 Quickstart Guide
- 02 AQL Referenz Kurzuebersicht
- 03 Datenmodellierung Guide
- 04 Uebungsaufgaben
- 05 Best Practices Guide
- Training Documents
- Training Overview
- 01 Einfuehrung Und Uebersicht
- 02 Datenmodelle Und Architektur
- 03 AQL Abfragesprache
- 04 Installation Und Setup
- 05 Anwendungsbeispiele
- Training Presentations
- Dependencies Readme
- Processmonitor Readme
- Themis.admintools.shared Readme
- Themis.aqlquerybuilder Readme
- Themis.aqlquerybuilder Roadmap
- Themis.auditlogviewer Readme
- Themis.auditlogviewer Roadmap
- Themis.classificationdashboard Readme
- Themis.classificationdashboard Roadmap
- Themis.compliancereports Readme
- Themis.compliancereports Roadmap
- Themis.gisviewer.controlpanel Readme
- Themis.gisviewer.controlpanel Roadmap
- Themis.impactanalysisviewer Readme
- Themis.impactanalysisviewer Roadmap
- Themis.ingestiontool Readme
- Themis.ingestiontool Roadmap
- Themis.keyrotationdashboard Readme
- Themis.keyrotationdashboard Roadmap
- Themis.piimanager Readme
- Themis.piimanager Roadmap
- Themis.retentionmanager Readme
- Themis.retentionmanager Roadmap
- Themis.sagaverifier Readme
- Themis.sagaverifier Roadmap
- Themis.usbadmintool Readme
- Themis.usbadmintool Roadmap
- Architecture Generator Readme
- CI Readme
- CI Roadmap
- Compiler Diagnostics Readme
- Compiler Diagnostics Roadmap
- Completion Readme
- Copilot Ollama Router Readme
- Copilot Ollama Router Roadmap
- Gnn Readme
- Gnn Roadmap
- Rope Visualizer Readme
- Rope Visualizer Roadmap
- Tco Calculator Readme
- Tco Calculator Roadmap
- Tests Readme
- Tests Roadmap
- Themis Config Wx Readme
- Themis Docs Builder Readme
- Wikipedia Ingestion Readme
- Ai Metadata And Provenance
- Build / Test / CI
- Governance And Roadmap
- Developer Wiki Index
- Module Direct Doxygen Check
- Module Doxygen Baseline Summary
- Module Doxygen Batch
- Module Doxygen Coverage Summary
- Module Doxygen Smoke Summary
- Modules And Apis
- Retrieval Direct Doxygen Check
- Soll Ist Gap Summary
- Wiki Delta Report