データベースとコレクション

Overview

このガイドでは、MongoDB Kotlin ドライバーで MongoDB の データベース と コレクション を使用する方法を学習できます。

MongoDB では、データは次のレベルの階層に整理されています。

1. データベース: データベースは、MongoDB インスタンスの最上位のデータ組織です。

2. コレクション: データベースは、ドキュメントを含むコレクションに整理されています。

3. ドキュメント: ドキュメントには、文字列、数値、日付などのリテラル データと、その他の埋め込みドキュメントが含まれます。 ドキュメント フィールドのタイプと構造の詳細については、 ドキュメント に関するサーバー ドキュメントを参照してください。

MongoDB Kotlinドライバーを使用すると、 Kotlinデータ クラス を使用するか、 Documentクラスを使用してMongoDBからデータを保存および検索することで、データをモデル化できます。

データ クラスの使用の詳細については、 データクラス データ形式のガイドをご覧ください。 Documentクラスの使用の詳細については、ドキュメント データ形式 のガイドを参照してください。

データベースへのアクセス

MongoDBインスタンス内の MongoDatabase にアクセスするには、MongoClientインスタンスの getDatabase() メソッドを使用します。

次の例えではtestDatabaseという名前のデータベースにアクセスします。

val database = client.getDatabase("testDatabase")

コレクションにアクセスする

MongoDatabaseインスタンスの getCollection() メソッドを使用して、接続済みのMongoDBインスタンスのデータベース内の MongoCollection にアクセスします。

次の例では、タイプ のドキュメントを含むtestCollection からMongoDatabase ExampleDataClassという名前のコレクションにアクセスします。

data class ExampleDataClass(
    @BsonId val id: ObjectId = ObjectId(),
    val exampleProperty: String,
)

val collection = database.getCollection<ExampleDataClass>("testCollection")

data class Fruit(
    @BsonId val id: Int,
    val name: String,
    val qty: Int,
    val seasons: List<String>
)

val collection =
    database.getCollection<Fruit>("fruits")
// Define a data class for returned documents
data class NewFruit(
    @BsonId val id: Int,
    val name: String,
    val quantity: Int,
    val seasons: List<String>
)
val filter = Filters.eq(Fruit::name.name, "strawberry")
val update = Updates.combine(
    Updates.rename(Fruit::qty.name, "quantity"),
    Updates.push(Fruit::seasons.name, "fall"),
)
val options = FindOneAndUpdateOptions()
    .returnDocument(ReturnDocument.AFTER)
// Specify the class for returned documents as the type parameter in withDocumentClass()
val result = collection
    .withDocumentClass<NewFruit>()
    .findOneAndUpdate(filter, update, options)
println(result)

NewFruit(id=1, name=strawberry, quantity=205, seasons=[summer, fall])

コレクションを作成する

MongoDatabaseインスタンスの createCollection() メソッドを使用して、接続されたMongoDBインスタンスのデータベースにコレクションを作成します。

次の例では、 exampleCollectionというコレクションを作成しています。

database.createCollection("exampleCollection")

CreateCollectionOptionsクラスを使用して、最大サイズやドキュメント検証ルールなどのコレクションオプションを指定できます。createCollection() メソッドは、CreateCollectionOptions のインスタンスを任意の 2 つ目のパラメータとして受け入れます。

val collOptions: ValidationOptions = ValidationOptions().validator(
    Filters.or(
        Filters.exists("title"),
        Filters.exists("name")
    )
)
database.createCollection(
    "movies",
    CreateCollectionOptions().validationOptions(collOptions)
)

コレクションの一覧を取得する

MongoDatabase.listCollectionNames() メソッドを使用して、データベース内のコレクションのリストをクエリできますメソッド:

val collectionList = database.listCollectionNames().toList()
println(collectionList)

[movies, exampleCollection]

コレクションの削除

MongoCollection.drop() メソッドを使用して、データベースからコレクションを削除できます。メソッド:

val collection =
    database.getCollection<ExampleDataClass>("movies")
collection.drop()

データベースの削除

次の例に示すように、 MongoDatabase.drop() メソッドを使用して、 MongoDBデプロイからデータベースを削除できます。

val database = mongoClient.getDatabase("testDatabase")
database.drop()

読み込み設定（read preference）、読み取り保証（read concern）、書込み保証（write concern）の指定

読み込み設定（read preference ） 、 読み取り保証（ read concern ） 、 書込み保証（ write concern ） は、MongoDB レプリカセットに接続するときに、ドライバーが読み取り操作をルーティングして読み取りおよび書込み操作の確認を待つ方法を制御します。 読み込み設定（read preference）と読み取り保証（read concern）はすべての読み取り操作に適用されます。書込み保証 (write concern) はすべての書込み (write) 操作に適用されます。

MongoDatabase インスタンスは、書込み保証（write concern）、読み取り保証（read concern）、書込み設定（write preference）の設定を、作成に使用されるMongoClientから継承します。 MongoCollectionインスタンスは、書込み保証（write concern）、読み取り保証（read concern）、書込み設定（write preference）の設定を、作成に使用されるMongoDatabaseから継承します。 ただし、次のメソッドを使用して、通常継承する設定とは異なる読み込み設定（read preference）、読み取り保証（read concern）、または書込み保証（write concern）を持つMongoDatabaseまたはMongoCollectionのインスタンスを取得できます。

• MongoDatabase.withReadConcern()

• MongoDatabase.withReadPreference()

• MongoDatabase.withWriteConcern()

• MongoCollection.withReadConcern()

• MongoCollection.withReadPreference()

• MongoCollection.withWriteConcern()

これらのトピックの詳細については、サーバー マニュアルの次のページを参照してください。

• 読み込み設定 (read preference)

• 読み取り保証（read concern）

• 書込み保証 (write concern)