summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/changelog.rst3
-rw-r--r--user_guide_src/source/database/utilities.rst53
2 files changed, 29 insertions, 27 deletions
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a3d29056e..cc9afc45c 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -180,10 +180,11 @@ Release Date: Not Released
- Deprecated ``add_column()``'s third method. *AFTER* clause should now be added to the field definition array instead.
- Added support for usage of the *FIRST* clause in ``add_column()`` for MySQL and CUBRID.
- Overall improved support for all of the drivers.
- - :doc:`Database Utility <database/utilities>` chages include:
+ - :doc:`Database Utility <database/utilities>` changes include:
- Added support for passing a custom database object to the loader.
- Modified the class to no longer extend :doc:`Database Forge <database/forge>`, which has been a deprecated behavior for awhile.
- Overall improved support for all of the drivers.
+ - Added 'foreign_key_checks' option to MySQL/MySQLi backup, allowing statement to disable/re-enable foreign key checks to be inserted into the backup output.
- Libraries
diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst
index 06ecb2da1..bd40cdadd 100644
--- a/user_guide_src/source/database/utilities.rst
+++ b/user_guide_src/source/database/utilities.rst
@@ -45,7 +45,7 @@ $this->dbutil->list_databases();
Returns an array of database names::
$dbs = $this->dbutil->list_databases();
-
+
foreach ($dbs as $db)
{
echo $db;
@@ -102,7 +102,7 @@ FALSE on failure.
::
$result = $this->dbutil->optimize_database();
-
+
if ($result !== FALSE)
{
print_r($result);
@@ -119,9 +119,9 @@ parameter of the method must contain the result object from your
query. Example::
$this->load->dbutil();
-
+
$query = $this->db->query("SELECT * FROM mytable");
-
+
echo $this->dbutil->csv_from_result($query);
The second, third, and fourth parameters allow you to set the delimiter
@@ -147,16 +147,16 @@ parameter expects a query result object, the second may contain an
optional array of config parameters. Example::
$this->load->dbutil();
-
+
$query = $this->db->query("SELECT * FROM mytable");
-
+
$config = array (
'root' => 'root',
'element' => 'element',
'newline' => "\n",
- 'tab' => "\t"
+ 'tab' => "\t"
);
-
+
echo $this->dbutil->xml_from_result($query, $config);
.. important:: This method will NOT write the XML file for you. It
@@ -172,7 +172,7 @@ backup data can be compressed in either Zip or Gzip format.
.. note:: This feature is only available for MySQL and Interbase/Firebird databases.
.. note:: For Interbase/Firebird databases, the backup file name is the only parameter.
-
+
Eg. $this->dbutil->backup('db_backup_filename');
.. note:: Due to the limited execution time and memory available to PHP,
@@ -188,14 +188,14 @@ Usage Example
// Load the DB utility class
$this->load->dbutil();
-
+
// Backup your entire database and assign it to a variable
$backup =& $this->dbutil->backup();
-
+
// Load the file helper and write the file to your server
$this->load->helper('file');
write_file('/path/to/mybackup.gz', $backup);
-
+
// Load the download helper and send the file to your desktop
$this->load->helper('download');
force_download('mybackup.gz', $backup);
@@ -215,22 +215,23 @@ parameter of the ``backup()`` method. Example::
'add_insert' => TRUE, // Whether to add INSERT data to backup file
'newline' => "\n" // Newline character used in backup file
);
-
+
$this->dbutil->backup($prefs);
Description of Backup Preferences
---------------------------------
-=============== ======================= ======================= ========================================================================
-Preference Default Value Options Description
-=============== ======================= ======================= ========================================================================
-**tables** empty array None An array of tables you want backed up. If left blank all tables will be
- exported.
-**ignore** empty array None An array of tables you want the backup routine to ignore.
-**format** gzip gzip, zip, txt The file format of the export file.
-**filename** the current date/time None The name of the backed-up file. The name is needed only if you are using
- zip compression.
-**add_drop** TRUE TRUE/FALSE Whether to include DROP TABLE statements in your SQL export file.
-**add_insert** TRUE TRUE/FALSE Whether to include INSERT statements in your SQL export file.
-**newline** "\\n" "\\n", "\\r", "\\r\\n" Type of newline to use in your SQL export file.
-=============== ======================= ======================= ======================================================================== \ No newline at end of file
+======================= ======================= ======================= ========================================================================
+Preference Default Value Options Description
+======================= ======================= ======================= ========================================================================
+**tables** empty array None An array of tables you want backed up. If left blank all tables will be
+ exported.
+**ignore** empty array None An array of tables you want the backup routine to ignore.
+**format** gzip gzip, zip, txt The file format of the export file.
+**filename** the current date/time None The name of the backed-up file. The name is needed only if you are using
+ zip compression.
+**add_drop** TRUE TRUE/FALSE Whether to include DROP TABLE statements in your SQL export file.
+**add_insert** TRUE TRUE/FALSE Whether to include INSERT statements in your SQL export file.
+**newline** "\\n" "\\n", "\\r", "\\r\\n" Type of newline to use in your SQL export file.
+**foreign_key_checks** TRUE TRUE/FALSE Whether output should keep foreign key checks enabled.
+======================= ======================= ======================= ======================================================================== \ No newline at end of file