MigrateRunnerCommands
class MigrateRunnerCommands extends DrushCommands implements ConfigAwareInterface (View source)
Migrate runner commands.
Traits
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
Properties
| protected CommandData|null | $commandData | from DrushCommands | |
| protected KeyValueStoreInterface | $keyValue | The key-value store service. |
|
| protected MigrationPluginManagerInterface|null | $migrationPluginManager |
Methods
Starts a background browser/tab for the current site or a specified URL.
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
No description
Persist commandData for use in primary command callback. Used by 'topic' commands.
Print the contents of a file. The path comes from the @topic annotation.
No description
Provide a migration plugin manager.
List all migrations with current status.
Returns the migration source rows count.
Returns the number of items that needs update.
Returns the number of unprocessed items.
Returns the number of imported items.
Returns the last imported date/time if any.
Pads an incomplete table row with empty cells.
Perform one or more migration processes.
Executes a single migration.
Rollback one or more migrations.
Stop an active migration operation.
Reset an active migration's status to idle.
View any messages associated with a migration.
List the fields available for mapping in a source.
Retrieves a list of active migrations.
Returns the migrate message logger.
Get the source ID keys.
Validates a migration ID is valid.
Details
bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)
Starts a background browser/tab for the current site or a specified URL.
Uses a non-blocking Process call, so Drush execution will continue.
static bool
programExists($program)
No description
static string
getEditor(string|null $editor = null)
No description
DrushConfig
getConfig()
Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.
__construct(DateFormatterInterface $dateFormatter, KeyValueFactoryInterface $keyValueFactory)
No description
protected SymfonyStyle
io()
Override Robo's IO function with our custom style.
protected DrushLoggerManager|null
logger()
Returns a logger object.
protected void
printFile(string $file)
Print the contents of a file.
preHook(CommandData $commandData)
Persist commandData for use in primary command callback. Used by 'topic' commands.
protected
printFileTopic(CommandData $commandData)
Print the contents of a file. The path comes from the @topic annotation.
protected HandlerStack
getStack()
Get a Guzzle handler stack that uses the Drush logger.
static MigrateRunnerCommands
create(ContainerInterface $container)
No description
setMigrationPluginManager(MigrationPluginManagerInterface $migrationPluginManager)
Provide a migration plugin manager.
RowsOfFields
status(string|null $migrationIds = null, array $options = ['tag' => self::REQ, 'format' => 'table'])
List all migrations with current status.
protected int|null
getMigrationSourceRowsCount(MigrationInterface $migration)
Returns the migration source rows count.
protected int
getMigrationNeedingUpdateCount(MigrationInterface $migration)
Returns the number of items that needs update.
protected int|null
getMigrationUnprocessedCount(MigrationInterface $migration)
Returns the number of unprocessed items.
protected int|null
getMigrationImportedCount(MigrationInterface $migration)
Returns the number of imported items.
protected string
getMigrationLastImportedTime(MigrationInterface $migration)
Returns the last imported date/time if any.
protected array
padTableRow(array $row, array $fields)
Pads an incomplete table row with empty cells.
void
import(string|null $migrationIds = null, array $options = ['all' => false, 'tag' => self::REQ, 'limit' => self::REQ, 'feedback' => self::REQ, 'idlist' => self::REQ, 'update' => false, 'force' => false, 'execute-dependencies' => false, 'timestamp' => false, 'total' => false, 'progress' => true, 'delete' => false])
Perform one or more migration processes.
protected void
executeMigration(MigrationInterface $migration, string $migrationId, array $userData)
Executes a single migration.
If the --execute-dependencies option was given, the migration's dependencies will also be executed first.
void
rollback(string|null $migrationIds = null, array $options = ['all' => false, 'tag' => self::REQ, 'feedback' => self::REQ, 'idlist' => self::REQ, 'progress' => true])
Rollback one or more migrations.
void
stop(string $migrationId)
Stop an active migration operation.
void
resetStatus(string $migrationId)
Reset an active migration's status to idle.
RowsOfFields
messages(string $migrationId, array $options = ['idlist' => self::REQ, 'format' => 'table'])
View any messages associated with a migration.
protected array
preprocessMessageRow(StdClass $row, array $sourceIdKeys)
Preprocesses migrate message rows.
Given an item inside the list generated by MigrateIdMapInterface::getMessages(), prepare it for display.
RowsOfFields
fieldsSource(string $migrationId, $options = ['format' => 'table'])
List the fields available for mapping in a source.
protected array
getMigrationList(string|null $migrationIds, string|null $tags)
Retrieves a list of active migrations.
protected MigrateMessageInterface
getMigrateMessage()
Returns the migrate message logger.
protected array
getSourceIdKeys(MigrateIdMapInterface $idMap)
Get the source ID keys.
CommandError|null
validateMigrationId(CommandData $commandData)
Validates a migration ID is valid.
If the argument to be validated is not named migrationId, pass the argument name as the value of the annotation.