Apache Derby: Documentation

The Derby documentation is available on-online. A description of each manual is below:

• Derby API Reference: An API Reference that is automatically generated for all public Derby classes. No API Reference is provided for the JDBC API, which is part of the Java 2 Platform, Standard Edition.

• Getting Started with Derby: Describes how to install and configure Derby. Includes a self-study tutorial for users new to Derby and a quick-start guide for experienced JDBC users. Introduces the sysinfo and ij tools that come with Derby. Describes the libraries and scripts that are included with Derby.

• Working with Derby: A self-study guide that includes hands-on activities which demonstrate how to use Derby in embedded and client-server configurations.

• Derby Reference Manual: Provides reference information, including SQL syntax and descriptions of the system catalogs.

• Derby Developer's Guide: Describes how to use JDBC to access Derby databases. It is intended for developers building Derby applications.

• Tuning Derby: Explains how to set properties to configure and tune Derby. It also provides performance tuning tips.

• Derby Server and Administration Guide: Describes how to use the Derby Network Server and how to perform administrative tasks such as backing up databases.

• Derby Tools and Utilities Guide: Explains the ins and outs of ij, dblook and sysinfo, and describes bulk export and import.

The latest development version of the manuals, corresponding to the Derby alpha codeline, are listed in this section.

The 10.4 manuals are listed in this section.

The 10.3 manuals are listed in this section.

The 10.2 manuals are listed in this section.

Derby adopted the Darwin Information Typing Architecture (DITA) XML format for the 10.1 Derby manuals. For a description of this Derby documentation project see the Apache Derby: DITA-sourced documentation page. Please participate in the Derby mail list discussions about format.

The 10.0 manuals are the files that were originally contributed to Apache. Before reporting a problem in one of these manuals, please check to see if the problem still exists in the 10.1 manuals.

Please post any technical errors (incorrect information) to Jira.