org.neo4j.commandline.dbms.ImportCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-dbms Show documentation
Show all versions of neo4j-dbms Show documentation
This component provides management functionality and product surface for Neo4j instances.
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.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 /data/graph.db)." ) );
private static final Arguments csvArguments = new Arguments()
.withArgument( new OptionalNamedArg( "mode", "csv", "csv", "Import a collection of CSV files." ) {
@Override
public String usage()
{
return String.format( "[--%s=%s]", name(), exampleValue() );
}
} )
.withDatabase()
.withAdditionalConfig()
.withArgument( new OptionalNamedArg( "report-file", "filename", DEFAULT_REPORT_FILE_NAME,
"File in which to store the report of the csv-import." ) )
.withArgument( new OptionalNamedArg( "nodes[:Label1:Label2]", "\"file1,file2,...\"", "",
"Node CSV header and data. Multiple files will be logically seen as " +
"one big file from the perspective of the importer. The first line " +
"must contain the header. Multiple data sources like these can be " +
"specified in one import, where each data source has its own header. " +
"Note that file groups must be enclosed in quotation marks." ) )
.withArgument( new OptionalNamedArg( "relationships[:RELATIONSHIP_TYPE]", "\"file1,file2,...\"", "",
"Relationship CSV header and data. Multiple files will be logically " +
"seen as one big file from the perspective of the importer. The first " +
"line must contain the header. Multiple data sources like these can be " +
"specified in one import, where each data source has its own header. " +
"Note that file groups must be enclosed in quotation marks." ) )
.withArgument( new OptionalNamedArg( "id-type", new String[]{"STRING", "INTEGER", "ACTUAL"},
"STRING", "Each node must provide a unique id. This is used to find the correct " +
"nodes when creating relationships. Possible values are\n" +
" STRING: arbitrary strings for identifying nodes,\n" +
" INTEGER: arbitrary integer values for identifying nodes,\n" +
" ACTUAL: (advanced) actual node ids.\n" +
"For more information on id handling, please see the Neo4j Manual: " +
"https://neo4j.com/docs/operations-manual/current/tools/import/" ) )
.withArgument( new OptionalNamedArg( "input-encoding", "character-set", "UTF-8",
"Character set that input data is encoded in." ) );
private static final Arguments allArguments = new Arguments()
.withDatabase()
.withAdditionalConfig()
.withArgument( new OptionalNamedArg( "mode", allowedModes, "csv",
"Import a collection of CSV files or a pre-3.0 installation." ) )
.withArgument( new OptionalNamedArg( "from", "source-directory", "",
"The location of the pre-3.0 database (e.g. /data/graph.db)." ) )
.withArgument( new OptionalNamedArg( "report-file", "filename", DEFAULT_REPORT_FILE_NAME,
"File in which to store the report of the csv-import." ) )
.withArgument( new OptionalNamedArgWithMetadata( "nodes",
":Label1:Label2",
"\"file1,file2,...\"", "",
"Node CSV header and data. Multiple files will be logically seen as " +
"one big file from the perspective of the importer. The first line " +
"must contain the header. Multiple data sources like these can be " +
"specified in one import, where each data source has its own header. " +
"Note that file groups must be enclosed in quotation marks." ) )
.withArgument( new OptionalNamedArgWithMetadata( "relationships",
":RELATIONSHIP_TYPE",
"\"file1,file2,...\"",
"",
"Relationship CSV header and data. Multiple files will be logically " +
"seen as one big file from the perspective of the importer. The first " +
"line must contain the header. Multiple data sources like these can be " +
"specified in one import, where each data source has its own header. " +
"Note that file groups must be enclosed in quotation marks." ) )
.withArgument( new OptionalNamedArg( "id-type", new String[]{"STRING", "INTEGER", "ACTUAL"},
"STRING", "Each node must provide a unique id. This is used to find the correct " +
"nodes when creating relationships. Possible values are:\n" +
" STRING: arbitrary strings for identifying nodes,\n" +
" INTEGER: arbitrary integer values for identifying nodes,\n" +
" ACTUAL: (advanced) actual node ids.\n" +
"For more information on id handling, please see the Neo4j Manual: " +
"https://neo4j.com/docs/operations-manual/current/tools/import/" ) )
.withArgument( new OptionalNamedArg( "input-encoding", "character-set", "UTF-8",
"Character set that input data is encoded in." ) );
public static Arguments databaseArguments()
{
return databaseArguments;
}
public static Arguments csvArguments()
{
return csvArguments;
}
public static Arguments allArguments()
{
return allArguments;
}
private final Path homeDir;
private final Path configDir;
private final OutsideWorld outsideWorld;
private final ImporterFactory importerFactory;
public ImportCommand( Path homeDir, Path configDir, OutsideWorld outsideWorld )
{
this( homeDir, configDir, outsideWorld, new ImporterFactory() );
}
ImportCommand( Path homeDir, Path configDir, OutsideWorld outsideWorld, ImporterFactory importerFactory )
{
this.homeDir = homeDir;
this.configDir = configDir;
this.outsideWorld = outsideWorld;
this.importerFactory = importerFactory;
}
@Override
public void execute( String[] args ) throws IncorrectUsage, CommandFailed
{
String mode;
Optional additionalConfigFile;
String database;
try
{
mode = allArguments.parse( args ).get("mode" );
database = allArguments.get( "database" );
additionalConfigFile = allArguments.getOptionalPath( "additional-config" );
}
catch ( IllegalArgumentException e )
{
throw new IncorrectUsage( e.getMessage() );
}
try
{
Config config =
loadNeo4jConfig( homeDir, configDir, database, loadAdditionalConfig( additionalConfigFile ) );
Validators.CONTAINS_NO_EXISTING_DATABASE
.validate( config.get( DatabaseManagementSystemSettings.database_path ) );
Importer importer = importerFactory.getImporterForMode( mode, Args.parse( args ), config, outsideWorld );
importer.doImport();
}
catch ( IllegalArgumentException e )
{
throw new IncorrectUsage( e.getMessage() );
}
catch ( IOException e )
{
throw new RuntimeException( e );
}
}
private Map loadAdditionalConfig( Optional additionalConfigFile )
{
if ( additionalConfigFile.isPresent() )
{
try
{
return MapUtil.load( additionalConfigFile.get().toFile() );
}
catch ( IOException e )
{
throw new IllegalArgumentException(
String.format( "Could not read configuration file [%s]", additionalConfigFile ), e );
}
}
return new HashMap<>();
}
private static Config loadNeo4jConfig( Path homeDir, Path configDir, String databaseName,
Map additionalConfig )
{
ConfigLoader configLoader = new ConfigLoader( settings() );
Config config = configLoader.loadOfflineConfig( Optional.of( homeDir.toFile() ),
Optional.of( configDir.resolve( "neo4j.conf" ).toFile() ) );
additionalConfig.put( DatabaseManagementSystemSettings.active_database.name(), databaseName );
return config.with( additionalConfig );
}
private static List> settings()
{
return Arrays.asList( GraphDatabaseSettings.class, DatabaseManagementSystemSettings.class );
}
}