nablarch.core.db.connection

インタフェース AppDbConnection

既知のサブインタフェースのリスト:

TransactionManagerConnection

public interface AppDbConnection

データベース接続を表すインタフェース。

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

作成者:

Hisaaki Sioiri

関連項目:

DbConnectionContext.getConnection(), DbConnectionContext.getConnection(String)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
nablarch.core.db.statement.SqlCStatement	prepareCall(String sql) ストアドプロシージャ実行用のStatementオブジェクトを生成する。
nablarch.core.db.statement.SqlCStatement	prepareCallBySqlId(String sqlId) ストアドプロシージャ実行用のStatementオブジェクトをSQL_IDを元に生成する。
SqlPStatement	prepareCountStatementBySqlId(String sqlId) SQL_IDを元に件数取得（カウント）用のStatementオブジェクトを生成する。
ParameterizedSqlPStatement	prepareParameterizedCountSqlStatementBySqlId(String sqlId, Object condition) SQL_IDを元に件数取得(カウント)用のStatementオブジェクトを生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatement(String sql) 名前付きパラメータをもつSQL文実行用のStatementオブジェクトを生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatement(String sql, Object condition) 名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトを生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatement(String sql, Object condition, SelectOption selectOption) 検索範囲を指定して、名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトを生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatement(String sql, SelectOption selectOption) 検索範囲を指定した名前付きパラメータをもつSQL文実行用のStatementオブジェクトを生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatementBySqlId(String sqlId) 名前付きパラメータをもつSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatementBySqlId(String sqlId, Object condition) 名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatementBySqlId(String sqlId, Object condition, SelectOption selectOption) 検索範囲を設定した名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。
ParameterizedSqlPStatement	prepareParameterizedSqlStatementBySqlId(String sqlId, SelectOption selectOption) 検索範囲を設定した名前付きパラメータをもつSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。
SqlPStatement	prepareStatement(String sql) パラメータ付きSQL文実行用のStatementオブジェクトを生成する。
SqlPStatement	prepareStatement(String sql, int autoGeneratedKeys) 自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。
SqlPStatement	prepareStatement(String sql, int[] columnIndexes) 自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。
SqlPStatement	prepareStatement(String sql, SelectOption selectOption) 検索範囲を指定したパラメータ付きSQL文実行用のStatementオブジェクトを生成する。
SqlPStatement	prepareStatement(String sql, String[] columnNames) 自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。
SqlPStatement	prepareStatementBySqlId(String sqlId) パラメータ付きSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。
SqlPStatement	prepareStatementBySqlId(String sqlId, SelectOption selectOption) 検索範囲を指定したパラメータ付きSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

メソッドの詳細

prepareStatement

@Published(tag="architect")
SqlPStatement prepareStatement(String sql)

パラメータ付きSQL文実行用のStatementオブジェクトを生成する。

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

パラメータ:

sql - SQL文

戻り値:

java.sql.PreparedStatementのラッパーstatement

関連項目:

java.sql.Connection#prepareStatement(String)

prepareStatement

@Published(tag="architect")
SqlPStatement prepareStatement(String sql,
                                                           SelectOption selectOption)

検索範囲を指定したパラメータ付きSQL文実行用のStatementオブジェクトを生成する。

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

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

パラメータ:

sql - SQL文

selectOption - 検索処理オプション

戻り値:

java.sql.PreparedStatementのラッパーstatement

関連項目:

java.sql.Connection#prepareStatement(String)

prepareStatement

@Published(tag="architect")
SqlPStatement prepareStatement(String sql,
                                                           int autoGeneratedKeys)

自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。

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

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

パラメータ:

sql - SQL文

autoGeneratedKeys - 自動生成キーを返すかどうかを示すフラグ。java.sql.Statement#RETURN_GENERATED_KEYS または java.sql.Statement#NO_GENERATED_KEYS

戻り値:

自動生成キーの取得機能を持つjava.sql.PreparedStatementのラッパーStatement

関連項目:

java.sql.Connection#prepareStatement(String, int)

prepareStatement

@Published(tag="architect")
SqlPStatement prepareStatement(String sql,
                                                           int[] columnIndexes)

自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。

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

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

パラメータ:

sql - SQL文

columnIndexes - 挿入された行から返される列を示す列インデックスの配列

戻り値:

自動生成キーの取得機能を持つjava.sql.PreparedStatementのラッパーStatement

関連項目:

java.sql.Connection#prepareStatement(String, int[])

prepareStatement

@Published(tag="architect")
SqlPStatement prepareStatement(String sql,
                                                           String[] columnNames)

自動生成キー（データベース側で自動生成された値）を取得する機能を持つStatementオブジェクトを生成する。

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

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

パラメータ:

sql - SQL文

columnNames - 挿入された行から返される列を示す列名の配列

戻り値:

自動生成キーの取得機能を持つjava.sql.PreparedStatementのラッパーStatement

関連項目:

java.sql.Connection#prepareStatement(String, String[])

prepareStatementBySqlId

@Published
SqlPStatement prepareStatementBySqlId(String sqlId)

パラメータ付きSQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

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

パラメータ:

sqlId - SQL_ID

戻り値:

java.sql.PreparedStatementのラッパーStatement

関連項目:

java.sql.Connection#prepareStatement(String)

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()を使用すること。

パラメータ:

sqlId - SQL_ID

selectOption - 検索処理オプション

戻り値:

java.sql.PreparedStatementのラッパーstatement

関連項目:

java.sql.Connection#prepareStatement(String)

prepareParameterizedSqlStatement

@Published(tag="architect")
ParameterizedSqlPStatement prepareParameterizedSqlStatement(String sql)

名前付きパラメータをもつSQL文実行用のStatementオブジェクトを生成する。

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

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

パラメータ:

sql - SQL文

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

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)のような、検索範囲を指定した簡易検索処理は実行できない。

パラメータ:

sql - SQL文

selectOption - 検索処理オプション

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

prepareParameterizedSqlStatementBySqlId

@Published
ParameterizedSqlPStatement prepareParameterizedSqlStatementBySqlId(String sqlId)

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

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

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

パラメータ:

sqlId - SQL_ID

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

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)のような、検索範囲を指定した簡易検索処理は実行できない。

パラメータ:

sqlId - SQL_ID

selectOption - 検索処理オプション

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

prepareParameterizedSqlStatement

@Published(tag="architect")
ParameterizedSqlPStatement prepareParameterizedSqlStatement(String sql,
                                                                                        Object condition)

名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトを生成する。

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

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

パラメータ:

sql - SQL文

condition - 可変条件に設定される条件をもつオブジェクト

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

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)のような、検索範囲を指定した簡易検索処理は実行できない。

パラメータ:

sql - SQL文

condition - 可変条件に設定される条件をもつオブジェクト

selectOption - 検索処理オプション

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

prepareParameterizedSqlStatementBySqlId

@Published
ParameterizedSqlPStatement prepareParameterizedSqlStatementBySqlId(String sqlId,
                                                                              Object condition)

名前付きパラメータをもつ可変条件SQL文実行用のStatementオブジェクトをSQL_IDを元に生成する。

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

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

パラメータ:

sqlId - SQL_ID

condition - 可変条件に設定される条件をもつオブジェクト

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

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)のような、検索範囲を指定した簡易検索処理は実行できない。

パラメータ:

sqlId - SQL_ID

condition - 可変条件に設定される条件をもつオブジェクト

selectOption - 検索処理オプション

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

prepareParameterizedCountSqlStatementBySqlId

@Published
ParameterizedSqlPStatement prepareParameterizedCountSqlStatementBySqlId(String sqlId,
                                                                                   Object condition)

SQL_IDを元に件数取得(カウント)用のStatementオブジェクトを生成する。

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

パラメータ:

sqlId - SQL_ID

condition - 可変条件に設定される条件をもつオブジェクト

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

prepareCountStatementBySqlId

@Published
SqlPStatement prepareCountStatementBySqlId(String sqlId)

SQL_IDを元に件数取得（カウント）用のStatementオブジェクトを生成する。

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

パラメータ:

sqlId - SQL_ID

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareStatement(String)

prepareCall

@Published(tag="architect")
nablarch.core.db.statement.SqlCStatement prepareCall(String sql)

ストアドプロシージャ実行用のStatementオブジェクトを生成する。

パラメータ:

sql - SQL文

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareCall(String)

prepareCallBySqlId

@Published
nablarch.core.db.statement.SqlCStatement prepareCallBySqlId(String sqlId)

ストアドプロシージャ実行用のStatementオブジェクトをSQL_IDを元に生成する。

パラメータ:

sqlId - SQL_ID

戻り値:

Statementオブジェクト

関連項目:

java.sql.Connection#prepareCall(String)