Package nablarch.core.db.connection

Interface AppDbConnection

All Known Subinterfaces:
TransactionManagerConnection
All Known Implementing Classes:
BasicDbConnection
public interface AppDbConnection
データベース接続を表すインタフェース。

データベースにアクセスを行う場合には、本インタフェース経由でSQL文実行用のオブジェクトを取得する必要がある。

Author:
Hisaaki Sioiri
See Also:

  • Method Details

    • prepareStatement

      @Published(tag="architect") SqlPStatement prepareStatement(String sql)
      パラメータ付きSQL文実行用のStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      Parameters:
      sql - SQL文
      Returns:
      PreparedStatementのラッパーstatement
      See Also:

    • prepareStatement

      @Published(tag="architect") SqlPStatement prepareStatement(String sql, SelectOption selectOption)
      検索範囲を指定したパラメータ付きSQL文実行用のStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるSqlPStatementは、あらかじめ検索範囲が設定されているため、 SqlPStatement.retrieve(int, int)のような、検索範囲を指定した簡易検索処理は実行できない。
      SqlPStatement.retrieve()を使用すること。

      Parameters:
      sql - SQL文
      selectOption - 検索処理オプション
      Returns:
      PreparedStatementのラッパーstatement
      See Also:

    • prepareStatement

      @Published(tag="architect") SqlPStatement prepareStatement(String sql, int autoGeneratedKeys)
      自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      自動生成されたキーは、SqlPStatement.getGeneratedKeys()を使用して取得する必要がある。

      Parameters:
      sql - SQL文
      autoGeneratedKeys - 自動生成キーを返すかどうかを示すフラグ。Statement.RETURN_GENERATED_KEYS または Statement.NO_GENERATED_KEYS
      Returns:
      自動生成キーの取得機能を持つPreparedStatementのラッパーStatement
      See Also:

    • prepareStatement

      @Published(tag="architect") SqlPStatement prepareStatement(String sql, int[] columnIndexes)
      自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      自動生成されたキーは、SqlPStatement.getGeneratedKeys()を使用して取得する必要がある。

      Parameters:
      sql - SQL文
      columnIndexes - 挿入された行から返される列を示す列インデックスの配列
      Returns:
      自動生成キーの取得機能を持つPreparedStatementのラッパーStatement
      See Also:

    • prepareStatement

      @Published(tag="architect") SqlPStatement prepareStatement(String sql, String[] columnNames)
      自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      自動生成されたキーは、SqlPStatement.getGeneratedKeys()を使用して取得する必要がある。

      Parameters:
      sql - SQL文
      columnNames - 挿入された行から返される列を示す列名の配列
      Returns:
      自動生成キーの取得機能を持つPreparedStatementのラッパーStatement
      See Also:

    • prepareStatementBySqlId

      @Published SqlPStatement prepareStatementBySqlId(String sqlId)
      パラメータ付きSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

      指定されたSQL_IDに紐づくSQL文を取得し、Statementオブジェクトを生成する。
      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      Parameters:
      sqlId - SQL_ID
      Returns:
      PreparedStatementのラッパーStatement
      See Also:

    • prepareStatementBySqlId

      @Published(tag="architect") SqlPStatement prepareStatementBySqlId(String sqlId, SelectOption selectOption)
      検索範囲を指定したパラメータ付きSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

      指定されたSQL_IDに紐づくSQL文を取得し、Statementオブジェクトを生成する。
      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるSqlPStatementは、あらかじめ検索範囲が設定されているため、 SqlPStatement.retrieve(int, int)のような、検索範囲を指定した簡易検索処理は実行できない。
      SqlPStatement.retrieve()を使用すること。

      Parameters:
      sqlId - SQL_ID
      selectOption - 検索処理オプション
      Returns:
      PreparedStatementのラッパーstatement
      See Also:

    • prepareParameterizedSqlStatement

      @Published(tag="architect") ParameterizedSqlPStatement prepareParameterizedSqlStatement(String sql)
      名前付きパラメータをもつSQL文実行用のStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      Parameters:
      sql - SQL文
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatement

      @Published(tag="architect") ParameterizedSqlPStatement prepareParameterizedSqlStatement(String sql, SelectOption selectOption)
      検索範囲を指定した名前付きパラメータをもつSQL文実行用のStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、あらかじめ検索範囲が設定されているため、 ParameterizedSqlPStatement.retrieve(int, int, Object)のような、検索範囲を指定した簡易検索処理は実行できない。

      Parameters:
      sql - SQL文
      selectOption - 検索処理オプション
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatementBySqlId

      @Published ParameterizedSqlPStatement prepareParameterizedSqlStatementBySqlId(String sqlId)
      名前付きパラメータをもつSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      Parameters:
      sqlId - SQL_ID
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatementBySqlId

      @Published(tag="architect") ParameterizedSqlPStatement prepareParameterizedSqlStatementBySqlId(String sqlId, SelectOption selectOption)
      検索範囲を設定した名前付きパラメータをもつSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、あらかじめ検索範囲が設定されているため、 ParameterizedSqlPStatement.retrieve(int, int, Object)のような、検索範囲を指定した簡易検索処理は実行できない。

      Parameters:
      sqlId - SQL_ID
      selectOption - 検索処理オプション
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatement

      @Published(tag="architect") ParameterizedSqlPStatement prepareParameterizedSqlStatement(String sql, Object condition)
      名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      Parameters:
      sql - SQL文
      condition - 可変条件に設定される条件をもつオブジェクト
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatement

      @Published(tag="architect") ParameterizedSqlPStatement prepareParameterizedSqlStatement(String sql, Object condition, SelectOption selectOption)
      検索範囲を指定して、名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトを生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、あらかじめ検索範囲が設定されているため、 ParameterizedSqlPStatement.retrieve(int, int, Object)のような、検索範囲を指定した簡易検索処理は実行できない。

      Parameters:
      sql - SQL文
      condition - 可変条件に設定される条件をもつオブジェクト
      selectOption - 検索処理オプション
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatementBySqlId

      @Published ParameterizedSqlPStatement prepareParameterizedSqlStatementBySqlId(String sqlId, Object condition)
      名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      Parameters:
      sqlId - SQL_ID
      condition - 可変条件に設定される条件をもつオブジェクト
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedSqlStatementBySqlId

      @Published(tag="architect") ParameterizedSqlPStatement prepareParameterizedSqlStatementBySqlId(String sqlId, Object condition, SelectOption selectOption)
      検索範囲を設定した名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

      Statementオブジェクトは、TransactionManagerConnection.terminate()メソッドで自動的にクローズされるため、 アプリケーションは、取得したStatementオブジェクトを明示的にクローズする必要はない。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、名前付きパラメータをもつSQL文専用である。 このため、通常のバインド変数(バインド変数を「?」で表すもの)をもつSQL文の場合は、 本メソッドで生成したParameterizedSqlPStatementでは処理できないことに注意すること。

      注意:本メソッドで返却されるParameterizedSqlPStatementは、あらかじめ検索範囲が設定されているため、 ParameterizedSqlPStatement.retrieve(int, int, Object)のような、検索範囲を指定した簡易検索処理は実行できない。

      Parameters:
      sqlId - SQL_ID
      condition - 可変条件に設定される条件をもつオブジェクト
      selectOption - 検索処理オプション
      Returns:
      Statementオブジェクト
      See Also:

    • prepareParameterizedCountSqlStatementBySqlId

      @Published ParameterizedSqlPStatement prepareParameterizedCountSqlStatementBySqlId(String sqlId, Object condition)
      SQL_IDを元に件数取得(カウント)用のStatementオブジェクトを生成する。

      SQL文を件数取得(カウント)用に変換すること以外は、prepareParameterizedSqlStatementBySqlId(String, Object)と同じ処理を行う。

      Parameters:
      sqlId - SQL_ID
      condition - 可変条件に設定される条件をもつオブジェクト
      Returns:
      Statementオブジェクト
      See Also:

    • prepareCountStatementBySqlId

      @Published SqlPStatement prepareCountStatementBySqlId(String sqlId)
      SQL_IDを元に件数取得（カウント）用のStatementオブジェクトを生成する。

      SQL文を件数取得（カウント）用に変換すること以外は、prepareStatementBySqlId(String)と同じ処理を行う。

      Parameters:
      sqlId - SQL_ID
      Returns:
      Statementオブジェクト
      See Also:

    • prepareCall

      @Published(tag="architect") SqlCStatement prepareCall(String sql)
      ストアドプロシージャ実行用のStatementオブジェクトを生成する。
      Parameters:
      sql - SQL文
      Returns:
      Statementオブジェクト
      See Also:

    • prepareCallBySqlId

      @Published SqlCStatement prepareCallBySqlId(String sqlId)
      ストアドプロシージャ実行用のStatementオブジェクトをSQL_IDを元に生成する。
      Parameters:
      sqlId - SQL_ID
      Returns:
      Statementオブジェクト
      See Also: