mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/AggregateIterable/comment

comment

fun comment(comment: String?): AggregateIterable<T>

Sets the comment for this operation. A null value means no comment is set.

Return

this

Parameters

comment

the comment

fun comment(comment: BsonValue?): AggregateIterable<T>

Sets the comment for this operation. A null value means no comment is set.

The comment can be any valid BSON type for server versions 4.4 and above. Server versions between 3.6 and 4.2 only support string as comment, and providing a non-string type will result in a server-side error.