Interface SnapshotFileSystemManager

All Superinterfaces:
org.apache.ignite.internal.lang.Debuggable, org.apache.ignite.internal.manager.IgniteComponent
All Known Implementing Classes:
SnapshotFileSystemManagerImpl

public interface SnapshotFileSystemManager extends org.apache.ignite.internal.manager.IgniteComponent
Class representing the file structure of all Snapshots.
  • Method Details

    • snapshotFileSystem

      SnapshotFileSystem snapshotFileSystem(UUID snapshotId, SnapshotUri snapshotUri)
      Resolves the filesystem for a given snapshot based on a given URI.
      Parameters:
      snapshotId - Snapshot ID.
      snapshotUri - Snapshot URI.
    • snapshotFileSystem

      @TestOnly SnapshotFileSystem snapshotFileSystem(UUID snapshotId)
      Resolves the filesystem for a given snapshot using default URI.
    • snapshotUri

      SnapshotUriWithName snapshotUri(@Nullable @Nullable String name)
      Resolves the snapshot path from configuration by name.
      Parameters:
      name - Name of the path or null for default.
      Returns:
      Snapshot URI.
      Throws:
      SnapshotUriNotFoundException - if path not found by given name.
    • snapshotUris

      List<SnapshotUriWithName> snapshotUris()
      Returns all registered snapshot paths from the configuration.
    • scanSnapshotMeta

      List<SnapshotMetaPath> scanSnapshotMeta(SnapshotUri uri)
      Returns the paths to the meta files of all snapshots along the path.
      Parameters:
      uri - Snapshot path from configuration.
      Throws:
      SnapshotIllegalArgumentException - If the given URI schema is invalid.
      SnapshotException - If an error occurs while collecting snapshot metas.
    • readSnapshotMeta

      SnapshotMeta readSnapshotMeta(SnapshotMetaPath path)
      Reads Snapshot Meta from the given path.
      Parameters:
      path - Path to the Snapshot Meta file.
      Throws:
      SnapshotMetaNotFoundException - If the snapshot meta file does not exist.
      SnapshotException - If an error occurs while reading the snapshot meta.