The backup & cleaning lady for your XAseco1/2 Database...
What it does:
DBTools can perform many tasks on your database like
- Backup your database locally or to FTP
- Restore a database backup from local file or from FTP
- Manage your backups (Automatically delete old backups after a given time) locally or on FTP
- Automatically perform optimizations/backups at a customizable time
- Optimize the database
- Repair the database
- Remove old tracks (including records, votes,...) from the database that are no more in the challengelist
- Remove all records behind position XX
- Remove all records/votes of a specific login
- Remove all records/votes of a specific track
- Remove records of cheaters that are on the Dedimania-Blacklist and optionally add them to your local blacklist. This feature is currently available for TMF only because we don't have a global TM2-Blacklist yet.
- Reset all user styles
- Wipe the database
- Clear the TimePlayed of all or of a specific login
- Clear the wins of all or of a specific login
- Clear Karma-Votes for a track / of a player / of all tracks
Just use the command /dbtools for more information (The command is available for MasterAdmins only!).
It works with XAseco 1.14 (TMF) and XAseco2 v1.0 (TM2).
- Always make a backup of your database first, DBTools comes with absolutely no warranty
- It's strongly recommended to restart XAseco1/2 after executing one of the commands
- It's strongly recommended to create an own directory for backups
- Copy dbtools.xml to your XAseco-Root-Directory
- Copy plugin.dbtools.php to your plugins directory
- Add <plugin>plugin.dbtools.php</plugin> to your plugins.xml
- Edit the dbtools.xml and make your settings
- Restart XAseco1/2
Since version 1.0.3, you can schedule all tasks for the plugin. It is important, that you enter the command without /dbtools. For example if you want to schedule a backup, just enter "backup" as command.
Code: Select all
<!-- This example creates a backup each Monday 04:18h --> <item> <command>backup</command> <week>ALL</week> <day>1</day> <time>04:18</time> </item> <!-- This example optimizes the database each Thursday 15:00h --> <item> <command>optimize</command> <week>ALL</week> <day>4</day> <time>15:00</time> </item>
You can enable FTP-Upload to manage all your backups on an external FTP-Server (Set <backup_location> to FTP)
Code: Select all
<ftp_hostname>www.myserver.com</ftp_hostname> <ftp_username>mylogin</ftp_username> <ftp_password>mypassword</ftp_password> <ftp_directory>directory/subdirectory</ftp_directory> <ftp_port>21</ftp_port> <!-- Default FTP-Port is 21--> <ftp_timeout>90</ftp_timeout> <!-- Connection Timeout in seconds-->
Backup & Restore Requirements
If you want to use the backup and restore features, the safe mode of your PHP-Installation must be turned off, you must use a Linux-OS, the xaseco directory must be writable (min 555) and the database must be located on the same machine as XAseco.
This should be used if you have deleted a large part of a table or if you have made many changes to a table with variable-length rows. You can use /dbtools optimize to reclaim the unused space and to defragment the data file. This statement may improve the performance sometimes significantly.
This command creates a backup of your database.
If you just use "/dbtools backup", the plugin creates an SQL-Dump with the filename you defined at the path you defined, or on the FTP-Server you definded.
/dbtools restore <ID>
This restores the last backup. You can find the <ID> by typing /dbtools listbackups. Normally /dbtools restore 1 should always restore the last backup. After the restore, you must restart Xaseco.
This command repairs a possibly corrupted table. Normally, you should never have to run /dbtools repair. However, if disaster strikes, this statement is very likely to get back all your data from a MyISAM table (important, your DB must be of type MyISAM).
This clears the complete database (like on a fresh install). Using this can make you cry...
First of all, DBTools is not magic and it can not do any magic but in some cases it can increase the speed of your database significantly by just cleaning up. On big databases the following commands, in the correct order, can be used to reduce the ressources consumption:
- Kick all players, set a password (This makes most fun and saves the most ressources ...joke.).
- /dbtools backup Always(!) create a backup of your DB first. If this fails, do not continue.
- /dbtools cleanupdb This removes tracks and records from the database that are no more in your tracklist
- /dbtools offsetdelete XX This will kick out all records behind position XX (replace XX by your number - in Xaseco's default configuration 50 is a good choice...)
- /dbtools optimize We deleted tons of rows, so we should optimize the tables now
DBTools v1.0.7 for XAseco1/2
Preview of the upcoming version
At the dev page
* Added general Mode-Selector: FTP or LOCAL for backups.
* Added backup restore directly from FTP
* Added check if FTP-Server is reachable on startup (in FTP-Mode only)
* Added <week> to scheduling (These are the calendar weeks from 1 to max 53).
* Scheduling <day> and <week> can now be set to ALL
* Added automatic deletion of old backups on the FTP-Server (configurable via <ftp_prune_after>)
* Added automatic deletion of old local backups (configurable via <backup_local_prune_after>)
* Added <blocked_commands> to the xml to disable selected features
* Added /dbtools listbackups command
* Added /dbtools deletebackup <ID> command
* Added the variable #DATE# to include the current timestamp into the backup filename
* Changed the /dbtools restore command – You must now restore the backups via the ID..Example: /dbtools restore 1
* /dbtools restore no more accepts custom filenames! Filename must be set in dbtools.xml!
* Disabled <allow_customfilenames> by default – it makes no sense
* Better structure for the /dbtools help command
* All backups must have the .sql ending
* Added checks if the backup directory is writable
v1.0.6 (sorry Xymph from now 1 update/week)
* Added the command offsetdelete to delete records behind a defined position
* Added the command "/dbtools help <COMMAND>" for more details on the usage
* Added the Console-Window
* Added sync with Dedi-Blacklist (cheaters command)
* Added karmaclear, karmaclearthis, karmaclearlogin
* Added support for undef.de's "Third-party Plugins UpToDate"
* Fixed an issue with the command cleanupdb
* Added misconfiguration checks
* Added <ftp_port> and <ftp_timeout> to the dbtools.xml
* Added the possibility to delete the local backup after uploading
* Added <scheduling_enabled> to the dbtools.xml
* Added uploading backups to an external FTP-Server
* Added scheduling
* Added Backup/Restore
* Bugfixed command clearstyles
* Initial release