Skip to content

Commit

Permalink
chore: update readme (#606)
Browse files Browse the repository at this point in the history
* chore: update readme

* chore: update readme
  • Loading branch information
earayu authored Dec 17, 2024
1 parent 7a6ee72 commit 30da642
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ docker run -itd --network wescale-network --name wescale \
-e MYSQL_ROOT_PASSWORD=passwd \
-e MYSQL_PORT=3306 \
-e MYSQL_HOST=mysql-server \
apecloud/apecloud-mysql-scale:0.3.7 \
apecloud/apecloud-mysql-scale:0.3.8 \
/vt/examples/wesql-server/init_single_node_cluster.sh
```

Expand All @@ -71,6 +71,31 @@ mysql -h127.0.0.1 -uroot -ppasswd -P15306
mysql -h127.0.0.1 -uroot -ppasswd -P3306
```

Try out Declarative DDL:
```sql
SET @@enable_declarative_ddl=true;

CREATE DATABASE if not exists test;
USE test;

CREATE TABLE if not exists test_table (
id int primary key,
name varchar(255)
);

SHOW CREATE TABLE test_table;

CREATE TABLE if not exists test_table (
id int primary key,
name varchar(255),
email varchar(255),
profile varchar(255),
index (name, email)
);

SHOW CREATE TABLE test_table;
```

Clean up the containers:
```shell
docker rm -f mysql-server wescale
Expand Down Expand Up @@ -105,6 +130,15 @@ Join our [Discord](https://discord.com/channels/1308609231498510427/130860923149
# Developer
* [Use FailPoint Injection In WeScale.md](doc%2Fdeveloper%2FUse%20FailPoint%20Injection%20In%20WeScale.md)

# Monitoring
Once you have WeScale up and running, you can monitor the cluster using prometheus and grafana.
```bash
cd ./examples/metrics && ./start_dashboard.sh
```
Open your browser and navigate to `http://localhost:3000/dashboards` to view the dashboard.

![20241217-164819.jpeg](doc%2F20241217-164819.jpeg)

# Contributing
We welcome contributions to WeScale! If you have any ideas, bug reports, or feature requests,
please feel free to open an issue or submit a pull request.
Expand Down
Binary file added doc/20241217-164819.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 30da642

Please sign in to comment.