com.edorasware.one.datacheck

Interface DataConsistencyCheck

All Known Implementing Classes:

DuplicateDefinitionKeyCheck, DuplicateVariableCheck, LegacyModelReferenceCheck

public interface DataConsistencyCheck

An interface for data consistency checks.

Method Summary

Modifier and Type	Method and Description
Optional<String>	execute(boolean quickCheck) Executes this data consistency check.
Optional<org.flywaydb.core.api.MigrationVersion>	getMaximumMigrationVersion() The maximum version where this check should be applied (inclusive).
Optional<org.flywaydb.core.api.MigrationVersion>	getMinimumMigrationVersion() The minimum version where this check should be applied (inclusive).
boolean	isFatalWhenProblemsFound() Indicates whether problems found by this data consistency check are fatal.
boolean	isTenantSpecific() Checks whether this data consistency check is tenant specific.

Method Detail

getMinimumMigrationVersion

Optional<org.flywaydb.core.api.MigrationVersion> getMinimumMigrationVersion()

The minimum version where this check should be applied (inclusive). <p> If Optional.empty() is returned then no restriction will be applied. </p>

Returns:

an optional migration version

getMaximumMigrationVersion

Optional<org.flywaydb.core.api.MigrationVersion> getMaximumMigrationVersion()

The maximum version where this check should be applied (inclusive). <p> If Optional.empty() is returned then no restriction will be applied. </p>

Returns:

an optional migration version

isTenantSpecific

boolean isTenantSpecific()

Checks whether this data consistency check is tenant specific.

Returns:

true if this data consistency check is tenant specific

isFatalWhenProblemsFound

boolean isFatalWhenProblemsFound()

Indicates whether problems found by this data consistency check are fatal.

Returns:

true if problems found by this data consistency check are fatal

execute

Optional<String> execute(boolean quickCheck)

Executes this data consistency check.

For tenant-specific checks, the tenant to be checked will already be set as the current tenant before this method is called.

Parameters:

quickCheck - true if only a quick check should be performed

Returns:

an summary of the problems found (absent if no problems were found)