summaryrefslogtreecommitdiff
path: root/plugins/mysql-macports/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/mysql-macports/README.md')
-rw-r--r--plugins/mysql-macports/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/mysql-macports/README.md b/plugins/mysql-macports/README.md
new file mode 100644
index 000000000..a4224d9c0
--- /dev/null
+++ b/plugins/mysql-macports/README.md
@@ -0,0 +1,20 @@
+# MySQL-Macports plugin
+
+This plugin adds aliases for some of the commonly used [MySQL](https://www.mysql.com/) commands when installed using [MacPorts](https://www.macports.org/) on macOS.
+
+To use it, add `mysql-macports` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... mysql-macports)
+```
+
+For instructions on how to install MySQL using MacPorts, read the [MacPorts wiki](https://trac.macports.org/wiki/howto/MySQL/).
+
+## Aliases
+
+| Alias | Command | Description |
+| ------------ | --------------------------------------------------------- | ------------------------------------------ |
+| mysqlstart | `sudo /opt/local/share/mysql5/mysql/mysql.server start` | Start the MySQL server. |
+| mysqlstop | `sudo /opt/local/share/mysql5/mysql/mysql.server stop` | Stop the MySQL server. |
+| mysqlrestart | `sudo /opt/local/share/mysql5/mysql/mysql.server restart` | Restart the MySQL server. |
+| mysqlstatus | `mysqladmin5 -u root -p ping` | Check whether the MySQL server is running. |