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

Overview

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

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

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

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

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

MongoDB Kotlin ドライバーでは、 Kotlin データ クラス を使用するか、 ドキュメント を使用してデータをモデル化できます MongoDB からデータを保存および検索するためのクラス。

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

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

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

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

val database = client.getDatabase("testDatabase")

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

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

次の例では、タイプ のドキュメントを含む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])

コレクションを作成する

createCollection() メソッド を使用するMongoDatabase インスタンスのメソッドを使用して、接続された 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()

読み込み設定（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)