@mxweb/db

Database management package for MXWeb Framework - A NestJS-inspired framework for Next.js App Router.

Features

• 🔌 Multi-database support - PostgreSQL, MySQL, MariaDB, MongoDB
• 🔄 Connection management - Singleton pattern with automatic retry
• 📦 Entity schema - Decorator-free entity definitions
• 🗄️ Repository pattern - Type-safe CRUD with built-in pagination
• 📋 Migration support - Schema migrations for SQL databases
• ⚡ TypeORM powered - Built on top of TypeORM

Installation

npm install @mxweb/core @mxweb/db typeorm
# or
yarn add @mxweb/core @mxweb/db typeorm

Install your database driver:

# PostgreSQL
npm install pg

# MySQL
npm install mysql2

# MariaDB
npm install mariadb

# MongoDB
npm install mongodb

Quick Start

import { Application } from "@mxweb/core";
import { Connection, Migration } from "@mxweb/db";

const app = Application.create({
  injects: async () => ({
    db: Connection.forRoot(Connection.postgresql({
      host: process.env.DB_HOST,
      database: process.env.DB_NAME,
    })),
    migration: Migration.forRoot({ autoRun: true }),
  }),
});

Documentation

For complete documentation, visit docs.mxweb.io

• Connection - Database connection setup
• Entity - Schema definitions
• Repository - Data access patterns
• Migration - Schema migrations

License

MIT © MXWeb Team