Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A PHP search replace tool for quickly modifying a string throughout a database. Useful for changing the base URL when migrating a WordPress site from development to production.
PHP
Branch: master

Merge pull request #141 from matt-icit/master

Only show highlights in Results pane when there's no serialised string lengths.
latest commit 008543a7c3
@matt-icit matt-icit authored

README.md

Search Replace DB

This script was made to aid the process of migrating PHP and MySQL based websites. It has additional features for WordPress and Drupal but works for most other similar CMSes.

If you find a problem let us know in the issues area and if you can improve the code then please fork the repository and send us a pull request :)

Warnings & Limitations

  1. Three character UTF8 seems to break in certain cases.
  2. We can't test every possible case, though we do our best. Backups and verifications are important.
  3. The license for this script is GPL v3 and no longer WTFPL. Please bear this in mind if contributing or branching.
  4. You use this script at your own risk and we have no responsibility for any problems it may cause.
  5. Do backups.

Usage

  1. Do backups.
  2. Migrate all your website files.
  3. Upload the script folder to your web root or higher.
  4. Browse to the script folder URL in your web browser.
  5. Fill in the fields as needed.
  6. Choose the Dry run button to do a dry run without searching/replacing.

Installation

If you would like Search Replace DB to detect your WordPress installation, you should install it within a new subfolder within your WordPress installation.

For example, if you have

/website.com/index.php

/website.com/wp-config.php

/website.com/wordpress/

/website.com/wordpress/index.php

/website.com/wordpress/wp-settings.php

etc.

You can copy Search Replace DB into the following location:

/website.com/wordpress/Search-Replace-DB/

/website.com/wordpress/Search-Replace-DB/index.php

/website.com/wordpress/Search-Replace-DB/srdb.class.php

/website.com/wordpress/Search-Replace-DB/srdb.cli.php

etc.

CLI script

To invoke the script, nagivate in your shell to the directory to where you installed Search Replace DB.

Type php srdb.cli.php to run the program. Type php srdb.cli.php --help for usage information:

-h, --host

    Required. The hostname of the database server.

-n, --name

    Required. Database name.

-u, --user

    Required. Database user.

-p, --pass

    Required. Database user's password.

--port

    Optional. Port on database server to connect to.
    The default is 3306. (MySQL default port).

-s, --search

    String to search for or `preg_replace()` style regular
    expression.

-r, --replace

    None empty string to replace search with or
    `preg_replace()` style replacement.

-t, --tables

    If set only runs the script on the specified table, comma
    separate for multiple values.

-i, --include-cols

    If set only runs the script on the specified columns, comma
    separate for multiple values.

-x, --exclude-cols

    If set excludes the specified columns, comma separate for
    multiple values.

-g, --regex [no value]

    Treats value for -s or --search as a regular expression and
    -r or --replace as a regular expression replacement.

-l, --pagesize

    How many rows to fetch at a time from a table.

-z, --dry-run [no value]

    Prevents any updates happening so you can preview the number
    of changes to be made

-e, --alter-engine

    Changes the database table to the specified database engine
    eg. InnoDB or MyISAM. If specified search/replace arguments
    are ignored. They will not be run simultaneously.

-a, --alter-collation

    Changes the database table to the specified collation
    eg. utf8_unicode_ci. If specified search/replace arguments
    are ignored. They will not be run simultaneously.

-v, --verbose [true|false]

    Defaults to true, can be set to false to run script silently.

--help

    Displays this help message ;)

Troubleshooting

I get a popup saying there was an AJAX error

This happens occasionally and could be for a couple of reasons:

  • When the script starts, it attempts to start your WordPress or Drupal installation to auto-detect your username and password settings. If this fails, you will see a message informing you that auto-detection failed. You will have to enter your details manually.
  • Script was unable to set the timeout so PHP closed the connection before the table could be processed, this can happen on some server configurations.
  • When using php-fpm (as you have with VVV) make sure that the socket is owned by the server user chown www-data:www-data /var/run/php5-fpm.sock.
Something went wrong with that request. Please try again.