com.google.gerrit.server.notedb

Class ConfigNotesMigration

java.lang.Object

com.google.gerrit.server.notedb.NotesMigration

com.google.gerrit.server.notedb.ConfigNotesMigration

public class ConfigNotesMigration
extends NotesMigration

Implement NoteDb migration stages using gerrit.config.

This class controls the state of the migration according to options in gerrit.config. In general, any changes to these options should only be made by adventurous administrators, who know what they're doing, on non-production data, for the purposes of testing the NoteDb implementation. Changing options quite likely requires re-running RebuildNoteDb. For these reasons, the options remain undocumented.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigNotesMigration.Module

Method Summary

Modifier and Type	Method and Description
static org.eclipse.jgit.lib.Config	allEnabledConfig()
NoteDbChangeState.PrimaryStorage	changePrimaryStorage()
boolean	disableChangeReviewDb() Disable ReviewDb access for changes.
boolean	readChanges() Read changes from NoteDb.
boolean	readChangeSequence() Read sequential change ID numbers from NoteDb.
protected boolean	writeChanges() Write changes to NoteDb.

Methods inherited from class com.google.gerrit.server.notedb.NotesMigration

commitChangeWrites, enabled, failChangeWrites, failOnLoad

Methods inherited from class java.lang.Object

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

Method Detail

allEnabledConfig

public static org.eclipse.jgit.lib.Config allEnabledConfig()

writeChanges

protected boolean writeChanges()

Description copied from class: NotesMigration

Write changes to NoteDb.

Updates to change data are written to NoteDb refs, but ReviewDb is still the source of truth. Change data will not be written unless the NoteDb refs are already up to date, and the write path will attempt to rebuild the change if not.

If false, the behavior when attempting to write depends on readChanges(). If readChanges() = false, writes to NoteDb are simply ignored; if true, any attempts to write will generate an error.

Specified by:

writeChanges in class NotesMigration

readChanges

public boolean readChanges()

Description copied from class: NotesMigration

Read changes from NoteDb.

Change data is read from NoteDb refs, but ReviewDb is still the source of truth. If the loader determines NoteDb is out of date, the change data in NoteDb will be transparently rebuilt. This means that some code paths that look read-only may in fact attempt to write.

If true and writeChanges() = false, changes can still be read from NoteDb, but any attempts to write will generate an error.

Specified by:

readChanges in class NotesMigration

readChangeSequence

public boolean readChangeSequence()

Description copied from class: NotesMigration

Read sequential change ID numbers from NoteDb.

If true, change IDs are read from refs/sequences/changes in All-Projects. If false, change IDs are read from ReviewDb's native sequences.

Specified by:

readChangeSequence in class NotesMigration

changePrimaryStorage

public NoteDbChangeState.PrimaryStorage changePrimaryStorage()

Specified by:

changePrimaryStorage in class NotesMigration

Returns:

default primary storage for new changes.

disableChangeReviewDb

public boolean disableChangeReviewDb()

Description copied from class: NotesMigration

Disable ReviewDb access for changes.

When set, ReviewDb operations involving the Changes table become no-ops. Lookups return no results; updates do nothing, as does opening, committing, or rolling back a transaction on the Changes table.

Specified by:

disableChangeReviewDb in class NotesMigration