README: replace list of admin actions with examples
All checks were successful
Build and test / check (push) Successful in 2m5s
Build and test / check-license (push) Successful in 1m13s
Build and test / build (push) Successful in 3m42s
Build and test / test (push) Successful in 3m26s
Build and test / docs (push) Successful in 7m18s

This commit is contained in:
2025-12-18 18:33:41 +09:00
parent 186adefc22
commit 6de83d122e

View File

@@ -18,11 +18,28 @@ For example, a user would be allowed to manage items like `<user>_mydb`, `<user>
The available administrative operations include:
- creating/listing/modifying/deleting databases and database users
- modifying privileges for a database user on a database
- changing the passwords of the database users
- locking and unlocking database users
- ... and more
```bash
# Creating, listing, modifying, and deleting databases and database users
muscl create-db user_testdb
muscl create-user user_testuser --password strongpassword
muscl show-db
muscl drop-db group_projectdb
# Modifying privileges for a database user on a database
muscl edit-privs user_testdb user_testuser +suid
muscl edit-privs -p user_testdb:user_testuser:A -p group_projectdb:otheruser:-d
muscl show-privs --json
# Changing the passwords of the database users
muscl passwd-user user_testuser
muscl passwd-user user_otheruser --stdin <<<"hunter2"
# Locking and unlocking database users
muscl lock-user user_testuser
muscl unlock-user user_testuser
# And more...
```
The software is designed to be run as a client and a server. The clients are run by the unprivileged users,
and does not have direct access to the MySQL server. Instead, they communicate with the muscl server