Package io.github.mfvanek.pg.common.maintenance

Interface DatabaseCheckOnCluster<T extends DbObject>

Type Parameters:
T - any database object associated with a table (table itself, index, column, constraint)
All Superinterfaces:
DiagnosticAware, RawTypeAware<T>
All Known Implementing Classes:
ColumnsWithJsonTypeCheckOnCluster, ColumnsWithoutDescriptionCheckOnCluster, ColumnsWithSerialTypesCheckOnCluster, DuplicatedIndexesCheckOnCluster, ForeignKeysNotCoveredWithIndexCheckOnCluster, FunctionsWithoutDescriptionCheckOnCluster, IndexesWithBloatCheckOnCluster, IndexesWithNullValuesCheckOnCluster, IntersectedIndexesCheckOnCluster, InvalidIndexesCheckOnCluster, TablesWithBloatCheckOnCluster, TablesWithMissingIndexesCheckOnCluster, TablesWithoutDescriptionCheckOnCluster, TablesWithoutPrimaryKeyCheckOnCluster, UnusedIndexesCheckOnCluster
public interface DatabaseCheckOnCluster<T extends DbObject> extends DiagnosticAware, RawTypeAware<T>
An abstract check on database structure.
Since:
0.6.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<T>
    check()
    Executes the check in the public schema without filtering results.
    default List<T>
    check(PgContext pgContext)
    Executes the check in the specified schema without filtering results.
    List<T>
    check(PgContext pgContext, Predicate<? super T> exclusionsFilter)
    Executes the check in the specified schema.
    default List<T>
    check(Collection<? extends PgContext> pgContexts, Predicate<? super T> exclusionsFilter)
    Executes the check in the specified schemas.

    Methods inherited from interface io.github.mfvanek.pg.common.maintenance.DiagnosticAware

    getDiagnostic

    Methods inherited from interface io.github.mfvanek.pg.common.maintenance.RawTypeAware

    getType

  • Method Details

    • check

      @Nonnull List<T> check(@Nonnull PgContext pgContext, @Nonnull Predicate<? super T> exclusionsFilter)
      Executes the check in the specified schema.
      Parameters:
      pgContext - check's context with the specified schema
      exclusionsFilter - predicate to filter out unnecessary results
      Returns:
      list of deviations from the specified rule
      See Also:

    • check

      @Nonnull default List<T> check(@Nonnull PgContext pgContext)
      Executes the check in the specified schema without filtering results.
      Parameters:
      pgContext - check's context with the specified schema
      Returns:
      list of deviations from the specified rule
      See Also:

    • check

      @Nonnull default List<T> check()
      Executes the check in the public schema without filtering results.
      Returns:
      list of deviations from the specified rule
      See Also:

    • check

      @Nonnull default List<T> check(@Nonnull Collection<? extends PgContext> pgContexts, @Nonnull Predicate<? super T> exclusionsFilter)
      Executes the check in the specified schemas.
      Parameters:
      pgContexts - a set of contexts specifying schemas
      exclusionsFilter - predicate to filter out unnecessary results
      Returns:
      list of deviations from the specified rule