NoteDbUpdateManager (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.notedb.NoteDbUpdateManager

All Implemented Interfaces:

java.lang.AutoCloseable
```
public class NoteDbUpdateManager
extends java.lang.Object
implements java.lang.AutoCloseable
```
Object to manage a single sequence of updates to NoteDb.
Instances are one-time-use. Handles updating both the change repo and the All-Users repo for any affected changes, with proper ordering.
To see the state that would be applied prior to executing the full sequence of updates, use stage().

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NoteDbUpdateManager.Factory`
`static class`	`NoteDbUpdateManager.Result`
`static class`	`NoteDbUpdateManager.StagedResult`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CHANGES_READ_ONLY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CHANGES_READ_ONLY`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(ChangeDraftUpdate draftUpdate)`
`void`	`add(ChangeUpdate update)` Add an update to the list of updates to execute.
`void`	`close()`
`void`	`deleteChange(com.google.gerrit.reviewdb.client.Change.Id id)`
`void`	`execute()`
`void`	`flush()`
`NoteDbUpdateManager`	`setAllUsersRepo(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectInserter ins, ChainedReceiveCommands cmds)`
`NoteDbUpdateManager`	`setChangeRepo(org.eclipse.jgit.lib.Repository repo, org.eclipse.jgit.revwalk.RevWalk rw, org.eclipse.jgit.lib.ObjectInserter ins, ChainedReceiveCommands cmds)`
`java.util.Map<com.google.gerrit.reviewdb.client.Change.Id,NoteDbUpdateManager.StagedResult>`	`stage()` Stage updates in the manager's internal list of commands.
`NoteDbUpdateManager.Result`	`stageAndApplyDelta(com.google.gerrit.reviewdb.client.Change change)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANGES_READ_ONLY

public static java.lang.String CHANGES_READ_ONLY

Method Detail

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

close in interface java.lang.AutoCloseable

setChangeRepo

public NoteDbUpdateManager setChangeRepo(org.eclipse.jgit.lib.Repository repo,
                                org.eclipse.jgit.revwalk.RevWalk rw,
                                org.eclipse.jgit.lib.ObjectInserter ins,
                                ChainedReceiveCommands cmds)

setAllUsersRepo

public NoteDbUpdateManager setAllUsersRepo(org.eclipse.jgit.lib.Repository repo,
                                  org.eclipse.jgit.revwalk.RevWalk rw,
                                  org.eclipse.jgit.lib.ObjectInserter ins,
                                  ChainedReceiveCommands cmds)

add
```
public void add(ChangeUpdate update)
```
Add an update to the list of updates to execute.
Updates should only be added to the manager after all mutations have been made, as this method may eagerly access the update.

Parameters:
update - the update to add.

add

public void add(ChangeDraftUpdate draftUpdate)

deleteChange

public void deleteChange(com.google.gerrit.reviewdb.client.Change.Id id)

stage

public java.util.Map<com.google.gerrit.reviewdb.client.Change.Id,NoteDbUpdateManager.StagedResult> stage()
                                                                                                  throws com.google.gwtorm.server.OrmException,
                                                                                                         java.io.IOException

Stage updates in the manager's internal list of commands.

Returns:: map of the state that would get written to the applicable repo(s) for each affected change.
Throws:: com.google.gwtorm.server.OrmException - if a database layer error occurs.; java.io.IOException - if a storage layer error occurs.

stageAndApplyDelta

public NoteDbUpdateManager.Result stageAndApplyDelta(com.google.gerrit.reviewdb.client.Change change)
                                              throws com.google.gwtorm.server.OrmException,
                                                     java.io.IOException

Throws:: com.google.gwtorm.server.OrmException; java.io.IOException

flush

public void flush()
           throws java.io.IOException

Throws:: java.io.IOException

execute

public void execute()
             throws com.google.gwtorm.server.OrmException,
                    java.io.IOException

Throws:: com.google.gwtorm.server.OrmException; java.io.IOException

Class NoteDbUpdateManager

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHANGES_READ_ONLY

Method Detail

close

setChangeRepo

setAllUsersRepo

add

add

deleteChange

stage

stageAndApplyDelta

flush

execute