1. class
  2. Drush
  3. \
  4. Sql
  5. \
  6. SqlMysql

SqlMysql

class SqlMysql extends SqlBase (View source)

Traits

ExecTrait
SqlTableSelectionTrait

Note: when using this trait, also implement ConfigAwareInterface/ConfigAwareTrait.

ConfigAwareTrait
ConfigAwareTrait

Properties

protected ConfigInterface $config from  ConfigAwareTrait
string $queryExtra
string $queryFile from  SqlBase
protected Process $process from  SqlBase
protected $uri from  ExecTrait
protected string $version

Methods

array
getExpandedTableSelection(array $options, array $all_tables)

Given a list of all tables, expand the convert the wildcards in the option-provided lists into a list of actual table names.

from  SqlTableSelectionTrait
array
expandAndFilterTables(array $tables, array $db_tables)

Given the table names in the input array that may contain wildcards (*), expand the table names so that the array returned only contains table names that exist in the database.

from  SqlTableSelectionTrait
array
expandWildcardTables(array $tables, array $db_tables)

Expand wildcard tables.

from  SqlTableSelectionTrait
array
filterTables(array $tables, array $db_tables)

Filters tables.

from  SqlTableSelectionTrait
array
getTableSelection(array $options)

Construct an array that places table names in appropriate buckets based on whether the table is to be skipped, included for structure only, or have structure and data dumped.

from  SqlTableSelectionTrait
array
getRawTableList(string $option_name, array $options)

Consult the specified options and return the list of tables specified.

from  SqlTableSelectionTrait
$this
setConfig(ConfigInterface $config)

Set the config management object.

from  ConfigAwareTrait
ConfigInterface
getConfig()

Get the config management object.

from  ConfigAwareTrait
static 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().

from  ConfigAwareTrait
static 
configClassIdentifier($classname)

No description

from  ConfigAwareTrait
static 
configPostfix()

No description

from  ConfigAwareTrait
static 
configure(string $key, mixed $value, ConfigInterface|null $config = null)

No description

from  ConfigAwareTrait
mixed|null
getConfigValue(string $key, mixed|null $default = null)

No description

from  ConfigAwareTrait
__construct(array $dbSpec, array $options)

Typically, SqlBase instances are constructed via SqlBase::create($options).

from  SqlBase
array
getEnv()

Get environment variables to pass to Process.

from  SqlBase
Process
getProcess()

Get the last used Process.

from  SqlBase
void
setProcess(Process $process)

No description

from  SqlBase
static SqlBase|null
create(array $options = [])

Get a driver specific instance of this class.

from  SqlBase
static SqlBase|null
getInstance($db_spec, $options)

No description

from  SqlBase
array
getDbSpec()

No description

from  SqlBase
void
setDbSpec(array $dbSpec)

Set the current db spec.

from  SqlBase
string
command()

The unix command used to connect to the database.

string
connect(bool $hide_password = true)

A string for connecting to a database.

from  SqlBase
string|bool|null
dump()

No description

from  SqlBase
string
addPipeFail(string $cmd, string $pipefail)

Handle 'pipefail' option for the specified command.

from  SqlBase
string
dumpCmd($table_selection)

No description

string|null
dumpFile($file)

No description

from  SqlBase
bool|null
query(string $query, $input_file = null, $result_file = '')

Execute a SQL query. Respect simulate mode.

from  SqlBase
bool
alwaysQuery(string $query, $input_file = null, string|null $result_file = '')

Execute a SQL query. Always execute regardless of simulate mode.

from  SqlBase
void
logQueryInDebugMode($query, $input_file_original)

Show the query in debug mode and simulate mode

from  SqlBase
string|null
silent()

No description

string|null
queryPrefix($query)

No description

from  SqlBase
queryFormat($query)

No description

from  SqlBase
bool|null
drop(array $tables)

Drop specified database.

from  SqlBase
string
createdbSql(string $dbname, bool $quoted = false)

Build a SQL string for dropping and creating a database.

bool|null
createdb(bool $quoted = false)

Create a new database.

from  SqlBase
bool
dropOrCreate()

Drop all tables (if DB exists) or CREATE target database.

from  SqlBase
bool
dbExists()

No description

string
creds(bool $hide_password = true)

Build a string containing connection credentials.

string
scheme()

The active database driver.

from  SqlBase
array
listTables()

Extract the name of all existing tables in the given database.

array
listTablesQuoted()

Extract the name of all existing tables in the given database.

string
paramsToOptions($parameters)

No description

from  SqlBase
void
su()

Adjust DB connection with superuser credentials if provided.

from  SqlBase
array
getOptions()

No description

from  SqlBase
getOption($name, $default = null)

No description

from  SqlBase
static array
dbSpecFromDbUrl($db_url)

Convert from an old-style database URL to an array of database settings.

from  SqlBase
array
alwaysQueryCommand($input_file)

Start building the command to run a query.

from  SqlBase
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.

from  ExecTrait
static bool
programExists($program)

No description

from  ExecTrait
static string
getEditor(string|null $editor = null)

No description

from  ExecTrait
static 
make(array $dbSpec, array $options)

A factory method which creates a mysql or mariadb instance as needed.

string
dumpProgram()

No description

string
getVersion()

The server version.

void
setVersion(string $version)

No description

Details

in SqlTableSelectionTrait at line 25
array getExpandedTableSelection(array $options, array $all_tables)

Given a list of all tables, expand the convert the wildcards in the option-provided lists into a list of actual table names.

Parameters

array $options

An options array as passed to an Annotated Command.
array $all_tables

A list of all eligible tables.

Return Value

array

An array of tables with each table name in the appropriate element of the array.

in SqlTableSelectionTrait at line 54
array expandAndFilterTables(array $tables, array $db_tables)

Given the table names in the input array that may contain wildcards (*), expand the table names so that the array returned only contains table names that exist in the database.

Parameters

array $tables

An array of table names where the table names may contain the * wildcard character.
array $db_tables

The list of tables present in a database.

Return Value

array

An array of tables with non-existent tables removed.

in SqlTableSelectionTrait at line 73
array expandWildcardTables(array $tables, array $db_tables)

Expand wildcard tables.

Parameters

array $tables

An array of table names, some of which may contain wildcards (*).
array $db_tables

An array with all the existing table names in the current database.

Return Value

array

$tables array with wildcards resolved to real table names.

in SqlTableSelectionTrait at line 100
array filterTables(array $tables, array $db_tables)

Filters tables.

Parameters

array $tables

An array of table names to filter.
array $db_tables

An array with all the existing table names in the current database.

Return Value

array

An array with only valid table names (i.e. all of which actually exist in the database).

in SqlTableSelectionTrait at line 125
array getTableSelection(array $options)

Construct an array that places table names in appropriate buckets based on whether the table is to be skipped, included for structure only, or have structure and data dumped.

The keys of the array are:

  • skip: tables to be skipped completed in the dump
  • structure: tables to only have their structure i.e. DDL dumped
  • tables: tables to have structure and data dumped

Parameters

array $options

Return Value

array

An array of table names with each table name in the appropriate element of the array.

in SqlTableSelectionTrait at line 148
array getRawTableList(string $option_name, array $options)

Consult the specified options and return the list of tables specified.

Parameters

string $option_name

The option name to check: skip-tables, structure-tables or tables. This function will check both -key and -list.
array $options

An options array as passed to an Annotated Command.

Return Value

array

Returns an array of tables based on the first option found, or an empty array if there were no matches.

in ConfigAwareTrait at line 22
$this setConfig(ConfigInterface $config)

Set the config management object.

Parameters

ConfigInterface $config

Return Value

$this

in ConfigAwareTrait at line 34
ConfigInterface getConfig()

Get the config management object.

Return Value

ConfigInterface

in ConfigAwareTrait at line 47
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().

Return Value

string

in ConfigAwareTrait at line 52
static protected configClassIdentifier($classname)

No description

Parameters

$classname

in ConfigAwareTrait at line 60
static protected configPostfix()

No description

in ConfigAwareTrait at line 84
static configure(string $key, mixed $value, ConfigInterface|null $config = null)

No description

Parameters

string $key
mixed $value
ConfigInterface|null $config

in ConfigAwareTrait at line 98
protected mixed|null getConfigValue(string $key, mixed|null $default = null)

No description

Parameters

string $key
mixed|null $default

Return Value

mixed|null

in SqlBase at line 55
__construct(array $dbSpec, array $options)

Typically, SqlBase instances are constructed via SqlBase::create($options).

Parameters

array $dbSpec
array $options

in SqlBase at line 65
array getEnv()

Get environment variables to pass to Process.

Return Value

array

in SqlBase at line 73
Process getProcess()

Get the last used Process.

Return Value

Process

in SqlBase at line 78
void setProcess(Process $process)

No description

Parameters

Process $process

Return Value

void

in SqlBase at line 89
static SqlBase|null create(array $options = [])

Get a driver specific instance of this class.

Parameters

array $options

An options array as handed to a command callback.

Return Value

SqlBase|null

in SqlBase at line 119
static SqlBase|null getInstance($db_spec, $options)

No description

Parameters

$db_spec
$options

Return Value

SqlBase|null

in SqlBase at line 150
array getDbSpec()

No description

Return Value

array

in SqlBase at line 158
void setDbSpec(array $dbSpec)

Set the current db spec.

Parameters

array $dbSpec

Return Value

void

at line 41
string command()

The unix command used to connect to the database.

Return Value

string

in SqlBase at line 178
string connect(bool $hide_password = true)

A string for connecting to a database.

Parameters

bool $hide_password

If TRUE, DBMS should try to hide password from process list. On mysql, that means using --defaults-file to supply the user+password.

Return Value

string

in SqlBase at line 190
string|bool|null dump()

No description

Return Value

string|bool|null

in SqlBase at line 235
protected string addPipeFail(string $cmd, string $pipefail)

Handle 'pipefail' option for the specified command.

Parameters

string $cmd

Script command to execute; should contain a pipe command
string $pipefail

Script statements to insert into / wrap around $cmd

Return Value

string

Result varies based on value of $pipefail

  • empty: Return $cmd unmodified
  • simple string: Return $cmd appended to $pipefail
  • interpolated: Add slashes to $cmd and insert in $pipefail

Interpolation is particularly for environments such as Ubuntu that use something other than bash as the default shell. To make pipefail work right in this instance, we must wrap it in 'bash -c', since pipefail is a bash feature.

at line 195
string dumpCmd($table_selection)

No description

Parameters

$table_selection

Return Value

string

in SqlBase at line 271
string|null dumpFile($file)

No description

Parameters

$file

Return Value

string|null

in SqlBase at line 308
bool|null query(string $query, $input_file = null, $result_file = '')

Execute a SQL query. Respect simulate mode.

If you don't want to query results to print during --debug then provide a $result_file whose value can be drush_bit_bucket().

Parameters

string $query

The SQL to be executed. Should be NULL if $input_file is provided.
$input_file

A path to a file containing the SQL to be executed.
$result_file

A path to save query results to. Can be drush_bit_bucket() if desired.

Return Value

bool|null

TRUE on success, FALSE on failure

in SqlBase at line 333
bool alwaysQuery(string $query, $input_file = null, string|null $result_file = '')

Execute a SQL query. Always execute regardless of simulate mode.

If you don't want results to print during --debug then provide a $result_file whose value can be drush_bit_bucket().

Parameters

string $query

The SQL to be executed. Should be null if $input_file is provided.
$input_file

A path to a file containing the SQL to be executed.
string|null $result_file

A path to save query results to. Can be drush_bit_bucket() if desired.

Return Value

bool

TRUE on success, FALSE on failure.

in SqlBase at line 385
protected void logQueryInDebugMode($query, $input_file_original)

Show the query in debug mode and simulate mode

Parameters

$query
$input_file_original

Return Value

void

at line 134
string|null silent()

No description

Return Value

string|null

in SqlBase at line 404
string|null queryPrefix($query)

No description

Parameters

$query

Return Value

string|null

in SqlBase at line 417
queryFormat($query)

No description

Parameters

$query

in SqlBase at line 429
bool|null drop(array $tables)

Drop specified database.

Parameters

array $tables

An array of table names True if successful, FALSE if failed.

Return Value

bool|null

at line 139
string createdbSql(string $dbname, bool $quoted = false)

Build a SQL string for dropping and creating a database.

Parameters

string $dbname

The database name.
bool $quoted

Quote the database name. Mysql uses backticks to quote which can cause problems in a Windows shell. Set TRUE if the CREATE is not running on the bash command line.

Return Value

string

in SqlBase at line 461
bool|null createdb(bool $quoted = false)

Create a new database.

Parameters

bool $quoted

Quote the database name. Mysql uses backticks to quote which can cause problems in a Windows shell. Set TRUE if the CREATE is not running on the bash command line. True if successful, FALSE otherwise.

Return Value

bool|null

in SqlBase at line 476
bool dropOrCreate()

Drop all tables (if DB exists) or CREATE target database.

return TRUE or FALSE depending on success.

Return Value

bool

at line 170
bool dbExists()

No description

Return Value

bool

at line 64
string creds(bool $hide_password = true)

Build a string containing connection credentials.

Parameters

bool $hide_password

If TRUE, DBMS should try to hide password from process list. On mysql, that means using --defaults-file to supply the user+password.

Return Value

string

in SqlBase at line 508
string scheme()

The active database driver.

Return Value

string

at line 176
array listTables()

Extract the name of all existing tables in the given database.

Return Value

array

at line 186
array listTablesQuoted()

Extract the name of all existing tables in the given database.

Return Value

array

An array of table names which exist in the current database, appropriately quoted for the RDMS.

in SqlBase at line 539
string paramsToOptions($parameters)

No description

Parameters

$parameters

Return Value

string

in SqlBase at line 556
void su()

Adjust DB connection with superuser credentials if provided.

Return Value

void

in SqlBase at line 576
array getOptions()

No description

Return Value

array

in SqlBase at line 581
getOption($name, $default = null)

No description

Parameters

$name
$default

in SqlBase at line 595
static array dbSpecFromDbUrl($db_url)

Convert from an old-style database URL to an array of database settings.

Parameters

$db_url

A Drupal 6 db url string to convert, or an array with a 'default' element. An array of database values containing only the 'default' element of the db url. If the parse fails the array is empty.

Return Value

array

in SqlBase at line 606
array alwaysQueryCommand($input_file)

Start building the command to run a query.

Parameters

$input_file

Return Value

array

in ExecTrait at line 28
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.

Parameters

string|null $uri

Optional URI or site path to open in browser. If omitted, or if a site path is specified, the current site home page uri will be prepended if the site's hostname resolves.
int $sleep
int|null $port
string|bool $browser

Return Value

bool

TRUE if browser was opened. FALSE if browser was disabled by the user or a default browser could not be found.

in ExecTrait at line 92
static bool programExists($program)

No description

Parameters

$program

Return Value

bool

in ExecTrait at line 104
static string getEditor(string|null $editor = null)

No description

Parameters

string|null $editor

Return Value

string

at line 22
static make(array $dbSpec, array $options)

A factory method which creates a mysql or mariadb instance as needed.

Parameters

array $dbSpec
array $options

at line 46
string dumpProgram()

No description

Return Value

string

at line 54
string getVersion()

The server version.

Return Value

string

at line 59
void setVersion(string $version)

No description

Parameters

string $version

Return Value

void