Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
Database Commands
/
Replication

appendOplogNote

On this page

  • Definition
  • Compatibility
  • Syntax
  • Example

Definition

appendOplogNote

Writes a non-operational entry to the oplog.

Compatibility

This command is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Important

This command is not supported in M0, M2, and M5 clusters. For more information, see Unsupported Commands.

Syntax

You can only run the appendOplogNote command on the admin database.

The command has this syntax:

db.adminCommand(
   {
      appendOplogNote: 1,
      data: <document>
   }
)

Command Fields

Field
Type
Description
appendOplogNote
any
Set to any value.
data
document
The document to append to the oplog.

Example

To append a non-operational entry to the oplog, use the db.adminCommand() method:

db.adminCommand(
   {
      appendOplogNote: 1,
      data: {
         msg: "Appending test message to oplog"
      }
   }
)

Example oplog entry:

{
   op: "n",
   ns: "",
   o: {
      msg: "Appending test message to oplog"
   },
   ts: Timestamp({ t: 1689177321, i: 1 }),
   t: Long("1"),
   v: Long("2"),
   wall: ISODate("2023-07-12T15:55:21.180Z")
}

Back

Replication