ShadowDB

ShadowDB is a mock database for testing and development that supports multiple databases. With advanced features like batch operations, transactions, pagination, sorting, and more, ShadowDB aims to provide a versatile and efficient data handling experience for developers.

Features

• Multi-Database Support: Connect to a mock database, PostgreSQL, or MongoDB.
• Batch Operations: Add and update multiple records simultaneously.
• Search Functionality: Filter records based on specific criteria.
• Transactions: Ensure data integrity with support for commit and rollback.
• Pagination: Efficiently handle large datasets with built-in pagination support.
• Sorting: Sort records by specified fields.
• Event System: Trigger actions when records are added, updated, or deleted.
• Data Validation: Enforce data integrity by validating records before adding or updating.
• Logging: Track operations with customizable logging levels.
• Custom Configuration: Customize behaviors such as validation rules and logging levels.
• Migration Support: Migrate data between different database types.
• Error Handling: Improved error messages and custom error types for better debugging.
• Unit Tests: A suite of unit tests ensuring code reliability.
• Performance Optimizations: Optimized for large datasets and complex queries.

Table of Contents

• Installation
• Example Environment Variables
• Usage
• API Documentation
  • Core Methods
  • New Features
• License

Installation

Install ShadowDB via npm:

npm install shadowdb

Example Environment Variables

To configure your database connections, create a .env file in the root of your project with the following format:

DB_TYPE=mock  # or 'postgres' or 'mongo'
POSTGRES_URL=your_postgres_url
MONGO_URL=your_mongo_url

Usage

Here's how to use ShadowDB:

const ShadowDB = require('shadowdb');
const db = new ShadowDB('mock');

// Basic operations
db.addRecord({ id: 1, name: 'Example Record' });
console.log(db.findAll());
db.updateRecord(1, { name: 'Updated Record' });
db.deleteRecord(1);

// Advanced operations
db.batchAdd([{ id: 2, name: 'Record 2' }, { id: 3, name: 'Record 3' }]);
db.batchUpdate([{ id: 2, name: 'Updated Record 2' }, { id: 3, name: 'Updated Record 3' }]);
console.log(db.search({ name: 'Updated Record 2' }));

// Transactions
db.beginTransaction();
db.addRecord({ id: 4, name: 'Transaction Record' });
db.commit(); // or db.rollback();

// Pagination & Sorting
console.log(db.findAll({ page: 1, limit: 10, sortBy: 'name' }));

API Documentation

Core Methods

• addRecord(record): Adds a new record to the database.
• findAll(options): Retrieves all records, optionally with pagination and sorting.
• updateRecord(id, newData): Updates a specific record by ID.
• deleteRecord(id): Deletes a specific record by ID.
• clearRecords(): Removes all records from the database.

New Features

Batch Operations

• batchAdd(records): Add multiple records at once.
• batchUpdate(records): Update multiple records simultaneously.

Search Functionality

• search(criteria): Filter records based on specific criteria.

Transactions

• beginTransaction(): Starts a transaction.
• commit(): Commits a transaction.
• rollback(): Rolls back a transaction.

Pagination & Sorting

• findAll({ page, limit, sortBy }): Retrieve records with pagination and sorting.

Event System

• on(event, callback): Listen for database events (e.g., 'add', 'update', 'delete').

Data Validation

• addRecord(record, { validate: true }): Validate records before adding or updating.

Logging & Configuration

• setLogging(level): Configure logging levels (e.g., 'info', 'warn', 'error').
• configure(options): Set custom configurations like validation rules and logging.

Migration Support

• migrateData(targetDatabase): Migrate data between different database types.

License

This project is licensed under the MIT License. See the LICENSE file for more details.