全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

インタフェース java.sql.CallableStatement

public interface CallableStatement
extends PreparedStatement

CallableStatement は、SQL ストアドプロシージャを実行するのに使用します。

JDBC はストアドプロシージャ SQL エスケープを提供します。これにより、すべての RDBMS に対し標準の方法で ストアドプロシージャを呼び出せます。このエスケープ構文には、結果パラメータを含めるものと含めないものとがあります。使用すると、結果パラメータは OUT パラメータとして登録されなければなりません。他のパラメータは入出力両方に使用できます。パラメータは、番号により順番に参照されます。最初のパラメータは 1 です。 

   {?= call <procedure-name>[<arg1>,<arg2>, ...]}
   {call <procedure-name>[<arg1>,<arg2>, ...]}

IN パラメータ値は、 PreparedStatement から継承した set メソッドを使用して設定されます。すべての OUT パラメータのタイプはストアドプロシージャの実行前に登録しなければなりません。それらの値は、ここで提供される get メソッドの実行後に取り出されます。

Callable 文は、一つまたは複数の ResultSet を返すことがあります。複数の ResultSet は Statement から継承した操作で処理されます。

ポータビリティを最大限にするには、出力パラメータを得る前に、呼び出しの ResultSet と更新カウントを処理しなければなりません。

参照:
prepareCall, ResultSet

Method Index

o getBigDecimal(int, int)
NUMERIC パラメータの値を java.math.BigDecimal オブジェクトとして取得する。
o getBoolean(int)
BIT パラメータの値を Java の boolean として取得する。
o getByte(int)
TINYINT パラメータの値を Java の byte として取得する。
o getBytes(int)
SQL BINARY または VARBINARY パラメータの値を Java の byte[] として取得する。
o getDate(int)
SQL DATE パラメータの値を java.sql.Date オブジェクトとして取得する。
o getDouble(int)
DOUBLE パラメータの値を Java の double として取得する。
o getFloat(int)
FLOAT パラメータの値を Java の float として取得する。
o getInt(int)
INTEGER パラメータの値を Java の int として取得する。
o getLong(int)
BIGINT パラメータの値を Java の long として取得する。
o getObject(int)
パラメータの値を Java オブジェクトとして取得する。
o getShort(int)
SMALLINT パラメータの値を Java の short として取得する。
o getString(int)
CHAR、VARCHAR、LONGVARCHAR パラメータの値を Java の String として取得する。
o getTime(int)
SQL TIME パラメータの値を java.sql.Time オブジェクトとして取得する。
o getTimestamp(int)
SQL TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取得する。
o registerOutParameter(int, int)
ストアドプロシージャ呼び出しの前に、registerOutParameter を明示的に呼び出して各 out パラメータの java.sql.Type を登録しなければならない。
o registerOutParameter(int, int, int)
Numeric または Decimal の out パラメータを登録するには、このバージョンの registerOutParameter を使用する。
o wasNull()
OUT パラメータは SQL NULL の値を持つこともある。wasNull は、最後に読まれた値に、この特殊な値が含まれるかどうかを通知する。

Methods

o registerOutParameter 
  public abstract void registerOutParameter(int parameterIndex,
                                            int sqlType) throws SQLException
ストアドプロシージャ呼び出しの前に、registerOutParameter を明示的に呼び出して、各 out パラメータの java.sql.Type を登録しなければなりません。

注: out パラメータの読み込みには、 Java タイプ XXX が、パラメータの登録された SQL タイプに対応している getXXX メソッドを使用しなければなりません。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
sqlType - java.sql.Types によって定義される SQL タイプコード。 Numeric または Decimal タイプのパラメータには、スケール値を受け入れるバージョンの registerOutParameter を使用する。
例外: SQLException
データベースアクセスエラーが発生した場合。
参照:
Type
o registerOutParameter 
  public abstract void registerOutParameter(int parameterIndex,
                                            int sqlType,
                                            int scale) throws SQLException
Numeric または Decimal の out パラメータを登録するには、このバージョンの registerOutParameter を使用します。

注: out パラメータの読み込みには、Java タイプ XXX が、パラメータの登録された SQL タイプに対応している getXXX メソッドを使用しなければなりません。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
sqlType - java.sql.Type.NUMERIC または java.sql.Type.DECIMAL のどちらかを使用する。
scale - 希望の小数点以下の桁数を表現する 0 以上の数値を指定する。
例外: SQLException
データベースアクセスエラーが発生した場合。
参照:
Type
o wasNull 
  public abstract boolean wasNull() throws SQLException
OUT パラメータは SQL NULL の値を持つことがあり、wasNull は、最後に読まれた値にこの特殊な値があるかどうかを通知します。

注: パラメータに関する getXXX を最初に呼び出して値を読み込み、それから wasNull() を呼び出して、値が SQL NULL かどうかを確認しなければなりません。

返り値:
最後のパラメータの読み値が SQL NULL ならば true。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getString 
  public abstract String getString(int parameterIndex) throws SQLException
CHAR、VARCHAR、LONGVARCHAR パラメータの値を Java の String として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は null。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getBoolean 
  public abstract boolean getBoolean(int parameterIndex) throws SQLException
BIT パラメータの値を Java の boolean として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は false。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getByte 
  public abstract byte getByte(int parameterIndex) throws SQLException
TINYINT パラメータの値を Java の byte として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は 0。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getShort 
  public abstract short getShort(int parameterIndex) throws SQLException
SMALLINT パラメータの値を Java の short として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は 0。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getInt 
  public abstract int getInt(int parameterIndex) throws SQLException
INTEGER パラメータの値を Java の int として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は 0。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getLong 
  public abstract long getLong(int parameterIndex) throws SQLException
BIGINT パラメータの値を Java の long として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は 0。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getFloat 
  public abstract float getFloat(int parameterIndex) throws SQLException
FLOAT パラメータの値を Java の float として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は 0。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getDouble 
  public abstract double getDouble(int parameterIndex) throws SQLException
DOUBLE パラメータの値を Java の double として取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は 0。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getBigDecimal 
  public abstract BigDecimal getBigDecimal(int parameterIndex,
                                           int scale) throws SQLException
NUMERIC パラメータの値を java.math.BigDecimal オブジェクトとして取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
scale - 希望の小数点以下の桁数を表現する 0 以上の数値を指定する。
返り値:
パラメータ値。値が SQL NULL の場合は null。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getBytes 
  public abstract byte[] getBytes(int parameterIndex) throws SQLException
SQL BINARY または VARBINARY パラメータの値を Java の byte として取得します[]。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は null。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getDate 
  public abstract Date getDate(int parameterIndex) throws SQLException
SQL DATE パラメータの値を java.sql.Date オブジェクトとして取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は null。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getTime 
  public abstract Time getTime(int parameterIndex) throws SQLException
SQL TIME パラメータの値を java.sql.Time オブジェクトとして取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は null。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getTimestamp 
  public abstract Timestamp getTimestamp(int parameterIndex) throws SQLException
SQL TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取得します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目は 2、等とする。
返り値:
パラメータ値。値が SQL NULL の場合は null。
例外: SQLException
データベースアクセスエラーが発生した場合。
o getObject 
  public abstract Object getObject(int parameterIndex) throws SQLException
パラメータの値を Java オブジェクトとして取得します。

このメソッドは、Java オブジェクトを返します。そのオブジェクトのタイプは、registerOutParameter を使用して登録された SQL タイプに対応します。

このメソッドは、データベース固有の抽象データタイプを読み込むのに使用することに注意してください。これは、java.sql.types.OTHER の targetSqlType を指定することによって実行できます。これにより、ドライバはデータベース固有の Java タイプを返すことができます。

パラメータ:
parameterIndex - 最初のパラメータは1、2 番目のパラメータは 2、等とする。
返り値:
OUT パラメータ値を保持する java.lang.Object。
例外: SQLException
データベースアクセスエラーが発生した場合。
参照:
Types 
全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス