wp-cli-size's Introduction

petenelson/wp-cli-size

Quick links: Installing | Usage | Contributing

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 petenelson/wp-cli-size

Usage

Some examples, use wp help size for full options

Database size: wp size database

+-------------------+------+---------+
| Name              | Size | Bytes   |
+-------------------+------+---------+
| wordpress_default | 2 MB | 1703936 |
+-------------------+------+---------+

Table sizes: wp size tables

+-----------------------+-------+---------+------+
| Name                  | Size  | Bytes   | Rows |
+-----------------------+-------+---------+------+
| wp_commentmeta        | 48 KB | 49152   | 0    |
| wp_comments           | 96 KB | 98304   | 1    |
| wp_links              | 32 KB | 32768   | 0    |
| wp_options            | 1 MB  | 1114112 | 152  |
| wp_postmeta           | 48 KB | 49152   | 36   |
| wp_posts              | 80 KB | 81920   | 10   |
| wp_term_relationships | 32 KB | 32768   | 1    |
| wp_term_taxonomy      | 48 KB | 49152   | 1    |
| wp_termmeta           | 48 KB | 49152   | 0    |
| wp_terms              | 48 KB | 49152   | 1    |
| wp_usermeta           | 48 KB | 49152   | 21   |
| wp_users              | 48 KB | 49152   | 1    |
+-----------------------+-------+---------+------+

CSV format: wp size tables --format=csv

Name,Size,Bytes,Rows
wp_commentmeta,"48 KB",49152,0
wp_comments,"96 KB",98304,1
wp_links,"32 KB",32768,0
wp_options,"1 MB",1114112,152
wp_postmeta,"48 KB",49152,36
wp_posts,"80 KB",81920,10
wp_term_relationships,"32 KB",32768,1
wp_term_taxonomy,"48 KB",49152,1
wp_termmeta,"48 KB",49152,0
wp_terms,"48 KB",49152,1
wp_usermeta,"48 KB",49152,21
wp_users,"48 KB",49152,1

Contributing

Code and ideas are more than welcome.

Please open an issue with questions and feedback. Pull requests are expected to include test coverage.

wp-cli-size's People

Contributors

Stargazers

Watchers

wp-cli-size's Issues

Add --order and --orderby options

Would be nice to sort results by size (and rows for tables), ascending and descending

What did you think about the process of writing a command?

What went well, and what could be improved?

To preface this, I won't be offended if you choose to ignore my suggestions :) I'm opening this issue just to provide my feedback on how I'd write the command, and you have complete freedom to ignore me.

With that out of the way, my initial thought on this package is that the syntax would be better suited as:

wp db size [<tables>....] [--network] [--all-with-prefix] [--format=<format>]

This would bring it closer in-line to wp search-replace, and you could make use of the WP_CLI\Utils\wp_get_table_names() helper API.

With this being said, it might also be cool to introduce wp size media which would give you the size of the uploads directory. As such, the package could become more generically known as wp size