User Guide

DB Replacer

Download Free Buy Pro   € 30

1) What is DB Replacer?

DB Replacer is Joomla! administrator component that enables you to search and replace in any table in your database.

To replace a certain string in your database table, you just need to:

  1. go to DB Replacer in your Joomla! administrator
  2. select proper content table and table column(s)
  3. input the search and replace text
  4. click on ‘Replace’

DB Replacer gives you a preview of what is going to be replaced, so you know what you are doing before actually replacing anything.

2) Using DB Replacer

Using DB Replacer is quite straightforward. Open DB Replacer from the component menu in the Joomla! administrator. You will be presented with the following component interface:

DB Replacer

2.1) Tables

TablesIn the Tables select box you will see the list of all database tables from which you can choose one table in which you want to make the changes.

2.2) Columns

ColumnsAfter selecting the table, the Columns select box will be populated. You can choose one or more columns here. To select multiple columns, keep the Control/Command key pressed when selecting.

2.3) Search & Replace

Search & ReplaceEnter the existing text to be replaced in the Search text box.

Once you enter some text in this field, the Preview table below will only show the rows which contain your search string.

Enter the new replacement text in the Replace text box.

The Preview table will show you a preview of the replacement. The search string will be marked red and the replacement will be marked green.

Preview

If you are satisfied with the Preview result, simply click on the Replace button to apply the changes.

You can search and replace in up to 1000 rows at one time (up to 50 in FREE version).
WE RECOMMEND not setting the default row count limit too high (around 100). Replacing in too many rows at once can make your page time out, depending on server and database settings.

2.4) Case sensitivity

If you need to make changes where case sensitivity is required, you can check “Case sensitive” checkbox. Now the replacements will only be done where the search matches exactly.

For instance, ‘Joomla’ will not match ‘joomla’ or ‘JOOMLA’.

2.5) Regular Expressions

The PRO version of DB Replacer also supports Regular Expressions searches and replacements.

This gives you great power to search for dynamic values and use (parts of) the searched text in the replacement.

For example, if you want to make all prices with syntax $123.00 bold, you can search for:

(\$[0-9]+\.[0-9][0-9])

and replace with:

<strong>\1</strong>

This will make $1.00 and $999.00 bold, but ignore $1 and $999.

When the Regular Expressions option is checked, you will also be able to search in UTF-8 mode. This can help you when using special characters or certain character sets.

For more info on Regular Expressions: http://www.regular-expressions.info/reference.html
For testing them: http://gskinner.com/RegExr

2.6) Where clause

WhereWith the PRO version of DB Replacer you can limit the search via a custom WHERE clause.

The WHERE clause is used to extract only those records that fulfill specific criteria.

This field follows the default MySQL WHERE syntax. For instance, if you only want to search and replace in records that have an id between 100 and 200, you can enter:

id > 100 AND id < 200

3) Options

In the toolbar, on the right, you will see the 'Options' button.

Options

When you click on that, a modal window will open with a couple of options for DB Replacer.

Here is an overview of the available options. All descriptions are available in the tooltips of the options.

Ignore Tables A comma separated list of table prefixes/names to ignore. Any table that starts with this will not be shown in the results.
Default Table
PRO ONLY
The default database table to select upon pageload. You can use #__ as joomla prefix.

Enter a '-' to disable.
Default Columns
PRO ONLY
A comma separated list of default database columns to select when the default table is selected. These columns must therefore be available in the default table.

Enter a '-' to disable.

Maximum Row Count
PRO ONLY

Set the maximum number of rows to return and search/replace in. If you set this too high, the page may timeout. If you need to replace someting in many rows, it is better to do replacements multiple times till there are no more results.
Choose from: 50, 100, 200, 500, 1000
Show 2nd Warning Select to show a second 'Are you sure' alert before replacing.

3.1) Permissions

The Joomla core permission settings to control access to the different actions. For more information on how these permissions work, see the Joomla docs:
Access Control List Tutorial : Component Options & Permissions

4) Requirements

DB Replacer will only work correctly if your setup meets these requirements:

  • Up-to-date version of Joomla:
    • Joomla 2.5.10 or higher
    • Joomla 3.2.2 or higher
  • PHP 5.3+ ( No PHP 5.2 support! )
  • PHP mbstring (Multibyte String) functions enabled
  • MySQL 5+

Important: I can only provide support for setups that:

  • meet the above requirements;
  • do not have extension files or Joomla! core files which have been altered in any way.

5) Installation

You can either install DB Replacer by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful NoNumber Extension Manager.

Note: When updating DB Replacer, you do not need to uninstall it first. The package will update all the files automatically.

Keep in mind that when you update to a major new version (or uninstall first), you might lose some configuration settings.

5.1) NoNumber Extension Manager

It is very easy to install/update any NoNumber Extension using the NoNumber Extension Manager.

Please see the User Guide for the NoNumber Extension Manager for more detailed information...

NoNumber Extension Manager

5.2) Joomla! Extension Manager

To install via the Joomla! Extension Manager, just follow these steps (based on Joomla 2.5 setup):

  1. Download the extension zip.
  2. Log into your Joomla administrator
  3. In the menu, choose: Extensions >> Extension Manager
  4. Under 'Upload Package File' select the extension zip.
  5. Click on 'Upload & Install'
Joomla! Installer

If you have problems installing DB Replacer, please try the manual installation process as described here: docs.joomla.org/Installing_an_extension

6) Uninstallation

You can either uninstall DB Replacer by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful NoNumber Extension Manager.

If you no longer use any NoNumber extensions, you can also uninstall the NoNumber Framework plugin by using the Joomla! core extension manager.

Quick Menu

Peter van Westen

Hosted by

SiteGround.com