Packages

package collection

Type Members

  1. class AsyncCollectionManager extends AnyRef
  2. class CollectionManager extends AnyRef
  3. case class CollectionSpec(name: String, scopeName: String, expiry: Option[Duration] = None, history: Option[Boolean] = None) extends Product with Serializable

    Represents a collection.

    Represents a collection.

    name

    the name of the collection.

    scopeName

    the name of the scope the collection is on.

    expiry

    any configured TTL for newly created documents on this collection. Older server versions will not have this setting, in which case it will be None.

    history

    whether history retention is enabled on this collection. Older server versions will not have this setting, in which case it will be None.

  4. case class CreateCollectionSettings(maxExpiry: Option[Duration] = None, history: Option[Boolean] = None) extends Product with Serializable

    Used when creating a new collection.

    Used when creating a new collection.

    maxExpiry

    is the time for the TTL for new documents in the collection. It defaults to no expiry.

    history

    is whether history retention override is enabled on this collection. If not set it will default to the bucket-level setting.

  5. class ReactiveCollectionManager extends AnyRef
  6. case class ScopeSpec(name: String, collections: Seq[CollectionSpec] = Seq()) extends Product with Serializable
  7. case class UpdateCollectionSettings(maxExpiry: Option[Duration] = None, history: Option[Boolean] = None) extends Product with Serializable

    Used when updating a new collection.

    Used when updating a new collection.

    maxExpiry

    is the time for the TTL for new documents in the collection. It defaults to no expiry.

    history

    is whether history retention override is enabled on this collection. If not set it will default to the bucket-level setting.

Ungrouped