Allows neo4j-admin 'database' argument w/ custom description

community/command-line/src/main/java/org/neo4j/commandline/arguments/Arguments.java

@@ -67,6 +67,11 @@ public Arguments withDatabase()
         return withArgument( new Database() );
     }
 
+    public Arguments withDatabase( String description )
+    {
+        return withArgument( new Database( description ) );
+    }
+
     public Arguments withAdditionalConfig()
     {
         return withArgument( new OptionalCanonicalPath( "additional-config", "config-file-path", "",

community/command-line/src/main/java/org/neo4j/commandline/arguments/common/Database.java

@@ -27,9 +27,16 @@
 
 public class Database extends OptionalNamedArg
 {
+    public static final String ARG_DATABASE = "database";
+
     public Database()
     {
-        super( "database", "name", "graph.db", "Name of database." );
+        this( "Name of database." );
+    }
+
+    public Database( String description )
+    {
+        super( ARG_DATABASE, "name", "graph.db", description );
     }
 
     private static String validate( String dbName )

community/consistency-check/src/main/java/org/neo4j/consistency/CheckConsistencyCommand.java

@@ -33,6 +33,7 @@
 import org.neo4j.commandline.admin.OutsideWorld;
 import org.neo4j.commandline.arguments.Arguments;
 import org.neo4j.commandline.arguments.OptionalBooleanArg;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.commandline.arguments.common.OptionalCanonicalPath;
 import org.neo4j.consistency.checking.full.ConsistencyCheckIncompleteException;
 import org.neo4j.consistency.checking.full.ConsistencyFlags;
@@ -50,6 +51,7 @@
 import org.neo4j.logging.FormattedLogProvider;
 
 import static java.lang.String.format;
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
 import static org.neo4j.graphdb.factory.GraphDatabaseSettings.database_path;
 
 public class CheckConsistencyCommand implements AdminCommand
@@ -111,7 +113,7 @@ public void execute( String[] args ) throws IncorrectUsage, CommandFailed
 
         try
         {
-            database = arguments.parse( args ).get( "database" );
+            database = arguments.parse( args ).get( ARG_DATABASE );
             backupPath = arguments.getOptionalPath( "backup" );
             verbose = arguments.getBoolean( "verbose" );
             additionalConfigFile = arguments.getOptionalPath( "additional-config" );
@@ -125,9 +127,9 @@ public void execute( String[] args ) throws IncorrectUsage, CommandFailed
 
         if ( backupPath.isPresent() )
         {
-            if ( arguments.has( "database" ) )
+            if ( arguments.has( ARG_DATABASE ) )
             {
-                throw new IncorrectUsage( "Only one of '--database' and '--backup' can be specified." );
+                throw new IncorrectUsage( "Only one of '--" + ARG_DATABASE + "' and '--backup' can be specified." );
             }
             if ( !backupPath.get().toFile().isDirectory() )
             {

community/dbms/src/main/java/org/neo4j/commandline/dbms/DumpCommand.java

@@ -32,6 +32,7 @@
 import org.neo4j.commandline.admin.CommandFailed;
 import org.neo4j.commandline.admin.IncorrectUsage;
 import org.neo4j.commandline.arguments.Arguments;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.dbms.archive.Dumper;
 import org.neo4j.graphdb.factory.GraphDatabaseSettings;
 import org.neo4j.kernel.StoreLockException;
@@ -41,6 +42,7 @@
 
 import static java.lang.String.format;
 import static org.neo4j.commandline.Util.canonicalPath;
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
 import static org.neo4j.graphdb.factory.GraphDatabaseSettings.database_path;
 import static org.neo4j.graphdb.factory.GraphDatabaseSettings.logical_logs_location;
 
@@ -65,7 +67,7 @@ public DumpCommand( Path homeDir, Path configDir, Dumper dumper )
     @Override
     public void execute( String[] args ) throws IncorrectUsage, CommandFailed
     {
-        String database = arguments.parse( args ).get( "database" );
+        String database = arguments.parse( args ).get( ARG_DATABASE );
         Path archive = calculateArchive( database, arguments.getMandatoryPath( "to" ) );
 
         Config config = buildConfig( database );

community/dbms/src/main/java/org/neo4j/commandline/dbms/ImportCommand.java

@@ -35,12 +35,14 @@
 import org.neo4j.commandline.arguments.OptionalBooleanArg;
 import org.neo4j.commandline.arguments.OptionalNamedArg;
 import org.neo4j.commandline.arguments.OptionalNamedArgWithMetadata;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.graphdb.factory.GraphDatabaseSettings;
 import org.neo4j.helpers.Args;
 import org.neo4j.helpers.collection.MapUtil;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.impl.util.Validators;
 
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
 import static org.neo4j.csv.reader.Configuration.DEFAULT;
 import static org.neo4j.tooling.ImportTool.parseFileArgumentList;
 import static org.neo4j.unsafe.impl.batchimport.Configuration.DEFAULT_MAX_MEMORY_PERCENT;
@@ -220,7 +222,7 @@ public void execute( String[] args ) throws IncorrectUsage, CommandFailed
             {
                 allArguments.parse( parseFileArgumentList( fileArgument.get().toFile() ) );
             }
-            database = allArguments.get( "database" );
+            database = allArguments.get( ARG_DATABASE );
             additionalConfigFile = allArguments.getOptionalPath( "additional-config" );
         }
         catch ( IllegalArgumentException e )

community/dbms/src/main/java/org/neo4j/commandline/dbms/LoadCommand.java

@@ -31,6 +31,7 @@
 import org.neo4j.commandline.admin.IncorrectUsage;
 import org.neo4j.commandline.arguments.Arguments;
 import org.neo4j.commandline.arguments.OptionalBooleanArg;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.commandline.arguments.common.MandatoryCanonicalPath;
 import org.neo4j.dbms.archive.IncorrectFormat;
 import org.neo4j.dbms.archive.Loader;
@@ -43,6 +44,7 @@
 import static org.neo4j.commandline.Util.checkLock;
 import static org.neo4j.commandline.Util.isSameOrChildPath;
 import static org.neo4j.commandline.Util.wrapIOException;
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
 import static org.neo4j.graphdb.factory.GraphDatabaseSettings.database_path;
 import static org.neo4j.graphdb.factory.GraphDatabaseSettings.logical_logs_location;
 
@@ -73,7 +75,7 @@ public void execute( String[] args ) throws IncorrectUsage, CommandFailed
     {
         arguments.parse( args );
         Path archive = arguments.getMandatoryPath( "from" );
-        String database = arguments.get( "database" );
+        String database = arguments.get( ARG_DATABASE );
         boolean force = arguments.getBoolean( "force" );
 
         Config config = buildConfig( database );

community/dbms/src/main/java/org/neo4j/commandline/dbms/MemoryRecommendationsCommand.java

@@ -32,12 +32,14 @@
 import org.neo4j.commandline.arguments.Arguments;
 import org.neo4j.commandline.arguments.OptionalBooleanArg;
 import org.neo4j.commandline.arguments.OptionalNamedArg;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.io.os.OsBeanUtil;
 import org.neo4j.kernel.api.impl.index.storage.FailureStorage;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.impl.store.StoreType;
 
 import static java.lang.String.format;
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
 import static org.neo4j.configuration.ExternalSettings.initialHeapSize;
 import static org.neo4j.configuration.ExternalSettings.maxHeapSize;
 import static org.neo4j.graphdb.factory.GraphDatabaseSettings.database_path;
@@ -76,7 +78,6 @@ public class MemoryRecommendationsCommand implements AdminCommand
             new Bracket( 1024.0, 30, 31 ),
     };
     private static final String ARG_MEMORY = "memory";
-    private static final String ARG_DB = "db";
     private final Path homeDir;
     private final OutsideWorld outsideWorld;
     private final Path configDir;
@@ -132,11 +133,11 @@ public static Arguments buildArgs()
                 .withArgument( new OptionalNamedArg( ARG_MEMORY, memory, memory,
                         "Recommend memory settings with respect to the given amount of memory, " +
                         "instead of the total memory of the system running the command." ) )
-                .withArgument( new OptionalBooleanArg( ARG_DB, false,
-                        "Specific database to calculate page cache memory requirement for. " +
+                .withDatabase(
+                        "Name of specific database to calculate page cache memory requirement for. " +
                         "The generic calculation is still a good generic recommendation for this machine, " +
                         "but there will be an additional calculation for minimal required page cache memory " +
-                        "for mapping all store and index files that are managed by the page cache." ) );
+                        "for mapping all store and index files that are managed by the page cache." );
     }
 
     static String bytesToString( double bytes )
@@ -220,7 +221,7 @@ public void execute( String[] args ) throws IncorrectUsage, CommandFailed
         print( maxHeapSize.name() + "=" + heap );
         print( pagecache_memory.name() + "=" + pagecache );
 
-        boolean db = arguments.getBoolean( ARG_DB );
+        boolean db = arguments.getBoolean( ARG_DATABASE );
         if ( !db )
         {
             return;

enterprise/backup/src/main/java/org/neo4j/restore/RestoreDatabaseCli.java

@@ -29,11 +29,14 @@
 import org.neo4j.commandline.arguments.Arguments;
 import org.neo4j.commandline.arguments.MandatoryNamedArg;
 import org.neo4j.commandline.arguments.OptionalBooleanArg;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.graphdb.factory.GraphDatabaseSettings;
 import org.neo4j.io.fs.DefaultFileSystemAbstraction;
 import org.neo4j.io.fs.FileSystemAbstraction;
 import org.neo4j.kernel.configuration.Config;
 
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
+
 public class RestoreDatabaseCli implements AdminCommand
 {
     private static final Arguments arguments = new Arguments()
@@ -66,7 +69,7 @@ public void execute( String[] incomingArguments ) throws IncorrectUsage, Command
 
         try
         {
-            databaseName = arguments.parse( incomingArguments ).get( "database" );
+            databaseName = arguments.parse( incomingArguments ).get( ARG_DATABASE );
             fromPath = arguments.get( "from" );
             forceOverwrite = arguments.getBoolean( "force" );
         }

enterprise/causal-clustering/src/main/java/org/neo4j/commandline/dbms/UnbindFromClusterCommand.java

@@ -31,12 +31,14 @@
 import org.neo4j.commandline.admin.IncorrectUsage;
 import org.neo4j.commandline.admin.OutsideWorld;
 import org.neo4j.commandline.arguments.Arguments;
+import org.neo4j.commandline.arguments.common.Database;
 import org.neo4j.graphdb.factory.GraphDatabaseSettings;
 import org.neo4j.io.fs.FileUtils;
 import org.neo4j.kernel.StoreLockException;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.impl.util.Validators;
 
+import static org.neo4j.commandline.arguments.common.Database.ARG_DATABASE;
 import static org.neo4j.kernel.configuration.Config.fromFile;
 
 public class UnbindFromClusterCommand implements AdminCommand
@@ -70,7 +72,7 @@ public void execute( String[] args ) throws IncorrectUsage, CommandFailed
     {
         try
         {
-            Config config = loadNeo4jConfig( homeDir, configDir, arguments.parse( args ).get( "database" ) );
+            Config config = loadNeo4jConfig( homeDir, configDir, arguments.parse( args ).get( ARG_DATABASE ) );
             File dataDirectory = config.get( GraphDatabaseSettings.data_directory );
             Path pathToSpecificDatabase = config.get( GraphDatabaseSettings.database_path ).toPath();