Apache Derby 10.4.1.3 Release

Use the links below to download a distribution of Apache Derby from one of our mirrors. You should always verify the integrity of distribution files downloaded from a mirror.

There are four different distributions:

• bin distribution - contains the documentation, javadoc, and jar files for Derby.
• lib distribution - contains only the jar files for Derby.
• lib-debug distribution - contains jar files for Derby with source line numbers.
• src distribution - contains the Derby source tree at the point which the binaries were built.

db-derby-10.4.1.3-bin.zip [PGP] [MD5]
db-derby-10.4.1.3-bin.tar.gz [PGP] [MD5]

db-derby-10.4.1.3-lib.zip [PGP] [MD5]
db-derby-10.4.1.3-lib.tar.gz [PGP] [MD5]

db-derby-10.4.1.3-lib-debug.zip [PGP] [MD5]
db-derby-10.4.1.3-lib-debug.tar.gz [PGP] [MD5]

db-derby-10.4.1.3-src.zip [PGP] [MD5]
db-derby-10.4.1.3-src.tar.gz [PGP] [MD5] (Note that, due to long filenames, you will need gnu tar to unravel this tarball.)

There are two separate Eclipse plugins for Derby:

• derby_core_plugin - provides the Derby jar files to other plugins in Eclipse.
• derby_ui_plugin - provides an Apache Derby Nature in Eclipse for easy database application development.

derby_core_plugin_10.4.1.648739.zip [PGP] [MD5]
derby_ui_plugin_1.1.2.zip [PGP] [MD5]

Please note: both plugins must be installed for full functionality. For information on installing and using the Derby plugins for Eclipse, please see the Using the 10 Core and 1.1 UI Derby plug-ins page.

These notes describe the difference between Derby release 10.4.1.3 and the preceding release 10.3.2.1.

Overview

Derby is a pure Java relational database engine using standard SQL and JDBC as its APIs.

Derby functionality includes:

• Embedded engine with JDBC drivers
• Network Server
• Network client JDBC drivers
• Command line tools: ij (SQL scripting), dblook (schema dump) and sysinfo (system info)

New Features

This is a feature release. The following new features were added:

• SQL ROW_NUMBER() window function, as described in the SQL 2003 standard section 6.10, for an empty, inlined window specification. The window clause, as described in section 7.11 is not implemented.
• Unique constraints on nullable columns. SQL Feature T591.
• Asynchronous replication with manual fail-over.
• Table Functions. SQL Feature T326. This lets you run queries against any external data source which can be presented as a JDBC ResultSet. Table Functions are useful for data migration and integration. For more information, please consult the "Programming Derby-style table functions" section of the Derby Developer's Guide as well as the functional specification attached to DERBY-716.
• Java Management Extensions (JMX) for Derby, allowing local and remote monitoring and management of a running Derby system (this release includes a basic set of MBeans - it is expected that more JMX functionality will be added in later releases).
• SQL bracketed comments (/*..*/). SQL Feature T351.
• ij continuation marker. Interactive ij shows > prompt until ; is entered.
• A JDBC statement object cache in the client driver. Some limitations imposed by the presence of DERBY-3596.
• Caching of the isolation level and the current schema in the client driver.
• Implement a new multi-threaded buffer manager to get better scalability on machines with multiple CPUs or multiple cores.

Bug Fixes

The following issues are addressed by Derby release 10.4.1.3. These issues are not addressed in the preceding 10.3.2.1 release.

Issues

Compared with the previous release (10.3.2.1), Derby release 10.4.1.3 introduces the following new features and incompatibilities. These merit your special attention.

• Note for DERBY-3585: Shutting down the Network Server now supports user authentication, and in fact requires credentials when authentication is enabled.

• Note for DERBY-3460: The two following reserved keywords are introduced: NONE and CURRENT_ROLE.

• Note for DERBY-3301: Queries with nested EXIST, ANY or IN clauses now return correct results.

• Note for DERBY-3026: The frameworks directory (and its contents) has been removed.

• Note for DERBY-3013: The column default value can now also be specified as CURRENT_USER or SESSION_USER.

• Note for DERBY-2351: An ORDER BY clause of a DISTINCT query which specifies to order by a column which was not in the DISTINCT list is now rejected, because the intent of the query is ambiguous. Previously, Derby instead produced non-distinct results. Also, an ORDER BY clause which specifies a table-name-qualified column alias is now rejected as invalid, where previously it was accepted.

• Note for DERBY-2065: Error code changed for embedded connection when a connection with an open transaction is attempted closed.

Note for DERBY-3585

Summary of Change

Shutting down the Network Server now supports user authentication, and in fact requires credentials when authentication is enabled.

Symptoms Seen by Applications Affected by Change

Previously, a network server running with user authentication didn't check for user credentials for server shutdown. Any client could shut down the server by calling NetworkServerControl with a shutdown command-line argument or by invoking the shutdown() method (provided the shutdown was initiated on the host running the server). While this generated a console warning (Connection refused : Invalid authentication.), the server shutdown proceeded and could also result in open databases not being properly closed.

Now, class NetworkServerControl supports user and password information as command-line and constructor arguments. When running a network server with user authentication, a server shutdown now requires user credentials; if the user authentication check fails, the client sees an authentication error and the running server remains intact. Note that Derby does not yet restrict the shutdown privilege to specific users: the server can be shut down by any user on the server machine who presents valid credentials.

In detail, to provide user credentials class org.apache.derby.drda.NetworkServerControl now supports new shutdown command-line options:

• -user <username>
• -password <password>

• NetworkServerControl(String userName, String password)
• NetworkServerControl(InetAddress address, int portNumber, String userName, String password)

Incompatibilities with Previous Release

If running a network server without user authentication (the default) no command-line or API incompatibilities will be experienced.

However, some incompatibilities were introduced if running a network server with user authentication:

1. The NetworkServerControl command-line usage changes for shutting down a sever: java org.apache.derby.drda.NetworkServerControl shutdown now results in an exception: 08004:Connection authentication failure occurred. Reason: Invalid authentication.

   The remedy is to provide credentials: java org.apache.derby.drda.NetworkServerControl shutdown -user <username> -password <password>

2. The NetworkServerControl API usage to programatically shutdown a server changes: NetworkServerControl nsc = new NetworkServerControl();nsc.shutdown(); results in a java.sql.SQLException: Connection authentication failure occurred. Reason: Invalid authentication.

   The remedy is provide credentials to the NetworkServerControl constructor: NetworkServerControl nsc = new NetworkServerControl(user, password); nsc.shutdown();

3. Note that there is an edge case NetworkServerControl nsc = new NetworkServerControl();nsc.start(console);...nsc.shutdown(); which currently fails with the SQLException shown above.

   A solution is to create the initial NetworkServerControl instance with user credentials: NetworkServerControl nscauth = new NetworkServerControl(user, password);nscauth.start(console);...nscauth.shutdown(); Another option is to create a second NetworkServerControl instance with user credential arguments for the purpose of server shutdown: NetworkServerControl nsc = new NetworkServerControl();nsc.start(console);...NetworkServerControl nscauth = new NetworkServerControl(user, password);nscauth.shutdown();

4. If users have their own tests that use Derby's junit test framework, they'll have to use a test decorator that takes user credential arguments.

Rationale for Change

The previous behavior represented a security issue, because any client could shut down a network server running with user authentication from the same host without needing to provide user credentials.

Application Changes Required

Application code and scripts will need to be adjusted to provide user credentials for shutting down a network server that runs with user authentication.

Note for DERBY-3460

Summary of Change

The two following reserved keywords are introduced: NONE and CURRENT_ROLE.

Symptoms Seen by Applications Affected by Change

Incompatibilities with Previous Release

Rationale for Change

Application Changes Required

Note for DERBY-3301

Summary of Change

Queries with nested EXIST, ANY or IN clauses now return correct results.

Symptoms Seen by Applications Affected by Change

In the previous release, applications that executed SQL statements containing nested EXISTS, ANY or IN clauses could see fewer rows than those satisfying the query. In particular, rows that had the same value for one of the selected columns as another row might not have been returned.

Incompatibilities with Previous Release

None.

Rationale for Change

The previous behavior violated the ANSI SQL standard. The new behavior is correct.

Application Changes Required

Typically none, but applications must handle that the correct results are now returned.

Note for DERBY-3026

Summary of Change

The frameworks directory (and its contents) has been removed.

Symptoms Seen by Applications Affected by Change

Incompatibilities with Previous Release

Applications or commands referencing files in the frameworks directory will fail.

Rationale for Change

In the 10.2.1.6 release, new and improved scripts were added in a new bin directory, intended to replace the scripts in the frameworks directory. The new scripts follow Apache conventions, and all scripts are located in a single directory, making them easier to find. Removing the old and deprecated scripts and the frameworks directory itself will eliminate a potential source of confusion and annoyance among users.

The frameworks directory has been deprecated since the 10.2.1.6 release, and has not been maintained since then. The 10.2.1.6 release notes announced the deprecation of the scripts in the frameworks directory, and an additional file (frameworks.DEPRECATED.txt) was added in the top-level directory of the 10.3.1.4 release, with the purpose of alerting users about this change. A warning message was also added to the scripts in the frameworks directory at the same time.

Application Changes Required

All references to the frameworks directory or its contents must be updated. The scripts in the bin directory may be used instead of the old scripts.

Note for DERBY-3013

Summary of Change

The column default value can now also be specified as CURRENT_USER or SESSION_USER.

Symptoms Seen by Applications Affected by Change

None

Incompatibilities with Previous Release

None

Rationale for Change

Extend Derby's support for standard SQL constructions.

Application Changes Required

None.

Note for DERBY-2351

Summary of Change

An ORDER BY clause of a DISTINCT query which specifies to order by a column which was not in the DISTINCT list is now rejected, because the intent of the query is ambiguous. Previously, Derby instead produced non-distinct results. Also, an ORDER BY clause which specifies a table-name-qualified column alias is now rejected as invalid, where previously it was accepted.

Symptoms Seen by Applications Affected by Change

New rules for DISTINCT and ORDER BY

Applications which specify certain combinations of SELECT DISTINCT with ORDER BY will now receive an error message, whereas formerly such applications received non-distinct results.

As an example, take the following:

create table person (name varchar(10), age int);
insert into person values ('John', 10);
insert into person values ('John', 30);
insert into person values ('Mary', 20);

SELECT DISTINCT name FROM person ORDER BY age;

The query above is now rejected, with the error message:

If the AGE column is included in the DISTINCT list in the above query, there is no ambiguity

New column alias rules

Applications which specify a column alias for a column in the SELECT statement, and which specify an ORDER BY clause which specifies that column alias qualified by the table name, will now receive an error indicating that the ORDER BY clause is invalid.

As an example, take the following:

create table t1 (i int, j int);
select t1.id as idcolumn1, t1.id as idcolumn2 from t1 order by t1.idcolumn1, t1.idcolumn2;

This query is now rejected, as there is no column named 'idcolumn1' in table 't1'. The error message is:

Valid forms of the query above are:

select t1.id as idcolumn1, t1.id as idcolumn2 from t1 order by idcolumn1, idcolumn2;

or

select t1.id as idcolumn1, t1.id as idcolumn2 from t1 order by t1.id, t1.id;

Rationale for Change

When the query ambiguously specifies both DISTINCT and ORDER BY, Derby was unsure whether to return the rows properly ordered, but non-distinct, or to return a distinct set of rows, but in an unknown order. Since no clear resolution of the ambiguity could be found, we chose instead to reject the query.

The rules for resolving column references in ORDER BY clauses have been enhanced to consider column aliases and column names more fully. Derby now uses different resolution rules depending on whether the ORDER BY column reference is table.column, or just column:

• if the table name is provided, we match against the underlying table name, and don't consider any aliases
• if the table name is NOT provided, we first match against the alias name, if present, and if no alias name matches then we match against the underlying source column name.

Application Changes Required

A query which specifies ordering by a non-distinct column should instead include the ORDER BY column in the DISTINCT list, to resolve the ambiguity about which values of that column should be used to distinctly identify the resulting rows.

A query which specifies table-name.alias-name should be rewritten to specify either simply alias-name, or table-name.column-name.

Note for DERBY-2065

Summary of Change

Error code changed for embedded connection when a connection with an open transaction is attempted closed.

Symptoms Seen by Applications Affected by Change

In the previous release, calling Connection.close() on a connection with an open transaction raised an error with error code 25001 with the client driver, whereas the embedded driver raised error code 25000. The embedded driver has now been changed to raise the same error code as the client driver, i.e. 25001, as specified by the SQL standard.

Incompatibilities with Previous Release

Embedded applications that are dependent on the error code ever being "25000" could start failing. Embedded applications that are dependent on the error code never being "25001" could start failing.

Rationale for Change

Harmonize error codes raised by the client and embedded drivers, thereby also making the embedded driver compatible with the SQL standard.

Application Changes Required

Applications that are dependent on the error code must be changed to expect the new code.

Build Environment

Derby release 10.4.1.3 was built using the following environment:

• Branch - Source code came from the 10.4 branch.
• Machine - SunOS khepri32 5.10 Generic_127112-01 i86pc i386 i86pc
• Ant - Apache Ant version 1.7.0 compiled on December 13 2006
• JDK 1.4 - java version "1.4.2_05" Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_05-b04) Java HotSpot(TM) Client VM (build 1.4.2_05-b04, mixed mode)
• Java 6 - java version "1.6.0_04" Java(TM) SE Runtime Environment (build 1.6.0_04-b06) Java HotSpot(TM) Server VM (build 10.0-b18, mixed mode)
• OSGi - The felix.jar was used to build org.apache.derby.osgi.EmbeddedActivator.
• Compiler - The 1.6.0_04 javac was used to compile all classes.
• JSR 169 - J2ME support was built using java.sun.com/j2me (cdc-1_1-fr-ri, jdbc_cdc1.0).

It is essential that you verify the integrity of the downloaded files using the PGP and MD5 signatures. MD5 verification ensures the file was not corrupted during the download process. PGP verification ensures that the file came from a certain person.

The PGP signatures can be verified using PGP or GPG. First download the Apache Derby KEYS as well as the asc signature file for the particular distribution. It is important that you get these files from the ultimate trusted source - the main ASF distribution site, rather than from a mirror. Then verify the signatures using ...

% pgpk -a KEYS
% pgpv db-derby-X.Y.tar.gz.asc

or

% pgp -ka KEYS
% pgp db-derby-X.Y.tar.gz.asc

or

% gpg --import KEYS
% gpg --verify db-derby-X.Y.tar.gz.asc

To verify the MD5 signature on the files, you need to use a program called md5 or md5sum, which is included in many unix distributions. It is also available as part of GNU Textutils. Windows users can get binary md5 programs from here, here, or here.

We strongly recommend you verify your downloads with both PGP and MD5.