BatchUpdate (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.git.BatchUpdate

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class BatchUpdate
extends java.lang.Object
implements java.lang.AutoCloseable
```
Context 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
`class`	`BatchUpdate.ChangeContext`
`class`	`BatchUpdate.Context`
`static interface`	`BatchUpdate.Factory`
`static class`	`BatchUpdate.InsertChangeOp`
`static class`	`BatchUpdate.Listener` Interface for listening during batch update execution.
`static class`	`BatchUpdate.Op`
`static class`	`BatchUpdate.Order` Order of execution of the various phases.
`class`	`BatchUpdate.RepoContext`
`static class`	`BatchUpdate.RepoOnlyOp`

Method Summary

Methods
Modifier and Type	Method and Description
`BatchUpdate`	`addOp(com.google.gerrit.reviewdb.client.Change.Id id, BatchUpdate.Op op)`
`BatchUpdate`	`addRepoOnlyOp(BatchUpdate.RepoOnlyOp op)`
`void`	`close()`
`void`	`execute()`
`void`	`execute(BatchUpdate.Listener listener)`
`org.eclipse.jgit.lib.ObjectInserter`	`getObjectInserter()`
`org.eclipse.jgit.lib.Repository`	`getRepository()`
`org.eclipse.jgit.revwalk.RevWalk`	`getRevWalk()`
`CurrentUser`	`getUser()`
`BatchUpdate`	`insertChange(BatchUpdate.InsertChangeOp op)`
`BatchUpdate`	`setOrder(BatchUpdate.Order order)`
`BatchUpdate`	`setRepository(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk revWalk, org.eclipse.jgit.lib.ObjectInserter inserter)`
`BatchUpdate`	`setRequestId(RequestId requestId)`
`BatchUpdate`	`updateChangesInParallel()` Execute `Op#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

Method Detail

close
```
public void close()
```
Specified by:

close in interface java.lang.AutoCloseable

setRequestId

public BatchUpdate setRequestId(RequestId requestId)

setRepository

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

setOrder

public BatchUpdate setOrder(BatchUpdate.Order order)

updateChangesInParallel
```
public BatchUpdate updateChangesInParallel()
```
Execute Op#updateChange(ChangeContext) in parallel for each change.

getUser
```
public CurrentUser getUser()
```

getRepository

public org.eclipse.jgit.lib.Repository getRepository()
                                              throws java.io.IOException

Throws:: java.io.IOException

getRevWalk

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

Throws:: java.io.IOException

getObjectInserter

public org.eclipse.jgit.lib.ObjectInserter getObjectInserter()
                                                      throws java.io.IOException

Throws:: java.io.IOException

addOp

public BatchUpdate addOp(com.google.gerrit.reviewdb.client.Change.Id id,
                BatchUpdate.Op op)

addRepoOnlyOp

public BatchUpdate addRepoOnlyOp(BatchUpdate.RepoOnlyOp op)

insertChange

public BatchUpdate insertChange(BatchUpdate.InsertChangeOp op)

execute

public void execute()
             throws UpdateException,
                    com.google.gerrit.extensions.restapi.RestApiException

Throws:: UpdateException; com.google.gerrit.extensions.restapi.RestApiException

execute

public void execute(BatchUpdate.Listener listener)
             throws UpdateException,
                    com.google.gerrit.extensions.restapi.RestApiException

Throws:: UpdateException; com.google.gerrit.extensions.restapi.RestApiException

Class BatchUpdate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

close

setRequestId

setRepository

setOrder

updateChangesInParallel

getUser

getRepository

getRevWalk

getObjectInserter

addOp

addRepoOnlyOp

insertChange

execute

execute