Module org.eclipse.jgit
Package org.eclipse.jgit.internal.storage.file

Class FileReftableDatabase

java.lang.Object
org.eclipse.jgit.lib.RefDatabase
org.eclipse.jgit.internal.storage.file.FileReftableDatabase
public class FileReftableDatabase extends RefDatabase
Implements RefDatabase using reftable for storage. This class is threadsafe.

  • Method Details

    • getReflogReader

      public ReflogReader getReflogReader(Ref ref) throws IOException
      Description copied from class: RefDatabase
      Get the reflog reader.
      Specified by:
      getReflogReader in class RefDatabase
      Parameters:
      ref - a Ref
      Returns:
      a ReflogReader for the supplied ref.
      Throws:
      IOException - if an IO error occurred

    • getReflogReader

      public ReflogReader getReflogReader(String refname) throws IOException
      Description copied from class: RefDatabase
      Get the reflog reader
      Overrides:
      getReflogReader in class RefDatabase
      Parameters:
      refname - a String object.
      Returns:
      a ReflogReader for the supplied refname, or null if the named ref does not exist.
      Throws:
      IOException - the ref could not be accessed.

    • isReftable

      public static boolean isReftable(File repoDir)
      Whether the given repo uses reftable for refdb storage
      Parameters:
      repoDir - the repository's metadata directory
      Returns:
      whether the given repo uses reftable for refdb storage.

    • hasFastTipsWithSha1

      public boolean hasFastTipsWithSha1() throws IOException
      Description copied from class: RefDatabase
      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 class RefDatabase
      Returns:
      whether this RefDatabase supports fast inverse ref queries.
      Throws:
      IOException - on I/O problems.

    • packRefs

      public void packRefs(ProgressMonitor pm, PackRefsCommand packRefs) throws IOException
      Optimize pack ref storage. For Reftable, all the data is compacted into a single table.
      Overrides:
      packRefs in class RefDatabase
      Parameters:
      pm - a progress monitor
      packRefs - PackRefsCommand to control ref packing behavior
      Throws:
      IOException - if an IO error occurred

    • compactFully

      public void compactFully() throws IOException
      Runs a full compaction for GC purposes.
      Throws:
      IOException - on I/O errors

    • performsAtomicTransactions

      public boolean performsAtomicTransactions()
      Description copied from class: RefDatabase
      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 calling update.setAtomic(false).

      If false, BatchRefUpdate instances will never perform updates atomically, and calling update.setAtomic(true) will cause the entire batch to fail with REJECTED_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 class RefDatabase
      Returns:
      whether transactions are atomic by default.

    • newBatchUpdate

      @NonNull public BatchRefUpdate newBatchUpdate()
      Description copied from class: RefDatabase
      Create a new batch update to attempt on this database.

      The default implementation performs a sequential update of each command.

      Overrides:
      newBatchUpdate in class RefDatabase
      Returns:
      a new batch update object.

    • newUpdate

      public RefUpdate newUpdate(String refName, boolean detach) throws IOException
      Description copied from class: RefDatabase
      Create a new update command to create, modify or delete a reference.
      Specified by:
      newUpdate in class RefDatabase
      Parameters:
      refName - the name of the reference.
      detach - if true and name is currently a SymbolicRef, the update will replace it with an ObjectIdRef. Otherwise, the update will recursively traverse SymbolicRefs and operate on the leaf ObjectIdRef.
      Returns:
      a new update for the requested name; never null.
      Throws:
      IOException - the reference space cannot be accessed.

    • exactRef

      public Ref exactRef(String name) throws IOException
      Description copied from class: RefDatabase
      Read a single reference.

      Unlike RefDatabase.findRef(java.lang.String), this method expects an unshortened reference name and does not search using the standard RefDatabase.SEARCH_PATH.

      Specified by:
      exactRef in class RefDatabase
      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

      public List<Ref> getRefs() throws IOException
      Description copied from class: RefDatabase
      Returns all refs.

      This includes HEAD, branches under ref/heads/, tags under refs/tags/, etc. It does not include pseudo-refs like FETCH_HEAD; for those, see RefDatabase.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 class RefDatabase
      Returns:
      immutable list of all refs.
      Throws:
      IOException - the reference space cannot be accessed.

    • getRefs

      public Map<String,Ref> getRefs(String prefix) throws IOException
      Description copied from class: RefDatabase
      Get a section of the reference namespace.
      Specified by:
      getRefs in class RefDatabase
      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
      Description copied from class: RefDatabase
      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 class RefDatabase
      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 in excludes.
      Throws:
      IOException - the reference space cannot be accessed.

    • getAdditionalRefs

      public List<Ref> getAdditionalRefs() throws IOException
      Description copied from class: RefDatabase
      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 by RefDatabase.findRef(String) and RefDatabase.exactRef(String).

      Specified by:
      getAdditionalRefs in class RefDatabase
      Returns:
      a list of additional refs
      Throws:
      IOException - the reference space cannot be accessed.

    • peel

      public Ref peel(Ref ref) throws IOException
      Description copied from class: RefDatabase
      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 class RefDatabase
      Parameters:
      ref - The reference to peel
      Returns:
      ref if ref.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 (or null).
      Throws:
      IOException - the reference space or object space cannot be accessed.

    • setAutoRefresh

      public void setAutoRefresh(boolean autoRefresh)
      Whether to auto-refresh the reftable stack if it is out of date.
      Parameters:
      autoRefresh - whether to auto-refresh the reftable stack if it is out of date.

    • isAutoRefresh

      public boolean isAutoRefresh()
      Whether the reftable stack is auto-refreshed if it is out of date.
      Returns:
      whether the reftable stack is auto-refreshed if it is out of date.

    • refresh

      public void refresh()
      Check if the reftable stack is up to date, and if not, reload it.

      Triggers a refresh of all internal data structures.

      In case the RefDatabase implementation has internal caches this method will trigger that all these caches are cleared.

      Implementors should overwrite this method if they use any kind of caches.

      Overrides:
      refresh in class RefDatabase

    • newRename

      public RefRename newRename(String fromName, String toName) throws IOException
      Description copied from class: RefDatabase
      Create a new update command to rename a reference.
      Specified by:
      newRename in class RefDatabase
      Parameters:
      fromName - name of reference to rename from
      toName - 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

      public boolean isNameConflicting(String name) throws IOException
      Description copied from class: RefDatabase
      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 class RefDatabase
      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()
      Description copied from class: RefDatabase
      Close any resources held by this database.
      Specified by:
      close in class RefDatabase

    • create

      public void create() throws IOException
      Description copied from class: RefDatabase
      Initialize a new reference database at this location.
      Specified by:
      create in class RefDatabase
      Throws:
      IOException - the database could not be created.

    • convertFrom

      public static void convertFrom(FileRepository repo, boolean writeLogs) throws IOException
      Convert FileRepository to a FileReftableDatabase
      Parameters:
      repo - the repository
      writeLogs - whether to write reflogs
      Throws:
      IOException - on IO error