Skip to content

Commit 62dd89f

Browse files
danielbachhuberdanielbachhuber
committed
Expand upon wp db * docs
1 parent 167bf00 commit 62dd89f

File tree

11 files changed

+47
-21
lines changed

11 files changed

+47
-21
lines changed

‎commands/db/cli/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: 'wp db cli'
44
display_global_parameters: true
55
---
66

7-
`wp db cli` - Open a mysql console using the WordPress credentials.
7+
`wp db cli` - Open a MySQL console using credentials from wp-config.php
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-cli+sort%3Aupdated-desc">Github issues</a></small>
1010

‎commands/db/create/index.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ title: 'wp db create'
44
display_global_parameters: true
55
---
66

7-
`wp db create` - Create the database, as specified in wp-config.php
7+
`wp db create` - Create the database in MySQL.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-create+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13-
13+
Runs `CREATE_DATABASE` MySQL statement using `DB_HOST`, `DB_NAME`,
14+
`DB_USER` and `DB_PASSWORD` database credentials specified in
15+
wp-config.php.
1416

1517

1618

‎commands/db/drop/index.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ title: 'wp db drop'
44
display_global_parameters: true
55
---
66

7-
`wp db drop` - Delete the database.
7+
`wp db drop` - Delete the database in MySQL.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-drop+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13+
Runs `DROP_DATABASE` MySQL statement using `DB_HOST`, `DB_NAME`,
14+
`DB_USER` and `DB_PASSWORD` database credentials specified in
15+
wp-config.php.
16+
1317
### OPTIONS
1418

1519
[\--yes]

‎commands/db/export/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ title: 'wp db export'
44
display_global_parameters: true
55
---
66

7-
`wp db export` - Exports the database to a file or to STDOUT.
7+
`wp db export` - Exports the MySQL database to a file or to STDOUT.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-export+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13+
Runs `mysqldump` utility using `DB_HOST`, `DB_NAME`, `DB_USER` and
14+
`DB_PASSWORD` database credentials specified in wp-config.php.
15+
1316
### OPTIONS
1417

1518
[&lt;file&gt;]

‎commands/db/import/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: 'wp db import'
44
display_global_parameters: true
55
---
66

7-
`wp db import` - Import database from a file or from STDIN.
7+
`wp db import` - Import a MySQL database from a file or from STDIN.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-import+sort%3Aupdated-desc">Github issues</a></small>
1010

‎commands/db/index.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,43 +26,43 @@ display_global_parameters: true
2626
<tbody>
2727
<tr>
2828
<td><a href="/commands/db/cli/">cli</a></td>
29-
<td>Open a mysql console using the WordPress credentials.</td>
29+
<td>Open a MySQL console using credentials from wp-config.php</td>
3030
</tr>
3131
<tr>
3232
<td><a href="/commands/db/create/">create</a></td>
33-
<td>Create the database, as specified in wp-config.php</td>
33+
<td>Create the database in MySQL.</td>
3434
</tr>
3535
<tr>
3636
<td><a href="/commands/db/drop/">drop</a></td>
37-
<td>Delete the database.</td>
37+
<td>Delete the database in MySQL.</td>
3838
</tr>
3939
<tr>
4040
<td><a href="/commands/db/export/">export</a></td>
41-
<td>Exports the database to a file or to STDOUT.</td>
41+
<td>Exports the MySQL database to a file or to STDOUT.</td>
4242
</tr>
4343
<tr>
4444
<td><a href="/commands/db/import/">import</a></td>
45-
<td>Import database from a file or from STDIN.</td>
45+
<td>Import a MySQL database from a file or from STDIN.</td>
4646
</tr>
4747
<tr>
4848
<td><a href="/commands/db/optimize/">optimize</a></td>
49-
<td>Optimize the database.</td>
49+
<td>Optimize the database in MySQL.</td>
5050
</tr>
5151
<tr>
5252
<td><a href="/commands/db/query/">query</a></td>
53-
<td>Execute a query against the database.</td>
53+
<td>Execute a MySQL query against the database.</td>
5454
</tr>
5555
<tr>
5656
<td><a href="/commands/db/repair/">repair</a></td>
57-
<td>Repair the database.</td>
57+
<td>Repair the database in MySQL.</td>
5858
</tr>
5959
<tr>
6060
<td><a href="/commands/db/reset/">reset</a></td>
61-
<td>Remove all tables from the database.</td>
61+
<td>Remove all tables from the database in MySQL.</td>
6262
</tr>
6363
<tr>
6464
<td><a href="/commands/db/tables/">tables</a></td>
65-
<td>List the database tables.</td>
65+
<td>List the MySQL database tables.</td>
6666
</tr>
6767
</tbody>
6868
</table>

‎commands/db/optimize/index.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@ title: 'wp db optimize'
44
display_global_parameters: true
55
---
66

7-
`wp db optimize` - Optimize the database.
7+
`wp db optimize` - Optimize the database in MySQL.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-optimize+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13+
Runs `mysqlcheck` utility with `--optimize=true` using `DB_HOST`,
14+
`DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
15+
specified in wp-config.php.
1316

17+
[See docs](http://dev.mysql.com/doc/refman/5.7/en/optimize-table.html)
18+
for more details on the `OPTIMIZE_TABLE` statement.
1419

1520

1621

‎commands/db/query/index.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@ title: 'wp db query'
44
display_global_parameters: true
55
---
66

7-
`wp db query` - Execute a query against the database.
7+
`wp db query` - Execute a MySQL query against the database.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-query+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13+
Executes an arbitrary MySQL query using `DB_HOST`, `DB_NAME`, `DB_USER`
14+
and `DB_PASSWORD` database credentials specified in wp-config.php.
15+
1316
### OPTIONS
1417

1518
[&lt;sql&gt;]

‎commands/db/repair/index.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@ title: 'wp db repair'
44
display_global_parameters: true
55
---
66

7-
`wp db repair` - Repair the database.
7+
`wp db repair` - Repair the database in MySQL.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-repair+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13+
Runs `mysqlcheck` utility with `--repair=true` using `DB_HOST`,
14+
`DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
15+
specified in wp-config.php.
1316

17+
[See docs](http://dev.mysql.com/doc/refman/5.7/en/repair-table.html) for
18+
more details on the `REPAIR_TABLE` statement.
1419

1520

1621

‎commands/db/reset/index.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ title: 'wp db reset'
44
display_global_parameters: true
55
---
66

7-
`wp db reset` - Remove all tables from the database.
7+
`wp db reset` - Remove all tables from the database in MySQL.
88

99
<small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Adb-reset+sort%3Aupdated-desc">Github issues</a></small>
1010

1111
<hr />
1212

13+
Runs `DROP_DATABASE` and `CREATE_DATABASE` MySQL statements using
14+
`DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
15+
specified in wp-config.php.
16+
1317
### OPTIONS
1418

1519
[\--yes]

0 commit comments

Comments
 (0)