クラス ResourceKeyspacePopulator

java.lang.ObjectSE
org.springframework.data.cassandra.core.cql.session.init.ResourceKeyspacePopulator
実装されたすべてのインターフェース:
KeyspacePopulator

public class ResourceKeyspacePopulator extends ObjectSE implements KeyspacePopulator
外部リソースで定義された CQL スクリプトを使用して、キースペースを設定、初期化、クリーンアップします。
導入:
3.0
作成者:
Mark Paluch
関連事項:
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    デフォルト設定で新しい ResourceKeyspacePopulator を構築します。
    ResourceKeyspacePopulator(boolean continueOnError, boolean ignoreFailedDrops, StringSE cqlScriptEncoding, Resource... scripts)
    指定された値を使用して新しい ResourceKeyspacePopulator を構築します。
    提供されたスクリプトのデフォルト設定を使用して新しい ResourceKeyspacePopulator を構築します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    データベースを初期化またはクリーンアップするために実行するスクリプトを追加します。
    void
    addScripts(Resource... scripts)
    データベースを初期化またはクリーンアップするために実行する複数のスクリプトを追加します。
    void
    execute(SessionFactory sessionFactory)
    指定された SessionFactory に対してこの ResourceKeyspacePopulator を実行します。
    void
    populate(com.datastax.oss.driver.api.core.CqlSession session)
    提供された CqlSession 接続を使用して、データベースを作成、初期化、クリーンアップします。
    void
    setBlockCommentEndDelimiter(StringSE blockCommentEndDelimiter)
    CQL スクリプト内のブロックコメントを識別する終了区切り文字を設定します。
    void
    setBlockCommentStartDelimiter(StringSE blockCommentStartDelimiter)
    CQL スクリプト内のブロックコメントを識別する開始区切り文字を設定します。
    void
    setCommentPrefix(StringSE commentPrefix)
    CQL スクリプト内の単一行コメントを識別するプレフィックスを設定します。
    void
    setCommentPrefixes(StringSE... commentPrefixes)
    CQL スクリプト内の単一行コメントを識別するプレフィックスを設定します。
    void
    setContinueOnError(boolean continueOnError)
    CQL のすべての失敗をログに記録する必要があるが、失敗の原因にはならないことを示すフラグ。
    void
    setCqlScriptEncoding(StringSE cqlScriptEncoding)
    プラットフォームのエンコーディングと異なる場合は、構成された CQL スクリプトのエンコーディングを指定します。
    void
    setIgnoreFailedDrops(boolean ignoreFailedDrops)
    失敗した CQL DROP ステートメントを無視できることを示すフラグ。
    void
    setScripts(Resource... scripts)
    実行するスクリプトを設定して、データベースを初期化またはクリーンアップし、以前に追加したスクリプトを置き換えます。
    void
    カスタムの場合は、ステートメントの区切り記号を指定します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
  • コンストラクターの詳細

    • ResourceKeyspacePopulator

      public ResourceKeyspacePopulator()
      デフォルト設定で新しい ResourceKeyspacePopulator を構築します。
    • ResourceKeyspacePopulator

      public ResourceKeyspacePopulator(Resource... scripts)
      提供されたスクリプトのデフォルト設定を使用して新しい ResourceKeyspacePopulator を構築します。
      パラメーター:
      scripts - データベースを初期化またはクリーンアップするために実行するスクリプト (非 null)
    • ResourceKeyspacePopulator

      public ResourceKeyspacePopulator(boolean continueOnError, boolean ignoreFailedDrops, @Nullable StringSE cqlScriptEncoding, Resource... scripts)
      指定された値を使用して新しい ResourceKeyspacePopulator を構築します。
      パラメーター:
      continueOnError - CQL のすべての失敗をログに記録する必要があるが、失敗の原因にはならないことを示すフラグ
      ignoreFailedDrops - 失敗した CQL DROP ステートメントを無視できることを示すフラグ
      cqlScriptEncoding - 提供された CQL スクリプトのエンコーディング (プラットフォームのエンコーディングを示すために null または空の場合があります)
      scripts - データベースを初期化またはクリーンアップするために実行するスクリプト (非 null)
  • メソッドの詳細

    • addScript

      public void addScript(Resource script)
      データベースを初期化またはクリーンアップするために実行するスクリプトを追加します。
      パラメーター:
      script - CQL スクリプトへのパス (null にはなりません)。
    • addScripts

      public void addScripts(Resource... scripts)
      データベースを初期化またはクリーンアップするために実行する複数のスクリプトを追加します。
      パラメーター:
      scripts - 実行するスクリプト(null にはなりません)。
    • setScripts

      public void setScripts(Resource... scripts)
      実行するスクリプトを設定して、データベースを初期化またはクリーンアップし、以前に追加したスクリプトを置き換えます。
      パラメーター:
      scripts - 実行するスクリプト(null にはなりません)。
    • setCqlScriptEncoding

      public void setCqlScriptEncoding(@Nullable StringSE cqlScriptEncoding)
      プラットフォームのエンコーディングと異なる場合は、構成された CQL スクリプトのエンコーディングを指定します。
      パラメーター:
      cqlScriptEncoding - スクリプトで使用されるエンコーディング(プラットフォームエンコーディングを示すために null または空の場合があります)。
      関連事項:
    • setSeparator

      public void setSeparator(StringSE separator)
      カスタムの場合は、ステートメントの区切り記号を指定します。

      指定しない場合はデフォルトで ";" になり、最後の手段として "\n" にフォールバックします。ScriptUtils.EOF_STATEMENT_SEPARATOR に設定すると、各スクリプトに区切り文字のない単一のステートメントが含まれることを通知できます。

      パラメーター:
      separator - スクリプトステートメントの区切り文字。
    • setCommentPrefix

      public void setCommentPrefix(StringSE commentPrefix)
      CQL スクリプト内の単一行コメントを識別するプレフィックスを設定します。

      デフォルトは "--" です。

      パラメーター:
      commentPrefix - 単一行コメントのプレフィックス。
      関連事項:
    • setCommentPrefixes

      public void setCommentPrefixes(StringSE... commentPrefixes)
      CQL スクリプト内の単一行コメントを識別するプレフィックスを設定します。

      デフォルトは ["--"] です。

      パラメーター:
      commentPrefixes - 単一行コメントのプレフィックス。
    • setBlockCommentStartDelimiter

      public void setBlockCommentStartDelimiter(StringSE blockCommentStartDelimiter)
      CQL スクリプト内のブロックコメントを識別する開始区切り文字を設定します。

      デフォルトは "/*" です。

      パラメーター:
      blockCommentStartDelimiter - ブロックコメントの開始区切り文字(null または空になることはありません)。
      関連事項:
    • setBlockCommentEndDelimiter

      public void setBlockCommentEndDelimiter(StringSE blockCommentEndDelimiter)
      CQL スクリプト内のブロックコメントを識別する終了区切り文字を設定します。

      デフォルトは "*/" です。

      パラメーター:
      blockCommentEndDelimiter - ブロックコメントの終了区切り文字(null または空にはなりません)。
      関連事項:
    • setContinueOnError

      public void setContinueOnError(boolean continueOnError)
      CQL のすべての失敗をログに記録する必要があるが、失敗の原因にはならないことを示すフラグ。

      デフォルトは false です。

      パラメーター:
      continueOnError - エラーが発生してもスクリプトの実行を続行する場合は true
    • setIgnoreFailedDrops

      public void setIgnoreFailedDrops(boolean ignoreFailedDrops)
      失敗した CQL DROP ステートメントを無視できることを示すフラグ。

      これは、CQL ダイアレクトが DROP ステートメントの IF EXISTS 句をサポートしていない非埋め込みデータベースに役立ちます。

      デフォルトは false であるため、ポピュレーターが誤って実行された場合、スクリプトが DROP ステートメントで始まると、ポピュレーターはすぐに失敗します。

      パラメーター:
      ignoreFailedDrops - 失敗したドロップステートメントを無視する必要がある場合は true。
    • populate

      public void populate(com.datastax.oss.driver.api.core.CqlSession session) throws ScriptException
      インターフェースからコピーされた説明: KeyspacePopulator
      提供された CqlSession 接続を使用して、データベースを作成、初期化、クリーンアップします。

      具体的な実装では、エラーが発生した場合に RuntimeExceptionSE をスローする場合がありますが、代わりに特定の ScriptException をスローすることを強くお勧めします。例: Spring の ResourceKeyspacePopulator は、すべての例外を ScriptExceptions にラップします。

      次で指定:
      インターフェース KeyspacePopulatorpopulate 
      パラメーター:
      session - キースペースを設定するために使用する CQL CqlSession。すでに構成されており、すぐに使用できます。null にはなりません。
      例外:
      ScriptException - 他のすべてのエラーの場合
    • execute

      public void execute(SessionFactory sessionFactory) throws ScriptException
      指定された SessionFactory に対してこの ResourceKeyspacePopulator を実行します。
      パラメーター:
      sessionFactory - 実行する SessionFactory (非 null)
      例外:
      ScriptException - エラーが発生した場合
      関連事項: