6 - PreparedStatement

6.1    概要

1. PreparedStatement のインスタンスには、すでにコンパイル済みの SQL 文が入っています。文が "prepared" (準備済み) と呼ばれるのはこのためです。
2. PreparedStatement に入っている SQL 文には、1 つ以上の IN パラメータを付けることができます。IN パラメータは、SQL 文が作成されたときにはその値が指定されていないパラメータです。その代わり、文には IN パラメータのプレースホルダとして疑問符 ("?") が付いています。それぞれの疑問符の値は、文を実行する前に適切な setXXX メソッドによって供給される必要があります。

PreparedStatement は Statement のサブクラスであるため、Statement のすべての機能を継承します。さらに、IN パラメータのプレースホルダの代わりにデータベースに送信する値を設定するのに必要な全てのメソッドを追加します。また、3 つのメソッドの execute、executeQuery、および executeUpdate は、引数を取らないように変更されています。この 3 つのメソッドの Statement 形式 (SQL 文のパラメータを取る形式) は、 PreparedStatement オブジェクトに対しては絶対に使用してはなりません。

6.1.1    PreparedStatementオブジェクトの作成

    PreparedStatement pstmt = con.prepareStatement(
        "UPDATE table4 SET m = ? WHERE x = ?");

6.1.2    IN Parametersの引き渡し

    pstmt.setLong(1, 123456789);
    pstmt.setLong(2, 100000000);

接続のためのデフォルトモード（自動コミット有効）では、接続が確立されると各文が自動的にコミットされたり、ロールバックされたりします。

PreparedStatement オブジェクトは、コミット後、基盤のデータベースとドライバがそれを開いたままにしていれば、同じオブジェクトを複数回実行することができます。ただし、これ以外の場合は、Statement オブジェクトの代わりに PreparedStatement オブジェクトを使用してパフォーマンスの向上を試みることには、まったく意味がありません。

以下のコードでは、上で作成した pstmt、PreparedStatement オブジェクトを使用して、2 つのパラメータのプレースホルダの値の設定と pstmt を 10 回実行する方法を説明します。前述のように、これが機能するためには、データベースが pstmtを閉じないようにする必要があります。この例では、最初のパラメータに "Hi" が設定され、定数のままになります。2 番目のパラメータには、0 で始まり、for ループを通るたびに異なる値が設定されて、最後は 9 で終ります。

    pstmt.setString(1, "Hi");  
    for (int i = 0; i < 10; i++) {
      pstmt.setInt(2, i);
      int rowCount = pstmt.executeUpdate();
    }

6.1.3    IN Parametersにおけるデータ型の適合性

    pstmt.setShort(2, 44);

Java 型の各 IN パラメータが、データベースが期待する JDBC のデータ型と互換性のある JDBC の型に確実にマップするかは、プログラマの責任です。データベースが JDBC SMALLINT を期待している場合を想定してください。メソッド setByte が使用される場合、ドライバは、 JDBC の TINYINT をデータベースに送信します。多くのデータベースでは、1 つの関連する型から他の型に変換すること、また一般に TINYINT は、SMALLINT が使用されているところではどこでも使用できることから、これはおそらく機能するでしょう。しかし、アプリケーションができるだけ多くのデータベースで機能するためには、データベースが期待する正確な JDBC の型に対応する Java の型を使用するのが最もよい方法です。期待される JDBC の型が SMALLINT の場合、setByte の代わりに setShort を使用することにより、アプリケーションの移植性を向上させることができます。

6.1.4    setObject の使用

JDBC の型が指定されていない場合、ドライバは（8.6.4 節の一覧を使用して、）単純に Java の Object をそのデフォルトの SQL の型にマップして、データベースに送信します。これは、通常の setXXX の処理と似ています。いずれの場合も、ドライバが Java の型を適切な JDBC の型に変換してから、データベースに送信します。相違点としては、setXXX メソッドが、Java の型から JDBC の型への標準のマッピングを使用するのに対し ( 9.5.2 節の一覧参照)、setObject メソッドは、Java の Object 型から JDBC の型へのマッピングを使用します (8.6.4 節の一覧参照)。

メソッド setObject はあらゆる Java オブジェクトを許容する能力を持つため、アプリケーションを汎用化して、パラメータ入力を実行時に受け取ることができます。その場合、アプリケーションのコンパイル時には入力の型は不明です。setObject を使用することにより、アプリケーションは任意の Java のオブジェクト型を入力として受け取り、それをデータベースが期待する JDBC の型に変換することができます。8.6.5 節の一覧に、setObject が実行できるすべての変換を示します。

6.1.5    JDBC NULL の IN パラメータとしての送信

Java の null 値が setXXX メソッドに渡された場合、 JDBC の NULL もデータベースに送信することができます (Java オブジェクトを引数として取る場合)。ただし、メソッド setObject が null 値を取れるのは、 JDBC の型が指定されている場合に限ります。

6.1.6    きわめて大きな IN パラメータの送信

JDBC には、IN パラメータを入力ストリームに設定するための方法が 3 通りあります。これらは、未解釈のバイトが入ったストリームのための setBinaryStream、ASCII 文字の入ったストリームのための setAsciiStream、および Unicode 文字の入ったストリームのための setUnicodeStream です。これらのメソッドは、ストリーム全体の長さを指定する必要があるので、他の setXXX メソッドより引数を 1 つ多く取ります。データベースによっては、データ送信の前に全転送サイズを知る必要があるので、この引数が必要になります。

以下のコードは、ストリームを使用し、ファイルの内容を IN パラメータとして送信する方法を示します。

    java.io.File file = new java.io.File("/tmp/data");
    int fileLength = file.length();
    java.io.InputStream fin = new java.io.FileInputStream(file);
    java.sql.PreparedStatement pstmt = con.prepareStatement(
      "UPDATE Table5 SET stuff = ? WHERE index = 4");
    pstmt.setBinaryStream (1, fin, fileLength);
    pstmt.executeUpdate();