@antelopejs/mongodb

A full-featured MongoDB client module that implements both the MongoDB interface and the Database interface for AntelopeJS.

For detailed documentation on the MongoDB interfaces, please refer to:

• MongoDB Interface
• Database Interface

Installation

ajs project modules add @antelopejs/mongodb

Overview

The AntelopeJS MongoDB module provides functionality for interacting with MongoDB:

• MongoDB client connection management through the MongoDB interface
• Common database operations through the Database interface

Configuration

The MongoDB module supports connection using the native MongoDB driver with the following options:

// MongoDB connection options
{
    url: "mongodb://localhost:27017",     // The MongoDB connection string
    id_provider: "uuid",                  // ID generation strategy: "uuid" (default) or "objectid"
    options: {                            // Optional MongoDB client options
        useNewUrlParser: true,
        useUnifiedTopology: true,
        maxPoolSize: 10,                  // Maximum number of connections in the pool
        connectTimeoutMS: 30000,          // Connection timeout in milliseconds
        socketTimeoutMS: 30000            // Socket timeout in milliseconds
    }
}

Configuration Details

The module uses the official MongoDB Node.js driver to establish connections to your MongoDB servers:

• Connection using MongoClient.connect() from the mongodb package
• Support for standard MongoDB connection options
• Built-in connection pooling through the MongoDB driver
• ID generation strategies:
  • uuid (default): Uses UUID v4 for generating unique identifiers
  • objectid: Uses MongoDB's native ObjectId for document identifiers

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.