JDBC Tutorials - Herong's Tutorial Examples - Version 2.21, by Dr. Herong Yang

Inserting BLOB Values with setBinaryStream() Method

This section describes how to insert BLOB values with the PreparedStatement.setBinaryStream() method.

If you want to insert the entire content of a binary file into a BLOB column, you should create an InputStream object from this file, and use the PreparedStatement.setBinaryStream() method to pass the binary file content to the BLOB column through the InputStream object. There are 3 versions of the setBinaryStream() method, two of them were added as part of JDBC 4.0 (Java 1.6). Your JDBC driver may not support them:

  • setBinaryStream(int parameterIndex, InputStream x) - The data will be read from the InputStream as needed until end-of-file is reached. This was added in JDBC 4.0 (Java 1.6).
  • setBinaryStream(int parameterIndex, InputStream x, int length) - The data will be read from the InputStream as needed for "length" bytes.
  • setBinaryStream(int parameterIndex, InputStream x, long length) - The data will be read from the InputStream as needed for "length" bytes. This was added in JDBC 4.0 (Java 1.6).

To test those setBinaryStream() methods, wrote the following program:

/**
 * MySqlBlobSetBinaryStream.java
 * Copyright (c) 2007 by Dr. Herong Yang. All rights reserved.
 */
import java.io.*;
import java.sql.*;
public class MySqlBlobSetBinaryStream {
  public static void main(String [] args) {
    Connection con = null;
    try {
      com.mysql.jdbc.jdbc2.optional.MysqlDataSource ds 
        = new com.mysql.jdbc.jdbc2.optional.MysqlDataSource();
      ds.setServerName("localhost");
      ds.setPortNumber(3306);
      ds.setDatabaseName("HerongDB");
      ds.setUser("Herong");
      ds.setPassword("TopSecret");
      con = ds.getConnection();

// Deleting the record for re-testing
      String subject = "Test of setBinaryStream() methods";
      Statement sta = con.createStatement(); 
      sta.executeUpdate("DELETE FROM Image WHERE Subject = '"
        +subject+"'");

// Inserting CLOB value with a PreparedStatement
      PreparedStatement ps = con.prepareStatement(
        "INSERT INTO Image (Subject, Body) VALUES (?,?)");
      ps.setString(1, subject);
      InputStream bodyIn = 
        new FileInputStream("MySqlBlobSetBinaryStream.class");

// Test 1 - This will not work with JDBC 3.0 drivers
//    ps.setBinaryStream(2, bodyIn);

// Test 2 - This will not work with JDBC 3.0 drivers
//    File fileIn = new File("MySqlBlobSetBinaryStream.class");
//    ps.setBinaryStream(2, bodyIn, fileIn.length());

// Test 3 - This works with JDBC 3.0 drivers
      File fileIn = new File("MySqlBlobSetBinaryStream.class");
      ps.setBinaryStream(2, bodyIn, (int) fileIn.length());

      int count = ps.executeUpdate();
      bodyIn.close();
      ps.close();

// Retrieving BLOB value with getBytes()
      sta = con.createStatement(); 
      ResultSet res = sta.executeQuery("SELECT * FROM Image" 
        +" WHERE Subject = '"+subject+"'");
      res.next();
      System.out.println("The inserted record: "); 
      System.out.println("   Subject = "+res.getString("Subject"));
      System.out.println("   Body = "
        +new String(res.getBytes("Body"),0,32)); 
      res.close();

      sta.close();
      con.close();
    } catch (Exception e) {
      System.err.println("Exception: "+e.getMessage());
      e.printStackTrace();
    }
  }
}

As I mentioned above setBinaryStream(int parameterIndex, InputStream x) will not work with JDBC 3.0 drivers. Here is what I got with the "Test 1" section open in my program. Remember that mysql-connector-java-5.0.7-bin is a JDBC 3.0 driver.

C:>java -cp .;\local\lib\mysql-connector-java-5.0.7-bin.jar
  MySqlBlobSetBinaryStream

Exception in thread "main" java.lang.AbstractMethodError: com.mysql
  .jdbc.PreparedStatement.setBinaryStream(ILjava/io/InputStream;)V
  at MySqlBlobSetBinaryStream.main(MySqlBlobSetBinaryStream.java:34)

"Test 2" also failed for the same reason - fileIn.length() returns "long" and that setCharacterStream(int, InputStream, long) is JDBC 4.0 method:

C:>java -cp .;\local\lib\mysql-connector-java-5.0.7-bin.jar
  MySqlBlobSetBinaryStream

Exception in thread "main" java.lang.AbstractMethodError: com.mysql
  .jdbc.PreparedStatement.setBinaryStream(ILjava/io/InputStream;J)V
  at MySqlBlobSetBinaryStream.main(MySqlBlobSetBinaryStream.java:38)

Of course, "Test 3" worked nicely.

C:>java -cp .;\local\lib\mysql-connector-java-5.0.7-bin.jar
  MySqlBlobSetBinaryStream

The inserted record:
   Subject = Test of setBinaryStream() methods
   Body = -||+   2 |
 ; H I
 ? J
 ? K

Table of Contents

 About This Book

 JDBC (Java Database Connectivity) Introduction

 Downloading and Installing JDK - Java SE

 Installing and Running Java DB - Derby

 Derby (Java DB) JDBC Driver

 Derby (Java DB) JDBC DataSource Objects

 Java DB (Derby) - DML Statements

 Java DB (Derby) - ResultSet Objects of Queries

 Java DB (Derby) - PreparedStatement

 MySQL Installation on Windows

 MySQL JDBC Driver (MySQL Connector/J)

 MySQL - PreparedStatement

 MySQL - Reference Implementation of JdbcRowSet

 MySQL - JBDC CallableStatement

 MySQL CLOB (Character Large Object) - TEXT

MySQL BLOB (Binary Large Object) - BLOB

 Overview of BLOB (Binary Large Object)

 Create Tables with CLOB Columns

 Inserting BLOB Values with SQL INSERT Statements

 Inserting BLOB Values with setBytes() Method

Inserting BLOB Values with setBinaryStream() Method

 Closing InputStream Too Early on setBinaryStream()

 Retrieving BLOB Values with getBytes() Method

 Retrieving BLOB Values with getBinaryStream() Method

 Retrieving BLOB Values with getBlob() Method

 Inserting BLOB Values with setBlob() Method

 Oracle Express Edition Installation on Windows

 Oracle JDBC Drivers

 Oracle - Reference Implementation of JdbcRowSet

 Oracle - PreparedStatement

 Oracle - JBDC CallableStatement

 Oracle CLOB (Character Large Object) - TEXT

 Oracle BLOB (Binary Large Object) - BLOB

 Microsoft SQL Server 2005 Express Edition

 Microsoft JDBC Driver for SQL Server - sqljdbc.jar

 Microsoft JDBC Driver - Query Statements and Result Sets

 Microsoft JDBC Driver - DatabaseMetaData Object

 Microsoft JDBC Driver - DDL Statements

 Microsoft JDBC Driver - DML Statements

 SQL Server - PreparedStatement

 SQL Server CLOB (Character Large Object) - TEXT

 SQL Server BLOB (Binary Large Object) - BLOB

 JDBC-ODBC Bridge Driver - sun.jdbc.odbc.JdbcOdbcDriver

 JDBC-ODBC Bridge Driver - Flat Text Files

 JDBC-ODBC Bridge Driver - MS Access

 JDBC-ODBC Bridge Driver - MS SQL Server

 Summary of JDBC Drivers and Database Servers

 Additional Tutorial Notes to Be Added

 References

 PDF Printing Version

Inserting BLOB Values with setBinaryStream() Method - Updated in 2014, by Dr. Herong Yang