Stoolap Documentation

Stoolap Documentation

Welcome to the Stoolap 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, a sophisticated cost-based query optimizer, 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), 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
• Subqueries Quick Start

Architecture

• Architecture Overview
• Storage Engine
• Indexing
• MVCC Implementation
• Transaction Isolation
• Expression Pushdown
• Persistence
• Unique Indexes

Data Types

• Data Types in Stoolap
• Date and Time Handling
• JSON Support

SQL Commands

• SQL Commands
• Schema Management in Stoolap
• PRAGMA Commands

Functions

• SQL Functions Reference
• Scalar Functions
• Aggregate Functions
• Window 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
• ON DUPLICATE KEY UPDATE
• Savepoints
• EXPLAIN

Performance

• Performance Optimization
• Query Optimizer
• Semantic Query Cache
• Query Execution and Optimization in Stoolap
• Parallel Execution

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!