SchemaVersion (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.schema.SchemaVersion

Direct Known Subclasses:

Schema_52, Schema_54, Schema_55, Schema_56, Schema_57, Schema_58, Schema_59, Schema_60, Schema_61, Schema_62, Schema_63, Schema_64, Schema_65, Schema_66, Schema_67, Schema_68, Schema_69, Schema_70, Schema_71, Schema_72, Schema_73, Schema_74, Schema_75, Schema_76, Schema_77, Schema_78, Schema_79, Schema_80, Schema_81, Schema_82, 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
```
public abstract class SchemaVersion
extends java.lang.Object
```
A version of the database schema.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SchemaVersion.Module

Nested Classes
Modifier and Type	Class and Description
`static class`	`SchemaVersion.Module`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.Class<Schema_98> C
The current schema version.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SchemaVersion(com.google.inject.Provider<? extends SchemaVersion> prior)`
`protected`	`SchemaVersion(com.google.inject.Provider<? extends SchemaVersion> prior, int versionNbr)`

Method Summary

Methods
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 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.
`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 void`	`preUpdateSchema(com.google.gerrit.reviewdb.server.ReviewDb db)` Invoke before updateSchema adds new columns/tables.
`protected 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 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_98> C

The current schema version.

Constructor Detail

SchemaVersion

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

SchemaVersion

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

Method Detail

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

Invoke before updateSchema adds new columns/tables.

Throws:: com.google.gwtorm.server.OrmException; java.sql.SQLException

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).

Throws:: com.google.gwtorm.server.OrmException; java.sql.SQLException

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 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 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 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

Class SchemaVersion

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

C

Constructor Detail

SchemaVersion

SchemaVersion

Method Detail

guessVersion

getVersionNbr

check

preUpdateSchema

migrateData

finish

renameTable

renameColumn

execute