Class FileReftableDatabase
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
private class
private class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final FileRepository
private final ReftableDatabase
private final FileReftableStack
Fields inherited from class org.eclipse.jgit.lib.RefDatabase
ALL, MAX_SYMBOLIC_REF_DEPTH, SEARCH_PATH
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate boolean
void
close()
Close any resources held by this database.void
Runs a full compaction for GC purposes.static FileReftableDatabase
convertFrom
(FileRepository repo, boolean writeLogs) void
create()
Initialize a new reference database at this location.private Ref
Read a single reference.Get the additional reference-like entities from the repository.private ReentrantLock
getLock()
(package private) ReflogReader
getReflogReader
(String refname) getRefs()
Returns all refs.Get a section of the reference namespace.getRefsByPrefixWithExclusions
(String include, Set<String> excludes) Returns refs whose names start with a given prefix excluding all refs that start with one of the given prefixes.boolean
If the ref database does not support fast inverse queries, it may be advantageous to build a complete SHA1 to ref map in advance for multiple uses.boolean
isNameConflicting
(String name) Determine if a proposed reference name overlaps with an existing one.static boolean
isReftable
(File repoDir) Create a new batch update to attempt on this database.Create a new update command to rename a reference.Create a new update command to create, modify or delete a reference.Peel a possibly unpeeled reference by traversing the annotated tags.boolean
Whether the database is capable of performing batch updates as atomic transactions.private static Ref
private static Ref
refForWrite
(RevWalk rw, Ref r) private static void
writeConvertTable
(Repository repo, ReftableWriter w, boolean writeLogs) Methods inherited from class org.eclipse.jgit.lib.RefDatabase
exactRef, findRef, findRef, firstExactRef, getConflictingNames, getRef, getRefsByPrefix, getRefsByPrefix, getTipsWithSha1, hasRefs, hasVersioning, refresh
-
Field Details
-
reftableDatabase
-
fileRepository
-
reftableStack
-
-
Constructor Details
-
FileReftableDatabase
FileReftableDatabase(FileRepository repo) throws IOException - Throws:
IOException
-
FileReftableDatabase
FileReftableDatabase(FileRepository repo, File refstackName) throws IOException - Throws:
IOException
-
-
Method Details
-
getReflogReader
- Throws:
IOException
-
isReftable
- Parameters:
repoDir
-- Returns:
- whether the given repo uses reftable for refdb storage.
-
hasFastTipsWithSha1
If the ref database does not support fast inverse queries, it may be advantageous to build a complete SHA1 to ref map in advance for multiple uses. To let applications decide on this decision, this function indicates whether the inverse map is available.- Overrides:
hasFastTipsWithSha1
in classRefDatabase
- Returns:
- whether this RefDatabase supports fast inverse ref queries.
- Throws:
IOException
- on I/O problems.
-
compactFully
Runs a full compaction for GC purposes.- Throws:
IOException
- on I/O errors
-
getLock
-
performsAtomicTransactions
public boolean performsAtomicTransactions()Whether the database is capable of performing batch updates as atomic transactions.If true, by default
BatchRefUpdate
instances will perform updates atomically, meaning either all updates will succeed, or all updates will fail. It is still possible to turn off this behavior on a per-batch basis by callingupdate.setAtomic(false)
.If false,
BatchRefUpdate
instances will never perform updates atomically, and callingupdate.setAtomic(true)
will cause the entire batch to fail withREJECTED_OTHER_REASON
.This definition of atomicity is stronger than what is provided by
ReceivePack
.ReceivePack
will attempt to reject all commands if it knows in advance some commands may fail, even if the storage layer does not support atomic transactions. Here, atomicity applies even in the case of unforeseeable errors.- Overrides:
performsAtomicTransactions
in classRefDatabase
- Returns:
- whether transactions are atomic by default.
-
newBatchUpdate
Create a new batch update to attempt on this database.The default implementation performs a sequential update of each command.
- Overrides:
newBatchUpdate
in classRefDatabase
- Returns:
- a new batch update object.
-
newUpdate
Create a new update command to create, modify or delete a reference.- Specified by:
newUpdate
in classRefDatabase
- Parameters:
refName
- the name of the reference.detach
- iftrue
andname
is currently aSymbolicRef
, the update will replace it with anObjectIdRef
. Otherwise, the update will recursively traverseSymbolicRef
s and operate on the leafObjectIdRef
.- Returns:
- a new update for the requested name; never null.
- Throws:
IOException
- the reference space cannot be accessed.
-
exactRef
Read a single reference.Unlike
RefDatabase.findRef(java.lang.String)
, this method expects an unshortened reference name and does not search using the standardRefDatabase.SEARCH_PATH
.- Specified by:
exactRef
in classRefDatabase
- Parameters:
name
- the unabbreviated name of the reference.- Returns:
- the reference (if it exists); else
null
. - Throws:
IOException
- the reference space cannot be accessed.
-
getRefs
Returns all refs.This includes
HEAD
, branches underref/heads/
, tags underrefs/tags/
, etc. It does not include pseudo-refs likeFETCH_HEAD
; for those, seeRefDatabase.getAdditionalRefs()
.Symbolic references to a non-existent ref (for example,
HEAD
pointing to a branch yet to be born) are not included.Callers interested in only a portion of the ref hierarchy can call
RefDatabase.getRefsByPrefix(java.lang.String)
instead.- Overrides:
getRefs
in classRefDatabase
- Returns:
- immutable list of all refs.
- Throws:
IOException
- the reference space cannot be accessed.
-
getRefs
Get a section of the reference namespace.- Specified by:
getRefs
in classRefDatabase
- Parameters:
prefix
- prefix to search the namespace with; must end with/
. If the empty string (RefDatabase.ALL
), obtain a complete snapshot of all references.- Returns:
- modifiable map that is a complete snapshot of the current
reference namespace, with
prefix
removed from the start of each key. The map can be an unsorted map. - Throws:
IOException
- the reference space cannot be accessed.
-
getRefsByPrefixWithExclusions
public List<Ref> getRefsByPrefixWithExclusions(String include, Set<String> excludes) throws IOException Returns refs whose names start with a given prefix excluding all refs that start with one of the given prefixes.The default implementation is not efficient. Implementors of
RefDatabase
should override this method directly if a better implementation is possible.- Overrides:
getRefsByPrefixWithExclusions
in classRefDatabase
- Parameters:
include
- string that names of refs should start with; may be empty.excludes
- strings that names of refs can't start with; may be empty.- Returns:
- immutable list of refs whose names start with
prefix
and none of the strings inexclude
. - Throws:
IOException
- the reference space cannot be accessed.
-
getAdditionalRefs
Get the additional reference-like entities from the repository.The result list includes non-ref items such as MERGE_HEAD and FETCH_RESULT cast to be refs. The names of these refs are not returned by
getRefs()
but are accepted byRefDatabase.findRef(String)
andRefDatabase.exactRef(String)
.- Specified by:
getAdditionalRefs
in classRefDatabase
- Returns:
- a list of additional refs
- Throws:
IOException
- the reference space cannot be accessed.
-
peel
Peel a possibly unpeeled reference by traversing the annotated tags.If the reference cannot be peeled (as it does not refer to an annotated tag) the peeled id stays null, but
Ref.isPeeled()
will be true.Implementors should check
Ref.isPeeled()
before performing any additional work effort.- Specified by:
peel
in classRefDatabase
- Parameters:
ref
- The reference to peel- Returns:
ref
ifref.isPeeled()
is true; otherwise a new Ref object representing the same data as Ref, but isPeeled() will be true and getPeeledObjectId() will contain the peeled object (ornull
).- Throws:
IOException
- the reference space or object space cannot be accessed.
-
doPeel
- Throws:
IOException
-
recreate
-
newRename
Create a new update command to rename a reference.- Specified by:
newRename
in classRefDatabase
- Parameters:
fromName
- name of reference to rename fromtoName
- name of reference to rename to- Returns:
- an update command that knows how to rename a branch to another.
- Throws:
IOException
- the reference space cannot be accessed.
-
isNameConflicting
Determine if a proposed reference name overlaps with an existing one.Reference names use '/' as a component separator, and may be stored in a hierarchical storage such as a directory on the local filesystem.
If the reference "refs/heads/foo" exists then "refs/heads/foo/bar" must not exist, as a reference cannot have a value and also be a container for other references at the same time.
If the reference "refs/heads/foo/bar" exists than the reference "refs/heads/foo" cannot exist, for the same reason.
- Specified by:
isNameConflicting
in classRefDatabase
- Parameters:
name
- proposed name.- Returns:
- true if the name overlaps with an existing reference; false if using this name right now would be safe.
- Throws:
IOException
- the database could not be read to check for conflicts.- See Also:
-
close
public void close()Close any resources held by this database.- Specified by:
close
in classRefDatabase
-
create
Initialize a new reference database at this location.- Specified by:
create
in classRefDatabase
- Throws:
IOException
- the database could not be created.
-
addReftable
- Throws:
IOException
-
writeConvertTable
private static void writeConvertTable(Repository repo, ReftableWriter w, boolean writeLogs) throws IOException - Throws:
IOException
-
refForWrite
- Throws:
IOException
-
convertFrom
public static FileReftableDatabase convertFrom(FileRepository repo, boolean writeLogs) throws IOException - Parameters:
repo
- the repositorywriteLogs
- whether to write reflogs- Returns:
- a reftable based RefDB from an existing repository.
- Throws:
IOException
- on IO error
-