Desi Mongoose Documentation

Welcome to Desi Mongoose - a fun and intuitive MongoDB ODM for Node.js that brings a Hinglish twist to database operations! 🚀

Table of Contents

• Installation
• Quick Start
• Core Features
• Documentation

Installation

npm install desi-mongoose

Quick Start

import { DesiModel, DesiSchema } from 'desi-mongoose';

// Define a schema
const userSchema = new DesiSchema({
  name: { type: String, required: true },
  age: { type: Number, min: 0 },
  email: { type: String, unique: true }
});

// Create a model
const User = new DesiModel('User', userSchema);

// Create a new user
await User.nayaBanao({
  name: 'Raj Kumar',
  age: 25,
  email: '[email protected]'
});

// Find users
const users = await User.dhoondo({ umar: { $gt: 18 } });

Core Features

1. Schema and Model

   • Schema definition with validation
   • Model creation and operations

2. CRUD Operations

   • Create (nayaBanao)
   • Read (dhoondo, ekDhoondo)
   • Update (badlo)
   • Delete (hatao)

3. Aggregations

   • Complex data pipeline operations
   • Hinglish-named aggregation methods

4. Relationships

   • Define and manage relationships
   • Population and references

5. Validation

   • Built-in validators
   • Custom validation rules

6. Events

   • Pre and post hooks
   • Middleware functions

7. Plugins

   • Plugin system
   • Extending functionality

8. Transactions

   • ACID transactions
   • Session management

9. Caching

   • Query result caching
   • Cache management

Documentation

Detailed documentation for each feature is available in separate files:

• Schema and Model Documentation
• CRUD Operations Guide
• Aggregation Pipeline Guide
• Relationships Guide
• Validation Rules
• Events and Middleware
• Plugin System
• Transaction Management
• Cache Management

Contributing

We welcome contributions! Please feel free to submit a Pull Request.

License

MIT