Package Exports

@unchainedshop/mongodb
@unchainedshop/mongodb/lib/mongodb-index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@unchainedshop/mongodb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@unchainedshop/mongodb

MongoDB database abstraction layer for the Unchained Engine.

Installation

npm install @unchainedshop/mongodb

Usage

import { initDb, startDb, stopDb, generateDbObjectId } from '@unchainedshop/mongodb';

// Initialize the database connection
const db = await initDb({
  connectionString: 'mongodb://localhost:27017/unchained',
});

// Start the database
await startDb(db);

// Generate a new ObjectId
const id = generateDbObjectId();

// Stop the database when shutting down
await stopDb(db);

API Overview

Database Lifecycle

Export	Description
`initDb`	Initialize MongoDB connection with connection string
`startDb`	Start the database connection
`stopDb`	Close the database connection

Query Utilities

Export	Description
`generateDbObjectId`	Generate a new MongoDB ObjectId
`generateDbFilterById`	Create a filter object for querying by ID
`buildDbIndexes`	Create indexes for a collection
`findPreservingIds`	Find documents while preserving ID order
`buildSortOptions`	Build MongoDB sort options from SortOption array
`findLocalizedText`	Find localized text by locale with fallback
`insensitiveTrimmedRegexOperator`	Create case-insensitive trimmed regex for text search

DocumentDB Compatibility

Export	Description
`isDocumentDBCompatModeEnabled`	Check if AWS DocumentDB compatibility mode is enabled
`assertDocumentDBCompatMode`	Throw error if DocumentDB compat mode is enabled (for unsupported operations)

Re-exports

Export	Description
`mongodb`	Re-exported mongodb driver for direct access

Types

Export	Description
`LogFields`	Interface for document log entries
`TimestampFields`	Interface for created/updated/deleted timestamps
`Address`	Interface for postal address data
`Contact`	Interface for contact information
`Migration`	Interface for database migrations
`MigrationRepository`	Interface for managing migrations
`ModuleInput`	Interface for core module initialization input

Environment Variables

Variable	Description
`UNCHAINED_DOCUMENTDB_COMPAT_MODE`	Enable AWS DocumentDB compatibility mode

License

EUPL-1.2