Merge pull request #265 from wp-cli/261-update-search-docs

mrsdizzie · web-flow · commit ef0f52ef9064 · 2024-08-13T10:25:16.000-04:00
Update db search docs
diff --git a/src/DB_Command.php b/src/DB_Command.php
@@ -1266,6 +1266,15 @@ public function prefix() {
 	 *
 	 * [--format=<format>]
 	 * : Render output in a particular format.
+	 * ---
+	 * options:
+	 *   - table
+	 *   - csv
+	 *   - json
+	 *   - yaml
+	 *   - ids
+	 *   - count
+	 * ---
 	 *
 	 * The percent color codes available are:
 	 *
@@ -1301,6 +1310,16 @@ public function prefix() {
 	 *
 	 * They can be concatenated. For instance, the default match color of black on a mustard (dark yellow) background `%3%k` can be made black on a bright yellow background with `%Y%0%8`.
 	 *
+	 * ## AVAILABLE FIELDS
+	 *
+	 * These fields will be displayed by default for each result:
+	 *
+	 * * table
+	 * * column
+	 * * match
+	 * * primary_key_name
+	 * * primary_key_value
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     # Search through the database for the 'wordpress-develop' string

Original file line number	Diff line number	Diff line change
`@@ -1266,6 +1266,15 @@ public function prefix() {`
`1266`	`1266`	`*`
`1267`	`1267`	`* [--format=<format>]`
`1268`	`1268`	`* : Render output in a particular format.`
	`1269`	`+ * ---`
	`1270`	`+ * options:`
	`1271`	`+ * - table`
	`1272`	`+ * - csv`
	`1273`	`+ * - json`
	`1274`	`+ * - yaml`
	`1275`	`+ * - ids`
	`1276`	`+ * - count`
	`1277`	`+ * ---`
`1269`	`1278`	`*`
`1270`	`1279`	`* The percent color codes available are:`
`1271`	`1280`	`*`
`@@ -1301,6 +1310,16 @@ public function prefix() {`
`1301`	`1310`	`*`
`1302`	`1311`	* They can be concatenated. For instance, the default match color of black on a mustard (dark yellow) background `%3%k` can be made black on a bright yellow background with `%Y%0%8`.
`1303`	`1312`	`*`
	`1313`	`+ * ## AVAILABLE FIELDS`
	`1314`	`+ *`
	`1315`	`+ * These fields will be displayed by default for each result:`
	`1316`	`+ *`
	`1317`	`+ * * table`
	`1318`	`+ * * column`
	`1319`	`+ * * match`
	`1320`	`+ * * primary_key_name`
	`1321`	`+ * * primary_key_value`
	`1322`	`+ *`
`1304`	`1323`	`* ## EXAMPLES`
`1305`	`1324`	`*`
`1306`	`1325`	`* # Search through the database for the 'wordpress-develop' string`