FileRepository
. Instances of
this class are not thread-safe. Don't use the same instance from multiple
threads.
This class started as a copy of DfsGarbageCollector from Shawn O. Pearce
adapted to FileRepositories.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A class holding statistical data for a FileRepository regarding how many objects are stored as loose or packed objects -
Constructor Summary
ConstructorsConstructorDescriptionGC
(FileRepository repo) Creates a new garbage collector with default values. -
Method Summary
Modifier and TypeMethodDescriptiongc()
Runs a garbage collector on aFileRepository
.Returns information about objects and pack files for a FileRepository.void
packRefs()
Pack ref storage.void
Like "git prune" this method tries to prune all loose objects which are unreferenced.void
Like "git prune-packed" this method tries to prune all loose objects which can be found in packs.repack()
Packs all objects which reachable from any of the heads into one pack file.void
setAuto
(boolean auto) Set thegc --auto
option.static void
Set the executor for running auto-gc in the background.void
During gc() or prune() each unreferenced, loose object which has been created or modified after or atexpire
will not be pruned.void
setExpireAgeMillis
(long expireAgeMillis) During gc() or prune() each unreferenced, loose object which has been created or modified in the lastexpireAgeMillis
milliseconds will not be pruned.void
setPackConfig
(PackConfig pconfig) Set the PackConfig used when (re-)writing packfiles.void
setPackExpire
(Date packExpire) During gc() or prune() packfiles which are created or modified after or atpackExpire
will not be deleted.void
setPackExpireAgeMillis
(long packExpireAgeMillis) During gc() or prune() packfiles which are created or modified in the lastpackExpireAgeMillis
milliseconds will not be deleted.void
setPackKeptObjects
(boolean packKeptObjects) Define whether to include objects in `.keep` files when repacking.Set the progress monitor used for garbage collection methods.
-
Constructor Details
-
GC
Creates a new garbage collector with default values. An expirationTime of two weeks andnull
as progress monitor will be used.- Parameters:
repo
- the repo to work on
-
-
Method Details
-
setExecutor
Set the executor for running auto-gc in the background. If no executor is set JGit's own WorkQueue will be used.- Parameters:
e
- the executor to be used for running auto-gc
-
gc
Runs a garbage collector on aFileRepository
. It will- pack loose references into packed-refs
- repack all reachable objects into new pack files and delete the old pack files
- prune all loose objects which are now reachable by packs
setAuto(boolean)
was set totrue
gc
will first check whether any housekeeping is required; if not, it exits without performing any work. IfsetBackground(boolean)
was set totrue
collectGarbage
will start the gc in the background, and then return immediately. In this case, errors will not be reported except in gc.log.- Returns:
- the collection of
Pack
's which are newly created - Throws:
IOException
- if an IO error occurredParseException
- If the configuration parameter "gc.pruneexpire" couldn't be parsed
-
prunePacked
Like "git prune-packed" this method tries to prune all loose objects which can be found in packs. If certain objects can't be pruned (e.g. because the filesystem delete operation fails) this is silently ignored.- Throws:
IOException
- if an IO error occurred
-
prune
Like "git prune" this method tries to prune all loose objects which are unreferenced. If certain objects can't be pruned (e.g. because the filesystem delete operation fails) this is silently ignored.- Parameters:
objectsToKeep
- a set of objects which should explicitly not be pruned- Throws:
IOException
- if an IO error occurredParseException
- If the configuration parameter "gc.pruneexpire" couldn't be parsed
-
packRefs
Pack ref storage. For a RefDirectory database, this packs all non-symbolic, loose refs into packed-refs. For Reftable, all of the data is compacted into a single table.- Throws:
IOException
- if an IO error occurred
-
repack
Packs all objects which reachable from any of the heads into one pack file. Additionally all objects which are not reachable from any head but which are reachable from any of the other refs (e.g. tags), special refs (e.g. FETCH_HEAD) or index are packed into a separate pack file. Objects included in pack files which have a .keep file associated are never repacked. All old pack files which existed before are deleted.- Returns:
- a collection of the newly created pack files
- Throws:
IOException
- when during reading of refs, index, packfiles, objects, reflog-entries or during writing to the packfilesIOException
occurs
-
setPackKeptObjects
public void setPackKeptObjects(boolean packKeptObjects) Define whether to include objects in `.keep` files when repacking.- Parameters:
packKeptObjects
- Whether to include objects in `.keep` files when repacking.
-
getStatistics
Returns information about objects and pack files for a FileRepository.- Returns:
- information about objects and pack files for a FileRepository
- Throws:
IOException
- if an IO error occurred
-
setProgressMonitor
Set the progress monitor used for garbage collection methods.- Parameters:
pm
- aProgressMonitor
object.- Returns:
- this
-
setExpireAgeMillis
public void setExpireAgeMillis(long expireAgeMillis) During gc() or prune() each unreferenced, loose object which has been created or modified in the lastexpireAgeMillis
milliseconds will not be pruned. Only older objects may be pruned. If set to 0 then every object is a candidate for pruning.- Parameters:
expireAgeMillis
- minimal age of objects to be pruned in milliseconds.
-
setPackExpireAgeMillis
public void setPackExpireAgeMillis(long packExpireAgeMillis) During gc() or prune() packfiles which are created or modified in the lastpackExpireAgeMillis
milliseconds will not be deleted. Only older packfiles may be deleted. If set to 0 then every packfile is a candidate for deletion.- Parameters:
packExpireAgeMillis
- minimal age of packfiles to be deleted in milliseconds.
-
setPackConfig
Set the PackConfig used when (re-)writing packfiles. This allows to influence how packs are written and to implement something similar to "git gc --aggressive"- Parameters:
pconfig
- thePackConfig
used when writing packs
-
setExpire
During gc() or prune() each unreferenced, loose object which has been created or modified after or atexpire
will not be pruned. Only older objects may be pruned. If set to null then every object is a candidate for pruning.- Parameters:
expire
- instant in time which defines object expiration objects with modification time before this instant are expired objects with modification time newer or equal to this instant are not expired
-
setPackExpire
During gc() or prune() packfiles which are created or modified after or atpackExpire
will not be deleted. Only older packfiles may be deleted. If set to null then every packfile is a candidate for deletion.- Parameters:
packExpire
- instant in time which defines packfile expiration
-
setAuto
public void setAuto(boolean auto) Set thegc --auto
option. With this option, gc checks whether any housekeeping is required; if not, it exits without performing any work. Some JGit commands rungc --auto
after performing operations that could create many loose objects.Housekeeping is required if there are too many loose objects or too many packs in the repository. If the number of loose objects exceeds the value of the gc.auto option JGit GC consolidates all existing packs into a single pack (equivalent to
-A
option), whereas git-core would combine all loose objects into a single pack usingrepack -d -l
. Setting the value ofgc.auto
to 0 disables automatic packing of loose objects.If the number of packs exceeds the value of
gc.autoPackLimit
, then existing packs (except those marked with a .keep file) are consolidated into a single pack by using the-A
option of repack. Settinggc.autoPackLimit
to 0 disables automatic consolidation of packs.Like git the following jgit commands run auto gc:
- fetch
- merge
- rebase
- receive-pack
receive.autogc = false
- Parameters:
auto
- defines whether gc should do automatic housekeeping
-