Perform basic database operations using credentials stored in wp-config.php.
Quick links: Using | Installing | Contributing
This package implements the following commands:
Create a new database.
wp db create
Runs CREATE_DATABASE SQL statement using DB_HOST, DB_NAME,
DB_USER and DB_PASSWORD database credentials specified in
wp-config.php.
EXAMPLES
$ wp db create
Success: Database created.
Delete the existing database.
wp db drop [--yes]
Runs DROP_DATABASE SQL statement using DB_HOST, DB_NAME,
DB_USER and DB_PASSWORD database credentials specified in
wp-config.php.
OPTIONS
[--yes]
Answer yes to the confirmation message.
EXAMPLES
$ wp db drop --yes
Success: Database dropped.
Remove all tables from the database.
wp db reset [--yes]
Runs DROP_DATABASE and CREATE_DATABASE SQL statements using
DB_HOST, DB_NAME, DB_USER and DB_PASSWORD database credentials
specified in wp-config.php.
OPTIONS
[--yes]
Answer yes to the confirmation message.
EXAMPLES
$ wp db reset --yes
Success: Database reset.
Check the current status of the database.
wp db check
Runs mysqlcheck utility with --check using DB_HOST,
DB_NAME, DB_USER and DB_PASSWORD database credentials
specified in wp-config.php.
See docs
for more details on the CHECK TABLE statement.
EXAMPLES
$ wp db check
Success: Database checked.
Optimize the database.
wp db optimize
Runs mysqlcheck utility with --optimize=true using DB_HOST,
DB_NAME, DB_USER and DB_PASSWORD database credentials
specified in wp-config.php.
See docs
for more details on the OPTIMIZE TABLE statement.
EXAMPLES
$ wp db optimize
Success: Database optimized.
Note: wp db optimize optimizes the entire database, including non-WordPress tables. See #24
Repair the database.
wp db repair
Runs mysqlcheck utility with --repair=true using DB_HOST,
DB_NAME, DB_USER and DB_PASSWORD database credentials
specified in wp-config.php.
See docs for
more details on the REPAIR TABLE statement.
EXAMPLES
$ wp db repair
Success: Database repaired.
Open a MySQL console using credentials from wp-config.php
wp db cli [--database=<database>] [--default-character-set=<character-set>] [--<field>=<value>]
OPTIONS
[--database=<database>]
Use a specific database. Defaults to DB_NAME.
[--default-character-set=<character-set>]
Use a specific character set. Defaults to DB_CHARSET when defined.
[--<field>=<value>]
Extra arguments to pass to the MySQL executable.
EXAMPLES
# Open MySQL console
$ wp db cli
mysql>
Execute a SQL query against the database.
wp db query [<sql>] [--<field>=<value>]
Executes an arbitrary SQL query using DB_HOST, DB_NAME, DB_USER
and DB_PASSWORD database credentials specified in wp-config.php.
OPTIONS
[<sql>]
A SQL query. If not passed, will try to read from STDIN.
[--<field>=<value>]
Extra arguments to pass to mysql.
EXAMPLES
# Execute a query stored in a file
$ wp db query < debug.sql
# Check all tables in the database
$ wp db query "CHECK TABLE $(wp db tables | paste -s -d',');"
+---------------------------------------+-------+----------+----------+
| Table | Op | Msg_type | Msg_text |
+---------------------------------------+-------+----------+----------+
| wordpress_dbase.wp_users | check | status | OK |
| wordpress_dbase.wp_usermeta | check | status | OK |
| wordpress_dbase.wp_posts | check | status | OK |
| wordpress_dbase.wp_comments | check | status | OK |
| wordpress_dbase.wp_links | check | status | OK |
| wordpress_dbase.wp_options | check | status | OK |
| wordpress_dbase.wp_postmeta | check | status | OK |
| wordpress_dbase.wp_terms | check | status | OK |
| wordpress_dbase.wp_term_taxonomy | check | status | OK |
| wordpress_dbase.wp_term_relationships | check | status | OK |
| wordpress_dbase.wp_termmeta | check | status | OK |
| wordpress_dbase.wp_commentmeta | check | status | OK |
+---------------------------------------+-------+----------+----------+
# Pass extra arguments through to MySQL
$ wp db query 'SELECT * FROM wp_options WHERE option_name="home"' --skip-column-names
+---+------+------------------------------+-----+
| 2 | home | http://wordpress-develop.dev | yes |
+---+------+------------------------------+-----+
Exports the database to a file or to STDOUT.
wp db export [<file>] [--<field>=<value>] [--tables=<tables>] [--exclude_tables=<tables>] [--porcelain]
Runs mysqldump utility using DB_HOST, DB_NAME, DB_USER and
DB_PASSWORD database credentials specified in wp-config.php.
OPTIONS
[<file>]
The name of the SQL file to export. If '-', then outputs to STDOUT. If omitted, it will be '{dbname}.sql'.
[--<field>=<value>]
Extra arguments to pass to mysqldump
[--tables=<tables>]
The comma separated list of specific tables to export. Excluding this parameter will export all tables in the database.
[--exclude_tables=<tables>]
The comma separated list of specific tables that should be skipped from exporting. Excluding this parameter will export all tables in the database.
[--porcelain]
Output filename for the exported database.
EXAMPLES
# Export database with drop query included
$ wp db export --add-drop-table
Success: Exported to 'wordpress_dbase.sql'.
# Export certain tables
$ wp db export --tables=wp_options,wp_users
Success: Exported to 'wordpress_dbase.sql'.
# Export all tables matching a wildcard
$ wp db export --tables=$(wp db tables 'wp_user*' --format=csv)
Success: Exported to 'wordpress_dbase.sql'.
# Export all tables matching prefix
$ wp db export --tables=$(wp db tables --all-tables-with-prefix --format=csv)
Success: Exported to 'wordpress_dbase.sql'.
# Skip certain tables from the exported database
$ wp db export --exclude_tables=wp_options,wp_users
Success: Exported to 'wordpress_dbase.sql'.
# Skip all tables matching a wildcard from the exported database
$ wp db export --exclude_tables=$(wp db tables 'wp_user*' --format=csv)
Success: Exported to 'wordpress_dbase.sql'.
# Skip all tables matching prefix from the exported database
$ wp db export --exclude_tables=$(wp db tables --all-tables-with-prefix --format=csv)
Success: Exported to 'wordpress_dbase.sql'.
Import a database from a file or from STDIN.
wp db import [<file>] [--skip-optimization]
Runs SQL queries using DB_HOST, DB_NAME, DB_USER and
DB_PASSWORD database credentials specified in wp-config.php. This
does not create database by itself and only performs whatever tasks are
defined in the SQL.
OPTIONS
[<file>]
The name of the SQL file to import. If '-', then reads from STDIN. If omitted, it will look for '{dbname}.sql'.
[--skip-optimization]
When using an SQL file, do not include speed optimization such as disabling auto-commit and key checks.
EXAMPLES
# Import MySQL from a file.
$ wp db import wordpress_dbase.sql
Success: Imported from 'wordpress_dbase.sql'.
List the database tables.
wp db tables [<table>...] [--scope=<scope>] [--network] [--all-tables-with-prefix] [--all-tables] [--format=<format>]
Defaults to all tables registered to the $wpdb database handler.
OPTIONS
[<table>...]
List tables based on wildcard search, e.g. 'wp_*_options' or 'wp_post?'.
[--scope=<scope>]
Can be all, global, ms_global, blog, or old tables. Defaults to all.
[--network]
List all the tables in a multisite install. Overrides --scope=<scope>.
[--all-tables-with-prefix]
List all tables that match the table prefix even if not registered on $wpdb. Overrides --network.
[--all-tables]
List all tables in the database, regardless of the prefix, and even if not registered on $wpdb. Overrides --all-tables-with-prefix.
[--format=<format>]
Render output in a particular format.
---
default: list
options:
- list
- csv
---
EXAMPLES
# List tables for a single site, without shared tables like 'wp_users'
$ wp db tables --scope=blog --url=sub.example.com
wp_3_posts
wp_3_comments
wp_3_options
wp_3_postmeta
wp_3_terms
wp_3_term_taxonomy
wp_3_term_relationships
wp_3_termmeta
wp_3_commentmeta
# Export only tables for a single site
$ wp db export --tables=$(wp db tables --url=sub.example.com --format=csv)
Success: Exported to wordpress_dbase.sql
Display the database name and size.
wp db size [--size_format] [--tables] [--format] [--scope=<scope>] [--network] [--all-tables-with-prefix] [--all-tables]
Display the database name and size for DB_NAME specified in wp-config.php.
The size defaults to a human-readable number.
OPTIONS
[--size_format]
Display the database size only, as a bare number.
---
default: b
options:
- b (bytes)
- kb (kilobytes)
- mb (megabytes)
---
[--tables]
Display each table name and size instead of the database size.
[--format]
table, csv, json
---
default: table
options:
- table
- csv
- json
---
[--scope=<scope>]
Can be all, global, ms_global, blog, or old tables. Defaults to all.
[--network]
List all the tables in a multisite install. Overrides --scope=<scope>.
[--all-tables-with-prefix]
List all tables that match the table prefix even if not registered on $wpdb. Overrides --network.
[--all-tables]
List all tables in the database, regardless of the prefix, and even if not registered on $wpdb. Overrides --all-tables-with-prefix.
EXAMPLES
$ wp db size
+-------------------+------+
| Name | Size |
+-------------------+------+
| wordpress_default | 6 MB |
+-------------------+------+
$ wp db size --tables
+-----------------------+-------+
| Name | Size |
+-----------------------+-------+
| wp_users | 64 KB |
| wp_usermeta | 48 KB |
| wp_posts | 80 KB |
| wp_comments | 96 KB |
| wp_links | 32 KB |
| wp_options | 32 KB |
| wp_postmeta | 48 KB |
| wp_terms | 48 KB |
| wp_term_taxonomy | 48 KB |
| wp_term_relationships | 32 KB |
| wp_termmeta | 48 KB |
| wp_commentmeta | 48 KB |
+-----------------------+-------+
$ wp db size --size_format=b
5865472
$ wp db size --size_format=kb
5728
$ wp db size --size_format=mb
6
Display the database table prefix.
wp db prefix
Display the database table prefix, as defined by the database handler's interpretation of the current site.
EXAMPLES
$ wp db prefix
wp_
This package is included with WP-CLI itself, no additional installation necessary.
To install the latest version of this package over what's included in WP-CLI, run:
wp package install git@github.com:wp-cli/db-command.git
We appreciate you taking the initiative to contribute to this project.
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
Think you’ve found a bug? We’d love for you to help us get it fixed.
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 the following:
- What you were doing (e.g. "When I run
wp post list"). - What you saw (e.g. "I see a fatal about a class being undefined.").
- What you expected to see (e.g. "I expected to see the list of posts.")
Include as much detail as you can, and clear steps to reproduce if possible.
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 commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
- Create a feature branch for each contribution.
- Submit your pull request early for feedback.
- Include functional tests with your changes. Read the WP-CLI documentation for an introduction.
- Follow the WordPress Coding Standards.
This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.