Documentation Index
Fetch the complete documentation index at: https://www.esixorm.com/llms.txt
Use this file to discover all available pages before exploring further.
Welcome to Esix Documentation
Esix is a TypeScript database library for MongoDB, heavily inspired by Laravel’s Eloquent. Models map to documents in the database, and the QueryBuilder is used to select which documents to retrieve.Features
- Convention over Configuration: Define your models as normal TypeScript classes with minimal boilerplate
- Type Safety: Advanced TypeScript features provide compile-time type safety
- Fluent Interface: Chainable query methods for intuitive database operations
- MongoDB Integration: Built specifically for MongoDB with support for modern features
- Aggregation Support: Built-in aggregation functions for common operations
Quick Start
Get started with Esix by following our Getting Started guide to install and configure Esix in your project.Documentation Structure
- Getting Started - Installation and basic setup
- Configuration - Database connection and configuration options
- Defining Models - How to create and structure your models
- Retrieving Models - Querying and fetching data
- Inserting and Updating - Creating and modifying records
- Deleting Models - Removing records from the database
- Pagination - Handling large datasets with pagination
- Testing - Testing strategies for your Esix applications