stoolap 0.4.0

data/Cargo.toml

@@ -0,0 +1,9 @@
+[workspace]
+resolver = "2"
+members = ["ext/stoolap"]
+
+[profile.release]
+lto = true
+codegen-units = 1
+opt-level = 3
+strip = "symbols"

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Stoolap Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,477 @@
+# stoolap-ruby
+
+High-performance Ruby driver for [Stoolap](https://stoolap.io) embedded SQL database. Built with [Magnus](https://github.com/matsadler/magnus) + [rb-sys](https://github.com/oxidize-rb/rb-sys) for direct Rust bindings with no FFI overhead.
+
+- Native Ruby extension gem (not an FFI wrapper).
+- Sub-microsecond point queries on in-memory databases.
+- MVCC transactions with snapshot isolation, parallel query execution, columnar cold volumes with zone maps, bloom filters, LZ4 compression.
+- Full SQL: JOINs, window functions, CTEs, subqueries, GROUP BY / ROLLUP / CUBE / GROUPING SETS, HNSW vector search.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "stoolap"
+```
+
+Or install directly:
+
+```sh
+gem install stoolap
+```
+
+Requires Ruby `>= 3.3` and a stable Rust toolchain at install time (the native extension is built from source on your machine). Rust: <https://rustup.rs>.
+
+## Quick Start
+
+```ruby
+require "stoolap"
+
+# In-memory database
+db = Stoolap::Database.open(":memory:")
+
+# exec runs one or more DDL/DML statements (no parameters)
+db.exec(<<~SQL)
+  CREATE TABLE users (
+    id    INTEGER PRIMARY KEY,
+    name  TEXT NOT NULL,
+    email TEXT
+  );
+  CREATE INDEX idx_users_name ON users(name);
+SQL
+
+# execute runs a single statement with parameters, returns rows affected
+db.execute(
+  "INSERT INTO users (id, name, email) VALUES ($1, $2, $3)",
+  [1, "Alice", "alice@example.com"]
+)
+
+# Named parameters (:key) with either Symbol or String keys
+db.execute(
+  "INSERT INTO users (id, name, email) VALUES (:id, :name, :email)",
+  { id: 2, name: "Bob", email: "bob@example.com" }
+)
+
+# query returns an Array of Hashes with String keys
+users = db.query("SELECT * FROM users ORDER BY id")
+# => [{"id" => 1, "name" => "Alice", ...}, ...]
+
+# query_one returns a single Hash or nil
+user = db.query_one("SELECT * FROM users WHERE id = $1", [1])
+# => {"id" => 1, "name" => "Alice", "email" => "alice@example.com"}
+
+# query_raw returns columnar format (skip the per-row Hash allocation)
+raw = db.query_raw("SELECT id, name FROM users ORDER BY id")
+# => {"columns" => ["id", "name"], "rows" => [[1, "Alice"], [2, "Bob"]]}
+
+db.close
+```
+
+### Block form auto-closes
+
+```ruby
+Stoolap::Database.open(":memory:") do |db|
+  db.exec("CREATE TABLE t (id INTEGER PRIMARY KEY)")
+  db.execute("INSERT INTO t VALUES ($1)", [1])
+end
+# db.close already ran, even if the block raised
+```
+
+## Opening a Database
+
+```ruby
+# In-memory (three equivalent forms)
+Stoolap::Database.open(":memory:")
+Stoolap::Database.open("")
+Stoolap::Database.open("memory://")
+
+# File-backed (data persists across restarts)
+Stoolap::Database.open("./mydata")
+Stoolap::Database.open("file:///absolute/path/to/db")
+```
+
+## Database Methods
+
+| Method | Returns | Description |
+|---|---|---|
+| `execute(sql, params = nil)` | `Integer` | Execute DML, return rows affected |
+| `exec(sql)` | `nil` | Execute one or more statements (no parameters) |
+| `query(sql, params = nil)` | `Array<Hash>` | All rows as Array of Hashes |
+| `query_one(sql, params = nil)` | `Hash, nil` | First row as Hash, or nil |
+| `query_raw(sql, params = nil)` | `Hash` | `{"columns" => [...], "rows" => [[...], ...]}` |
+| `execute_batch(sql, params_list)` | `Integer` | Same SQL, many param sets, auto-tx |
+| `prepare(sql)` | `PreparedStatement` | Cache a parsed + planned statement |
+| `begin_transaction` | `Transaction` | Start a manual transaction |
+| `transaction { \|tx\| ... }` | block return | Auto-commit or rollback on raise |
+| `close` | `nil` | Close the database |
+
+## Parameters
+
+All parameter-accepting methods take either an `Array` (positional, `$1, $2, ...`) or a `Hash` (named, `:key`):
+
+```ruby
+# Positional
+db.query("SELECT * FROM users WHERE id = $1 AND name = $2", [1, "Alice"])
+
+# Named with Symbol keys
+db.query("SELECT * FROM users WHERE id = :id AND name = :name",
+         { id: 1, name: "Alice" })
+
+# Named with String keys
+db.query("SELECT * FROM users WHERE id = :id", { "id" => 1 })
+```
+
+Named-parameter keys can optionally carry a `:`, `@`, or `$` sigil. The driver strips it:
+
+```ruby
+db.query("SELECT * FROM users WHERE id = :id", { ":id" => 1 })
+db.query("SELECT * FROM users WHERE id = :id", { "@id" => 1 })
+db.query("SELECT * FROM users WHERE id = :id", { "$id" => 1 })
+```
+
+## Raw Query Format
+
+`query_raw` returns `{"columns" => [...], "rows" => [[...], ...]}` instead of an Array of Hashes. Use it when you are streaming large results and do not need named access to each row.
+
+```ruby
+raw = db.query_raw("SELECT id, name, email FROM users ORDER BY id")
+raw["columns"]  # => ["id", "name", "email"]
+raw["rows"]     # => [[1, "Alice", "alice@example.com"], ...]
+```
+
+## Batch Execution
+
+Execute the same statement with many parameter sets in one call. Automatically wrapped in a transaction:
+
+```ruby
+changes = db.execute_batch(
+  "INSERT INTO users (id, name, email) VALUES ($1, $2, $3)",
+  [
+    [1, "Alice",   "alice@example.com"],
+    [2, "Bob",     "bob@example.com"],
+    [3, "Charlie", "charlie@example.com"]
+  ]
+)
+# changes => 3
+```
+
+`execute_batch` only supports positional parameters (Arrays). Hash parameter sets raise `Stoolap::Error`.
+
+## Prepared Statements
+
+A prepared statement parses SQL once and caches the execution plan. Column-key `String`s are also cached on the first query so repeated calls do not re-allocate them.
+
+```ruby
+insert = db.prepare("INSERT INTO users (id, name) VALUES ($1, $2)")
+insert.execute([1, "Alice"])
+insert.execute([2, "Bob"])
+
+# Batch on a prepared statement (reuses the cached plan)
+insert.execute_batch([
+  [3, "Charlie"],
+  [4, "Diana"]
+])
+
+# Prepared reads
+lookup = db.prepare("SELECT * FROM users WHERE id = $1")
+lookup.query_one([1])   # => {"id" => 1, "name" => "Alice"}
+lookup.query([1])       # => [{"id" => 1, "name" => "Alice"}]
+lookup.query_raw([1])   # => {"columns" => [...], "rows" => [[...]]}
+
+# Named parameters work the same
+lookup_named = db.prepare("SELECT * FROM users WHERE id = :id")
+lookup_named.query_one({ id: 1 })
+```
+
+### PreparedStatement methods
+
+| Method | Returns | Description |
+|---|---|---|
+| `execute(params = nil)` | `Integer` | Execute DML |
+| `query(params = nil)` | `Array<Hash>` | All rows |
+| `query_one(params = nil)` | `Hash, nil` | First row or nil |
+| `query_raw(params = nil)` | `Hash` | Columnar format |
+| `execute_batch(params_list)` | `Integer` | Many param sets, auto-tx |
+| `sql` | `String` | The SQL text this statement was built from |
+
+## Transactions
+
+### Block form (recommended)
+
+```ruby
+db.transaction do |tx|
+  tx.execute("INSERT INTO users (id, name) VALUES ($1, $2)", [1, "Alice"])
+  tx.execute("INSERT INTO users (id, name) VALUES ($1, $2)", [2, "Bob"])
+
+  # Reads within the tx see its own uncommitted writes
+  rows = tx.query("SELECT * FROM users")
+  one  = tx.query_one("SELECT * FROM users WHERE id = $1", [1])
+  raw  = tx.query_raw("SELECT id, name FROM users")
+end
+# commit on clean exit, rollback on any raise
+```
+
+The block helper returns whatever the block returns:
+
+```ruby
+total = db.transaction do |tx|
+  tx.query_one("SELECT COUNT(*) AS c FROM users")["c"]
+end
+```
+
+### Manual control
+
+```ruby
+tx = db.begin_transaction
+begin
+  tx.execute("INSERT INTO users (id, name) VALUES ($1, $2)", [1, "Alice"])
+  tx.commit
+rescue StandardError
+  tx.rollback
+  raise
+end
+```
+
+Or the equivalent `Transaction#with_rollback` helper:
+
+```ruby
+tx = db.begin_transaction
+tx.with_rollback do |t|
+  t.execute("INSERT INTO users (id, name) VALUES ($1, $2)", [1, "Alice"])
+end
+# commit on success, rollback on raise
+```
+
+### Transaction methods
+
+| Method | Returns | Description |
+|---|---|---|
+| `execute(sql, params = nil)` | `Integer` | Execute DML |
+| `query(sql, params = nil)` | `Array<Hash>` | All rows |
+| `query_one(sql, params = nil)` | `Hash, nil` | First row or nil |
+| `query_raw(sql, params = nil)` | `Hash` | Columnar format |
+| `execute_batch(sql, params_list)` | `Integer` | Many param sets |
+| `execute_prepared(stmt, params = nil)` | `Integer` | Run a `PreparedStatement` inside this tx |
+| `query_prepared(stmt, params = nil)` | `Array<Hash>` | Query a `PreparedStatement` inside this tx |
+| `query_one_prepared(stmt, params = nil)` | `Hash, nil` | First row from a prepared query |
+| `query_raw_prepared(stmt, params = nil)` | `Hash` | Columnar result from a prepared query |
+| `commit` | `nil` | Commit the transaction |
+| `rollback` | `nil` | Roll back the transaction |
+| `with_rollback { \|tx\| ... }` | block return | Commit on clean exit, rollback on raise |
+
+Calling `execute` / `query` / `commit` / `rollback` on a committed or rolled-back transaction raises `Stoolap::Error`. DDL statements (`CREATE TABLE`, etc.) are not allowed inside explicit transactions; run them outside.
+
+## Type Mapping
+
+| Ruby | Stoolap | Notes |
+|---|---|---|
+| `Integer` | `INTEGER` | 64-bit signed (full `i64::MIN..=i64::MAX`) |
+| `Float` | `FLOAT` | 64-bit double |
+| `String` | `TEXT` | UTF-8, returned as UTF-8-encoded `String` |
+| `true` / `false` | `BOOLEAN` | |
+| `nil` | `NULL` | Any column type |
+| `Time` | `TIMESTAMP` | Nanosecond precision; local times converted to UTC; returned as UTC `Time` |
+| `Symbol` | `TEXT` | Converted to its string name |
+| `Hash` | `JSON` | Serialized via `JSON.dump` (requires `require "json"`) |
+| `Array` | `JSON` | Serialized via `JSON.dump` |
+| `Stoolap::Vector` | `VECTOR(N)` | See below |
+
+Any other type passed as a parameter raises `TypeError`.
+
+## Vector Similarity Search
+
+Stoolap has native `VECTOR(N)` columns and HNSW indexes. Wrap a Ruby numeric array in `Stoolap::Vector` to avoid the JSON encoding path:
+
+```ruby
+db.exec(<<~SQL)
+  CREATE TABLE documents (
+    id        INTEGER PRIMARY KEY,
+    title     TEXT,
+    embedding VECTOR(3)
+  );
+  CREATE INDEX idx_emb ON documents(embedding) USING HNSW WITH (metric = 'cosine');
+SQL
+
+db.execute(
+  "INSERT INTO documents VALUES ($1, $2, $3)",
+  [1, "Hello world", Stoolap::Vector.new([0.1, 0.2, 0.3])]
+)
+db.execute(
+  "INSERT INTO documents VALUES ($1, $2, $3)",
+  [2, "Goodbye world", Stoolap::Vector.new([0.9, 0.1, 0.0])]
+)
+
+# k-NN search: 5 nearest neighbours by cosine distance
+results = db.query(<<~SQL)
+  SELECT id, title,
+         VEC_DISTANCE_COSINE(embedding, '[0.1, 0.2, 0.3]') AS dist
+  FROM documents
+  ORDER BY dist
+  LIMIT 5
+SQL
+
+# Read vectors back as Array<Float>
+row = db.query_one("SELECT embedding FROM documents WHERE id = 1")
+row["embedding"]  # => [0.1, 0.2, 0.3]
+```
+
+### Vector class
+
+| Method | Returns | Description |
+|---|---|---|
+| `Stoolap::Vector.new(array)` | `Vector` | Build from an `Array` of numbers (raises `TypeError` on non-numeric) |
+| `#to_a` | `Array<Float>` | Copy to a plain Array |
+| `#length` / `#size` | `Integer` | Dimension count |
+| `#inspect` / `#to_s` | `String` | `#<Stoolap::Vector [0.1, 0.2, 0.3]>` |
+
+### Vector distance functions
+
+| Function | Description |
+|---|---|
+| `VEC_DISTANCE_L2(a, b)` | Euclidean distance |
+| `VEC_DISTANCE_COSINE(a, b)` | Cosine distance (1 minus cosine similarity) |
+| `VEC_DISTANCE_IP(a, b)` | Negative inner product |
+
+### HNSW index options
+
+```sql
+CREATE INDEX idx ON documents(embedding) USING HNSW WITH (metric = 'cosine');
+```
+
+Supported metrics: `l2` (default), `cosine`, `ip`.
+
+## Persistence and Configuration
+
+File-backed databases persist data via Write-Ahead Logging and immutable columnar cold volumes. A background checkpoint cycle seals hot rows into volume files, compacts them, and truncates the WAL. Data survives process restarts.
+
+```ruby
+Stoolap::Database.open("./mydata") do |db|
+  db.exec("CREATE TABLE kv (key TEXT PRIMARY KEY, value TEXT)")
+  db.execute("INSERT INTO kv VALUES ($1, $2)", ["hello", "world"])
+end
+
+# Reopen: data is still there
+Stoolap::Database.open("./mydata") do |db|
+  db.query_one("SELECT value FROM kv WHERE key = $1", ["hello"])
+  # => {"value" => "world"}
+end
+```
+
+### DSN query parameters
+
+Append options to the path as query parameters:
+
+```ruby
+# Maximum durability (fsync on every WAL write)
+Stoolap::Database.open("./mydata?sync=full")
+
+# High throughput (no fsync, larger buffers)
+Stoolap::Database.open("./mydata?sync=none&wal_buffer_size=131072")
+
+# Custom checkpoint interval with compression
+Stoolap::Database.open("./mydata?checkpoint_interval=60&compression=on")
+```
+
+| Parameter | Default | Description |
+|---|---|---|
+| `sync` | `normal` | Sync mode: `none`, `normal`, `full` |
+| `checkpoint_interval` | `60` | Seconds between automatic checkpoint cycles |
+| `compact_threshold` | `4` | Sub-target volumes per table before merging |
+| `keep_snapshots` | `3` | Backup snapshots retained per table |
+| `wal_flush_trigger` | `32768` | WAL flush trigger in bytes (32 KB) |
+| `wal_buffer_size` | `65536` | WAL buffer size in bytes (64 KB) |
+| `wal_max_size` | `67108864` | Max WAL file size before rotation (64 MB) |
+| `commit_batch_size` | `100` | Commits batched before syncing (normal mode) |
+| `sync_interval_ms` | `1000` | Minimum ms between syncs (normal mode) |
+| `wal_compression` | `on` | LZ4 compression for WAL entries |
+| `volume_compression` | `on` | LZ4 compression for cold volume files |
+| `compression` | -- | Alias that sets both `wal_compression` and `volume_compression` |
+| `compression_threshold` | `64` | Minimum bytes before compressing an entry |
+| `checkpoint_on_close` | `on` | Seal all hot rows to volumes on clean shutdown |
+| `target_volume_rows` | `1048576` | Target rows per cold volume (min 65536) |
+
+### Sync Modes
+
+| Mode | Value | Description |
+|---|---|---|
+| `none` | `sync=none` | No fsync. Fastest, data may be lost on crash |
+| `normal` | `sync=normal` | Fsync in commit batches (default) |
+| `full` | `sync=full` | Fsync on every WAL write. Slowest, maximum durability |
+
+### Same DSN shares one engine
+
+Opening the same DSN twice in one process returns the same underlying engine. Closing one handle closes the engine for all handles. This prevents corruption and is why you should open a database once per process and pass the instance around.
+
+## Error Handling
+
+All database errors raise `Stoolap::Error`, which inherits from `StandardError`:
+
+```ruby
+begin
+  db.execute("SELEXT * FROM nothing")
+rescue Stoolap::Error => e
+  warn "database error: #{e.message}"
+end
+```
+
+Invalid parameter types raise `TypeError`:
+
+```ruby
+begin
+  db.execute("INSERT INTO t VALUES ($1)", [Object.new])
+rescue TypeError => e
+  warn e.message
+end
+```
+
+## Features
+
+Stoolap is a full-featured embedded SQL database:
+
+- **MVCC transactions** with snapshot isolation.
+- **Cost-based query optimizer** with adaptive execution.
+- **Parallel execution** for filter, join, sort, and distinct operators.
+- **JOINs**: INNER, LEFT, RIGHT, FULL OUTER, CROSS, NATURAL.
+- **Subqueries**: scalar, `EXISTS`, `IN`, `NOT IN`, `ANY`/`ALL`, correlated.
+- **Window functions**: `ROW_NUMBER`, `RANK`, `DENSE_RANK`, `LAG`, `LEAD`, `NTILE`, plus frame specs.
+- **CTEs**: `WITH` and `WITH RECURSIVE`.
+- **Aggregations**: `GROUP BY`, `HAVING`, `ROLLUP`, `CUBE`, `GROUPING SETS`.
+- **Vector similarity search** with HNSW indexes over `l2`, `cosine`, `ip`.
+- **Indexes**: B-tree, hash, bitmap (auto-selected), HNSW, multi-column composite.
+- **131 built-in functions**: string, math, date/time, JSON, vector, aggregate.
+- **Immutable volume storage** with columnar format, zone maps, bloom filters, LZ4 compression.
+- **WAL + checkpoint cycles** for crash recovery.
+- **Aggregation pushdown** to cold volume statistics (`COUNT`, `SUM`, `MIN`, `MAX`).
+- **Semantic query caching** with predicate subsumption.
+
+See the [Stoolap documentation](https://stoolap.io/docs/) for SQL reference.
+
+## Building from Source
+
+Requires:
+- [Rust](https://rustup.rs) (stable)
+- Ruby `>= 3.3`
+- A C toolchain for the Ruby header files
+
+```sh
+git clone https://github.com/stoolap/stoolap-ruby.git
+cd stoolap-ruby
+bundle install
+bundle exec rake compile
+bundle exec rake test
+```
+
+The `compile` task invokes `rb_sys/mkmf` which builds the Rust extension into `lib/stoolap/stoolap.<ext>` so the installed gem can `require` it.
+
+## Running the test suite
+
+```sh
+bundle exec rake test
+```
+
+The suite runs against `lib/stoolap.rb` with 100% line coverage (SimpleCov). `lib/stoolap/version.rb` is filtered from the metric because Bundler loads it via the gemspec before SimpleCov can instrument it.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).