Configuration

Database

• host: Database host
• user: Database user
• password: Database password for above user
• database: Database name. Create one or use an existing one. Patchr needs to create a single table.

• table: Table name. Defaults to patchr_dbpatches. Usually there is no need to update this except in cases where multiple instances of patchr runs on the same project.

• timeout: Override MySQLi default timeout. Useful for large datasets. The default 500 will work in almost every case.

• multiple: Create a brand new database connection for each patch. If using this option set a smaller timeout.

Naming

Never change these options after the first patch has been applied.

With the default options filenames will be: patch-xxxxx.sql, usually there is no reason to change these.

• patches_dir: Directory that will contain the patches. This is relative to the patchr.class.php file.
• prefix: This is the prefix that you will append to each patch file.
• digits: This is the amount of digits that patchr will expect on the filename.
• extension: Extension of the patches file. Usually .sql is the reasonable one.

Advanced

• skip_patches: This option, forces patchr to skip certain patches. You might want to commit the existing structure of a database without patchr actually applying it. This option allows you to explicitly skip any number of patches. It accepts an array of filenames: array('patch-00001.sql','patch-00002.sql')