Skip to content

Commit bb74f05

Browse files
committed
Update README to mention both 8213 and 3128 ports
1 parent 3d51754 commit bb74f05

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ This client uses https://crates.io/crates/clickhouse as a dependency.
1414

1515
## Install Proton
1616

17-
Please install Proton as a standalone server or via Docker. Make sure port 8123 is exposed for `pront-rust-client` to connect and run SQL.
17+
Please install Proton as a standalone server or via Docker. Make sure either port 8123 or 3218 is exposed for `pront-rust-client` to connect and run SQL.
18+
* 8123 is the port to run DDL and queries in historical mode
19+
* 3218 is the port to run DDL and quries in streaming mode by default. You can still wrap the stream with `table(..)` function to query them in historical mode.
20+
21+
Learn more
22+
* [SQL syntax](https://docs.timeplus.com/query-syntax)
23+
* [Proton ports](https://docs.timeplus.com/proton-ports)
1824

1925
### As a single binary
2026

@@ -99,7 +105,7 @@ pub async fn create_stream(client: &ProtonClient) -> Result<()> {
99105
}
100106
```
101107

102-
## Run the examples
108+
## Run the examples
103109

104110
```bash
105111
make example

examples/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@
55

66
## Install Proton
77

8-
Please install Proton as a standalone server or via Docker. Make sure port 8123 is exposed for `pront-rust-client` to connect and run SQL.
8+
Please install Proton as a standalone server or via Docker. Make sure either port 8123 or 3218 is exposed for `pront-rust-client` to connect and run SQL.
9+
* 8123 is the port to run DDL and queries in historical mode
10+
* 3218 is the port to run DDL and quries in streaming mode by default. You can still wrap the stream with `table(..)` function to query them in historical mode.
11+
12+
Learn more
13+
* [SQL syntax](https://docs.timeplus.com/query-syntax)
14+
* [Proton ports](https://docs.timeplus.com/proton-ports)
915

1016
### As a single binary
1117

0 commit comments

Comments
 (0)