Files
cacti/cli/convert_tables.php
T

339 lines
9.1 KiB
PHP
Executable File

#!/usr/bin/env php
<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2026 The Cacti Group |
| |
| This program is free software; you can redistribute it and/or |
| modify it under the terms of the GNU General Public License |
| as published by the Free Software Foundation; either version 2 |
| of the License, or (at your option) any later version. |
| |
| This program is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| GNU General Public License for more details. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
require(__DIR__ . '/../include/cli_check.php');
// process calling arguments
$parms = $_SERVER['argv'];
array_shift($parms);
global $debug, $database_default;
$innodb = false;
$utf8 = false;
$latin = false;
$debug = false;
$size = 1000000;
$force = false;
$rebuild = false;
$dynamic = false;
$table_name = '';
$skip_tables = [];
$installer = false;
$local = false;
if (cacti_sizeof($parms)) {
foreach ($parms as $parameter) {
if (strpos($parameter, '=')) {
[$arg, $value] = explode('=', $parameter, 2);
} else {
$arg = $parameter;
$value = '';
}
switch ($arg) {
case '-d':
case '--debug':
$debug = true;
break;
case '-r':
case '--rebuild':
$rebuild = true;
break;
case '--dynamic':
$dynamic = true;
break;
case '--local':
$local = true;
break;
case '-s':
case '--size':
$size = $value;
break;
case '-t':
case '--table':
$table_name = $value;
break;
case '-i':
case '--innodb':
$innodb = true;
break;
case '-l':
case '--latin1':
$latin = true;
break;
case '-n':
case '--skip-innodb':
$skip_tables = explode(' ', $value);
break;
case '-f':
case '--force':
$force = true;
break;
case '-u':
case '--utf8':
$utf8 = true;
break;
case '--installer':
$installer = true;
require_once(__DIR__ . '../install/functions.php');
break;
case '--version':
case '-V':
case '-v':
display_version();
exit(0);
case '--help':
case '-H':
case '-h':
display_help();
exit(0);
default:
print 'ERROR: Invalid Parameter ' . $parameter . PHP_EOL . PHP_EOL;
display_help();
exit(1);
}
}
}
if (cacti_sizeof($skip_tables) && $table_name != '') {
print_or_log($installer, 'ERROR: You can not specify a single table and skip tables at the same time.' . PHP_EOL . PHP_EOL);
display_help();
exit;
}
if (!($innodb || $utf8 || $latin)) {
print_or_log($installer, 'ERROR: Must select either UTF8, LATIN1 or InnoDB conversion.' . PHP_EOL . PHP_EOL);
display_help();
exit;
}
if (!$local) {
if (POLLER_ID > 1) {
db_switch_remote_to_main();
print_or_log($installer, 'NOTE: Repairing Tables for Main Database' . PHP_EOL);
} else {
print_or_log($installer, 'NOTE: Repairing Tables for Local Database' . PHP_EOL);
}
} else {
print_or_log($installer, 'NOTE: Repairing Tables for Local Database' . PHP_EOL);
}
if (cacti_sizeof($skip_tables)) {
foreach ($skip_tables as $table) {
if (!db_table_exists($table)) {
print_or_log($installer, "ERROR: Skip Table $table does not Exist. Can not continue." . PHP_EOL . PHP_EOL);
display_help();
exit;
}
}
}
$convert = $innodb ? 'InnoDB' : '';
if ($utf8) {
$convert .= (strlen($convert) ? ' and ' : '') . ' utf8';
}
print_or_log($installer, "Converting Database Tables to $convert with less than '$size' Records" . PHP_EOL);
if ($innodb) {
$engines = db_fetch_assoc('SHOW ENGINES');
if (cacti_sizeof($engines)) {
foreach ($engines as $engine) {
if (strtolower($engine['Engine']) == 'innodb' && strtolower($engine['Support']) == 'off') {
print_or_log($installer, 'InnoDB Engine is not enabled' . PHP_EOL);
exit;
}
}
}
$file_per_table = db_fetch_row("SHOW GLOBAL VARIABLES LIKE 'innodb_file_per_table'");
if (strtolower($file_per_table['Value']) != 'on') {
print_or_log($installer, 'innodb_file_per_table not enabled');
exit;
}
}
if (strlen($table_name)) {
$tables = [$table_name];
} else {
$tables = get_cacti_base_tables();
}
if (cacti_sizeof($tables)) {
foreach ($tables as $table) {
$table_data = db_fetch_row_prepared('SELECT *
FROM information_schema.TABLES
WHERE TABLE_NAME = ?
AND TABLE_SCHEMA = ?',
[$table, $database_default]);
$canConvert = $rebuild;
$canInnoDB = false;
if (!$canConvert && $innodb) {
if ($table_data['ENGINE'] == 'MyISAM') {
$canConvert = true;
$canInnoDB = true;
} elseif ($table_data['ENGINE'] == 'Aria') {
$canConvert = true;
}
}
if (in_array($table, $skip_tables, true)) {
$canInnoDB = false;
}
if (!$canConvert && $utf8) {
$canConvert = $table_data['TABLE_COLLATION'] != 'utf8mb4_unicode_ci';
}
if (!$canConvert && $latin) {
$canConvert = $table_data['TABLE_COLLATION'] != 'latin1';
}
if ($dynamic && $table_data['ROW_FORMAT'] == 'Compact') {
$canConvert = true;
}
if ($dynamic && $table_data['ROW_FORMAT'] == 'Page') {
$canConvert = false;
}
if ($canConvert) {
if ($table_data['TABLE_ROWS'] < $size || $force) {
print_or_log($installer, "Converting Table > '$table'");
$sql = '';
if ($utf8) {
$sql .= ' CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci';
} elseif ($latin) {
$sql .= ' CONVERT TO CHARACTER SET latin1';
}
if ($innodb && $canInnoDB) {
$sql .= (strlen($sql) ? ',' : '') . ' ENGINE=Innodb';
}
$status = db_execute("ALTER TABLE `$table`" . ($dynamic ? ' ROW_FORMAT=Dynamic, ' : '') . $sql);
if ($status === false) {
print_or_log($installer, ' Failed' . PHP_EOL);
record_log($installer, "FATAL: Conversion of Table '$table' Failed. Command: 'ALTER TABLE `$table` $sql'");
} else {
print_or_log($installer, ' Successful' . PHP_EOL);
}
} else {
print_or_log($installer, "Skipping Table > '$table' too many rows '{$table_data['TABLE_ROWS']}'" . PHP_EOL);
}
} else {
print_or_log($installer, "Skipping Table > '$table'" . PHP_EOL);
}
}
}
function print_or_log(bool $installer, string $text) : void {
if ($installer) {
log_install_and_file(POLLER_VERBOSITY_MEDIUM, rtrim($text), 'CONVERT', true);
} else {
print $text;
}
}
function record_log(bool $installer, string $text) : void {
if ($installer) {
log_install_and_file(POLLER_VERBOSITY_MEDIUM, rtrim($text), 'CONVERT', true);
} else {
cacti_log($text, false, 'CONVERT');
}
}
/**
* display_version - displays version information
*
* @return void
*/
function display_version() : void {
$version = get_cacti_cli_version();
print "Cacti Database Conversion Utility, Version $version, " . COPYRIGHT_YEARS . PHP_EOL;
}
/**
* display_help - displays the usage of the function
*
* @return void
*/
function display_help() : void {
display_version();
print PHP_EOL;
print 'usage: convert_tables.php [--debug] [--innodb] [--utf8] [--latin1] [--table=N] [--size=N] [--rebuild] [--dynamic]' . PHP_EOL . PHP_EOL;
print 'A utility to convert a Cacti Database from MyISAM to the InnoDB table format.' . PHP_EOL;
print 'MEMORY tables are not converted to InnoDB in this process.' . PHP_EOL . PHP_EOL;
print 'Required (one or more):' . PHP_EOL;
print '-i | --innodb - Convert any MyISAM tables to InnoDB' . PHP_EOL . PHP_EOL;
print '-u | --utf8 - Convert any non-UTF8 tables to utf8mb4_unicode_ci' . PHP_EOL;
print '-l | --latin1 - Convert any non-latin1 tables to latin1' . PHP_EOL . PHP_EOL;
print 'Optional:' . PHP_EOL;
print '-t | --table=S - The name of a single table to change' . PHP_EOL;
print '-n | --skip-innodb="table1 table2 ..." - Skip converting tables to InnoDB' . PHP_EOL;
print '-s | --size=N - The largest table size in records to convert. Default is 1,000,000 rows.' . PHP_EOL;
print '-r | --rebuild - Will compress/optimize existing InnoDB tables if found' . PHP_EOL;
print ' --dynamic - Convert a table to Dynamic row format if available' . PHP_EOL;
print ' --local - Perform the action on the Remote Data Collector if run from there' . PHP_EOL;
print '-f | --force - Proceed with conversion regardless of table size' . PHP_EOL;
print '-d | --debug - Display verbose output during execution' . PHP_EOL;
}