add a mysql-query utility

[staabm]

in our recipe we added a utility function, which allows to send sql queries to e.g. do database migrations or set some required flags/properties within the database.

currently the impl looks like

/**
 * Allows to exectue a sql query on the remote database using the given access credentials.
 *
 * @param string $query
 *
 * @return string[][]|null A array containing the result of a SELECT query, or null on writable queries
 * @phpstan-return list<list<string>>|null
 */
function runMysqlQuery($query, DbCredentials $dbCredentials)
{
    $data = run('mysql --default-character-set=utf8 --silent --raw --skip-column-names --execute '.AsyncProcess::escapeArgument(escapeRun($query)).' '.$dbCredentials->asCliArgs());
    $data = trim($data);

    if (!$data) {
        if (false !== stripos($query, 'SELECT')) {
            return [];
        } else {
            return null;
        }
    }

    $rows = [];
    foreach (explode("\n", $data) as $line) {
        $row = explode("\t", $line);
        $rows[] = $row;
    }

    return $rows;
}

what do you think about adding such utility directly into deployer?

[antonmedv]

I think it will be cool, but it must be generic and should support some other databases.