function db_maintenance_help in DB Maintenance 6

Same name and namespace in other branches

1. 8.2 db_maintenance.module \db_maintenance_help()
2. 8 db_maintenance.module \db_maintenance_help()
3. 5.2 db_maintenance.module \db_maintenance_help()
4. 5 db_maintenance.module \db_maintenance_help()
5. 6.2 db_maintenance.module \db_maintenance_help()
6. 7.2 db_maintenance.module \db_maintenance_help()
7. 7 db_maintenance.module \db_maintenance_help()
8. 2.0.x db_maintenance.module \db_maintenance_help()

Implementation of hook_help().

Parameters

$section string:

Return value

string

File

./db_maintenance.module, line 20

Optimizes database tables during cron runs.

Code

function db_maintenance_help($path, $arg) {
  switch ($path) {
    case 'admin/help#db_maintenance':
      return t('<p>DB maintenance performs an optimization query on selected tables.</p>
        <p>For MyISAM tables,
        OPTIMIZE TABLE repairs a table if it has deleted or split rows, sorts table indexes,
        and updates table statistics. For BDB and InnoDB, OPTIMIZE rebuilds the table. Note, MySQL
        locks tables during the time OPTIMIZE TABLE is running. OPTIMIZE works best on tables with
        large deletions (e.g. cache or watchdog), however MySQL will reuse old record positions,
        therefore in most setups, OPTIMIZE TABLE is unnecessary unless you just like defragmenting.</p>
        <p>The Overhead column in phpMyAdmin\'s database view is the most common way to determine the
        need of an OPTIMIZE TABLE query. It essentially shows the amount of disk space you would
        recover by running an optimize/defragmentation query.</p>
        <p>For PostgreSQL tables, VACUUM reclaims storage occupied by deleted tuples.
        In normal PostgreSQL operation, tuples that are deleted or obsoleted by an update are not
        physically removed from their table; they remain present until a VACUUM is done. Therefore
        it\'s necessary to do VACUUM periodically, especially on frequently-updated tables.</p>');
    case 'admin/settings/db_maintenance':
      return t('Executes an optimization query on database tables during cron runs.');
  }
}