Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tyt2y3 committed May 5, 2024
1 parent c6c9466 commit b7f696d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,12 @@ In Redis, shards and nodes is a M-N mapping - shards can be moved among nodes *a
It makes testing much more difficult.
Let us know if you'd like to help!

You can quickly start a Redis instance via Docker:

```sh
docker run -d --rm --name redis -p 6379:6379 redis
```

There is also a [small utility](https://github.com/SeaQL/sea-streamer/tree/main/sea-streamer-redis/redis-streams-dump) to dump Redis Streams messages into a SeaStreamer file.

This crate is built on top of [`redis`](https://docs.rs/redis).
Expand Down
2 changes: 1 addition & 1 deletion examples/sea-orm-sink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This example demonstrates how to consume a stream from Redis / Kafka and store t
It will create the table automatically. You have to run the `price-feed` example first. It will subscribe to `GBP_USD` and saves to `GBP_USD.sqlite` by default. Incoming JSON messages will be deserialized and inserted into database.

```sh
cargo run
RUST_LOG=info cargo run
```

A more complex example with buffering and periodic flush can be found at https://github.com/SeaQL/FireDBG.for.Rust/blob/main/indexer/src/main.rs
Expand Down
1 change: 0 additions & 1 deletion sea-streamer-redis/NOTES.md

This file was deleted.

6 changes: 6 additions & 0 deletions sea-streamer-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ In Redis, shards and nodes is a M-N mapping - shards can be moved among nodes *a
It makes testing much more difficult.
Let us know if you'd like to help!

You can quickly start a Redis instance via Docker:

```sh
docker run -d --rm --name redis -p 6379:6379 redis
```

There is also a [small utility](https://github.com/SeaQL/sea-streamer/tree/main/sea-streamer-redis/redis-streams-dump) to dump Redis Streams messages into a SeaStreamer file.

This crate is built on top of [`redis`](https://docs.rs/redis).
6 changes: 6 additions & 0 deletions sea-streamer-redis/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@
//! It makes testing much more difficult.
//! Let us know if you'd like to help!
//!
//! You can quickly start a Redis instance via Docker:
//!
//! ```sh
//! docker run -d --rm --name redis -p 6379:6379 redis
//! ```
//!
//! There is also a [small utility](https://github.com/SeaQL/sea-streamer/tree/main/sea-streamer-redis/redis-streams-dump) to dump Redis Streams messages into a SeaStreamer file.
//!
//! This crate is built on top of [`redis`](https://docs.rs/redis).
Expand Down

0 comments on commit b7f696d

Please sign in to comment.