SqlCommands
final class SqlCommands extends DrushCommands implements StdinAwareInterface (View source)
Traits
StdinAwareTrait provides the implementation for StdinAwareInterface.
Constants
| REQ |
|
| OPT |
|
| EXIT_SUCCESS |
|
| EXIT_FAILURE |
|
| EXIT_FAILURE_WITH_CLARITY |
|
| CONF |
|
| CONNECT |
|
| CREATE |
|
| DROP |
|
| CLI |
|
| QUERY |
|
| DUMP |
|
Properties
| protected | $uri | from ExecTrait | |
| protected ConfigInterface | $config | from ConfigAwareTrait | |
| protected InputInterface | $input | from InputAwareTrait | |
| protected OutputInterface | $output | from OutputAwareTrait | |
| protected | $io | from IO | |
| protected | $obj | from IO | |
| protected CommandData|null | $commandData | from DrushCommands | |
| protected | $stdinHandler | from StdinAwareTrait |
Methods
Starts a background browser/tab for the current site or a specified URL.
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
No description
No description
Prompt the user until the given validation callback passes.
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.
This method overrides the trait in order to provide a more specific return type.
No description
A string for connecting to the DB.
Create a database.
Drop all tables in a given database.
Open a SQL command-line interface using Drupal's credentials.
Execute a query against a database.
Exports the Drupal DB as SQL using mysqldump or equivalent.
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
$this
setConfig(ConfigInterface $config)
Set the config management object.
ConfigInterface
getConfig()
Get the config management object.
static protected string
configPrefix()
Any class that uses ConfigAwareTrait SHOULD override this method , and define a prefix for its configuration items. This is usually done in a base class. When used, this method should return a string that ends with a "."; see BaseTask::configPrefix().
static protected
configClassIdentifier($classname)
No description
static protected
configPostfix()
No description
static
configure(string $key, mixed $value, ConfigInterface|null $config = null)
No description
protected mixed|null
getConfigValue(string $key, mixed|null $default = null)
No description
$this
setInput(InputInterface $input)
No description
protected InputInterface
input()
No description
protected InputInterface
getInput()
deprecated
deprecated
Backwards compatibility.
$this
setOutput(OutputInterface $output)
No description
protected OutputInterface
output()
No description
protected OutputInterface
stderr()
No description
protected OutputInterface
getOutput()
deprecated
deprecated
Backwards compatibility
in
IO at line 24
currentState()
No description
in
IO at line 32
__construct($obj, $input, $output, $io)
No description
in
IO at line 40
restore()
No description
protected void
configurePrompts(InputInterface $input)
Configure the prompt fallbacks.
protected mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Prompt the user until the given validation callback passes.
protected void
restorePrompts()
Restore the prompts output.
protected bool
runningUnitTests()
No description
protected DrushStyle
io()
Override Robo's IO function with our custom style.
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.
initHook($input, AnnotationData $annotationData)
Configure Laravel prompts package.
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.
ProcessManager
processManager()
This method overrides the trait in order to provide a more specific return type.
setStdinHandler(StdinHandler $stdin)
No description
stdin()
No description
array|null
conf($options = ['format' => 'yaml', 'all' => false, 'show-passwords' => false])
No description
string
connect($options = ['extra' => self::REQ])
A string for connecting to the DB.
void
createDb($options = ['db-su' => self::REQ, 'db-su-pw' => self::REQ, 'extra' => self::REQ])
Create a database.
void
drop($options = ['extra' => self::REQ])
Drop all tables in a given database.
void
cli(InputInterface $input, $options = ['extra' => self::REQ])
Open a SQL command-line interface using Drupal's credentials.
bool
query($query = '', $options = ['result-file' => null, 'file' => self::REQ, 'file-delete' => false, 'extra' => self::REQ, 'db-prefix' => false])
Execute a query against a database.
PropertyList
dump($options = ['result-file' => self::REQ, 'create-db' => false, 'data-only' => false, 'ordered-dump' => false, 'gzip' => false, 'extra' => self::REQ, 'extra-dump' => self::REQ, 'format' => 'null'])
Exports the Drupal DB as SQL using mysqldump or equivalent.
--create-db is used by sql-sync, since including the DROP TABLE statements interferes with the import when the database is created.
validate(CommandData $commandData)
Assert that mysql or similar are on the user's PATH.