com.google.gerrit.server.update

Class BatchUpdate

java.lang.Object

com.google.gerrit.server.update.BatchUpdate

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

NoteDbBatchUpdate, ReviewDbBatchUpdate

public abstract class BatchUpdate
extends java.lang.Object
implements java.lang.AutoCloseable

Helper for a set of updates that should be applied for a site.

An update operation can be divided into three phases:

1. Git reference updates
2. Database updates
3. Post-update steps

A single conceptual operation, such as a REST API call or a merge operation, may make multiple changes at each step, which all need to be serialized relative to each other. Moreover, for consistency, all git ref updates must be performed before any database updates, since database updates might refer to newly-created patch set refs. And all post-update steps, such as hooks, should run only after all storage mutations have completed.

Depending on the backend used, each step might support batching, for example in a BatchRefUpdate or one or more database transactions. All operations in one phase must complete successfully before proceeding to the next phase.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchUpdate.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jgit.lib.BatchRefUpdate	batchRefUpdate
protected java.util.Map<Change.Id,Change>	newChanges
protected OnSubmitValidators	onSubmitValidators
protected com.google.common.collect.ListMultimap<Change.Id,BatchUpdateOp>	ops
protected Order	order
protected Project.NameKey	project
protected org.eclipse.jgit.transport.PushCertificate	pushCert
protected java.lang.String	refLogMessage
protected GitRepositoryManager	repoManager
protected java.util.List<RepoOnlyOp>	repoOnlyOps
protected RepoView	repoView
protected java.util.TimeZone	tz
protected CurrentUser	user
protected java.sql.Timestamp	when

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BatchUpdate(GitRepositoryManager repoManager, org.eclipse.jgit.lib.PersonIdent serverIdent, Project.NameKey project, CurrentUser user, java.sql.Timestamp when)

Method Summary

Modifier and Type	Method and Description
BatchUpdate	addOp(Change.Id id, BatchUpdateOp op)
BatchUpdate	addRepoOnlyOp(RepoOnlyOp op)
void	close()
void	execute()
abstract void	execute(BatchUpdateListener listener)
protected java.util.Optional<AccountState>	getAccount()
java.util.Map<java.lang.String,org.eclipse.jgit.transport.ReceiveCommand>	getRefUpdates()
protected RepoView	getRepoView()
protected org.eclipse.jgit.revwalk.RevWalk	getRevWalk()
protected CurrentUser	getUser()
protected void	initRepository()
BatchUpdate	insertChange(InsertChangeOp op)
protected static void	logDebug(java.lang.String msg)
protected static void	logDebug(java.lang.String msg, java.lang.Object arg)
protected static void	logDebug(java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2)
protected static void	logDebug(java.lang.String msg, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
protected static void	logDebug(java.lang.String msg, java.lang.Throwable t)
static com.google.inject.Module	module()
protected abstract Context	newContext()
BatchUpdate	setOnSubmitValidators(OnSubmitValidators onSubmitValidators) Add a validation step for intended ref operations, which will be performed at the end of RepoOnlyOp.updateRepo(RepoContext) step.
BatchUpdate	setOrder(Order order)
BatchUpdate	setPushCertificate(org.eclipse.jgit.transport.PushCertificate pushCert)
BatchUpdate	setRefLogMessage(java.lang.String refLogMessage)
BatchUpdate	setRepository(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk revWalk, org.eclipse.jgit.lib.ObjectInserter inserter)
BatchUpdate	updateChangesInParallel() Execute BatchUpdateOp.updateChange(ChangeContext) in parallel for each change.

Methods inherited from class java.lang.Object

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

Field Detail

repoManager

protected GitRepositoryManager repoManager

project

protected final Project.NameKey project

user

protected final CurrentUser user

when

protected final java.sql.Timestamp when

tz

protected final java.util.TimeZone tz

ops

protected final com.google.common.collect.ListMultimap<Change.Id,BatchUpdateOp> ops

newChanges

protected final java.util.Map<Change.Id,Change> newChanges

repoOnlyOps

protected final java.util.List<RepoOnlyOp> repoOnlyOps

repoView

protected RepoView repoView

batchRefUpdate

protected org.eclipse.jgit.lib.BatchRefUpdate batchRefUpdate

order

protected Order order

onSubmitValidators

protected OnSubmitValidators onSubmitValidators

pushCert

protected org.eclipse.jgit.transport.PushCertificate pushCert

refLogMessage

protected java.lang.String refLogMessage

Constructor Detail

BatchUpdate

protected BatchUpdate(GitRepositoryManager repoManager,
                      org.eclipse.jgit.lib.PersonIdent serverIdent,
                      Project.NameKey project,
                      CurrentUser user,
                      java.sql.Timestamp when)

Method Detail

module

public static com.google.inject.Module module()

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

execute

public abstract void execute(BatchUpdateListener listener)
                      throws UpdateException,
                             RestApiException

Throws:

UpdateException

RestApiException

execute

public void execute()
             throws UpdateException,
                    RestApiException

Throws:

UpdateException

RestApiException

newContext

protected abstract Context newContext()

setRepository

public BatchUpdate setRepository(org.eclipse.jgit.lib.Repository repo,
                                 org.eclipse.jgit.revwalk.RevWalk revWalk,
                                 org.eclipse.jgit.lib.ObjectInserter inserter)

setPushCertificate

public BatchUpdate setPushCertificate(org.eclipse.jgit.transport.PushCertificate pushCert)

setRefLogMessage

public BatchUpdate setRefLogMessage(java.lang.String refLogMessage)

setOrder

public BatchUpdate setOrder(Order order)

setOnSubmitValidators

public BatchUpdate setOnSubmitValidators(OnSubmitValidators onSubmitValidators)

Add a validation step for intended ref operations, which will be performed at the end of RepoOnlyOp.updateRepo(RepoContext) step.

updateChangesInParallel

public BatchUpdate updateChangesInParallel()

Execute BatchUpdateOp.updateChange(ChangeContext) in parallel for each change.

This improves performance of writing to multiple changes in separate ReviewDb transactions. When only NoteDb is used, updates to all changes are written in a single batch ref update, so parallelization is not used and this option is ignored.

initRepository

protected void initRepository()
                       throws java.io.IOException

Throws:

java.io.IOException

getRepoView

protected RepoView getRepoView()
                        throws java.io.IOException

Throws:

java.io.IOException

getUser

protected CurrentUser getUser()

getAccount

protected java.util.Optional<AccountState> getAccount()

getRevWalk

protected org.eclipse.jgit.revwalk.RevWalk getRevWalk()
                                               throws java.io.IOException

Throws:

java.io.IOException

getRefUpdates

public java.util.Map<java.lang.String,org.eclipse.jgit.transport.ReceiveCommand> getRefUpdates()

addOp

public BatchUpdate addOp(Change.Id id,
                         BatchUpdateOp op)

addRepoOnlyOp

public BatchUpdate addRepoOnlyOp(RepoOnlyOp op)

insertChange

public BatchUpdate insertChange(InsertChangeOp op)
                         throws java.io.IOException

Throws:

java.io.IOException

logDebug

protected static void logDebug(java.lang.String msg,
                               java.lang.Throwable t)

logDebug

protected static void logDebug(java.lang.String msg)

logDebug

protected static void logDebug(java.lang.String msg,
                               java.lang.Object arg)

logDebug

protected static void logDebug(java.lang.String msg,
                               java.lang.Object arg1,
                               java.lang.Object arg2)

logDebug

protected static void logDebug(java.lang.String msg,
                               java.lang.Object arg1,
                               java.lang.Object arg2,
                               java.lang.Object arg3)