パッケージ org.springframework.data.mongodb

インターフェース MongoDatabaseFactory

すべてのスーパーインターフェース:
CodecRegistryProvider, MongoSessionProvider
すべての既知の実装クラス:
MongoDatabaseFactorySupport, SimpleMongoClientDatabaseFactory
public interface MongoDatabaseFactory extends CodecRegistryProvider, MongoSessionProvider
MongoDatabase インスタンスを作成するファクトリのインターフェース。
導入:
3.0
作成者:
Mark Pollack, Thomas Darimont, Christoph Strobl

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default org.bson.codecs.configuration.CodecRegistry
    getCodecRegistry()
    MongoDB Java ドライバーによって使用される基盤となる CodecRegistry を取得します。
    PersistenceExceptionTranslator
    getExceptionTranslator()
    共有 MongoExceptionTranslator を公開します。
    com.mongodb.client.MongoDatabase
    getMongoDatabase()
    基礎となるファクトリから MongoDatabase を取得します。
    com.mongodb.client.MongoDatabase
    getMongoDatabase(StringSE dbName)
    指定された名前のデータベースにアクセスするには、MongoDatabase インスタンスを取得します。
    com.mongodb.client.ClientSession
    getSession(com.mongodb.ClientSessionOptions options)
    指定された ClientSessionOptions の ClientSession を取得します。
    default boolean
    isTransactionActive()
    指定された MongoDatabaseFactory が active transaction を持つ ClientSession にバインドされているかどうかを返します。
    MongoDatabaseFactory
    withSession(com.mongodb.client.ClientSession session)
    指定されたセッションを認識してバインドされている MongoDatabase インスタンスを返す、MongoDatabaseFactory の ClientSession バインドインスタンスを取得します。
    default MongoDatabaseFactory
    withSession(com.mongodb.ClientSessionOptions options)
    MongoDatabaseFactory の ClientSession バインドされたインスタンスを取得し、指定された options で新しいセッションを認識してバインドされている MongoDatabase インスタンスを返します。

    インターフェース org.springframework.data.mongodb.CodecRegistryProvider から継承されたメソッド

    getCodecFor, hasCodecFor

  • メソッドの詳細

    • getMongoDatabase

      com.mongodb.client.MongoDatabase getMongoDatabase() throws DataAccessException
      基礎となるファクトリから MongoDatabase を取得します。
      戻り値:
      決して null にはなりません。
      例外:
      DataAccessException

    • getMongoDatabase

      com.mongodb.client.MongoDatabase getMongoDatabase(StringSE dbName) throws DataAccessException
      指定された名前のデータベースにアクセスするには、MongoDatabase インスタンスを取得します。
      パラメーター:
      dbName - null であってはなりません。
      戻り値:
      決して null にはなりません。
      例外:
      DataAccessException

    • getExceptionTranslator

      PersistenceExceptionTranslator getExceptionTranslator()
      共有 MongoExceptionTranslator を公開します。
      戻り値:
      null になることはありません。

    • getCodecRegistry

      default org.bson.codecs.configuration.CodecRegistry getCodecRegistry()
      MongoDB Java ドライバーによって使用される基盤となる CodecRegistry を取得します。
      次で指定:
      インターフェース CodecRegistryProvider の getCodecRegistry 
      戻り値:
      決して null にはなりません。

    • getSession

      com.mongodb.client.ClientSession getSession(com.mongodb.ClientSessionOptions options)
      指定された ClientSessionOptions の ClientSession を取得します。
      次で指定:
      インターフェース MongoSessionProvider の getSession 
      パラメーター:
      options - null であってはなりません。
      戻り値:
      決して null にはなりません。
      導入:
      2.1

    • withSession

      default MongoDatabaseFactory withSession(com.mongodb.ClientSessionOptions options)
      MongoDatabaseFactory の ClientSession バインドされたインスタンスを取得し、指定された options で新しいセッションを認識してバインドされている MongoDatabase インスタンスを返します。
      パラメーター:
      options - null であってはなりません。
      戻り値:
      決して null にはなりません。
      導入:
      2.1

    • withSession

      MongoDatabaseFactory withSession(com.mongodb.client.ClientSession session)
      指定されたセッションを認識してバインドされている MongoDatabase インスタンスを返す、MongoDatabaseFactory の ClientSession バインドインスタンスを取得します。
      パラメーター:
      session - null であってはなりません。
      戻り値:
      決して null にはなりません。
      導入:
      2.1

    • isTransactionActive

      default boolean isTransactionActive()
      指定された MongoDatabaseFactory が active transaction を持つ ClientSession にバインドされているかどうかを返します。
      戻り値:
      アクティブなトランザクションがある場合は true、それ以外の場合は false です。
      導入:
      2.1.3