You are here

Home » API reference » Site Audit 8.3 » DatabaseFragmentation.php

class DatabaseFragmentation in Site Audit 8.3

Provides the CronLast Check.

Plugin annotation


@SiteAuditCheck(
 id = "database_fragmentation",
 name = @Translation("Database Fragmentation"),
 description = @Translation("Detect table fragmentation which increases storage space and decreases I/O efficiency."),
 report = "database"
)

Hierarchy

Expanded class hierarchy of DatabaseFragmentation

File

src/Plugin/SiteAuditCheck/DatabaseFragmentation.php, line 18

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck
View source 
class DatabaseFragmentation extends SiteAuditCheckBase {

  /**
   * {@inheritdoc}.
   */
  public function getResultFail() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    arsort($this->registry->database_fragmentation);
    $header = [
      'table_name' => $this
        ->t('Table Name'),
      'frag_ratio' => $this
        ->t('Fragmentation Ratio'),
    ];
    $rows = [];
    foreach ($this->registry->database_fragmentation as $name => $ratio) {
      $rows[] = [
        'table_name' => $name,
        'frag_ratio' => $ratio,
      ];
    }
    return [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this
      ->getScore() == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
      return $this
        ->t('Run "OPTIMIZE TABLE" on the fragmented tables. Refer to https://dev.mysql.com/doc/en/optimize-table.html for more details.');
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    $connection = Database::getConnection();
    $query = \Drupal::database()
      ->select('information_schema.TABLES', 'ist');
    $query
      ->fields('ist', [
      'TABLE_NAME',
    ]);
    $query
      ->addExpression('ROUND(DATA_LENGTH / 1024 / 1024)', 'data_length');
    $query
      ->addExpression('ROUND(INDEX_LENGTH / 1024 / 1024)', 'index_length');
    $query
      ->addExpression('ROUND(DATA_FREE / 1024 / 1024)', 'data_free');
    $query
      ->condition('ist.DATA_FREE', 0, '>');
    $query
      ->condition('ist.table_schema', $connection
      ->getConnectionOptions()['database']);
    $result = $query
      ->execute();
    while ($row = $result
      ->fetchAssoc()) {
      $data = $row['data_length'] + $row['index_length'];
      if ($data != 0) {
        $free = $row['data_free'];
        $fragmentation_ratio = $free / $data;
        if ($fragmentation_ratio > 0.05) {
          $this->registry->database_fragmentation[$row['TABLE_NAME']] = $fragmentation_ratio;
        }
      }
    }
    if (empty($this->registry->database_fragmentation)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DatabaseFragmentation::calculateScore public function . Overrides SiteAuditCheckBase::calculateScore
DatabaseFragmentation::getAction public function . Overrides SiteAuditCheckBase::getAction
DatabaseFragmentation::getResultFail public function . Overrides SiteAuditCheckBase::getResultFail
DatabaseFragmentation::getResultInfo public function . Overrides SiteAuditCheckBase::getResultInfo
DatabaseFragmentation::getResultPass public function . Overrides SiteAuditCheckBase::getResultPass
DatabaseFragmentation::getResultWarn public function . Overrides SiteAuditCheckBase::getResultWarn
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
SiteAuditCheckBase::$abort protected property Names of checks that should not run as a result of this check.
SiteAuditCheckBase::$options protected property Options passed in for reports and checks.
SiteAuditCheckBase::$optOut protected property User has opted out of this check in configuration.
SiteAuditCheckBase::$percentOverride protected property If set, will override the Report's percentage.
SiteAuditCheckBase::$registry protected property Use for passing data between checks within a report.
SiteAuditCheckBase::$score protected property Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckBase::$static protected property Are we in a static context.
SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN constant
SiteAuditCheckBase::checkInvokeCalculateScore protected function Invoke another check's calculateScore() method if it is needed.
SiteAuditCheckBase::getDescription public function Get a more verbose description of what is being checked.
SiteAuditCheckBase::getId public function Get the ID or machine name for the check.
SiteAuditCheckBase::getLabel public function Get the label for the check that describes, high level what is happening.
SiteAuditCheckBase::getPercentOverride public function Get the report percent override, if any.
SiteAuditCheckBase::getRegistry public function Get the check registry.
SiteAuditCheckBase::getResult public function Determine the result message based on the score.
SiteAuditCheckBase::getScore public function Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckBase::getScoreLabel public function Get a human readable label for a score.
SiteAuditCheckBase::renderAction public function Display action items for a user to perform.
SiteAuditCheckBase::shouldAbort public function Determine whether the check failed so badly that the report must stop.
SiteAuditCheckBase::__construct public function Constructor. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.