Package ac.simons.neo4j.migrations.core

Interface MigrationChain

All Superinterfaces:

ConnectionDetails

public interface MigrationChain
extends ConnectionDetails

Public information about an applied migration. All migrations (applied and pending) form a chain of transformations to a database. The chain starts implicit with a baseline version. The baseline version is not contained in this chain.

Since:

0.0.4

Author:

Michael J. Simons

Soundtrack

Paul van Dyk - From Then On

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MigrationChain.ChainBuilderMode	Used for selecting how the MigrationChain should be computed.
static interface	MigrationChain.Element	A chain element describing a pending or applied migration.

Method Summary

Modifier and Type	Method	Description
String	getDatabaseName()	Deprecated. since 1.1.0, see ConnectionDetails.getOptionalDatabaseName()
Collection<MigrationChain.Element>	getElements()
default Optional<MigrationVersion>	getLastAppliedVersion()
boolean	isApplied(String version)
default String	prettyPrint()	Pretty prints this chain as an ASCII table.

Methods inherited from interface ac.simons.neo4j.migrations.core.ConnectionDetails

getOptionalDatabaseName, getOptionalSchemaDatabaseName, getServerAddress, getServerEdition, getServerVersion, getUsername

Method Details

prettyPrint

default String prettyPrint()

Pretty prints this chain as an ASCII table.

Returns:

A formatted string (an ASCII table representing the chain)

Since:

0.0.11

getDatabaseName

@Deprecated
String getDatabaseName()

Deprecated.

since 1.1.0, see ConnectionDetails.getOptionalDatabaseName()

Returns:

The database if applicable (Neo4j 4.0 and up), maybe null

isApplied

boolean isApplied(String version)

Parameters:

version - An arbitrary version string

Returns:

True, if the version string maps to a migration that has been applied.

getElements

Collection<MigrationChain.Element> getElements()

Returns:

The elements of this migration

getLastAppliedVersion

default Optional<MigrationVersion> getLastAppliedVersion()

Returns:

the last applied version

Since:

1.11.0