comment property

String? comment
final

A user-provided comment to attach to this command. Once set, this comment appears alongside records of this command in the following locations:

  • mongod log messages, in the attr.command.cursor.comment field.
  • Database profiler output, in the command.comment field.
  • currentOp output, in the command.comment field. A comment can be only of type String unlike MongoDb that allows any valid BSON type since 4.4. Note Any comment set on a find command is inherited by any subsequent getMore commands run on the find cursor.

Implementation

final String? comment;