MongoDB Atlas

https://www.mongodb.com/cloud/atlas/register
npm i @pi-r/atlas

Interface

import type { MongoDBDataSource } from "../db/mongodb";
import type { MongoClientOptions } from "mongodb";

interface AtlasDatabaseQuery extends MongoDBDataSource {
    source: "cloud";
    service: "atlas";
    uri: string;
    credential: string | AtlasDatabaseCredential;
    table: string;
}

interface AtlasDatabaseCredential extends AuthValue, MongoClientOptions {/* Empty */}

Authentication

Connection

{
  "dataSource": {
    "uri": "mongodb+srv://<username>:<password>@cluster0.abcdef.mongodb.net/<database>", // Required
    /* OR */
    "credential": "main", // squared.cloud.json
    /* OR */
    "credential": {
      "server": "localhost:27017", // OR: 0.0.0.0
      /* OR */
      "hostname": "cluster0.abcdef.mongodb.net",
      "port": 8080, // Default is "27017"

      "username": "**********",
      "password": "**********",
      /* OR */
      "auth": {
        "username": "**********",
        "password": "**********"
      },
      /* OR */
      "authMechanism": "MONGODB-X509",
      "tlsCertificateKeyFile": "/path/to/cert.pem",
      /* OR */
      "authMechanism": "MONGODB-AWS",
      "authMechanismProperties": {}
      /* OR */
      "authMechanism": "PLAIN"

      /* Same as @pi-r/mongodb */
    }
  }
}

Tip

Atlas connections are compatible with the @pi-r/mongodb plugin.

Example usage

Query

{
  "selector": "img",
  "type": "attribute",
  "dataSource": {
    "source": "cloud",
    "service": "atlas",
    "credential": {/* Authentication */},
    "table": "demo",

    "name": "nodejs", // Database name (optional)

    "id": "1", // Alias for "_id"
    /* OR */
    "query": {
      "id": {
        "$eq": "1"
      },
      "start_date": {
        "$gt": "new Date('2021-01-01')" // When using web service
      },
      "$in": ["new RegExp(^mongodb, i)"], // Quotes are optional [/^mongodb/i]
      "$where": "function() { return this.name == 'mongodb.com'; }" // async is supported
    },

    "value": "<b>${title}</b>: ${description}",

    /* Update */
    "id": "1", // Same as item above
    /* OR */
    "query": {/* Filter<Document> */},

    "updateType": 0, // findOneAndUpdate
    "updateType": 1, // limit > 1 ? updateMany : findOneAndUpdate
    "updateType": 2, // findOneAndReplace
    "updateType": 3, // findOneAndDelete
    "update": {/* UpdateFilter<Document> */},

    "update": [/* Document */, /* Document */] // Not related to query (insertMany)
  }
}

@pi-r/atlas

Added in version 0.12.0:

AtlasDatabaseQuery property withFields for use with projections was created.
AtlasDatabaseQuery property timeoutMS for limiting the duration of a single command operation was created.

Changed in version 0.11.0:

NPM package mongodb was upgraded from 6.2 to 7.1 with a NodeJS 20.19 requirement.

Added in version 0.10.2:

AtlasDatabaseQuery property distinct for using a specified field across a single collection was created.
AtlasDatabaseQuery property driverInfo for driver information (name/version/platform) was created.

Added in version 0.8.1:

MongoDB authentication mechanisms were implemented:
MONGODB-X509
MONGODB-AWS
PLAIN