Index (Neo4j Migrations (Core) 1.5.6 API)

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ac.simons.neo4j.migrations.core - package ac.simons.neo4j.migrations.core: The main entry package to Neo4j-Migrations.
ac.simons.neo4j.migrations.core.internal - package ac.simons.neo4j.migrations.core.internal: Internal, utility classes.
APPLIED - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationState: A migration already applied
apply() - Method in class ac.simons.neo4j.migrations.core.Migrations: Applies all discovered Neo4j migrations.
apply(MigrationContext) - Method in interface ac.simons.neo4j.migrations.core.Migration: Implement your migration code here.
AUTOCRLF - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default setting for autocrlf.
AUTOCRLF_VALUE - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Same as Defaults.AUTOCRLF but as string value to be used in configuration that requires defaults given as string.

B

build() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder
builder() - Static method in class ac.simons.neo4j.migrations.core.MigrationsConfig: Start building a new configuration.
Builder() - Constructor for class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Deprecated.
since 1.1.0, will be made private in 2.0.0, please use MigrationsConfig.builder().

C

capitalize(String) - Static method in class ac.simons.neo4j.migrations.core.internal.Strings: Capitalizees a string
CLASSPATH - Enum constant in enum ac.simons.neo4j.migrations.core.internal.Location.LocationType: A location inside the classpath.
ClasspathResourceScanner - Interface in ac.simons.neo4j.migrations.core: A scanner for Cypher resources (resources ending with Defaults.CYPHER_SCRIPT_EXTENSION) available in the classpath.
clean(boolean) - Method in class ac.simons.neo4j.migrations.core.Migrations: Cleans the selected schema database.
CleanResult - Class in ac.simons.neo4j.migrations.core: Result of a clean operation.
compare(String, String) - Method in class ac.simons.neo4j.migrations.core.internal.Neo4jVersionComparator
COMPARE - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationChain.ChainBuilderMode: Create the chain of applied and pending migrations by comparing the locally discovered migrations and the migrations applied remotely.
ConnectionDetails - Interface in ac.simons.neo4j.migrations.core: Provides detailed information about the connection being used when invoking any method that talks to the database.
CYPHER - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationType: Indicates a Cypher-based migration.
CYPHER_SCRIPT_ENCODING - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default encoding for Cypher scripts.
CYPHER_SCRIPT_EXTENSION - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default script extension to look for.
CYPHER_SINGLE_LINE_COMMENT - Static variable in class ac.simons.neo4j.migrations.core.internal.Strings: Single line comment indicator.

D

DatabaseOperationResult - Interface in ac.simons.neo4j.migrations.core: A specialization of the OperationResult that always affects a database, either the default one or a named other.
DEFAULT_USER - Static variable in class ac.simons.neo4j.migrations.core.Defaults: The default Neo4j user to use.
defaultConfig() - Static method in class ac.simons.neo4j.migrations.core.MigrationsConfig
Defaults - Class in ac.simons.neo4j.migrations.core: Defaults for Migrations configuration.
DIFFERENT_CONTENT - Enum constant in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: Some migrations have been changed since they have been applied to the target database or their version doesn't fit anymore.
discover(MigrationContext) - Method in interface ac.simons.neo4j.migrations.core.Discoverer: Discover migrations within the given context.
Discoverer<T> - Interface in ac.simons.neo4j.migrations.core: Discoverer of migrations.

E

equals(Object) - Method in class ac.simons.neo4j.migrations.core.MigrationVersion

F

FILESYSTEM - Enum constant in enum ac.simons.neo4j.migrations.core.internal.Location.LocationType: A location inside the filesystem.

G

get(String) - Method in enum ac.simons.neo4j.migrations.core.internal.Messages: Retrieves the message with the given key.
getAffectedDatabase() - Method in class ac.simons.neo4j.migrations.core.CleanResult
getAffectedDatabase() - Method in interface ac.simons.neo4j.migrations.core.DatabaseOperationResult
getAffectedDatabase() - Method in class ac.simons.neo4j.migrations.core.ValidationResult
getChainsDeleted() - Method in class ac.simons.neo4j.migrations.core.CleanResult: The list of chains deleted.
getChecksum() - Method in interface ac.simons.neo4j.migrations.core.Migration
getChecksum() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getConfig() - Method in interface ac.simons.neo4j.migrations.core.MigrationContext
getConnectionDetails() - Method in interface ac.simons.neo4j.migrations.core.MigrationContext: The details will give detailed information about the user being connected, server address and which databases - if available - are being migrated and which are used to store the schema.
getConnectionDetails() - Method in class ac.simons.neo4j.migrations.core.Migrations
getConstraintsRemoved() - Method in class ac.simons.neo4j.migrations.core.CleanResult
getDatabase() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig: Deprecated.
since 1.1.0, please use MigrationsConfig.getOptionalDatabase()
getDatabaseName() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain: Deprecated.
since 1.1.0, please use ConnectionDetails.getOptionalDatabaseName() ()}
getDefaultConstructorFor(Class<T>) - Static method in class ac.simons.neo4j.migrations.core.internal.Reflections: Helper method for retrieving the default constructor of a given class.
getDescription() - Method in interface ac.simons.neo4j.migrations.core.JavaBasedMigration
getDescription() - Method in interface ac.simons.neo4j.migrations.core.Migration
getDescription() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getDriver() - Method in interface ac.simons.neo4j.migrations.core.MigrationContext
getElements() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain
getExecutionTime() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getImpersonatedUser() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig: Deprecated.
since 1.1.0, please use MigrationsConfig.getOptionalImpersonatedUser()
getIndexesRemoved() - Method in class ac.simons.neo4j.migrations.core.CleanResult
getInstalledBy() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getInstalledBy() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig: Deprecated.
since 1.1.0, please use MigrationsConfig.getOptionalInstalledBy()
getInstalledOn() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getLocationsToScan() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getMigrationClassesDiscoverer() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getName() - Method in class ac.simons.neo4j.migrations.core.internal.Location
getNodesDeleted() - Method in class ac.simons.neo4j.migrations.core.CleanResult
getOptionalDatabase() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getOptionalDatabaseName() - Method in interface ac.simons.neo4j.migrations.core.ConnectionDetails
getOptionalImpersonatedUser() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getOptionalInstalledBy() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getOptionalSchemaDatabase() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getOptionalSchemaDatabaseName() - Method in interface ac.simons.neo4j.migrations.core.ConnectionDetails
getOutcome() - Method in class ac.simons.neo4j.migrations.core.ValidationResult
getPackagesToScan() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getPrefix() - Method in enum ac.simons.neo4j.migrations.core.internal.Location.LocationType
getRelationshipsDeleted() - Method in class ac.simons.neo4j.migrations.core.CleanResult
getResourceScanner() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getSchemaSession() - Method in interface ac.simons.neo4j.migrations.core.MigrationContext
getServerAddress() - Method in interface ac.simons.neo4j.migrations.core.ConnectionDetails
getServerEdition() - Method in interface ac.simons.neo4j.migrations.core.ConnectionDetails
getServerVersion() - Method in interface ac.simons.neo4j.migrations.core.ConnectionDetails
getSession() - Method in interface ac.simons.neo4j.migrations.core.MigrationContext: Convenience method to return an imperative session against the configured server and database.
getSessionConfig() - Method in interface ac.simons.neo4j.migrations.core.MigrationContext: Use this session config in your Java-based migration to make sure you use the same database as the migration tool itself.
getSessionConfig(UnaryOperator<SessionConfig.Builder>) - Method in interface ac.simons.neo4j.migrations.core.MigrationContext: This method provides a callback that will be applied to the SessionConfig.Builder just before a SessionConfig is created.
getSource() - Method in interface ac.simons.neo4j.migrations.core.JavaBasedMigration
getSource() - Method in interface ac.simons.neo4j.migrations.core.Migration
getSource() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getState() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getTransactionMode() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
getType() - Method in class ac.simons.neo4j.migrations.core.internal.Location
getType() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getUserAgent() - Static method in class ac.simons.neo4j.migrations.core.Migrations
getUsername() - Method in interface ac.simons.neo4j.migrations.core.ConnectionDetails
getValue() - Method in class ac.simons.neo4j.migrations.core.MigrationVersion
getVersion() - Method in interface ac.simons.neo4j.migrations.core.JavaBasedMigration
getVersion() - Method in interface ac.simons.neo4j.migrations.core.Migration
getVersion() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain.Element
getWarnings() - Method in interface ac.simons.neo4j.migrations.core.OperationResult
getWarnings() - Method in class ac.simons.neo4j.migrations.core.ValidationResult

H

hashCode() - Method in class ac.simons.neo4j.migrations.core.MigrationVersion
hasPlacesToLookForMigrations() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig: Deprecated.
Since 1.1.0, will be removed from public without replace.

I

INCOMPLETE_DATABASE - Enum constant in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: The target database has not been fully migrated, meaning there are resolved migrations that have not been applied.
INCOMPLETE_MIGRATIONS - Enum constant in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: Some migrations have been applied to the target database that cannot be resolved locally any longer.
info() - Method in class ac.simons.neo4j.migrations.core.Migrations: Returns information about the context, the database, all applied and all pending applications.
info(MigrationChain.ChainBuilderMode) - Method in class ac.simons.neo4j.migrations.core.Migrations: Returns information about the context, the database, all applied and all pending applications.
INSTANCE - Enum constant in enum ac.simons.neo4j.migrations.core.internal.Messages: The single instance.
isApplied(String) - Method in interface ac.simons.neo4j.migrations.core.MigrationChain
isAutocrlf() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig
isSingleLineComment(String) - Static method in class ac.simons.neo4j.migrations.core.internal.Strings: This won't match a statement like
isValid() - Method in class ac.simons.neo4j.migrations.core.ValidationResult
isValidateOnMigrate() - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig

J

JAVA - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationType: Indicates a Java-based migration.
JavaBasedMigration - Interface in ac.simons.neo4j.migrations.core: Interface to be implemented for Java-based migrations.

L

LINE_DELIMITER - Static variable in class ac.simons.neo4j.migrations.core.internal.Strings: Pattern used for splitting lines.
LOCAL - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationChain.ChainBuilderMode: Build a chain only based on locally discovered migrations and assume all migrations are pending.
Location - Class in ac.simons.neo4j.migrations.core.internal
Location.LocationType - Enum in ac.simons.neo4j.migrations.core.internal: A location type.
LOCATIONS_TO_SCAN - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default locations to scan (with a Location.LocationType prefix).
LOCATIONS_TO_SCAN_VALUE - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default locations to scan (with a Location.LocationType prefix).
LOCATIONS_TO_SCAN_WITHOUT_PREFIX - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default package or folder name for locations to scan, agnostic to classpath or filesystem.
logTo(Logger, boolean) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig: Helper method to pretty print this configuration into a logger (on level INFO respectively WARNING.

M

Messages - Enum in ac.simons.neo4j.migrations.core.internal: Accessor to messages shared between the core module and extensions.
Migration - Interface in ac.simons.neo4j.migrations.core: Base interface for any migration.
MigrationChain - Interface in ac.simons.neo4j.migrations.core: Public information about an applied migration.
MigrationChain.ChainBuilderMode - Enum in ac.simons.neo4j.migrations.core: Used for selecting how the MigrationChain should be computed.
MigrationChain.Element - Interface in ac.simons.neo4j.migrations.core: A chain element describing a pending or applied migration.
MigrationContext - Interface in ac.simons.neo4j.migrations.core: Parameter object / context for migrations to be applied.
Migrations - Class in ac.simons.neo4j.migrations.core: Main entry to Neo4j Migrations
Migrations(MigrationsConfig, Driver) - Constructor for class ac.simons.neo4j.migrations.core.Migrations: Creates a migrations instance ready to used with the given configuration over the connection defined by the driver.
MigrationsConfig - Class in ac.simons.neo4j.migrations.core: Configuration for Migrations.
MigrationsConfig.Builder - Class in ac.simons.neo4j.migrations.core: A builder to create new instances of configurations.
MigrationsConfig.TransactionMode - Enum in ac.simons.neo4j.migrations.core: Used for configuring the transaction mode in Cypher-based transactions.
MigrationsException - Exception in ac.simons.neo4j.migrations.core: An unchecked exception that is thrown when something didn't work as expected.
MigrationsException(String) - Constructor for exception ac.simons.neo4j.migrations.core.MigrationsException: Constructs a new exception with the given message.
MigrationsException(String, Throwable) - Constructor for exception ac.simons.neo4j.migrations.core.MigrationsException: Constructs a new exception with the given message and cause.
MigrationState - Enum in ac.simons.neo4j.migrations.core: State of a migration.
MigrationType - Enum in ac.simons.neo4j.migrations.core: Type of a migration.
MigrationVersion - Class in ac.simons.neo4j.migrations.core: A migrations version.

N

needsRepair() - Method in class ac.simons.neo4j.migrations.core.ValidationResult: If this method returns false, the database is either valid or the resolved migrations can be applied to bring the database into a valid state.
Neo4jVersionComparator - Class in ac.simons.neo4j.migrations.core.internal: Compares two Neo4j versions.
Neo4jVersionComparator() - Constructor for class ac.simons.neo4j.migrations.core.internal.Neo4jVersionComparator

O

of(String) - Static method in class ac.simons.neo4j.migrations.core.internal.Location: Creates a new Location object from a given location that has an optional prefix (protocol) and a name
OperationResult - Interface in ac.simons.neo4j.migrations.core: Represents the result of some operations.

P

PENDING - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationState: A pending migration (available as Java or Cypher-based migration)
PER_MIGRATION - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationsConfig.TransactionMode: Run all statements in one transaction.
PER_STATEMENT - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationsConfig.TransactionMode: Runs each statement in a separate transaction.
prettyPrint() - Method in class ac.simons.neo4j.migrations.core.CleanResult
prettyPrint() - Method in interface ac.simons.neo4j.migrations.core.MigrationChain: Pretty prints this chain as an ASCII table.
prettyPrint() - Method in interface ac.simons.neo4j.migrations.core.OperationResult
prettyPrint() - Method in class ac.simons.neo4j.migrations.core.ValidationResult

R

Reflections - Class in ac.simons.neo4j.migrations.core.internal: Utilities to deal with some minor reflection tasks.
REMOTE - Enum constant in enum ac.simons.neo4j.migrations.core.MigrationChain.ChainBuilderMode: Build a chain only based on remotely applied migrations and assume all migrations are applied.

S

scan(List<String>) - Method in interface ac.simons.neo4j.migrations.core.ClasspathResourceScanner: Scan the given locations for resources matching the criteria of this scanner.
Strings - Class in ac.simons.neo4j.migrations.core.internal: Internally used String utilities.

T

toCamelCase(String) - Static method in class ac.simons.neo4j.migrations.core.internal.Strings: Transforms a string with words separated by _ into a camelCase string.
toString() - Method in class ac.simons.neo4j.migrations.core.MigrationVersion
TRANSACTION_MODE - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default transaction mode to use.
TRANSACTION_MODE_VALUE - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Same as Defaults.LOCATIONS_TO_SCAN but as string value to be used in configuration that requires defaults given as string.

U

UNDEFINED - Enum constant in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: The database is in an undefined state.

V

VALID - Enum constant in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: The combined state of migrations resolved and applied to the target database is valid.
validate() - Method in class ac.simons.neo4j.migrations.core.Migrations: Validates the database against the resolved migrations.
VALIDATE_ON_MIGRATE - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Default setting for validateOnMigrate.
VALIDATE_ON_MIGRATE_VALUE - Static variable in class ac.simons.neo4j.migrations.core.Defaults: Same as Defaults.VALIDATE_ON_MIGRATE but as string value to be used in configuration that requires defaults given as string.
ValidationResult - Class in ac.simons.neo4j.migrations.core: The result of the Migrations.validate() operation.
ValidationResult.Outcome - Enum in ac.simons.neo4j.migrations.core: The outcome of the validation.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.internal.Location.LocationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.internal.Messages: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.MigrationChain.ChainBuilderMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.MigrationsConfig.TransactionMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.MigrationState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.MigrationType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: Returns the enum constant of this type with the specified name.
values() - Static method in enum ac.simons.neo4j.migrations.core.internal.Location.LocationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ac.simons.neo4j.migrations.core.internal.Messages: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ac.simons.neo4j.migrations.core.MigrationChain.ChainBuilderMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ac.simons.neo4j.migrations.core.MigrationsConfig.TransactionMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ac.simons.neo4j.migrations.core.MigrationState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ac.simons.neo4j.migrations.core.MigrationType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ac.simons.neo4j.migrations.core.ValidationResult.Outcome: Returns an array containing the constants of this enum type, in the order they are declared.

W

withAutocrlf(boolean) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: If you’re programming on Windows and working with people who are not (or vice-versa), you’ll probably run into line-ending issues at some point.
withDatabase(String) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the database to apply Cypher-based migrations too.
withImpersonatedUser(String) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the impersonated user to use.
withInstalledBy(String) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the user / principal name of the that is recorded in the MIGRATED_TO relationship as by.
withLocationsToScan(String...) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the list of locations to scan.
withMigrationClassesDiscoverer(Discoverer<JavaBasedMigration>) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder
withPackagesToScan(String...) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the list of packages to scan.
withResourceScanner(ClasspathResourceScanner) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder
withSchemaDatabase(String) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the schema database to use.
withTransactionMode(MigrationsConfig.TransactionMode) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Configures the transaction mode.
withValidateOnMigrate(boolean) - Method in class ac.simons.neo4j.migrations.core.MigrationsConfig.Builder: Validating helps you verify that the migrations applied to the database match the ones available locally and is on by default.

A B C D E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form