Skip to content

Adds --human-readable parameter to db size command #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 6 commits into from
Dec 17, 2018
Merged

Adds --human-readable parameter to db size command #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4754f26
Adds —human-readable parameter to db size command
pmgarman Dec 9, 2018
cef3709
Update error more user friendly.
schlessera Dec 9, 2018
26d20f8
Code formatting
schlessera Dec 9, 2018
62886b4
—human-readable should not allow plain numeric repsonses
pmgarman Dec 10, 2018
22a90cc
Adding tests for —human-readable
pmgarman Dec 10, 2018
0af95c6
Base 1000 vs 1024
pmgarman Dec 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions features/db-size.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,55 @@ Feature: Display database size
wp_cli_test
"""

Scenario: Display only database size in a human readable format for a WordPress install
Given a WP install

When I run `wp db size --human-readable`
Then STDOUT should contain:
"""
wp_cli_test
"""

And STDOUT should contain:
"""
KB
"""

When I try `wp db size --human-readable --size_format=b`
Then the return code should not be 0
And STDERR should contain:
"""
Cannot use --size_format and --human-readable arguments at the same time.
"""
And STDOUT should be empty

Scenario: Display only table sizes in a human readable format for a WordPress install
Given a WP install

When I run `wp db size --tables --human-readable`
Then STDOUT should contain:
"""
wp_posts
"""

And STDOUT should contain:
"""
KB
"""

But STDOUT should not contain:
"""
wp_cli_test
"""

When I try `wp db size --tables --human-readable --size_format=b`
Then the return code should not be 0
And STDERR should contain:
"""
Cannot use --size_format and --human-readable arguments at the same time.
"""
And STDOUT should be empty

Scenario: Display only database size in bytes for a WordPress install
Given a WP install

Expand Down
22 changes: 19 additions & 3 deletions src/DB_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,9 @@ public function tables( $args, $assoc_args ) {
* [--tables]
* : Display each table name and size instead of the database size.
*
* [--human-readable]
* : Display database sizes in human readable formats.
*
* [--format]
* : table, csv, json
* ---
Expand Down Expand Up @@ -751,11 +754,17 @@ public function size( $args, $assoc_args ) {

$format = WP_CLI\Utils\get_flag_value( $assoc_args, 'format' );
$size_format = WP_CLI\Utils\get_flag_value( $assoc_args, 'size_format' );
$human_readable = WP_CLI\Utils\get_flag_value( $assoc_args, 'human-readable', false );
$tables = WP_CLI\Utils\get_flag_value( $assoc_args, 'tables' );
$tables = ! empty( $tables );

if( ! is_null( $size_format ) && $human_readable ) {
WP_CLI::error( "Cannot use --size_format and --human-readable arguments at the same time." );
}

unset( $assoc_args['format'] );
unset( $assoc_args['size_format'] );
unset( $assoc_args['human-readable'] );
unset( $assoc_args['tables'] );

if ( empty( $args ) && empty( $assoc_args ) ) {
Expand All @@ -766,7 +775,7 @@ public function size( $args, $assoc_args ) {
$rows = array();
$fields = array( 'Name', 'Size' );

$default_unit = ( empty( $size_format ) ) ? ' B' : '';
$default_unit = ( empty( $size_format ) && ! $human_readable ) ? ' B' : '';

if ( $tables ) {

Expand Down Expand Up @@ -803,7 +812,7 @@ public function size( $args, $assoc_args ) {
);
}

if ( ! empty( $size_format ) ) {
if ( ! empty( $size_format ) || $human_readable ) {
foreach( $rows as $index => $row ) {
// These added WP 4.4.0.
if ( ! defined( 'KB_IN_BYTES' ) ) {
Expand All @@ -819,6 +828,13 @@ public function size( $args, $assoc_args ) {
define( 'TB_IN_BYTES', 1024 * GB_IN_BYTES );
}

if ( $human_readable ) {
$size_key = floor( log( $row['Size'] ) / log( 1000 ) );
$sizes = array( 'B', 'KB', 'MB', 'GB', 'TB' );
Comment thread
pmgarman marked this conversation as resolved.
Resolved

$size_format = isset( $sizes[ $size_key ] ) ? $sizes[ $size_key ] : $sizes[ 0 ];
}

// Display the database size as a number.
switch( $size_format ) {
case 'TB':
Expand Down Expand Up @@ -869,7 +885,7 @@ public function size( $args, $assoc_args ) {
}
}

if ( ! empty( $size_format) && ! $tables && ! $format ) {
if ( ! empty( $size_format) && ! $tables && ! $format && ! $human_readable ) {
WP_CLI::Line( filter_var( $rows[0]['Size'], FILTER_SANITIZE_NUMBER_INT ) );
} else {
// Display the rows.
Expand Down