final case class AggregateQueryBuilder[F[_], T] extends QueryBuilder[AggregatePublisher, T] with Product with Serializable
- Alphabetic
- By Inheritance
- AggregateQueryBuilder
- Serializable
- Product
- Equals
- QueryBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def all: F[Iterable[T]]
- def allowDiskUse(allowDiskUse: Boolean): AggregateQueryBuilder[F, T]
Enables writing to temporary files.
Enables writing to temporary files. A null value indicates that it's unspecified.
- allowDiskUse
true if writing to temporary files is enabled
- returns
AggregateQueryBuilder
- def applyCommands(): AggregatePublisher[T]
- Attributes
- protected
- Definition Classes
- QueryBuilder
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def batchSize(batchSize: Int): AggregateQueryBuilder[F, T]
Sets the number of documents to return per batch.
Sets the number of documents to return per batch.
Overrides the Subscription#request value for setting the batch size, allowing for fine grained control over the underlying cursor.
- batchSize
the batch size
- returns
AggregateQueryBuilder
- Since
1.8
- def boundedStream(capacity: Int): Stream[F, T]
- def bypassDocumentValidation(bypassDocumentValidation: Boolean): AggregateQueryBuilder[F, T]
Sets the bypass document level validation flag.
Sets the bypass document level validation flag.
Note: This only applies when an $out stage is specified.
- bypassDocumentValidation
If true, allows the write to opt-out of document level validation.
- returns
AggregateQueryBuilder
- Since
1.2
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException])
- def collation(collation: Collation): AggregateQueryBuilder[F, T]
Sets the collation options
Sets the collation options
A null value represents the server default.
- collation
the collation options to use
- returns
AggregateQueryBuilder
- Since
1.3
- val commands: List[AggregateCommand[T]]
- Attributes
- protected
- Definition Classes
- AggregateQueryBuilder → QueryBuilder
- def comment(comment: String): AggregateQueryBuilder[F, T]
Sets the comment to the aggregation.
Sets the comment to the aggregation.
- comment
the comment
- returns
AggregateQueryBuilder
- Since
1.7
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def explain(verbosity: ExplainVerbosity): F[Document]
Explain the execution plan for this operation with the given verbosity level
Explain the execution plan for this operation with the given verbosity level
- verbosity
the verbosity of the explanation
- returns
the execution plan
- Since
4.2
- def explain: F[Document]
Explain the execution plan for this operation with the server's default verbosity level
Explain the execution plan for this operation with the server's default verbosity level
- returns
the execution plan
- Since
4.2
- def first: F[Option[T]]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hint(index: Index): AggregateQueryBuilder[F, T]
- def hint(hint: Bson): AggregateQueryBuilder[F, T]
Sets the hint for which index to use.
Sets the hint for which index to use.
- hint
the hint
- returns
AggregateQueryBuilder
- Since
1.7
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def let(variables: Bson): AggregateQueryBuilder[F, T]
Add top-level variables to the aggregation.
Add top-level variables to the aggregation.
For MongoDB 5.0+, the aggregate command accepts a
letoption. This option is a document consisting of zero or more fields representing variables that are accessible to the aggregation pipeline. The key is the name of the variable and the value is a constant in the aggregate expression language. Each parameter name is then usable to access the value of the corresponding expression with the "$$" syntax within aggregate expression contexts which may require the use of $expr or a pipeline.- variables
the variables
- returns
AggregateQueryBuilder
- Since
4.3
- def maxAwaitTime(duration: Duration): AggregateQueryBuilder[F, T]
The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.
The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.
A zero value will be ignored.
- duration
the max await time
- returns
the maximum await execution time in the given time unit
- Since
1.6
- def maxTime(duration: Duration): AggregateQueryBuilder[F, T]
Sets the maximum execution time on the server for this operation.
Sets the maximum execution time on the server for this operation.
- duration
the max time
- returns
AggregateQueryBuilder
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val observable: AggregatePublisher[T]
- Attributes
- protected
- Definition Classes
- AggregateQueryBuilder → QueryBuilder
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def stream: Stream[F, T]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toCollection: F[Unit]
Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.
Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.
- returns
a unit, that indicates when the operation has completed
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated