Class MigrationsRecorder

java.lang.Object

ac.simons.neo4j.migrations.quarkus.runtime.MigrationsRecorder

public class MigrationsRecorder
extends Object

Records both initialization of the migration config and the migrations itself.

Since:

1.2.2

Author:

Michael J. Simons

Constructor Summary

Constructors

Constructor	Description
MigrationsRecorder(io.quarkus.runtime.RuntimeValue<MigrationsProperties> rtvruntimeProperties)

Method Summary

Modifier and Type	Method	Description
void	applyMigrations(io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.Migrations> migrationsRv, io.quarkus.runtime.RuntimeValue<Boolean> migrationsEnabledRv)	Applies the migrations if MigrationsProperties.enabled() is true.
io.quarkus.runtime.RuntimeValue<Boolean>	isEnabled()	Records the enabled-flag.
io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.MigrationsConfig>	recordConfig(MigrationsBuildTimeProperties buildTimeProperties, StaticJavaBasedMigrationDiscoverer discoverer, ac.simons.neo4j.migrations.core.ClasspathResourceScanner resourceScanner)	Records the configuration.
io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.Migrations>	recordMigrations(io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.MigrationsConfig> migrationsConfig, io.quarkus.runtime.RuntimeValue<org.neo4j.driver.Driver> driver)	Records the migration itself.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MigrationsRecorder

public MigrationsRecorder(io.quarkus.runtime.RuntimeValue<MigrationsProperties> rtvruntimeProperties)

Method Details

recordConfig

public io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.MigrationsConfig> recordConfig(MigrationsBuildTimeProperties buildTimeProperties,
 StaticJavaBasedMigrationDiscoverer discoverer,
 ac.simons.neo4j.migrations.core.ClasspathResourceScanner resourceScanner)

Records the configuration.

Parameters:

buildTimeProperties - build-time properties

discoverer - the (static) discovered configured during build time

resourceScanner - the (static) scanner configured during build time

Returns:

a runtime value containing the configuration

isEnabled

public io.quarkus.runtime.RuntimeValue<Boolean> isEnabled()

Records the enabled-flag. The actual value of the property must be recorded here as well before use.

Returns:

a runtime value containing the enabled-flag

recordMigrations

public io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.Migrations> recordMigrations(io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.MigrationsConfig> migrationsConfig,
 io.quarkus.runtime.RuntimeValue<org.neo4j.driver.Driver> driver)

Records the migration itself.

Parameters:

migrationsConfig - the runtime value for the configuration

driver - the runtime value of a driver instance

Returns:

a runtime value containing the migrations

applyMigrations

public void applyMigrations(io.quarkus.runtime.RuntimeValue<ac.simons.neo4j.migrations.core.Migrations> migrationsRv,
 io.quarkus.runtime.RuntimeValue<Boolean> migrationsEnabledRv)

Applies the migrations if MigrationsProperties.enabled() is true.

Parameters:

migrationsRv - the runtime value containing the migrations instance

migrationsEnabledRv - the runtime value containing the flag whether migrations are enabled or not