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 zero unsafe code, Stoolap features:

• Multiple Index Types: B-tree, Hash, and Bitmap indexes with automatic type selection
• Multi-Column Indexes: Composite indexes for complex query patterns
• Parallel Query Execution: Automatic parallelization using Rayon for large datasets
• Cost-Based Optimizer: PostgreSQL-style optimizer with adaptive execution and cardinality feedback
• Semantic Query Caching: Intelligent result caching with predicate subsumption
• Disk Persistence: WAL and snapshots with crash recovery
• Rich SQL Support: Window functions, CTEs (including recursive), subqueries, ROLLUP/CUBE, and 101+ built-in functions

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!