Merge pull request #37 from wp-cli/add-example-to-export-stdout

Introduce `wp db export --stdout`

Author: gitlost

features/db-export.feature

@@ -20,7 +20,7 @@ Feature: Export a WordPress database
       """
     And the wp_cli_test.sql file should exist
 
-  Scenario: Exclude tables when exporting the dtabase
+  Scenario: Exclude tables when exporting the database
     Given a WP install
 
     When I run `wp db export wp_cli_test.sql --exclude_tables=wp_users --porcelain`
@@ -33,3 +33,24 @@ Feature: Export a WordPress database
       """
       wp_options
       """
+
+  Scenario: Export database to STDOUT
+    Given a WP install
+
+    When I run `wp db export -`
+    Then STDOUT should contain:
+      """
+      -- MySQL dump
+      """
+
+    When I run `wp db export --stdout`
+    Then STDOUT should contain:
+      """
+      -- MySQL dump
+      """
+
+    When I try `wp db export - --stdout`
+    Then STDERR should be:
+      """
+      Error: The file name is not allowed when output mode is STDOUT.
+      """

src/DB_Command.php

@@ -269,6 +269,9 @@ public function query( $args, $assoc_args ) {
 	 * [--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.
 	 *
+	 * [--stdout]
+	 * : Output database to STDOUT.
+	 *
 	 * [--porcelain]
 	 * : Output filename for the exported database.
 	 *
@@ -302,6 +305,15 @@ public function query( $args, $assoc_args ) {
 	 *     $ wp db export --exclude_tables=$(wp db tables --all-tables-with-prefix --format=csv)
 	 *     Success: Exported to 'wordpress_dbase-db72bb5.sql'.
 	 *
+	 *     # Export database to STDOUT.
+	 *     $ wp db export --stdout
+	 *     -- MySQL dump 10.13  Distrib 5.7.19, for osx10.12 (x86_64)
+	 *     --
+	 *     -- Host: localhost    Database: wpdev
+	 *     -- ------------------------------------------------------
+	 *     -- Server version	5.7.19
+	 *     ...
+	 *
 	 * @alias dump
 	 */
 	public function export( $args, $assoc_args ) {
@@ -311,7 +323,19 @@ public function export( $args, $assoc_args ) {
 			$hash = substr( md5( mt_rand() ), 0, 7 );
 			$result_file = sprintf( '%s-%s-%s.sql', DB_NAME, date( 'Y-m-d' ), $hash );;
 		}
-		$stdout = ( '-' === $result_file );
+
+		if ( \WP_CLI\Utils\get_flag_value( $assoc_args, 'stdout' ) && ! empty( $args[0] ) ) {
+			WP_CLI::error( 'The file name is not allowed when output mode is STDOUT.' );
+		}
+
+		if ( \WP_CLI\Utils\get_flag_value( $assoc_args, 'stdout' ) ) {
+			$stdout = true;
+		} elseif ( '-' === $result_file ) {
+			$stdout = true;
+		} else {
+			$stdout = false;
+		}
+
 		$porcelain = \WP_CLI\Utils\get_flag_value( $assoc_args, 'porcelain' );
 
 		// Bail if both porcelain and STDOUT are set.
@@ -351,6 +375,7 @@ public function export( $args, $assoc_args ) {
 
 		// Remove parameters not needed for SQL run.
 		unset( $assoc_args['porcelain'] );
+		unset( $assoc_args['stdout'] );
 
 		self::run( $escaped_command, $assoc_args );