Documentation
Welcome to the Documentation! This is your comprehensive guide to using and understanding Stoolap, a high-performance embedded SQL database written in pure Rust.
What is Stoolap?
Stoolap is a modern embedded SQL database that provides full ACID transactions with MVCC, statements planned once and shown by EXPLAIN, and features that rival established databases like PostgreSQL and DuckDB. Built entirely in Rust with minimal unsafe code (only for FFI and performance-critical hot paths), Stoolap features multiple index types (B-tree, Hash, Bitmap, HNSW), native vector search with semantic search support, parallel query execution, and comprehensive SQL support including window functions, CTEs, and temporal queries.
Documentation Sections
Getting Started
- Installation Guide
- Quick Start Tutorial
- Connection String Reference
- API Reference
- Stoolap Desktop
- Stoolap Studio
Drivers
- Python Driver
- Go Driver
- Node.js Driver
- Java Driver
- C# Driver
- PHP Driver
- Ruby Driver
- Swift Driver
- C API (FFI)
- WebAssembly (WASM)
- Go WASM Driver
- MCP Server
Architecture
- Architecture Overview
- Storage Engine
- Indexing
- MVCC Implementation
- Transaction Isolation
- Expression Pushdown
- Persistence
- Unique Indexes
Data Types
SQL Commands
Functions
- SQL Functions Reference
- Scalar Functions
- Aggregate Functions
- Window Functions
- Table-Valued Functions
SQL Features
- Temporal Queries (AS OF)
- JOIN Operations
- Subqueries
- Common Table Expressions (CTEs)
- ROLLUP, CUBE, and GROUPING SETS
- Operators and Expressions
- CAST Operations
- DISTINCT Operations
- NULL Handling
- Parameter Binding
- Upsert (ON CONFLICT / ON DUPLICATE KEY)
- Savepoints
- EXPLAIN
- Foreign Keys
- Views
- Set Operations
- Transactions
- ALTER TABLE
- RETURNING Clause
- Auto Increment
- Collation
- Row Identity (_rowid_)
- Names and Case
Performance
- Performance Optimization
- Query Planning
- Semantic Query Cache
- Query Execution and Optimization in Stoolap
- Parallel Execution
- ANN Benchmarks
Development
- Migration Guide v0.3.7 to v0.4.0
- Migration Guide v0.4.2 to v0.5.0
- Testing
- Known Limitations
- Building from Source
- Contributing
Need Help?
If you can't find what you're looking for in the documentation, you can:
- Open an issue on GitHub
- Join the discussions to ask questions
This documentation is under active development. Contributions are welcome!