Ruggy LogoRuggy
Quick StartFeaturesAPIGitHubGet Started
Version 0.2.0

High-performance embedded database for Node.js

A simple, fast embedded database backed by Rust. Zero dependencies, native performance, and full TypeScript support.

View Docs
Quick Start

Get started in seconds

Install Ruggy and start building with just three steps

1

Install via npm

Add Ruggy to your project with a single command

npm install ruggy
2

Initialize your database

Create a new database instance and collection

const { RuggyDatabase } = require('ruggy');
const db = new RuggyDatabase('./my-database');
const users = db.collection('users');
3

Start performing operations

Insert, query, update, and delete data instantly

// Insert data
const id = users.insert({
  name: 'John Doe',
  email: 'john@example.com'
});

// Query data
const user = users.findById(id);
quick-start.js
const { RuggyDatabase } = require('ruggy');
const db = new RuggyDatabase('./data');

const users = db.collection('users');

// 1. Insert
const id = users.insert({ 
  name: 'Alice',
  email: 'alice@example.com'
});

// 2. Advanced Search
const results = users.findWithOperator(
  'email',
  '@example.com',
  'ends_with'
);

// 3. Update field
users.updateField(id, 'status', 'premium');

// 4. Delete
users.delete(id);

Built for performance

Everything you need to build fast, reliable applications with embedded data storage.

Native Performance

Rust backend with FFI bindings delivers lightning-fast operations. ~10,000 inserts/sec, ~50,000 reads/sec.

Embedded Database

No separate server required. Your database runs directly in your Node.js process with persistent storage.

TypeScript Support

Full type definitions included. Autocomplete and type checking for a better developer experience.

Advanced Search

Search with operators: equals, like, starts_with, ends_with. Find data with flexible query patterns.

Full CRUD Operations

Insert, find, update, and delete documents with a simple, intuitive API. All operations are fast and reliable.

Persistent Storage

Data stored in append-only files. Your data persists across restarts with automatic recovery.

Connection Pool

Built-in connection pooling for long-running applications. Manage database lifecycle automatically.

YAML Configuration

Configure database paths with ruggy.yaml. Flexible deployment with environment-based configuration.

Zero Dependencies

No external database servers or complex setups. Just install and start building immediately.

API Reference

Complete API at your fingertips

Simple, powerful methods to manage your embedded database

RuggyDatabase

Core database class for managing collections and connections

new RuggyDatabase(path: string)

Creates a new database at the specified path

RuggyDatabase.fromConfig(options?)

Creates instance using ruggy.yaml configuration

RuggyDatabase.withDatabase(path, callback)

Automatically manages database lifecycle with auto-close

collection(name: string): RuggyCollection

Gets or creates a collection

RuggyCollection

Collection class for CRUD operations on documents

insert(data: Object): string

Inserts document, returns ID

findAll(): Array

Returns all documents

find(field, value): Array

Finds by field match

findWithOperator(field, value, operator)

Advanced search with operators

updateField(id, field, value): boolean

Updates specific field

delete(id: string): boolean

Deletes document by ID

RuggyPool

Connection pool for long-running applications

new RuggyPool(path: string, options?)

Creates connection pool with lazy connect option

withDatabase(callback): Promise

Executes with pooled connection

closeGracefully(timeoutMs?): Promise

Waits for operations before closing

Performance Benchmarks

Optimized for embedded use cases with thousands of documents

~10K
Inserts per second
~50K
FindAll per second
~20K
Find by field per second

Platform Support

Windows x64

Pre-built binaries included for instant setup

!

Linux / macOS

Requires building from source (Rust toolchain required)

Ready to build with Ruggy?

Version 0.2.0 brings enhanced stability, advanced features, and improved cross-platform support.

Read DocumentationView on GitHub
Ruggy LogoRuggy

A simple, fast embedded database for Node.js backed by Rust.

Resources

  • Documentation
  • Quick Start
  • API Reference
  • Examples

Community

  • GitHub
  • Issues
  • Discussions
  • npm Package

Built With

  • Rust
  • Koffi (FFI)
  • js-yaml

MIT License © 2026 Ruggy. Built with ❤️ by the community.