~pbms-core/pbms/5.15.beta

MySQL Connector/J @MYSQL_CJ_VERSION@ (formerly MM.MySQL)

 

MySQL AB's JDBC Driver for MySQL

 

Copyright (c) 2003 MySQL AB

 

 

 

CONTENTS

 

 

 

* License

 

* Documentation Location

 

* Modifications for BLOB streaming

 

* Building JDBC

 

 

 

 

 

LICENSE

 

 

 

MySQL Connector/J is licensed under the GPL or a commercial license

 

from MySQL AB. 

 

 

 

If you have licensed this product under the GPL, please see the COPYING

 

file for more information. 

 

 

 

There are special exceptions to the terms and conditions of the GPL 

 

as it is applied to this software. View the full text of the 

 

exception in file EXCEPTIONS-CONNECTOR-J in the directory of this 

 

software distribution.

 

 

 

If you have licensed this product under a commercial license from

 

MySQL AB, please see the file "MySQLEULA.txt" that comes with this 

 

distribution for the terms of the license.

 

 

 

If you need non-GPL licenses for commercial distribution please contact 

 

me <mark@mysql.com> or <sales@mysql.com>.

 

 

 

 

 

DOCUMENTATION LOCATION

 

 

 

The documentation formerly contained in this file has moved into the 

 

'doc' directory, where it is available in HTML, PDF and plaintext

 

forms.

 

 

 

You may also find the latest copy of the documentation on the MySQL

 

website at http://dev.mysql.com/doc/refman/5.0/en/connector-j.html

 

 

 

 

 

MODIFICATION FOR BLOB STREAMING

 

 

 

This version of MySQL Connector/J has been modified for BLOB streaming in combination with the BLOB streaming engine (MyBS) and the PBXT storage engine. The modifications have been release under the standard GPL license and are copyright PrimeBase Technologies GmbH.

 

 

 

The lastest versions of PBMS and PBXT can be downloaded from: http://www.blobstreaming.org/download.

 

 

 

Enable BLOB streaming by adding the following option to the JDBC URL: enableBlobStreaming=true.

 

 

 

When set to true the driver will upload values set with setBinaryStream(), setAsciiStream() and setBlob() to the MyBS BLOB repository and insert a URL reference into the table, but only if a valid length is specified. For example, a value inserted using setBinaryStream() with a length of -1 will be not be uploaded to the repository. Instead the value will by inserted directly into the table, as if enableBlobStreaming were set to false.

 

 

 

NOTE: When enableBlobStreaming=true you should only use setBinaryStream(), setAsciiStream() and setBlob() with a valid length on columns of type LONGBLOB. Streamable BLOBs are currently only recognised in LONGBLOB type columns.

 

 

 

Selected values of type LONGBLOB are checked for valid BLOB URLs. Valid URLs are used to automatically download the BLOB data from the BLOB repository. Using a getBinaryStream(), getAsciiStream() or getBlob() you have direct access to the BLOB data stream from the repository.

 

 

 

Valid BLOB URLs are issued by the BLOB streaming engine, and have the following format:

 

 

 

'~>' <db-name> '/' <type-char> <table-id> '-' <blob-id> '-' <access-code> '-' <server-id>

 

 

 

Examples: ~>test/^11-128-fbd590b-0, ~>test/:1-524-3dc45b09-0

 

 

 

The sequence '~>' is a prefix which helps to identify a value BLOB URL quickly. <type-char> is ':' or '^'. BLOB URLs with type-char '^' are BLOBs that do not have a corresponding table (also called an unreferenced BLOB). In this case, the <table-id> is a repository file ID, and <blob-id> is the repository file offset. BLOB URLs with type-char ':' are standard BLOB repository references with a corresponding table. On INSERT, an unreferenced BLOB URL is transformed into a standard BLOB repository reference.

 

 

 

LIMITATION: This implementation is based on JDK 1.5.x, which only allows for lengths in setBinaryStream(), setAsciiStream() and setBlob() of type 'int'. This means that the maximum BLOB size that can currently permitted is 2GB.

 

 

 

 

 

BUILDING JDBC

 

 

 

This distribution includes an already built JDBC driver. If you want to build the driver yourself, you will need the following:

 

 

 

* Apache Ant version 1.6 or newer (available from http://ant.apache.org/).

 

 

 

* JDK-1.4.2 or later.

 

 

 

Then enter the following command to compile and create the driver:

 

 

 

ant dist

 

 

 

After this you can test the BLOB streaming using the 'runtest.sh' shell script:

 

 

 

./runtest.sh

 

 

 

 

 

--

 

This software is OSI Certified Open Source Software.

 

OSI Certified is a certification mark of the Open Source Initiative.