A BSONDocument
structure (BSON type 0x03
).
A BSONDocument
is an unordered set of fields (String, BSONValue)
.
'''Note:''' The insertion/initial order of the fields may not be maintained through the operations.
Attributes
- Companion:
- object
- Graph
- Supertypes
- Known subtypes
- class BSONStrictDocument
- Self type
Members list
Value members
Abstract methods
The document fields as a sequence of BSONElements.
The first/mandatory element, if any.
The first/mandatory element, if any.
import reactivemongo.api.bson.BSONDocument
BSONDocument("foo" -> 1).
headOption // Some(BSONInteger(1))
Attributes
Concrete methods
Returns the BSONDocument containing all the elements of this one and the elements of the given document.
Returns the BSONDocument containing all the elements of this one and the elements of the given document.
import reactivemongo.api.bson.BSONDocument
val doc1 = BSONDocument("foo" -> 1)
val doc2 = BSONDocument("bar" -> "lorem")
doc1 ++ doc2 // { 'foo': 1, 'bar': 'lorem' }
Attributes
Creates a new BSONDocument containing all the elements of this one and the specified element sequence.
Creates a new BSONDocument containing all the elements of this one and the specified element sequence.
import reactivemongo.api.bson.{
BSONDocument, BSONElement, BSONString
}
val doc = BSONDocument("foo" -> 1)
doc ++ BSONElement("bar", BSONString("lorem"))
// { 'foo': 1, 'bar': 'lorem' }
Attributes
Returns a set without the values corresponding to the specified keys.
Returns a set without the values corresponding to the specified keys.
import reactivemongo.api.bson.BSONDocument
val doc = BSONDocument("foo" -> 1, "bar" -> "v")
doc -- "bar" // { 'foo': 1 }
Attributes
Checks whether the given key is found in this element set.
Checks whether the given key is found in this element set.
import reactivemongo.api.bson.BSONDocument
val doc = BSONDocument("foo" -> 1)
doc.contains("foo") // true
doc.contains("bar") // false
Attributes
- key
the key to be found in the document
- Returns:
true if the key is found
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Compares the receiver object (this
) with the argument object (that
) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
x
of typeAny
,x.equals(x)
should returntrue
. - It is symmetric: for any instances
x
andy
of typeAny
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any instances
x
,y
, andz
of typeAny
ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is usually necessary to override hashCode
to ensure that
objects which are "equal" (o1.equals(o2)
returns true
) hash to the same scala.Int.
(o1.hashCode.equals(o2.hashCode)
).
Attributes
- that
the object to compare against this object for equality.
- Returns:
true
if the receiver object is equivalent to the argument;false
otherwise.- Definition Classes
- Any
Returns the BSONValue associated with the given key
.
If the key cannot be found, returns None
.
Returns the BSONValue associated with the given key
.
If the key cannot be found, returns None
.
import reactivemongo.api.bson.BSONDocument
val doc = BSONDocument("foo" -> 1)
doc.get("foo") // Some(BSONInteger(1))
doc.contains("bar") // None
Attributes
- key
the key to be found in the document
Returns the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
Returns the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
If there is no matching value (or value is a BSONNull),
or the value could not be deserialized, or converted, returns a None
.
import reactivemongo.api.bson.{ BSONDocument, BSONNull }
val doc = BSONDocument("foo" -> 1, "bar" -> BSONNull)
doc.getAsOpt[Int]("foo") // Some(1)
doc.getAsOpt[String]("foo") // None, as not a string
doc.getAsOpt[Int]("lorem") // None, no 'lorem' key
doc.getAsOpt[Int]("bar") // None, as `BSONNull`
Attributes
- key
the key to be found in the document
- Note:
When implementing a custom reader, getAsTry must be preferred.
Gets the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
Gets the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
If there is no matching value, or the value could not be deserialized,
or converted, returns a Failure
.
The Failure
may hold a exceptions.BSONValueNotFoundException,
if the key could not be found.
import reactivemongo.api.bson.{ BSONDocument, BSONNull }
val doc = BSONDocument("foo" -> 1, "bar" -> BSONNull)
doc.getAsTry[Int]("foo") // Success(1)
doc.getAsTry[String]("foo") // Failure(..), as not a string
doc.getAsTry[Int]("lorem")
// Failure(BSONValueNotFoundException), no 'lorem' key
doc.getAsTry[Int]("bar")
// Failure(BSONValueNotFoundException), as `BSONNull`
Attributes
- key
the key to be found in the document
Gets the BSONValue at the given key
,
and converts it with the given implicit BSONReader.
Gets the BSONValue at the given key
,
and converts it with the given implicit BSONReader.
If there is no matching value, Success(None)
is returned.
If there is a value, it must be valid or a Failure
is returned.
import reactivemongo.api.bson.{ BSONDocument, BSONNull }
val doc = BSONDocument("foo" -> 1, "bar" -> BSONNull)
doc.getAsUnflattenedTry[Int]("foo") // Success(Some(1))
doc.getAsUnflattenedTry[String]("foo") // Failure(..), as not a string
doc.getAsUnflattenedTry[Int]("lorem")
// Success(None), no 'lorem' key
doc.getAsUnflattenedTry[Int]("bar")
// Success(None), as `BSONNull`
Attributes
- key
the key to be found in the document
Returns the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
Returns the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
If there is no matching value (or value is a BSONNull),
or the value could not be deserialized, or converted,
returns the default
value.
import reactivemongo.api.bson.{ BSONDocument, BSONNull }
val doc = BSONDocument("foo" -> 1, "bar" -> BSONNull)
doc.getOrElse[Int]("foo", -1) // 1
doc.getOrElse[String]("foo", "default") // 'default', as not a string
doc.getOrElse[Int]("lorem", -1) // -1, no 'lorem' key
doc.getOrElse[Int]("bar", -1) // -1, as `BSONNull`
Attributes
- key
the key to be found in the document
- Note:
When implementing a custom reader, getAsTry must be preferred.
Gets the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
Gets the BSONValue associated with the given key
,
and converts it with the given implicit BSONReader.
If there is no matching value, or the value could not be deserialized,
or converted, returns a Failure
.
The Failure
may hold a exceptions.BSONValueNotFoundException,
if the key could not be found.
Contrary to getAsTry (which must generally be preferred),
if the value is BSONNull it passed to the given reader
(not skipped).
Attributes
- key
the key to be found in the document
Calculate a hash code value for the object.
Calculate a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)
) yet
not be equal (o1.equals(o2)
returns false
). A degenerate implementation could always return 0
.
However, it is required that if two objects are equal (o1.equals(o2)
returns true
) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)
). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals
method.
Attributes
- Returns:
the hash code value for this object.
- Definition Classes
- Any
Returns the Map
representation for this document.
Returns the Map
representation for this document.
import reactivemongo.api.bson.BSONDocument
BSONDocument("foo" -> 1).toMap
// => Map("foo" -> BSONInteger(1))
Attributes
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns:
a string representation of the object.
- Definition Classes
- Any
Inherited methods
Creates a new BSONDocument containing all the elements of this one and the specified element producers.
Creates a new BSONDocument containing all the elements of this one and the specified element producers.
import reactivemongo.api.bson.BSONDocument
val doc = BSONDocument("foo" -> 1)
doc ++ ("bar" -> "lorem") // { 'foo': 1, 'bar': 'lorem' }
Attributes
- Inherited from:
- BSONDocumentLowPriority (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is an array field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is an array field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
Optionally parses this value as a T
one.
Optionally parses this value as a T
one.
Attributes
- Returns:
Some
successfully parsed value, orNone
if failsimport reactivemongo.api.bson.BSONValue def foo(v: BSONValue): Option[String] = v.asOpt[String]
- Inherited from:
- BSONValue
'''EXPERIMENTAL:''' Returns a strict representation (with only the last value kept per each field name).
'''EXPERIMENTAL:''' Returns a strict representation (with only the last value kept per each field name).
reactivemongo.api.bson.BSONDocument(
"foo" -> 1, "bar" -> 2, "foo" -> 3).asStrict
// { 'foo': 3, 'bar': 2 }
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
Tries to parse this value as a T
one.
Tries to parse this value as a T
one.
import scala.util.Try
import reactivemongo.api.bson.BSONValue
def foo(v: BSONValue): Try[String] = v.asTry[String]
Attributes
- Inherited from:
- BSONValue
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a binary field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a binary field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a boolean-like field (numeric or boolean).
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a boolean-like field (numeric or boolean).
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a nested document.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a nested document.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a list of nested documents.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a list of nested documents.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a double field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a double field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a integer field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a integer field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a long field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a long field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a string field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a string field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a binary/uuid field.
'''EXPERIMENTAL:''' Returns the named element from the current document, if the element is a binary/uuid field.
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)
Attributes
- Inherited from:
- BSONDocumentExperimental (hidden)