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

Interface MaintenanceRunSpec

@PolarisImmutable public interface MaintenanceRunSpec
Configures a maintenance run.

Must specify both the realms to purge and the realms to retain. The two sets are distinct to allow certain database specific and implementation detail optimizations. Existing data of realms that are in neither of the sets to purge and to process will be ignored, not processed at all.

Reserved realms, realm IDs that start with ::, except "::system::", are considered to be "special" and are not processed, and all references and objects in those realms are retained.

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.apache.polaris.persistence.nosql.maintenance.api.ImmutableMaintenanceRunSpec.Builder
    builder()
     
    default boolean
    includeSystemRealm()
    Whether to run maintenance on the system realm, defaults to true.
    Set<String>
    realmsToProcess()
     
    Set<String>
    realmsToPurge()
     

  • Method Details

    • realmsToPurge

      Set<String> realmsToPurge()

    • realmsToProcess

      Set<String> realmsToProcess()

    • includeSystemRealm

      @Default default boolean includeSystemRealm()
      Whether to run maintenance on the system realm, defaults to true.

    • builder

      static org.apache.polaris.persistence.nosql.maintenance.api.ImmutableMaintenanceRunSpec.Builder builder()