-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(setupchecks): add row format setup check for MySQL databases #48547
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/** | ||
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
* SPDX-License-Identifier: AGPL-3.0-or-later | ||
*/ | ||
namespace OCA\Settings\SetupChecks; | ||
|
||
use Doctrine\DBAL\Platforms\MySQLPlatform; | ||
use OC\DB\Connection; | ||
use OCP\IConfig; | ||
use OCP\IL10N; | ||
use OCP\IURLGenerator; | ||
use OCP\SetupCheck\ISetupCheck; | ||
use OCP\SetupCheck\SetupResult; | ||
|
||
class MysqlRowFormat implements ISetupCheck { | ||
public function __construct( | ||
private IL10N $l10n, | ||
private IConfig $config, | ||
private Connection $connection, | ||
private IURLGenerator $urlGenerator, | ||
) { | ||
} | ||
|
||
public function getName(): string { | ||
return $this->l10n->t('MySQL row format'); | ||
} | ||
|
||
public function getCategory(): string { | ||
return 'database'; | ||
} | ||
|
||
public function run(): SetupResult { | ||
if (!$this->connection->getDatabasePlatform() instanceof MySQLPlatform) { | ||
return SetupResult::success($this->l10n->t('You are not using MySQL')); | ||
} | ||
|
||
$wrongRowFormatTables = $this->getRowNotDynamicTables(); | ||
if (empty($wrongRowFormatTables)) { | ||
return SetupResult::success($this->l10n->t('None of your table use ROW_FORMAT=Compressed')); | ||
} | ||
|
||
return SetupResult::warning( | ||
$this->l10n->n( | ||
'Table %s is not using ROW_FORMAT=Dynamic. This format offers the best database performances for Nextcloud. Please change the row format to Dynamic.', | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. plurals without |
||
'Some tables are not using ROW_FORMAT=Dynamic. This format offers the best database performances for Nextcloud. Please change the row format to Dynamic on the following tables: %s.', | ||
count($wrongRowFormatTables), | ||
[implode(', ', $wrongRowFormatTables)], | ||
), | ||
'https://dev.mysql.com/doc/refman/en/innodb-row-format.html', | ||
); | ||
} | ||
|
||
/** | ||
* @return string[] | ||
*/ | ||
private function getRowNotDynamicTables(): array { | ||
$sql = 'SELECT table_name | ||
FROM information_schema.tables | ||
WHERE table_schema = ? | ||
AND table_name LIKE "*PREFIX*%" | ||
AND row_format != "Dynamic";'; | ||
|
||
return $this->connection->executeQuery( | ||
$sql, | ||
[$this->config->getSystemValueString('dbname')], | ||
)->fetchFirstColumn(); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think it makes sense to introduce something like
SetupResult::skipped
and then filter out the setup checks with severity = skipped by default? If you think so, I would log a feature request.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea!