/db-ack

Find a specific string in the database

Primary LanguagePHP

runcommand/db-ack

Find a specific string in the database.

runcommand open source Build Status

Quick links: Using | Installing | Support

Using

wp db ack <search> [<tables>...] [--network] [--all-tables-with-prefix] [--all-tables] [--before_context=<num>] [--after_context=<num>]

Like ack, but for your WordPress database. Searches through all or a selection of database tables for a given string. Outputs colorized references to the string.

Example of search for 'wordpress-development'

Defaults to searching through all tables registered to $wpdb. On multisite, this default is limited to the tables for the current site.

OPTIONS

<search>
	String to search for.

[<tables>...]
	One or more tables to search through for the string.

[--network]
	Search through all the tables registered to $wpdb in a multisite
	install.

[--all-tables-with-prefix]
	Search through all tables that match the registered table prefix, even
	if not registered on $wpdb. On one hand, sometimes plugins use tables
	without registering them to $wpdb. On another hand, this could return
	tables you don't expect.

[--all-tables]
	Search through ALL tables in the database, regardless of the prefix,
	and even if not registered on $wpdb. Overrides --network and
	--all-tables-with-prefix.

[--before_context=<num>]
	Number of characters to display before the match (for large blobs).
	---
	default: 40
	---

[--after_context=<num>]
	Number of characters to display after the match (for large blobs).
	---
	default: 40
	---

EXAMPLES

# Search through database for the 'wordpress-develop' string
$ wp db ack wordpress-develop
wp_options:option_value
1:http://wordpress-develop.dev
wp_options:option_value
2:http://wordpress-develop.dev

Installing

Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with wp cli update.

Once you've done so, you can install this package with wp package install runcommand/db-ack.

Support

This WP-CLI package is free for anyone to use. Support, including usage questions and feature requests, is available to paying runcommand customers.

Think you’ve found a bug? Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version. Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue with description of what you were doing, what you saw, and what you expected to see.

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project. Once you've decided to work on a pull request, please include functional tests and follow the WordPress Coding Standards.

runcommand customers can also email support@runcommand.io for private support.