drush_multi: drush_multi/doxygen/page_multi-sql-dump.php Source File

00001 <?php 
00002 // $Id:
00003 
00004 /**
00005  * @file 
00006  * Page multi-sql-dump
00007  * 
00008  * Additional Doxygen documentation 
00009  */
00010 
00011 /** 
00012  * @page multi_sql_dump_help multi-sql-dump
00013  * Improved sql-dump.
00014  * @section Aliases
00015  * @subsection multi_sql_dump_alias_msd msd
00016  * @section Options
00017  * @subsection multi_sql_dump_destination --target
00018  * Absolute Path to the directory where to store the sql dumps. 
00019  * Default /tmp.
00020  * @subsection multi_sql_dump_dump_type --dump-type
00021  * Allowed values:
00022  * 
00023  * "full" Creates one file for all tables (default).
00024  * 
00025  * "tables" Creates for each table within each database a seperate file.
00026  * 
00027  * @subsection multi_sql_dump_datetime --datetime
00028  * Adds a datetime to resultfiles. (YYYY-MM-DDThh:mm) 
00029  * @subsection multi_sql_dump_comment --comment
00030  * Comment for filename. May contain alphanumics, '-' and '_'.
00031  * @subsection multi_sql_dump_bzip2 --bzip2
00032  * Use bzip2 for compression of each sql dump.
00033  * 
00034  * @section dump_name_schema Dump name schema
00035  * With --dump-type=full (default)
00036  * @code
00037  * ${uri} [ _ ${comment}] [ _ ${datetime}] .sql [.bz2]
00038  * @endcode
00039  * 
00040  * With --dump-type=tables:
00041  * @code
00042  * ${uri}.${table} [ _ ${comment}] [ _ ${datetime}] .sql [.bz2]
00043  * @endcode                               
00044  * where ${url} is example.com supplied by -l/--uri.
00045  * @section Examples
00046  * @code
00047  * drush -r /path/to/drupal -l example.com  multi-sql-dump --bzip2 --comment=before-update-to-6.15 --target=$HOME/db_backups
00048  * @endcode
00049  * Run 'sql dump' on example.com with 'before-update-to-6.15' as comment.                     
00050  *
00051  * The result file will be bzip compressed and stored in 'db_backups' in your home directory.
00052  * 
00053  */