com.google.gerrit.server.schema

Class SchemaVersion

java.lang.Object

com.google.gerrit.server.schema.SchemaVersion

Direct Known Subclasses:

Schema_100, Schema_101, Schema_102, Schema_103, Schema_104, Schema_105, Schema_106, Schema_107, Schema_108, Schema_109, Schema_110, Schema_111, Schema_112, Schema_113, Schema_114, Schema_115, Schema_83, Schema_84, Schema_85, Schema_86, Schema_87, Schema_88, Schema_89, Schema_90, Schema_91, Schema_92, Schema_93, Schema_94, Schema_95, Schema_96, Schema_97, Schema_98, Schema_99

public abstract class SchemaVersion
extends java.lang.Object

A version of the database schema.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class<Schema_115>	C The current schema version.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchemaVersion(com.google.inject.Provider<? extends SchemaVersion> prior)

Method Summary

Modifier and Type	Method and Description
void	check(UpdateUI ui, com.google.gerrit.reviewdb.client.CurrentSchemaVersion curr, com.google.gerrit.reviewdb.server.ReviewDb db)
protected static void	execute(com.google.gerrit.reviewdb.server.ReviewDb db, java.lang.String sql) Execute an SQL statement.
protected void	finish(com.google.gerrit.reviewdb.client.CurrentSchemaVersion curr, com.google.gerrit.reviewdb.server.ReviewDb db) Mark the current schema version.
static int	getBinaryVersion()
int	getVersionNbr()
static int	guessVersion(java.lang.Class<?> c)
protected void	migrateData(com.google.gerrit.reviewdb.server.ReviewDb db, UpdateUI ui) Invoked between updateSchema (adds new columns/tables) and pruneSchema (removes deleted columns/tables).
protected static com.google.gwtorm.jdbc.JdbcExecutor	newExecutor(com.google.gerrit.reviewdb.server.ReviewDb db) Open a new statement executor.
protected static java.sql.Statement	newStatement(com.google.gerrit.reviewdb.server.ReviewDb db) Open a new single statement.
protected static java.sql.PreparedStatement	prepareStatement(com.google.gerrit.reviewdb.server.ReviewDb db, java.lang.String sql) Open a new prepared statement.
protected void	preUpdateSchema(com.google.gerrit.reviewdb.server.ReviewDb db) Invoked before updateSchema adds new columns/tables.
protected static void	renameColumn(com.google.gerrit.reviewdb.server.ReviewDb db, java.lang.String table, java.lang.String from, java.lang.String to) Rename an existing column.
protected static void	renameTable(com.google.gerrit.reviewdb.server.ReviewDb db, java.lang.String from, java.lang.String to) Rename an existing table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

C

public static final java.lang.Class<Schema_115> C

The current schema version.

Constructor Detail

SchemaVersion

protected SchemaVersion(com.google.inject.Provider<? extends SchemaVersion> prior)

Method Detail

getBinaryVersion

public static int getBinaryVersion()

guessVersion

public static int guessVersion(java.lang.Class<?> c)

getVersionNbr

public final int getVersionNbr()

Returns:

the CurrentSchemaVersion.versionNbr this step targets.

check

public final void check(UpdateUI ui,
                        com.google.gerrit.reviewdb.client.CurrentSchemaVersion curr,
                        com.google.gerrit.reviewdb.server.ReviewDb db)
                 throws com.google.gwtorm.server.OrmException,
                        java.sql.SQLException

Throws:

com.google.gwtorm.server.OrmException

java.sql.SQLException

preUpdateSchema

protected void preUpdateSchema(com.google.gerrit.reviewdb.server.ReviewDb db)
                        throws com.google.gwtorm.server.OrmException,
                               java.sql.SQLException

Invoked before updateSchema adds new columns/tables.

Parameters:

db - open database handle.

Throws:

com.google.gwtorm.server.OrmException - if a Gerrit-specific exception occurred.

java.sql.SQLException - if an underlying SQL exception occurred.

migrateData

protected void migrateData(com.google.gerrit.reviewdb.server.ReviewDb db,
                           UpdateUI ui)
                    throws com.google.gwtorm.server.OrmException,
                           java.sql.SQLException

Invoked between updateSchema (adds new columns/tables) and pruneSchema (removes deleted columns/tables).

Parameters:

db - open database handle.

ui - interface for interacting with the user.

Throws:

com.google.gwtorm.server.OrmException - if a Gerrit-specific exception occurred.

java.sql.SQLException - if an underlying SQL exception occurred.

finish

protected void finish(com.google.gerrit.reviewdb.client.CurrentSchemaVersion curr,
                      com.google.gerrit.reviewdb.server.ReviewDb db)
               throws com.google.gwtorm.server.OrmException

Mark the current schema version.

Throws:

com.google.gwtorm.server.OrmException

renameTable

protected static void renameTable(com.google.gerrit.reviewdb.server.ReviewDb db,
                                  java.lang.String from,
                                  java.lang.String to)
                           throws com.google.gwtorm.server.OrmException

Rename an existing table.

Throws:

com.google.gwtorm.server.OrmException

renameColumn

protected static void renameColumn(com.google.gerrit.reviewdb.server.ReviewDb db,
                                   java.lang.String table,
                                   java.lang.String from,
                                   java.lang.String to)
                            throws com.google.gwtorm.server.OrmException

Rename an existing column.

Throws:

com.google.gwtorm.server.OrmException

execute

protected static void execute(com.google.gerrit.reviewdb.server.ReviewDb db,
                              java.lang.String sql)
                       throws java.sql.SQLException

Execute an SQL statement.

Throws:

java.sql.SQLException

newStatement

protected static java.sql.Statement newStatement(com.google.gerrit.reviewdb.server.ReviewDb db)
                                          throws java.sql.SQLException

Open a new single statement.

Throws:

java.sql.SQLException

prepareStatement

protected static java.sql.PreparedStatement prepareStatement(com.google.gerrit.reviewdb.server.ReviewDb db,
                                                             java.lang.String sql)
                                                      throws java.sql.SQLException

Open a new prepared statement.

Throws:

java.sql.SQLException

newExecutor

protected static com.google.gwtorm.jdbc.JdbcExecutor newExecutor(com.google.gerrit.reviewdb.server.ReviewDb db)
                                                          throws com.google.gwtorm.server.OrmException

Open a new statement executor.

Throws:

com.google.gwtorm.server.OrmException