Package org.apache.polaris.persistence.nosql.maintenance.api

Interface MaintenanceService

public interface MaintenanceService

  • Method Details

    • buildMaintenanceRunSpec

      @NonNull MaintenanceRunSpec buildMaintenanceRunSpec()
      Generates a maintenance service run-specification containing realms in states ACTIVE and INACTIVE as "to retain" and realms in state PURGING as "to purge".

    • performMaintenance

      @NonNull MaintenanceRunInformation performMaintenance(@NonNull MaintenanceRunSpec maintenanceRunSpec, @NonNull OptionalLong overrideRunId)
      Perform maintenance.
      Parameters:
      maintenanceRunSpec - define the mandatory run-specification, see buildMaintenanceRunSpec()
      overrideRunId - optional run ID of the currently unfinished maintenance run that shall be superseded
      Returns:
      information about the maintenance run
      Throws:
      MaintenanceRunInProgressException - if the latest maintenance run has not finished and overrideRunId is empty or does not match that latest unfinished run

    • maintenanceRunLog

      @NonNull List<MaintenanceRunInformation> maintenanceRunLog()
      Retrieve information about recent maintenance runs. The number of available elements is configured via MaintenanceConfig.retainedRuns().