Documentation

h2/src/installer/release.txt

@@ -79,47 +79,63 @@ The following can be skipped currently; benchmarks should probably be removed:
 
 ## Build the Release
 
-Change directory to src/installer
-Run ./buildRelease.sh (non-Windows) or buildRelease.bat (Windows)
+Run the following commands:
+Non-Windows:
 
-Scan for viruses
-Test installer, H2 Console (test new languages)
-Check docs, versions and links in main, downloads, build numbers
-Check the PDF file size
+    cd src/installer
+    ./buildRelease.sh
+
+Windows:
+
+    cd src/installer
+    buildRelease.bat
+
+Scan for viruses.
+
+Test installer, H2 Console (test new languages).
+
+Check docs, versions and links in main, downloads, build numbers.
+
+Check the PDF file size.
 
 Upload (http and https) to ftp://h2database.com/javadoc
 Upload (http and https) to ftp://h2database.com
 Upload (http and https) to ftp://h2database.com/m2-repo
-Github: create a release
-Newsletter: prepare (always to BCC)
-Newsletter: send to h2-database-jp@googlegroups.com; h2-database@googlegroups.com; h2database-news@googlegroups.com; ...
-Add to http://twitter.com
-- tweet: add @geospatialnews for the new geometry type and disk spatial index
+
+Github: create a release.
+
+Newsletter: send (always to BCC!), the following:
+
+    h2-database-jp@googlegroups.com; h2-database@googlegroups.com; h2database-news@googlegroups.com; ...
+
+Create tweet at http://twitter.com
 
 Sign files and publish files on Maven Central
 (check java version is 1.7)
-./build.sh clean compile jar mavenDeployCentral
-cd /data/h2database/m2-repo/com/h2database
-# remove sha and md5 files:
-find . -name "*.sha1" -delete
-find . -name "*.md5" -delete
-cd h2/1...
-# for each file separately (-javadoc.jar, -sources.jar, .jar, .pom):
-gpg -u "Thomas Mueller Graf <thomas.tom.mueller@gmail.com>" -ab h2-...
-jar -cvf bundle.jar h2-*
-cd ../../h2-mvstore/1...
-# for each file separately (-javadoc.jar, -sources.jar, .jar, .pom):
-gpg -u "Thomas Mueller Graf <thomas.tom.mueller@gmail.com>" -ab h2-mvstore...
-jar -cvf bundle.jar h2-*
-# http://central.sonatype.org/pages/ossrh-guide.html
-# http://central.sonatype.org/pages/manual-staging-bundle-creation-and-deployment.html
-# https://oss.sonatype.org/#welcome - Log In "t..."
-# - Staging Upload
-# - Upload Mode: Artifact Bundle, Select Bundle to Upload... - /data/.../bundle.jar
-# - Upload Bundle - Staging Repositories - select comh2database - Release - Confirm
-# - Staging Upload
-# - Upload Mode: Artifact Bundle, Select Bundle to Upload... - /data/.../bundle.jar
-# - Upload Bundle - Staging Repositories - select comh2database - Release - Confirm
-
-Update statistics
-Change version in pom.xml, commit
+
+    ./build.sh clean compile jar mavenDeployCentral
+    cd /data/h2database/m2-repo/com/h2database
+    # remove sha and md5 files:
+    find . -name "*.sha1" -delete
+    find . -name "*.md5" -delete
+    cd h2/1...
+    # for each file separately (-javadoc.jar, -sources.jar, .jar, .pom):
+    gpg -u "Thomas Mueller Graf <thomas.tom.mueller@gmail.com>" -ab h2-...
+    jar -cvf bundle.jar h2-*
+    cd ../../h2-mvstore/1...
+    # for each file separately (-javadoc.jar, -sources.jar, .jar, .pom):
+    gpg -u "Thomas Mueller Graf <thomas.tom.mueller@gmail.com>" -ab h2-mvstore...
+    jar -cvf bundle.jar h2-*
+    # http://central.sonatype.org/pages/ossrh-guide.html
+    # http://central.sonatype.org/pages/manual-staging-bundle-creation-and-deployment.html
+    # https://oss.sonatype.org/#welcome - Log In "t..."
+    # - Staging Upload
+    # - Upload Mode: Artifact Bundle, Select Bundle to Upload... - /data/.../bundle.jar
+    # - Upload Bundle - Staging Repositories - select comh2database - Release - Confirm
+    # - Staging Upload
+    # - Upload Mode: Artifact Bundle, Select Bundle to Upload... - /data/.../bundle.jar
+    # - Upload Bundle - Staging Repositories - select comh2database - Release - Confirm
+
+Update statistics.
+
+Change version in pom.xml, commit.

h2/src/main/org/h2/command/ddl/AlterTableAlterColumn.java

@@ -84,6 +84,9 @@ public class AlterTableAlterColumn extends CommandWithColumns {
         this.oldColumn = oldColumn;
     }
 
+    /**
+     * Add the column as the first column of the table.
+     */
     public void setAddFirst() {
         addFirst = true;
     }

h2/src/main/org/h2/command/ddl/CommandWithColumns.java

@@ -60,6 +60,12 @@ public abstract class CommandWithColumns extends SchemaCommand {
         }
     }
 
+    /**
+     * For the given list of columns, disable "nullable" for those columns that
+     * are primary key columns.
+     *
+     * @param columns the list of columns
+     */
     protected void changePrimaryKeysToNotNull(ArrayList<Column> columns) {
         if (pkColumns != null) {
             for (Column c : columns) {
@@ -72,6 +78,9 @@ public abstract class CommandWithColumns extends SchemaCommand {
         }
     }
 
+    /**
+     * Create the constraints.
+     */
     protected void createConstraints() {
         if (constraintCommands != null) {
             for (DefineCommand command : constraintCommands) {
@@ -81,6 +90,15 @@ public abstract class CommandWithColumns extends SchemaCommand {
         }
     }
 
+    /**
+     * For the given list of columns, create sequences for auto-increment
+     * columns (if needed), and then get the list of all sequences of the
+     * columns.
+     *
+     * @param columns the columns
+     * @param temporary whether generated sequences should be temporary
+     * @return the list of sequences (may be empty)
+     */
     protected ArrayList<Sequence> generateSequences(ArrayList<Column> columns, boolean temporary) {
         ArrayList<Sequence> sequences = New.arrayList();
         if (columns != null) {

h2/src/main/org/h2/index/AbstractFunctionCursor.java

@@ -12,7 +12,9 @@ import org.h2.result.SearchRow;
 import org.h2.value.Value;
 
 /**
- * Abstract function cursor.
+ * Abstract function cursor. This implementation filters the rows (only returns
+ * entries that are larger or equal to "first", and smaller than last or equal
+ * to "last").
  */
 abstract class AbstractFunctionCursor implements Cursor {
     private final FunctionIndex index;
@@ -85,6 +87,11 @@ abstract class AbstractFunctionCursor implements Cursor {
         return false;
     }
 
+    /**
+     * Skip to the next row if one is available. This method does not filter.
+     *
+     * @return true if another row is available
+     */
     abstract boolean nextImpl();
 
     @Override

h2/src/main/org/h2/util/DateTimeFunctions.java

@@ -215,7 +215,7 @@ public final class DateTimeFunctions {
     /**
      * Calculate the number of crossed unit boundaries between two timestamps. This
      * method is supported for MS SQL Server compatibility.
-     * 
+     *
      * <pre>
      * DATEDIFF(YEAR, '2004-12-31', '2005-01-01') = 1
      * </pre>

h2/src/test/org/h2/test/db/TestIndex.java

@@ -710,6 +710,11 @@ public class TestIndex extends TestBase {
         trace("---done---");
     }
 
+    /**
+     * This method is called from the database.
+     *
+     * @return the result set
+     */
     public static ResultSet testFunctionIndexFunction() {
         // There are additional callers like JdbcConnection.prepareCommand() and
         // CommandContainer.recompileIfRequired()

h2/src/tools/org/h2/build/doc/dictionary.txt

@@ -767,3 +767,6 @@ interpolated thead
 die weekdiff osx subprocess dow proleptic microsecond microseconds divisible cmp denormalized suppressed saturated mcs
 london dfs weekdays intermittent looked msec tstz africa monrovia asia tokyo weekday joi callers multipliers ucn
 openoffice organize libre systemtables gmane sea borders announced millennium alex nordlund rarely
+
+opti excessively
+