class DbHandler in DB Maintenance 7.2

DbHandler class.

Hierarchy

• class \Drupal\db_maintenance\Module\Db\DbHandler

3 files declare their use of DbHandler

AdminHookHandler.php in src/Module/Hook/AdminHookHandler.php

AdminHookHandler class.

CommonHookHandler.php in src/Module/Hook/CommonHookHandler.php

CommonHookHandler class.

db_maintenance.module in ./db_maintenance.module

Optimizes database tables during cron runs.

File

src/Module/Db/DbHandler.php, line 16

DbHandler class.

Namespace

Drupal\db_maintenance\Module\Db

class DbHandler {

  /**
   * Performs the maintenance.
   */
  public static function optimizeTables() {
    global $databases;
    foreach ($databases as $db => $connection) {
      $db_name = $connection['default']['database'];
      $all_tables = ConfigHandler::getProcessAllTables();
      if ($all_tables) {
        $config_tables = self::listTables($db);
      }
      else {
        $config_tables = ConfigHandler::getTableList($db_name);
      }

      // Only proceed if tables are selected for this database.
      if (is_array($config_tables) && count($config_tables) > 0) {
        foreach ($config_tables as $key => $table_name) {

          // Set the database to query.
          $previous = db_set_active($db);
          $table_clear = PrefixHandler::clearPrefix($table_name);
          if (db_table_exists($table_clear)) {
            $handler = DbServerHandlerFactory::getDbServerHandler();
            $handler
              ->optimizeTable($table_clear);
          }
          else {
            watchdog('db_maintenance', '@table table in @db database was configured to be optimized but does not exist.', array(
              '@db' => $db_name,
              '@table' => $table_name,
            ), WATCHDOG_NOTICE);
          }

          // Return to the previously set database.
          db_set_active($previous);
          watchdog('db_maintenance', 'Optimized @table table in @db database.', array(
            '@db' => $db_name,
            '@table' => $table_name,
          ), WATCHDOG_DEBUG);
        }
        if (ConfigHandler::getWriteLog()) {
          $tables = implode(', ', $config_tables);
          watchdog('db_maintenance', 'Optimized tables in @db database: @tables', array(
            '@db' => $db_name,
            '@tables' => $tables,
          ), WATCHDOG_INFO);
        }
      }
    }
    variable_set('db_maintenance_cron_last', REQUEST_TIME);
  }

  /**
   * Get a list of all the tables in a database.
   *
   * @param string $db
   *   The name of the database connection to query for tables.
   *
   * @return array
   *   Array representing the tables in the specified database.
   */
  public static function listTables($db) {
    $table_names = array();

    // Set the database to query.
    $previous = db_set_active($db);
    $handler = DbServerHandlerFactory::getDbServerHandler();
    $result = $handler
      ->listTables();

    // Return to the previously set database.
    db_set_active($previous);
    foreach ($result as $table_name) {
      $table_name = current($table_name);
      $table_names[$table_name] = $table_name;
    }
    return $table_names;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DbHandler::listTables	public static	function	Get a list of all the tables in a database.
DbHandler::optimizeTables	public static	function	Performs the maintenance.