org.neo4j.consistency.CheckConsistencyCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-consistency-check Show documentation
Show all versions of neo4j-consistency-check Show documentation
Tool for checking consistency of a Neo4j data store.
/*
* Copyright (c) 2002-2020 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see additionalConfigFile;
final Path reportDir;
final Optional backupPath;
final boolean checkGraph;
final boolean checkIndexes;
final boolean checkIndexStructure;
final boolean checkLabelScanStore;
final boolean checkPropertyOwners;
try
{
database = arguments.parse( args ).get( ARG_DATABASE );
backupPath = arguments.getOptionalPath( "backup" );
verbose = arguments.getBoolean( "verbose" );
additionalConfigFile = arguments.getOptionalPath( "additional-config" );
reportDir = arguments.getOptionalPath( "report-dir" )
.orElseThrow( () -> new IllegalArgumentException( "report-dir must be a valid path" ) );
}
catch ( IllegalArgumentException e )
{
throw new IncorrectUsage( e.getMessage() );
}
if ( backupPath.isPresent() )
{
if ( arguments.has( ARG_DATABASE ) )
{
throw new IncorrectUsage( "Only one of '--" + ARG_DATABASE + "' and '--backup' can be specified." );
}
if ( !backupPath.get().toFile().isDirectory() )
{
throw new CommandFailed( format( "Specified backup should be a directory: %s", backupPath.get() ) );
}
}
Config config = loadNeo4jConfig( homeDir, configDir, database, loadAdditionalConfig( additionalConfigFile ) );
try
{
// We can remove the loading from config file in 4.0
if ( arguments.has( CHECK_GRAPH ) )
{
checkGraph = arguments.getBoolean( CHECK_GRAPH );
}
else
{
checkGraph = config.get( ConsistencyCheckSettings.consistency_check_graph );
}
if ( arguments.has( CHECK_INDEXES ) )
{
checkIndexes = arguments.getBoolean( CHECK_INDEXES );
}
else
{
checkIndexes = config.get( ConsistencyCheckSettings.consistency_check_indexes );
}
if ( arguments.has( CHECK_INDEX_STRUCTURE ) )
{
checkIndexStructure = arguments.getBoolean( CHECK_INDEX_STRUCTURE );
}
else
{
checkIndexStructure = config.get( ConsistencyCheckSettings.consistency_check_index_structure );
}
if ( arguments.has( CHECK_LABEL_SCAN_STORE ) )
{
checkLabelScanStore = arguments.getBoolean( CHECK_LABEL_SCAN_STORE );
}
else
{
checkLabelScanStore = config.get( ConsistencyCheckSettings.consistency_check_label_scan_store );
}
if ( arguments.has( CHECK_PROPERTY_OWNERS ) )
{
checkPropertyOwners = arguments.getBoolean( CHECK_PROPERTY_OWNERS );
}
else
{
checkPropertyOwners = config.get( ConsistencyCheckSettings.consistency_check_property_owners );
}
}
catch ( IllegalArgumentException e )
{
throw new IncorrectUsage( e.getMessage() );
}
try ( FileSystemAbstraction fileSystem = new DefaultFileSystemAbstraction() )
{
File databaseDirectory = backupPath.map( Path::toFile ).orElse( config.get( database_path ) );
DatabaseLayout databaseLayout = DatabaseLayout.of( databaseDirectory );
checkDbState( databaseLayout, config );
ZoneId logTimeZone = config.get( GraphDatabaseSettings.db_timezone ).getZoneId();
// Only output progress indicator if a console receives the output
ProgressMonitorFactory progressMonitorFactory = ProgressMonitorFactory.NONE;
if ( System.console() != null )
{
progressMonitorFactory = ProgressMonitorFactory.textual( System.out );
}
ConsistencyCheckService.Result consistencyCheckResult = consistencyCheckService
.runFullConsistencyCheck( databaseLayout, config, progressMonitorFactory,
FormattedLogProvider.withZoneId( logTimeZone ).toOutputStream( System.out ), fileSystem,
verbose, reportDir.toFile(),
new ConsistencyFlags( checkGraph, checkIndexes, checkIndexStructure, checkLabelScanStore, checkPropertyOwners ) );
if ( !consistencyCheckResult.isSuccessful() )
{
throw new CommandFailed( format( "Inconsistencies found. See '%s' for details.",
consistencyCheckResult.reportFile() ) );
}
}
catch ( ConsistencyCheckIncompleteException | IOException e )
{
throw new CommandFailed( "Consistency checking failed." + e.getMessage(), e );
}
}
private static Config loadAdditionalConfig( Optional additionalConfigFile )
{
if ( additionalConfigFile.isPresent() )
{
try
{
return Config.fromFile( additionalConfigFile.get() ).build();
}
catch ( Exception e )
{
throw new IllegalArgumentException(
String.format( "Could not read configuration file [%s]", additionalConfigFile ), e );
}
}
return Config.defaults();
}
private static void checkDbState( DatabaseLayout databaseLayout, Config additionalConfiguration ) throws CommandFailed
{
try ( FileSystemAbstraction fileSystem = new DefaultFileSystemAbstraction();
JobScheduler jobScheduler = createInitialisedScheduler();
PageCache pageCache = ConfigurableStandalonePageCacheFactory
.createPageCache( fileSystem, additionalConfiguration, jobScheduler ) )
{
assertRecoveryIsNotRequired( fileSystem, pageCache, additionalConfiguration, databaseLayout, new Monitors() );
}
catch ( RecoveryRequiredException rre )
{
throw new CommandFailed( rre.getMessage() );
}
catch ( Exception e )
{
throw new CommandFailed( "Failure when checking for recovery state: '%s'." + e.getMessage(), e );
}
}
private static Config loadNeo4jConfig( Path homeDir, Path configDir, String databaseName, Config additionalConfig )
{
Config config = Config.fromFile( configDir.resolve( Config.DEFAULT_CONFIG_FILE_NAME ) )
.withHome( homeDir )
.withConnectorsDisabled()
.withNoThrowOnFileLoadFailure()
.build();
config.augment( additionalConfig );
config.augment( GraphDatabaseSettings.active_database, databaseName );
return config;
}
public static Arguments arguments()
{
return arguments;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy