libraries/engines/innodb.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * @package phpMyAdmin-Engines
   5  */
   6
   7 /**
   8  *
   9  * @package phpMyAdmin-Engines
  10  */
  11 class PMA_StorageEngine_innodb extends PMA_StorageEngine
  12 {
  13     /**
  14      * @return  array
  15      */
  16     function getVariables()
  17     {
  18         return array(
  19             'innodb_data_home_dir' => array(
  20                 'title' => __('Data home directory'),
  21                 'desc'  => __('The common part of the directory path for all InnoDB data files.'),
  22             ),
  23             'innodb_data_file_path' => array(
  24                 'title' => __('Data files'),
  25             ),
  26             'innodb_autoextend_increment' => array(
  27                 'title' => __('Autoextend increment'),
  28                 'desc'  => __('The increment size for extending the size of an autoextending tablespace when it becomes full.'),
  29                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  30             ),
  31             'innodb_buffer_pool_size' => array(
  32                 'title' => __('Buffer pool size'),
  33                 'desc'  => __('The size of the memory buffer InnoDB uses to cache data and indexes of its tables.'),
  34                 'type'  => PMA_ENGINE_DETAILS_TYPE_SIZE,
  35             ),
  36             'innodb_additional_mem_pool_size' => array(
  37                 'title' => 'innodb_additional_mem_pool_size',
  38                 'type'  => PMA_ENGINE_DETAILS_TYPE_SIZE,
  39             ),
  40             'innodb_buffer_pool_awe_mem_mb' => array(
  41                 'type'  => PMA_ENGINE_DETAILS_TYPE_SIZE,
  42             ),
  43             'innodb_checksums' => array(
  44             ),
  45             'innodb_commit_concurrency' => array(
  46             ),
  47             'innodb_concurrency_tickets' => array(
  48                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  49             ),
  50             'innodb_doublewrite' => array(
  51             ),
  52             'innodb_fast_shutdown' => array(
  53             ),
  54             'innodb_file_io_threads' => array(
  55                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  56             ),
  57             'innodb_file_per_table' => array(
  58             ),
  59             'innodb_flush_log_at_trx_commit' => array(
  60             ),
  61             'innodb_flush_method' => array(
  62             ),
  63             'innodb_force_recovery' => array(
  64             ),
  65             'innodb_lock_wait_timeout' => array(
  66                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  67             ),
  68             'innodb_locks_unsafe_for_binlog' => array(
  69             ),
  70             'innodb_log_arch_dir' => array(
  71             ),
  72             'innodb_log_archive' => array(
  73             ),
  74             'innodb_log_buffer_size' => array(
  75                 'type'  => PMA_ENGINE_DETAILS_TYPE_SIZE,
  76             ),
  77             'innodb_log_file_size' => array(
  78                 'type'  => PMA_ENGINE_DETAILS_TYPE_SIZE,
  79             ),
  80             'innodb_log_files_in_group' => array(
  81                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  82             ),
  83             'innodb_log_group_home_dir' => array(
  84             ),
  85             'innodb_max_dirty_pages_pct' => array(
  86                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  87             ),
  88             'innodb_max_purge_lag' => array(
  89             ),
  90             'innodb_mirrored_log_groups' => array(
  91                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  92             ),
  93             'innodb_open_files' => array(
  94                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
  95             ),
  96             'innodb_support_xa' => array(
  97             ),
  98             'innodb_sync_spin_loops' => array(
  99                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
 100             ),
 101             'innodb_table_locks' => array(
 102                 'type'  => PMA_ENGINE_DETAILS_TYPE_BOOLEAN,
 103             ),
 104             'innodb_thread_concurrency' => array(
 105                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
 106             ),
 107             'innodb_thread_sleep_delay' => array(
 108                 'type'  => PMA_ENGINE_DETAILS_TYPE_NUMERIC,
 109             ),
 110          );
 111     }
 112
 113     /**
 114      * @return  string  SQL query LIKE pattern
 115      */
 116     function getVariablesLikePattern()
 117     {
 118         return 'innodb\\_%';
 119     }
 120
 121     /**
 122      * @return  array   detail pages
 123      */
 124     function getInfoPages()
 125     {
 126         if ($this->support < PMA_ENGINE_SUPPORT_YES) {
 127             return array();
 128         }
 129         $pages = array();
 130         $pages['Bufferpool'] = __('Buffer Pool');
 131         $pages['Status'] = __('InnoDB Status');
 132         return $pages;
 133     }
 134
 135     /**
 136      * returns html tables with stats over inno db buffer pool
 137      *
 138      * @return  string  html table with stats
 139      */
 140     function getPageBufferpool()
 141     {
 142         // The following query is only possible because we know
 143         // that we are on MySQL 5 here (checked above)!
 144         // side note: I love MySQL 5 for this. :-)
 145         $sql = '
 146              SHOW STATUS
 147             WHERE Variable_name LIKE \'Innodb\\_buffer\\_pool\\_%\'
 148                OR Variable_name = \'Innodb_page_size\';';
 149         $status = PMA_DBI_fetch_result($sql, 0, 1);
 150
 151         $output = '<table class="data" id="table_innodb_bufferpool_usage">' . "\n"
 152                 . '    <caption class="tblHeaders">' . "\n"
 153                 . '        ' . __('Buffer Pool Usage') . "\n"
 154                 . '    </caption>' . "\n"
 155                 . '    <tfoot>' . "\n"
 156                 . '        <tr>' . "\n"
 157                 . '            <th colspan="2">' . "\n"
 158                 . '                ' . __('Total') . "\n"
 159                 . '                : ' . PMA_formatNumber(
 160                         $status['Innodb_buffer_pool_pages_total'], 0)
 161                 . '&nbsp;' . __('pages')
 162                 . ' / '
 163                 . join('&nbsp;',
 164                     PMA_formatByteDown($status['Innodb_buffer_pool_pages_total'] * $status['Innodb_page_size'])) . "\n"
 165                 . '            </th>' . "\n"
 166                 . '        </tr>' . "\n"
 167                 . '    </tfoot>' . "\n"
 168                 . '    <tbody>' . "\n"
 169                 . '        <tr class="odd">' . "\n"
 170                 . '            <th>' . __('Free pages') . '</th>' . "\n"
 171                 . '            <td class="value">'
 172                 . PMA_formatNumber($status['Innodb_buffer_pool_pages_free'], 0)
 173                 . '</td>' . "\n"
 174                 . '        </tr>' . "\n"
 175                 . '        <tr class="even">' . "\n"
 176                 . '            <th>' . __('Dirty pages') . '</th>' . "\n"
 177                 . '            <td class="value">'
 178                 . PMA_formatNumber($status['Innodb_buffer_pool_pages_dirty'], 0)
 179                 . '</td>' . "\n"
 180                 . '        </tr>' . "\n"
 181                 . '        <tr class="odd">' . "\n"
 182                 . '            <th>' . __('Pages containing data') . '</th>' . "\n"
 183                 . '            <td class="value">'
 184                 . PMA_formatNumber($status['Innodb_buffer_pool_pages_data'], 0) . "\n"
 185                 . '</td>' . "\n"
 186                 . '        </tr>' . "\n"
 187                 . '        <tr class="even">' . "\n"
 188                 . '            <th>' . __('Pages to be flushed') . '</th>' . "\n"
 189                 . '            <td class="value">'
 190                 . PMA_formatNumber($status['Innodb_buffer_pool_pages_flushed'], 0) . "\n"
 191                 . '</td>' . "\n"
 192                 . '        </tr>' . "\n"
 193                 . '        <tr class="odd">' . "\n"
 194                 . '            <th>' . __('Busy pages') . '</th>' . "\n"
 195                 . '            <td class="value">'
 196                 . PMA_formatNumber($status['Innodb_buffer_pool_pages_misc'], 0) . "\n"
 197                 . '</td>' . "\n"
 198                 . '        </tr>';
 199
 200             // not present at least since MySQL 5.1.40
 201             if (isset($status['Innodb_buffer_pool_pages_latched'])) {
 202                 $output .= '        <tr class="even">'
 203                 . '            <th>' . __('Latched pages') . '</th>'
 204                 . '            <td class="value">'
 205                 . PMA_formatNumber($status['Innodb_buffer_pool_pages_latched'], 0)
 206                 . '</td>'
 207                 . '        </tr>';
 208             }
 209
 210             $output .= '    </tbody>' . "\n"
 211                 . '</table>' . "\n\n"
 212                 . '<table class="data" id="table_innodb_bufferpool_activity">' . "\n"
 213                 . '    <caption class="tblHeaders">' . "\n"
 214                 . '        ' . __('Buffer Pool Activity') . "\n"
 215                 . '    </caption>' . "\n"
 216                 . '    <tbody>' . "\n"
 217                 . '        <tr class="odd">' . "\n"
 218                 . '            <th>' . __('Read requests') . '</th>' . "\n"
 219                 . '            <td class="value">'
 220                 . PMA_formatNumber($status['Innodb_buffer_pool_read_requests'], 0) . "\n"
 221                 . '</td>' . "\n"
 222                 . '        </tr>' . "\n"
 223                 . '        <tr class="even">' . "\n"
 224                 . '            <th>' . __('Write requests') . '</th>' . "\n"
 225                 . '            <td class="value">'
 226                 . PMA_formatNumber($status['Innodb_buffer_pool_write_requests'], 0) . "\n"
 227                 . '</td>' . "\n"
 228                 . '        </tr>' . "\n"
 229                 . '        <tr class="odd">' . "\n"
 230                 . '            <th>' . __('Read misses') . '</th>' . "\n"
 231                 . '            <td class="value">'
 232                 . PMA_formatNumber($status['Innodb_buffer_pool_reads'], 0) . "\n"
 233                 . '</td>' . "\n"
 234                 . '        </tr>' . "\n"
 235                 . '        <tr class="even">' . "\n"
 236                 . '            <th>' . __('Write waits') . '</th>' . "\n"
 237                 . '            <td class="value">'
 238                 . PMA_formatNumber($status['Innodb_buffer_pool_wait_free'], 0) . "\n"
 239                 . '</td>' . "\n"
 240                 . '        </tr>' . "\n"
 241                 . '        <tr class="odd">' . "\n"
 242                 . '            <th>' . __('Read misses in %') . '</th>' . "\n"
 243                 . '            <td class="value">'
 244                 . ($status['Innodb_buffer_pool_read_requests'] == 0
 245                     ? '---'
 246                     : htmlspecialchars(PMA_formatNumber($status['Innodb_buffer_pool_reads'] * 100 / $status['Innodb_buffer_pool_read_requests'], 3, 2)) . ' %') . "\n"
 247                 . '</td>' . "\n"
 248                 . '        </tr>' . "\n"
 249                 . '        <tr class="even">' . "\n"
 250                 . '            <th>' . __('Write waits in %') . '</th>' . "\n"
 251                 . '            <td class="value">'
 252                 . ($status['Innodb_buffer_pool_write_requests'] == 0
 253                     ? '---'
 254                     : htmlspecialchars(PMA_formatNumber($status['Innodb_buffer_pool_wait_free'] * 100 / $status['Innodb_buffer_pool_write_requests'], 3, 2)) . ' %') . "\n"
 255                 . '</td>' . "\n"
 256                 . '        </tr>' . "\n"
 257                 . '    </tbody>' . "\n"
 258                 . '</table>' . "\n";
 259         return $output;
 260     }
 261
 262     /**
 263      * returns InnoDB status
 264      *
 265      * @return  string  result of SHOW INNODB STATUS inside pre tags
 266      */
 267     function getPageStatus()
 268     {
 269         return '<pre id="pre_innodb_status">' . "\n"
 270             . htmlspecialchars(PMA_DBI_fetch_value('SHOW INNODB STATUS;', 0, 'Status')) . "\n"
 271             . '</pre>' . "\n";
 272     }
 273
 274     /**
 275      * returns content for page $id
 276      *
 277      * @param   string  $id page id
 278      * @return  string  html output
 279      */
 280     function getPage($id)
 281     {
 282         if (! array_key_exists($id, $this->getInfoPages())) {
 283             return false;
 284         }
 285
 286         $id = 'getPage' . $id;
 287
 288         return $this->$id();
 289     }
 290
 291     /**
 292      * returns string with filename for the MySQL helppage
 293      * about this storage engne
 294      *
 295      * @return  string  mysql helppage filename
 296      */
 297     function getMysqlHelpPage()
 298     {
 299         return 'innodb';
 300     }
 301
 302     /**
 303      *
 304      * Gets the InnoDB plugin version number
 305      * http://www.innodb.com/products/innodb_plugin
 306      * (do not confuse this with phpMyAdmin's storage engine plugins!)
 307      *
 308      * @return string the version number, or empty if not running as a plugin
 309      */
 310     function getInnodbPluginVersion()
 311     {
 312         return PMA_DBI_fetch_value('SELECT @@innodb_version;');
 313     }
 314
 315     /**
 316      *
 317      * Gets the InnoDB file format
 318      * (works only for the InnoDB plugin)
 319      * http://www.innodb.com/products/innodb_plugin
 320      * (do not confuse this with phpMyAdmin's storage engine plugins!)
 321      *
 322      * @return string the InnoDB file format
 323      */
 324     function getInnodbFileFormat()
 325     {
 326         return PMA_DBI_fetch_value("SHOW GLOBAL VARIABLES LIKE 'innodb_file_format';", 0, 1);
 327     }
 328
 329     /**
 330      *
 331      * Verifies if this server supports the innodb_file_per_table feature
 332      * (works only for the InnoDB plugin)
 333      * http://www.innodb.com/products/innodb_plugin
 334      * (do not confuse this with phpMyAdmin's storage engine plugins!)
 335      *
 336      * @return boolean whether this feature is supported or not
 337      */
 338     function supportsFilePerTable()
 339     {
 340         $innodb_file_per_table = PMA_DBI_fetch_value("SHOW GLOBAL VARIABLES LIKE 'innodb_file_per_table';", 0, 1);
 341         if ($innodb_file_per_table == 'ON') {
 342             return true;
 343         } else {
 344             return false;
 345         }
 346
 347     }
 348 }
 349
 350 ?>