Merge pull request #19 from wp-cli/db-size-readme

Regenerate README for `db size`

Author: gitlost

README.md

@@ -350,6 +350,92 @@ Defaults to all tables registered to the $wpdb database handler.
     $ wp db export --tables=$(wp db tables --url=sub.example.com --format=csv)
     Success: Exported to wordpress_dbase.sql
 
+
+
+### wp db size
+
+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
+
 ## Installing
 
 Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with `wp cli update`.

src/DB_Command.php

@@ -459,13 +459,13 @@ public function tables( $args, $assoc_args ) {
 	/**
 	 * Display the database name and size.
 	 *
-	 * Display the database name and size for `DB_NAME` specified in wp-config.php,
-	 * defaults to a human-readable number.
+	 * 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 only the database size as a number.
+	 * : Display the database size only, as a bare number.
 	 * ---
 	 * default: b
 	 * options:
@@ -526,14 +526,14 @@ public function tables( $args, $assoc_args ) {
 	 *     | wp_commentmeta        | 48 KB |
 	 *     +-----------------------+-------+
 	 *
-	 * 	   $ wp db size --size_format=b
-	 * 	   5865472
+	 *     $ wp db size --size_format=b
+	 *     5865472
 	 *
-	 * 	   $ wp db size --size_format=kb
-	 * 	   5728
+	 *     $ wp db size --size_format=kb
+	 *     5728
 	 *
-	 * 	   $ wp db size --size_format=mb
-	 * 	   6
+	 *     $ wp db size --size_format=mb
+	 *     6
 	 */
 	public function size( $args, $assoc_args ) {