Skip to main content
Version: 0.4.4

Quick Start

Get SochDB running in 5 minutes.

Prerequisites​

RequirementVersionCheck Command
Rust2024 edition (≥1.75)rustc --version
Python (optional)≥3.9python --version
GitAny recentgit --version

Installation​

Python​

pip install sochdb

Node.js / TypeScript​

npm install @sochdb/sochdb

Rust​

Add to your Cargo.toml:

[dependencies]
sochdb = "0.4"

Go​

go get github.com/sochdb/sochdb-go@v0.4.3

Build from Source​

git clone https://github.com/sochdb/sochdb
cd sochdb
cargo build --release

Hello World​

Python​

from sochdb import Database

# Open database (creates automatically)
db = Database.open("./my_first_db")

# Store data
db.put(b"users/alice/name", b"Alice Smith")
db.put(b"users/alice/email", b"alice@example.com")

# Retrieve data
name = db.get(b"users/alice/name")
print(f"Name: {name.decode()}")  # Output: Name: Alice Smith

db.close()

Node.js / TypeScript​

import { Database } from '@sochdb/sochdb';

// Open database
const db = Database.open('./my_first_db');

// Store data
await db.put(Buffer.from('users/alice/name'), Buffer.from('Alice Smith'));
await db.put(Buffer.from('users/alice/email'), Buffer.from('alice@example.com'));

// Retrieve data
const name = await db.get(Buffer.from('users/alice/name'));
console.log(`Name: ${name?.toString()}`);  // Output: Name: Alice Smith

await db.close();

Go​

package main

import (
    "fmt"
    sochdb "github.com/sochdb/sochdb-go"
)

func main() {
    // Open database
    db, err := sochdb.Open("./my_first_db")
    if err != nil {
        panic(err)
    }
    defer db.Close()

    // Store data
    db.Put([]byte("users/alice/name"), []byte("Alice Smith"))
    db.Put([]byte("users/alice/email"), []byte("alice@example.com"))

    // Retrieve data
    name, _ := db.Get([]byte("users/alice/name"))
    fmt.Printf("Name: %s\n", name)  // Output: Name: Alice Smith
}

Rust​

use sochdb::Database;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Open database
    let db = Database::open("./my_first_db")?;

    // Store data
    db.put(b"users/alice/name", b"Alice Smith")?;
    db.put(b"users/alice/email", b"alice@example.com")?;

    // Retrieve data
    if let Some(name) = db.get(b"users/alice/name")? {
        println!("Name: {}", String::from_utf8_lossy(&name));
    }

    Ok(())
}

Verify Installation​

Python​

python -c "from sochdb import Database; print('SochDB Python SDK installed!')"

Node.js​

node -e "const {SochDatabase} = require('@sochdb/sochdb'); console.log('SochDB Node.js SDK installed!')"

Go​

go run -e 'package main; import _ "github.com/sochdb/sochdb-go"; func main() { println("SochDB Go SDK installed!") }'

Rust​

cargo build --release && echo "SochDB Rust SDK installed!"

Configuration​

SochDB works out of the box with sensible defaults. For customization:

Environment Variables​

# Enable debug logging
export RUST_LOG=sochdb=debug

# Set default database path
export SOCHDB_PATH=./data

# Library path for Python FFI
export SOCHDB_LIB_PATH=/path/to/sochdb/target/release

Configuration File​

Create sochdb.toml in your database directory:

[storage]
path = "./data"
sync_mode = "normal"  # "full", "normal", or "off"

[index]
hnsw_m = 16           # HNSW graph connectivity
hnsw_ef = 200         # Construction search width

[server]
socket_path = "/tmp/sochdb.sock"
max_connections = 100

Next Steps​

GoalResource
Build a complete appFirst App Tutorial
Learn vector searchVector Search Tutorial
Use with LLM agentsMCP Integration
Understand internalsArchitecture
ContributeContributing Guide

Troubleshooting​

Common Issues​

Python: ModuleNotFoundError: No module named 'sochdb'​

pip install --upgrade sochdb

Rust: error: linking with 'cc' failed​

Install build tools:

# macOS
xcode-select --install

# Ubuntu/Debian
sudo apt install build-essential

# Fedora
sudo dnf install gcc

Permission denied on Unix socket​

chmod 755 /tmp/sochdb.sock

Get Help​