3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Console;
24 use Friendica\Core\Config\Cache;
25 use Friendica\Core\Update;
26 use Friendica\Database\Database;
27 use Friendica\Database\DBStructure;
31 * Performs database updates from the command line
33 class DatabaseStructure extends \Asika\SimpleConsole\Console
35 protected $helpOptions = ['h', 'help', '?'];
46 protected function getHelp()
49 console dbstructure - Performs database updates
51 bin/console dbstructure <command> [-h|--help|-?] |-f|--force] [-v]
54 dryrun Show database update schema queries without running them
55 update Update database schema
56 dumpsql Dump database schema
57 toinnodb Convert all tables from MyISAM or InnoDB in the Antelope file format to InnoDB in the Barracuda file format
58 version Set the database to a given number
61 -h|--help|-? Show help information
62 -v Show more debug information.
63 -f|--force Force the update command (Even if the database structure matches)
64 -o|--override Override running or stalling updates
69 public function __construct(Database $dba, Cache $configCache, $argv = null)
71 parent::__construct($argv);
74 $this->configCache = $configCache;
77 protected function doExecute()
79 if ($this->getOption('v')) {
80 $this->out('Class: ' . __CLASS__);
81 $this->out('Arguments: ' . var_export($this->args, true));
82 $this->out('Options: ' . var_export($this->options, true));
85 if (count($this->args) == 0) {
86 $this->out($this->getHelp());
90 if ((count($this->args) > 1) && ($this->getArgument(0) != 'version')) {
91 throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments');
92 } elseif ((count($this->args) != 2) && ($this->getArgument(0) == 'version')) {
93 throw new \Asika\SimpleConsole\CommandArgsException('This command needs two arguments');
96 if (!$this->dba->isConnected()) {
97 throw new RuntimeException('Unable to connect to database');
100 $basePath = $this->configCache->get('system', 'basepath');
102 switch ($this->getArgument(0)) {
104 $output = DBStructure::update($basePath, true, false);
107 $force = $this->getOption(['f', 'force'], false);
108 $override = $this->getOption(['o', 'override'], false);
109 $output = Update::run($basePath, $force, $override,true, false);
113 DBStructure::printStructure($basePath);
114 $output = ob_get_clean();
118 DBStructure::convertToInnoDB();
119 $output = ob_get_clean();
123 DBStructure::setDatabaseVersion($this->getArgument(1));
124 $output = ob_get_clean();
128 $output = 'Unknown command: ' . $this->getArgument(0);