Database Utility Class

class CI_DB_utility

The Database Utility Class contains methods that help you manage your database. Load the Utility Class as follows:

ee()->load->dbutil()

Once initialized you will access the methods using the ee()->dbutil object:

ee()->dbutil->some_method()

list_databases()

Returns an array of database names:

$dbs = ee()->dbutil->list_databases();

foreach ($dbs as $db)
{
    echo $db;
}

database_exists($database_name)

Sometimes it’s helpful to know whether a particular database exists. Returns a boolean TRUE/FALSE. Usage example:

if (ee()->dbutil->database_exists('database_name'))
{
    // some code...
}

optimize_table($table_name)

Permits you to optimize a table using the table name specified in the first parameter. Returns TRUE/FALSE based on success or failure:

if (ee()->dbutil->optimize_table('table_name'))
{
    echo 'Success!';
}

repair_table($table_name)

Permits you to repair a table using the table name specified in the first parameter. Returns TRUE/FALSE based on success or failure:

if (ee()->dbutil->repair_table('table_name'))
{
    echo 'Success!';
}

optimize_database()

Permits you to optimize the database your DB class is currently connected to. Returns an array containing the DB status messages or FALSE on failure:

$result = ee()->dbutil->optimize_database();

if ($result !== FALSE)
{
    print_r($result);
}

csv_from_result($query[, $delim = ', '[, $newline = 'n'[, $enclosure = '"']]])

Permits you to generate a CSV file from a query result. The first parameter of the method must contain the result object from your query. Example:

ee()->load->dbutil();

$query = ee()->db->query("SELECT * FROM mytable");

echo ee()->dbutil->csv_from_result($query);

The second, third, and fourth parameters allow you to set the delimiter newline, and enclosure characters respectively. By default commas are used as the delimiter, “n” is used as a new line, and a double-quote is used as the enclosure. Example:

$delimiter = ",";
$newline = "\r\n";
$enclosure = '"';

echo ee()->dbutil->csv_from_result($query, $delimiter, $newline, $enclosure);

Important: This method will NOT write the CSV file for you. It simply creates the CSV layout. If you need to write the file use the File Helper.

xml_from_result($query[, $params = array()])

Permits you to generate an XML file from a query result. The first parameter expects a query result object, the second may contain an optional array of config parameters. Example:

ee()->load->dbutil();

$query = ee()->db->query("SELECT * FROM mytable");

$config = array (
    'root'      => 'root',
    'element'   => 'element',
    'newline'   => "\n",
    'tab'       => "\t"
);

echo ee()->dbutil->xml_from_result($query, $config);

Important: This method will NOT write the XML file for you. It simply creates the XML layout. If you need to write the file use the File Helper.

backup([$params = array()])

$params preferences:

Permits you to backup your full database or individual tables. The backup data can be compressed in either Zip or Gzip format.

Note: Due to the limited execution time and memory available to PHP, backing up very large databases may not be possible. If your database is very large you might need to backup directly from your SQL server via the command line, or have your server admin do it for you if you do not have root privileges.

Usage Example

// Load the DB utility class
ee()->load->dbutil();

// Backup your entire database and assign it to a variable
$backup =& ee()->dbutil->backup();

// Load the file helper and write the file to your server
ee()->load->helper('file');
write_file('/path/to/mybackup.gz', $backup);

// Load the download helper and send the file to your desktop
ee()->load->helper('download');
force_download('mybackup.gz', $backup);

Setting Backup Preferences

Backup preferences are set by submitting an array of values to the first parameter of the backup() method. Example:

$prefs = array(
    'tables'    => array('table1', 'table2'),   // Array of tables to backup.
    'ignore'    => array(),         // List of tables to omit from the backup
    'format'    => 'txt',           // gzip, zip, txt
    'filename'  => 'mybackup.sql',      // File name - NEEDED ONLY WITH ZIP FILES
    'add_drop'  => TRUE,            // Whether to add DROP TABLE statements to backup file
    'add_insert'    => TRUE,            // Whether to add INSERT data to backup file
    'newline'   => "\n"             // Newline character used in backup file
);

ee()->dbutil->backup($prefs);

ExpressionEngine 6 Docs
©2002–2022 Packet Tide,LLC. Edit this page