You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-24Lines changed: 26 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,36 @@
2
2
[//]: #(SPDX-License-Identifier: Apache-2.0)
3
3
[//]: #(---)
4
4
5
-
# Rust Client for Proton SQL Streaming Engine
6
-
7
-
Rust client for [Proton / TimePlus]([url](https://www.timeplus.com/)https://www.timeplus.com/).
5
+
# Rust Client for Proton
6
+
7
+
Rust client for [Timeplus Proton](https://github.com/timeplus-io/proton).
8
8
9
9
Proton is a streaming SQL engine, a fast and lightweight alternative to Apache Flink, 🚀 powered by ClickHouse. It enables developers to solve streaming data processing, routing and analytics challenges from Apache Kafka, Redpanda and more sources, and send aggregated data to the downstream systems. Proton is the core engine of [Timeplus](https://timeplus.com), which is a cloud native streaming analytics platform.
10
10
11
+
The initial version(0.1.0) of the client was written by [Marvin Hansen](https://github.com/marvin-hansen). Thanks for the contribution.
11
12
12
-
## Install proton
13
+
## Install Proton
13
14
14
-
```
15
-
brew install proton
16
-
```
15
+
### As a single binary
16
+
17
+
On Linux or Mac, you can install it via `curl https://install.timeplus.com | sh`
18
+
19
+
On Mac, you can also install it via `brew install proton`
20
+
21
+
After you get the `proton` binary, you can start the Proton server via `proton server start`
17
22
18
-
1. Start the Proton server:
19
-
$ proton server start
23
+
In a separate terminal, connect to the server via `proton client` (Note: If you encounter a 'connection refused' error, use: proton client --host 127.0.0.1)
20
24
21
-
2. In a separate terminal, connect to the server:
22
-
$ proton client
23
-
(Note: If you encounter a 'connection refused' error, use: proton client --host 127.0.0.1)
25
+
### As a Docker container
26
+
27
+
```bash
28
+
docker run -d --pull always --name proton ghcr.io/timeplus-io/proton:latest
29
+
```
30
+
31
+
Proton is automatically started. Open the terminal of the container, and run `proton client`
24
32
25
-
3. To terminate the server, press ctrl+c in the server terminal.
26
33
27
-
For detailed usage and more information, check out the Timeplus documentation:
28
-
https://docs.timeplus.com/
34
+
For detailed usage and more information, check out the documentation: https://docs.timeplus.com/proton
29
35
30
36
31
37
## Install ProtonClient
@@ -34,7 +40,7 @@ Add the following to your Cargo.toml:
To see more examples of using Proton, check out the [examples](examples) folder.
96
+
To see more examples of using Proton, check out the [examples](https://github.com/timeplus-io/proton/tree/develop/examples) folder in Proton repo.
91
97
92
-
Check out the proton [documentation on the SQL Query syntax](https://docs.timeplus.com/query-syntax).
98
+
Please note, by default the SQL queries are in streaming mode. Learn more about SQL syntax at [Proton Documentation](https://docs.timeplus.com/query-syntax).
93
99
94
100
95
101
## Documentation
96
102
97
103
You find the full documentation for Proton at [docs.timeplus.com](https://docs.timeplus.com/proton) alongside documentation for the Timeplus (Cloud and BYOC) platform.
98
104
99
-
We also have a [FAQ](https://docs.timeplus.com/proton-faq/) for detailing how we chose Apache License 2.0, how Proton is related to ClickHouse, what features are available in Proton versus Timeplus, and more.
100
-
101
-
102
105
## Contributing
103
106
104
-
We welcome your contributions! If you are looking for issues to work on, try looking at [the issue list](FIXLINK).
107
+
We welcome your contributions!
105
108
106
109
## Need help?
107
110
108
111
Join our [Timeplus Community Slack](https://timeplus.com/slack) to connect with Timeplus engineers and other Proton users.
109
112
110
-
For filing bugs, suggesting improvements, or requesting new features, see the [open issues](FIXLINK) here on GitHub.
113
+
For filing bugs, suggesting improvements, or requesting new features, see the [open issues](https://github.com/timeplus-io/proton-rust-client/issues) here on GitHub.
111
114
112
115
## Licensing
113
116
114
117
Proton Rust Client uses Apache License 2.0. See details in the [LICENSE](LICENSE).
0 commit comments