パッケージ org.springframework.data.cassandra.core.cql.session.init

クラス ScriptUtils

java.lang.ObjectSE
org.springframework.data.cassandra.core.cql.session.init.ScriptUtils
public abstract class ScriptUtils extends ObjectSE
CQL スクリプトを操作するための汎用ユーティリティメソッド。

主にフレームワーク内での内部使用向け。

導入:
3.0
作成者:
Mark Paluch

  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    DEFAULT_BLOCK_COMMENT_END_DELIMITER
    CQL スクリプト内のブロックコメントのデフォルトの終了区切り文字: "*/"。
    static final StringSE
    DEFAULT_BLOCK_COMMENT_START_DELIMITER
    CQL スクリプト内のブロックコメントのデフォルトの開始区切り文字: "/*"。
    static final StringSE
    DEFAULT_COMMENT_PREFIX
    CQL スクリプト内の単一行コメントのデフォルトのプレフィックス: "--"。
    static final StringSE[]
    DEFAULT_COMMENT_PREFIXES
    CQL スクリプト内の単一行コメントのデフォルトのプレフィックス: ["--"]。
    static final StringSE
    DEFAULT_STATEMENT_SEPARATOR
    CQL スクリプト内のデフォルトのステートメント区切り文字: ";"。
    static final StringSE
    EOF_STATEMENT_SEPARATOR
    ファイルの終わり (EOF) CQL ステートメントの区切り文字: "^^^ END OF SCRIPT ^^^"。
    static final StringSE
    FALLBACK_STATEMENT_SEPARATOR
    CQL スクリプト内のフォールバックステートメント区切り文字: "\n"。

  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    ScriptUtils()

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    static boolean
    containsCqlScriptDelimiters(StringSE script, StringSE separator)
    提供された CQL スクリプトには指定された区切り文字が含まれていますか ?
    static void
    executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, Resource resource)
    ステートメント区切り文字、コメント区切り文字、例外処理フラグのデフォルト設定を使用して、指定された CQL スクリプトを実行します。
    static void
    executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, EncodedResource resource)
    ステートメント区切り文字、コメント区切り文字、例外処理フラグのデフォルト設定を使用して、指定された CQL スクリプトを実行します。
    static void
    executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, StringSE[] commentPrefixes, StringSE separator, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter)
    指定された CQL スクリプトを実行します。
    static void
    executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, StringSE commentPrefix, StringSE separator, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter)
    指定された CQL スクリプトを実行します。
    static StringSE
    readScript(LineNumberReaderSE lineNumberReader, StringSE[] lineCommentPrefixes, StringSE separator, StringSE blockCommentEndDelimiter)
    提供されたコメント接頭辞とステートメント区切り文字を使用して、提供された LineNumberReader からスクリプトを読み取り、行を含む String を構築します。
    static StringSE
    readScript(LineNumberReaderSE lineNumberReader, StringSE lineCommentPrefix, StringSE separator, StringSE blockCommentEndDelimiter)
    提供されたコメント接頭辞とステートメント区切り文字を使用して、提供された LineNumberReader からスクリプトを読み取り、行を含む String を構築します。
    static void
    splitCqlScript(StringSE script, char separator, ListSE<StringSE> statements)
    CQL スクリプトを、指定された区切り文字で区切られた個別のステートメントに分割します。
    static void
    splitCqlScript(StringSE script, StringSE separator, ListSE<StringSE> statements)
    CQL スクリプトを、指定された区切り文字列で区切られた個別のステートメントに分割します。
    static void
    splitCqlScript(EncodedResource resource, StringSE script, StringSE separator, StringSE[] commentPrefixes, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter, ListSE<StringSE> statements)
    CQL スクリプトを、指定された区切り文字列で区切られた個別のステートメントに分割します。
    static void
    splitCqlScript(EncodedResource resource, StringSE script, StringSE separator, StringSE commentPrefix, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter, ListSE<StringSE> statements)
    CQL スクリプトを、指定された区切り文字列で区切られた個別のステートメントに分割します。

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • フィールドの詳細

    • DEFAULT_STATEMENT_SEPARATOR

      public static final StringSE DEFAULT_STATEMENT_SEPARATOR
      CQL スクリプト内のデフォルトのステートメント区切り文字: ";"。
      関連事項:

    • FALLBACK_STATEMENT_SEPARATOR

      public static final StringSE FALLBACK_STATEMENT_SEPARATOR
      CQL スクリプト内のフォールバックステートメント区切り文字: "\n"。

      特定のスクリプトにカスタムセパレータも DEFAULT_STATEMENT_SEPARATOR も存在しない場合に使用されます。

      関連事項:

    • EOF_STATEMENT_SEPARATOR

      public static final StringSE EOF_STATEMENT_SEPARATOR
      ファイルの終わり (EOF) CQL ステートメントの区切り文字: "^^^ END OF SCRIPT ^^^"。

      この値は、CQL スクリプトに明示的なステートメント区切り文字のない単一のステートメント (複数行にまたがる可能性がある) が含まれていることを示すために、separator から executeCqlScript(CqlSession, EncodedResource, boolean, boolean, String, String, String, String) として指定できます。このようなスクリプトには、この値は実際には含まれず、単なる仮想ステートメント区切り文字であることに注意してください。

      関連事項:

    • DEFAULT_COMMENT_PREFIX

      public static final StringSE DEFAULT_COMMENT_PREFIX
      CQL スクリプト内の単一行コメントのデフォルトのプレフィックス: "--"。
      関連事項:

    • DEFAULT_COMMENT_PREFIXES

      public static final StringSE[] DEFAULT_COMMENT_PREFIXES
      CQL スクリプト内の単一行コメントのデフォルトのプレフィックス: ["--"]。
      導入:
      5.2

    • DEFAULT_BLOCK_COMMENT_START_DELIMITER

      public static final StringSE DEFAULT_BLOCK_COMMENT_START_DELIMITER
      CQL スクリプト内のブロックコメントのデフォルトの開始区切り文字: "/*"。
      関連事項:

    • DEFAULT_BLOCK_COMMENT_END_DELIMITER

      public static final StringSE DEFAULT_BLOCK_COMMENT_END_DELIMITER
      CQL スクリプト内のブロックコメントのデフォルトの終了区切り文字: "*/"。
      関連事項:

  • コンストラクターの詳細

    • ScriptUtils

      public ScriptUtils()

  • メソッドの詳細

    • splitCqlScript

      public static void splitCqlScript(StringSE script, char separator, ListSE<StringSE> statements) throws ScriptException
      CQL スクリプトを、指定された区切り文字で区切られた個別のステートメントに分割します。各ステートメントは、指定された List に追加されます。

      スクリプト内では、"--" がコメント接頭辞として使用されます。コメント接頭辞で始まり、行の終わりまで続くテキストは、出力から省略されます。同様に、"/*" および "*/" は、ブロックコメントの開始および終了の区切り文字として使用されます。ブロックコメントで囲まれたテキストは、出力から省略されます。さらに、隣接する複数の空白文字は 1 つのスペースに折りたたまれます。

      パラメーター:
      script - CQL スクリプト。
      separator - 各ステートメントを区切る文字 (通常は ';')。
      statements - 個々のステートメントが含まれるリスト。
      例外:
      ScriptException - CQL スクリプトの分割中にエラーが発生した場合。
      関連事項:

    • splitCqlScript

      public static void splitCqlScript(StringSE script, StringSE separator, ListSE<StringSE> statements) throws ScriptException
      CQL スクリプトを、指定された区切り文字列で区切られた個別のステートメントに分割します。各ステートメントは、指定された List に追加されます。

      スクリプト内では、"--" がコメント接頭辞として使用されます。コメント接頭辞で始まり、行の終わりまで続くテキストは、出力から省略されます。同様に、"/*" および "*/" は、ブロックコメントの開始および終了の区切り文字として使用されます。ブロックコメントで囲まれたテキストは、出力から省略されます。さらに、隣接する複数の空白文字は 1 つのスペースに折りたたまれます。

      パラメーター:
      script - CQL スクリプト。
      separator - 各ステートメントを区切るテキスト (通常は ';' または改行文字)。
      statements - 個々のステートメントが含まれるリスト。
      例外:
      ScriptException - CQL スクリプトの分割中にエラーが発生した場合。
      関連事項:

    • splitCqlScript

      public static void splitCqlScript(@Nullable EncodedResource resource, StringSE script, StringSE separator, StringSE commentPrefix, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter, ListSE<StringSE> statements) throws ScriptException
      CQL スクリプトを、指定された区切り文字列で区切られた個別のステートメントに分割します。各ステートメントは、指定された List に追加されます。

      スクリプト内では、提供された commentPrefix が優先されます。コメントプレフィックスで始まり、行の終わりまで続くテキストは、出力から省略されます。同様に、提供された blockCommentStartDelimiter および blockCommentEndDelimiter 区切り文字が優先されます。ブロックコメントで囲まれたテキストは、出力から省略されます。さらに、隣接する複数の空白文字は 1 つのスペースに折りたたまれます。

      パラメーター:
      resource - スクリプトが読み取られたリソース。
      script - CQL スクリプト。
      separator - 各ステートメントを区切るテキスト (通常は ';' または改行文字)。
      commentPrefix - CQL 行コメントを識別するプレフィックス (通常は "--" )。
      blockCommentStartDelimiter - 開始ブロックコメント区切り文字。null または空にはなりません。
      blockCommentEndDelimiter - 終了ブロックコメント区切り文字。null または空にはなりません。
      statements - 個々のステートメントを含むリスト
      例外:
      ScriptException - CQL スクリプトの分割中にエラーが発生した場合

    • splitCqlScript

      public static void splitCqlScript(@Nullable EncodedResource resource, StringSE script, StringSE separator, StringSE[] commentPrefixes, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter, ListSE<StringSE> statements) throws ScriptException
      CQL スクリプトを、指定された区切り文字列で区切られた個別のステートメントに分割します。各ステートメントは、指定された List に追加されます。

      スクリプト内では、提供された commentPrefixes が優先されます。コメントプレフィックスの 1 つで始まり、行の終わりまで続くテキストは、出力から省略されます。同様に、提供された blockCommentStartDelimiter および blockCommentEndDelimiter 区切り文字が優先されます。ブロックコメントで囲まれたテキストは、出力から省略されます。さらに、隣接する複数の空白文字は 1 つのスペースに折りたたまれます。

      パラメーター:
      resource - スクリプトが読み取られたリソース。
      script - CQL スクリプト。
      separator - 各ステートメントを区切るテキスト (通常は ';' または改行文字)。
      commentPrefixes - CQL 行コメントを識別するプレフィックス (通常は "--" )。
      blockCommentStartDelimiter - 開始ブロックコメント区切り文字。null または空にはなりません。
      blockCommentEndDelimiter - 終了ブロックコメント区切り文字。null または空にはなりません。
      statements - 個々のステートメントが含まれるリスト。
      例外:
      ScriptException - CQL スクリプトの分割中にエラーが発生した場合

    • readScript

      public static StringSE readScript(LineNumberReaderSE lineNumberReader, @Nullable StringSE lineCommentPrefix, @Nullable StringSE separator, @Nullable StringSE blockCommentEndDelimiter) throws IOExceptionSE
      提供されたコメント接頭辞とステートメント区切り文字を使用して、提供された LineNumberReader からスクリプトを読み取り、行を含む String を構築します。

      コメント接頭辞で始まる行は結果から除外されます。ただし、他の場所（たとえば、ステートメント内）の行コメントは結果に含まれます。

      パラメーター:
      lineNumberReader - 処理するスクリプトを含む LineNumberReader。
      lineCommentPrefix - CQL スクリプト内のコメントを識別するプレフィックス (通常は "--" )。
      separator - CQL スクリプト内のステートメント区切り文字 (通常は ";" )。
      blockCommentEndDelimiter - 終了ブロックのコメント区切り文字。
      戻り値:
      スクリプト行を含む String 
      例外:
      IOExceptionSE - I/O エラーの場合

    • readScript

      public static StringSE readScript(LineNumberReaderSE lineNumberReader, @Nullable StringSE[] lineCommentPrefixes, @Nullable StringSE separator, @Nullable StringSE blockCommentEndDelimiter) throws IOExceptionSE
      提供されたコメント接頭辞とステートメント区切り文字を使用して、提供された LineNumberReader からスクリプトを読み取り、行を含む String を構築します。

      コメント接頭辞のいずれかで始まる行は結果から除外されます。ただし、他の場所（たとえば、ステートメント内）の行コメントは結果に含まれます。

      パラメーター:
      lineNumberReader - 処理するスクリプトを含む LineNumberReader。
      lineCommentPrefixes - CQL スクリプト内のコメントを識別するプレフィックス (通常は "--" )。
      separator - CQL スクリプト内のステートメント区切り文字 (通常は ";" )。
      blockCommentEndDelimiter - 終了ブロックのコメント区切り文字。
      戻り値:
      スクリプト行を含む String 
      例外:
      IOExceptionSE - I/O エラーの場合

    • containsCqlScriptDelimiters

      public static boolean containsCqlScriptDelimiters(StringSE script, StringSE separator)
      提供された CQL スクリプトには指定された区切り文字が含まれていますか ?
      パラメーター:
      script - CQL スクリプト。
      separator - 各ステートメントを区切る文字列 - 通常は ";" 文字です。

    • executeCqlScript

      public static void executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, Resource resource) throws ScriptException
      ステートメント区切り文字、コメント区切り文字、例外処理フラグのデフォルト設定を使用して、指定された CQL スクリプトを実行します。

      提供されたスクリプト内で個々のステートメントを実行する前に、ステートメントの区切り文字とコメントが削除されます。

      パラメーター:
      session - スクリプトを実行するために使用する CQL CqlSession。すでに構成されており、すぐに使用できます。
      resource - CQL スクリプトをロードするリソース。現在のプラットフォームのデフォルトのエンコーディングでエンコードされます。
      例外:
      ScriptException - CQL スクリプトの実行中にエラーが発生した場合
      関連事項:

    • executeCqlScript

      public static void executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, EncodedResource resource) throws ScriptException
      ステートメント区切り文字、コメント区切り文字、例外処理フラグのデフォルト設定を使用して、指定された CQL スクリプトを実行します。

      提供されたスクリプト内で個々のステートメントを実行する前に、ステートメントの区切り文字とコメントが削除されます。

      パラメーター:
      session - スクリプトを実行するために使用する CQL CqlSession。すでに構成されており、すぐに使用できます。
      resource - CQL スクリプトをロードするリソース (特定のエンコーディングに関連付けられている可能性があります)。
      例外:
      ScriptException - CQL スクリプトの実行中にエラーが発生した場合
      関連事項:

    • executeCqlScript

      public static void executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, StringSE commentPrefix, @Nullable StringSE separator, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter) throws ScriptException
      指定された CQL スクリプトを実行します。

      提供されたスクリプト内で個々のステートメントを実行する前に、ステートメントの区切り文字とコメントが削除されます。

      パラメーター:
      session - スクリプトを実行するために使用する CQL CqlSession。すでに構成されており、すぐに使用できます。
      resource - CQL スクリプトをロードするリソース (特定のエンコーディングに関連付けられている可能性があります)。
      continueOnError - エラーが発生した場合に例外をスローせずに続行するかどうか。
      ignoreFailedDrops - 特に DROP ステートメントでエラーが発生した場合に続行するかどうか。
      commentPrefix - CQL スクリプト内の単一行コメントを識別するプレフィックス (通常は "--") -
      separator - スクリプトステートメントセパレータ。指定されていない場合、デフォルトで ";" になり、最後の手段として "\n" にフォールバックします。スクリプトに区切り文字のない単一のステートメントが含まれていることを通知するために、「^^^ スクリプトの終わり ^^^」に設定できます。
      blockCommentStartDelimiter - 開始ブロックのコメント区切り文字
      blockCommentEndDelimiter - 終了ブロックのコメント区切り文字
      例外:
      ScriptException - CQL スクリプトの実行中にエラーが発生した場合
      関連事項:

    • executeCqlScript

      public static void executeCqlScript(com.datastax.oss.driver.api.core.CqlSession session, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, StringSE[] commentPrefixes, @Nullable StringSE separator, StringSE blockCommentStartDelimiter, StringSE blockCommentEndDelimiter) throws ScriptException
      指定された CQL スクリプトを実行します。

      提供されたスクリプト内で個々のステートメントを実行する前に、ステートメントの区切り文字とコメントが削除されます。

      パラメーター:
      session - スクリプトを実行するために使用する CQL CqlSession。すでに構成されており、すぐに使用できます。
      resource - CQL スクリプトをロードするリソース (特定のエンコーディングに関連付けられている可能性があります)。
      continueOnError - エラーが発生した場合に例外をスローせずに続行するかどうか。
      ignoreFailedDrops - 特に DROP ステートメントでエラーが発生した場合に続行するかどうか。
      commentPrefixes - CQL スクリプト内の単一行コメントを識別するプレフィックス (通常は "--" )。
      separator - スクリプトステートメントセパレータ。指定されていない場合、デフォルトで ";" になり、最後の手段として "\n" にフォールバックします。スクリプトに区切り文字のない単一のステートメントが含まれていることを通知するために、「^^^ スクリプトの終わり ^^^」に設定できます。
      blockCommentStartDelimiter - 開始ブロックのコメント区切り文字
      blockCommentEndDelimiter - 終了ブロックのコメント区切り文字
      例外:
      ScriptException - CQL スクリプトの実行中にエラーが発生した場合
      関連事項: