net.fehmicansaglam.tepkin.protocol.command

Delete

Related Doc: package command

case class Delete(databaseName: String, collectionName: String, deletes: Seq[DeleteElement], ordered: Option[Boolean] = None, writeConcern: Option[BsonDocument] = None) extends Command with Product with Serializable

The delete command removes documents from a collection. A single delete command can contain multiple delete specifications. The command cannot operate on capped collections.

collectionName

The name of the target collection.

deletes

An array of one or more delete statements to perform in the named collection.

ordered

Optional. If true, then when a delete statement fails, return without performing the remaining delete statements. If false, then when a delete statement fails, continue with the remaining delete statements, if any. Defaults to true.

writeConcern

Optional. A document expressing the write concern of the delete command. Omit to use the default write concern.

Linear Supertypes
Serializable, Serializable, Product, Equals, Command, Message, Writable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Delete
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Command
  7. Message
  8. Writable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Delete(databaseName: String, collectionName: String, deletes: Seq[DeleteElement], ordered: Option[Boolean] = None, writeConcern: Option[BsonDocument] = None)

    collectionName

    The name of the target collection.

    deletes

    An array of one or more delete statements to perform in the named collection.

    ordered

    Optional. If true, then when a delete statement fails, return without performing the remaining delete statements. If false, then when a delete statement fails, continue with the remaining delete statements, if any. Defaults to true.

    writeConcern

    Optional. A document expressing the write concern of the delete command. Omit to use the default write concern.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. implicit val byteOrder: ByteOrder

    Definition Classes
    Message
  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val collectionName: String

    The name of the target collection.

  8. val command: BsonDocument

    Definition Classes
    DeleteCommand
  9. val databaseName: String

    Definition Classes
    DeleteCommand
  10. val deletes: Seq[DeleteElement]

    An array of one or more delete statements to perform in the named collection.

  11. def encode: ByteString

    Definition Classes
    Message → Writable
  12. def encodeBody: ByteString

    Definition Classes
    CommandMessage
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. val opCode: Int

    Definition Classes
    CommandMessage
  21. val ordered: Option[Boolean]

    Optional.

    Optional. If true, then when a delete statement fails, return without performing the remaining delete statements. If false, then when a delete statement fails, continue with the remaining delete statements, if any. Defaults to true.

  22. def putCString(builder: ByteStringBuilder, value: String): ByteStringBuilder

    Definition Classes
    Writable
  23. val requestID: Int

    Definition Classes
    Message
  24. val responseTo: Int

    Definition Classes
    CommandMessage
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. val writeConcern: Option[BsonDocument]

    Optional.

    Optional. A document expressing the write concern of the delete command. Omit to use the default write concern.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from Message

Inherited from Writable

Inherited from AnyRef

Inherited from Any

Ungrouped