ドキュメント

Overview

The Scala driver includes two Scala-specific representations for BSON documents. Following the convention from the Scala collections library, there are immutable and mutable implementations of the Document type. The underlying implementations of Document use the type-safe BsonDocument class. The BSON classes are available from the org.mongodb.scala.bson namespace, which includes type aliases and companion objects. These objects should suffice for many use cases, but for advanced use cases you may need to use classes from the org.bson namespace directly.

BsonValue は、 org.bsonライブラリからの BSON 型の型セーフな表現であり、特定の値の型を表します。 最も一般的に使用される値の型は次のとおりです。

これらのマッピングを変更または拡張することができます。そのプロセスについて、次のセクションで説明します。

次のセクションでは、2 つの主要なDocumentクラスについて説明します。

不変のドキュメント

Scala コレクション ライブラリと同様に、不変クラス が優先クラスです。 便宜上、 org.mongodb.scala.Documentとorg.mongodb.scala.bson.Documentのエイリアスになるだけでなく、 org.mongodb.scala.bson.collection.immutable.Documentから利用することもできます。

この型のインスタンスは、すべてのユーザーに対して不変であることが保証されます。 このようなコレクションは、作成された後は変更されません。 したがって、時間の異なる点で同じコレクション値に繰り返しアクセスすると、常に同じ要素を含むコレクションが生成されるという結果に依存できます。

import org.mongodb.scala.bson._
val doc1 = Document("AL" -> BsonString("Alabama"))
val doc2 = doc1 + ("AK" -> BsonString("Alaska"))
val doc3 = doc2 ++ Document("AR" -> BsonString("Arkansas"), "AZ" -> BsonString("Arizona"))

可変ドキュメント

可変のDocument型を取得するには、 org.mongodb.scala.collections.mutable.Documentから明示的にインポートする必要があります。 ミューテーション可能なDocumentは、その場で更新または拡張できます。 つまり、 Documentの要素を変更、追加、削除することができるようになります。 Scala コレクションと同様に、可変型を処理する場合は、どのコードがどのコレクションをいつ変更するかを理解する必要があります。

import org.mongodb.scala.bson._
import org.mongodb.scala.bson.collection.mutable.Document
val doc = Document("AL" -> BsonString("Alabama"))
val doc1 = doc + ("AK" -> BsonString("Alaska"))   // doc not mutated but new doc created
doc1 ++= Document("AR" -> BsonString("Arkansas"),
                  "AZ" -> BsonString("Arizona"))  // doc1 mutated as ++= changes in place.

暗黙的な変換

BsonValue型の多くには、Scala 型からの明確な直接マッピングがあります。 たとえば、 StringはBsonStringにマップされ、 IntはBsonInt32にマップされ、 LongはBsonInt64にマップされます。 便宜上、これらの型はDocument型で直接使用でき、 BsonMagnetsオブジェクトの契約方式によって変換されます。 特定の型のスコープに暗黙的なBsonTransformerがある限り、その型はBsonValueに変換できます。

次のBsonTransformersはデフォルトでスコープ内にあります。

import org.mongodb.scala.Document
val doc1 = Document("AL" -> "Alabama")
val doc2 = doc1 + ("AK" -> "Alaska")
val doc3 = doc2 ++ Document("AR" -> "Arkansas", "population" -> 2.966)

This is achieved by making use of the Magnet Pattern, which you can learn more about in the Magnet Pattern blog post on spray.io.

API では、 BsonValue 、（ String 、 BsonValue ）、 Iterable[(String, BsonValue)]など、単一の値またはキーと値のペアまたは複数のキーと値のペアを通常期待する API では、次の値になるものはすべて必要です。正しい型に準拠するために必要な暗黙的な変換を処理するCanBeX経由の 型。 これらの特性は、 CanBeBsonValue 、 CanBeBsonElement 、 CanBeBsonElementsです。

たとえば、 Documentまたは値のリストにキーと値のペアを追加する方法は次のとおりです。

val doc1 = Document("AL" -> "Alabama")
val doc2 = Document("codes" -> List("AL", "AK", "AR"))

collection.find(Document("x" -> 1))
collection.find(Filters.eq("x", 1))