CleanCommand class

Inheritance
Implemented types
Mixed-in types

Constructors

CleanCommand.new()

Properties

aliases List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
The argument parser for this command.
no setterinherited
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
category String
The command's category.
no setteroverride
description String
A description of this command, included in usage.
no setteroverride
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
hidden bool
Whether or not this command should be hidden from help listings.
no setterinherited
invocation String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
name String
The name of this command.
no setteroverride
parent → Command<int>?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner<int>?
The command runner for this command.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
subcommands Map<String, Command<int>>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases List<String>
Alternate non-functional names for this command.
no setterinherited
summary String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter String?
An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command<int> command) → void
Adds Command as a subcommand of this.
inherited
clearError() → void
Clear the current error line and return the caret.
inherited
clearInfo() → void
Clear the current info line and return the caret.
inherited
error(String message) → void
Append the current error line with message.
inherited
errorC(String message) → void
Rewrite the current error line with message.
inherited
errorCLn(String message) → void
Rewrite the current error line with message and start the next line.
inherited
errorLn(String message) → void
Append the current error line with message and start the next line.
inherited
getPassword(String userName) String
inherited
getPostgresHomeUrl(EnvConfig env) String
inherited
getPostgresUrl(EnvConfig env) String
inherited
info(String message) → void
Append the current info line with message.
inherited
infoC(String message) → void
Rewrite the current info line with message.
inherited
infoCLn(String message) → void
Rewrite the current info line with message and start the next line.
inherited
infoLn(String message) → void
Append the current info line with message and start the next line.
inherited
loadConfig() Future<Config>
inherited
loadEnv([Config? config]) Future<EnvConfig?>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onAfterPreparingError(String reason) → void
Occurs when after_prepare.sql script fails.
override
onBeforePreparingError(String reason) → void
Occurs when before_prepare.sql script fails.
override
onCleanupFailed(String reason) → void
Occurs when the cleanup process fails due to the specified reason.
override
onCleanupStarted() → void
Occurs when all migrations are rolled back in the database and there is no any migration to be committed.
override
onCleanupSucceeded() → void
Occurs when the cleanup process succeeds.
override
onMigrationRollbackFailed(int migration, String reason) → void
Occurs when the specified migration fails to rollback due to the specified reason.
override
onMigrationsTableError(String tableName, String reason) → void
Occurs when the migrations table creation fails.
override
onPreparingStarted() → void
Occurs when the preparing process starts.
override
onPreparingSucceeded() → void
Occurs when the preparing process succeeds.
override
onRollbackFailed(String reason) → void
Occurs when the rollback process fails due to the specified reason.
override
onRollbackForbidden(int number) → void
Occurs when the rollback process with the specified number of migrations is aborted for safety reason.
override
onRollbackStarted(int number) → void
Occurs when the rollback process starts with the specified number of migrations to be rolled back.
override
onRollbackSucceeded(int number) → void
Occurs when the rollback process succeeds with the specified number of rolled back migrations.
override
onScanningError(String reason) → void
Occurs when the migration scanning process fails.
override
onScanningStarted() → void
Occurs when the migration scanning process starts.
override
onScanningSucceeded() → void
Occurs when the migration scanning process succeeds.
override
printUsage() → void
Prints the usage information for this command.
inherited
run() Future<int>
Runs this command.
override
toString() String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited