bulkwriteoptions

Author: joyjwang

mongo/options/bulkwriteoptions.go

@@ -11,25 +11,13 @@ var DefaultOrdered = true
 
 // BulkWriteOptions represents arguments that can be used to configure a
 // BulkWrite operation.
+//
+// See corresponding setter methods for documentation.
 type BulkWriteOptions struct {
-	// If true, writes executed as part of the operation will opt out of document-level validation on the server. This
-	// option is valid for MongoDB versions >= 3.2 and is ignored for previous server versions. The default value is
-	// false. See https://www.mongodb.com/docs/manual/core/schema-validation/ for more information about document
-	// validation.
 	BypassDocumentValidation *bool
-
-	// A string or document that will be included in server logs, profiling logs, and currentOp queries to help trace
-	// the operation.  The default value is nil, which means that no comment will be included in the logs.
-	Comment interface{}
-
-	// If true, no writes will be executed after one fails. The default value is true.
-	Ordered *bool
-
-	// Specifies parameters for all update and delete commands in the BulkWrite. This option is only valid for MongoDB
-	// versions >= 5.0. Older servers will report an error for using this option. This must be a document mapping
-	// parameter names to values. Values must be constant or closed expressions that do not reference document fields.
-	// Parameters can then be accessed as variables in an aggregate expression context (e.g. "$$var").
-	Let interface{}
+	Comment                  interface{}
+	Ordered                  *bool
+	Let                      interface{}
 }
 
 // BulkWriteOptionsBuilder contains options to configure bulk write operations.
@@ -52,7 +40,9 @@ func (b *BulkWriteOptionsBuilder) List() []func(*BulkWriteOptions) error {
 	return b.Opts
 }
 
-// SetComment sets the value for the Comment field.
+// SetComment sets the value for the Comment field. Specifies a string or document that will be included in
+// server logs, profiling logs, and currentOp queries to help tracethe operation.  The default value is nil,
+// which means that no comment will be included in the logs.
 func (b *BulkWriteOptionsBuilder) SetComment(comment interface{}) *BulkWriteOptionsBuilder {
 	b.Opts = append(b.Opts, func(opts *BulkWriteOptions) error {
 		opts.Comment = comment
@@ -63,7 +53,8 @@ func (b *BulkWriteOptionsBuilder) SetComment(comment interface{}) *BulkWriteOpti
 	return b
 }
 
-// SetOrdered sets the value for the Ordered field.
+// SetOrdered sets the value for the Ordered field. If true, no writes will be executed after one fails.
+// The default value is true.
 func (b *BulkWriteOptionsBuilder) SetOrdered(ordered bool) *BulkWriteOptionsBuilder {
 	b.Opts = append(b.Opts, func(opts *BulkWriteOptions) error {
 		opts.Ordered = &ordered
@@ -74,7 +65,11 @@ func (b *BulkWriteOptionsBuilder) SetOrdered(ordered bool) *BulkWriteOptionsBuil
 	return b
 }
 
-// SetBypassDocumentValidation sets the value for the BypassDocumentValidation field.
+// SetBypassDocumentValidation sets the value for the BypassDocumentValidation field. If true, writes
+// executed as part of the operation will opt out of document-level validation on the server. This option
+// is valid for MongoDB versions >= 3.2 and is ignored for previous server versions. The default value is
+// false. See https://www.mongodb.com/docs/manual/core/schema-validation/ for more information about document
+// validation.
 func (b *BulkWriteOptionsBuilder) SetBypassDocumentValidation(bypass bool) *BulkWriteOptionsBuilder {
 	b.Opts = append(b.Opts, func(opts *BulkWriteOptions) error {
 		opts.BypassDocumentValidation = &bypass