mirror of https://github.com/go-redis/redis.git
1ed936eb09
* DOC-4232 added first stream example * DOC-4232 examples up to xadd_7 * DOC-4232 examples up to xread * DOC-4232 examples up to xclaim * DOC-4232 added remaining examples * DOC-4232 more fixes * DOC-4232 fix for test fail on CI build --------- Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| bf_tutorial_test.go | ||
| bitfield_tutorial_test.go | ||
| bitmap_tutorial_test.go | ||
| cmds_generic_test.go | ||
| cmds_hash_test.go | ||
| cmds_sorted_set_test.go | ||
| cmds_string_test.go | ||
| cms_tutorial_test.go | ||
| cuckoo_tutorial_test.go | ||
| geo_tutorial_test.go | ||
| hash_tutorial_test.go | ||
| hll_tutorial_test.go | ||
| json_tutorial_test.go | ||
| list_tutorial_test.go | ||
| lpush_lrange_test.go | ||
| set_get_test.go | ||
| sets_example_test.go | ||
| ss_tutorial_test.go | ||
| stream_tutorial_test.go | ||
| string_example_test.go | ||
| tdigest_tutorial_test.go | ||
| topk_tutorial_test.go | ||
README.md
Command examples for redis.io
These examples appear on the Redis documentation site as part of the tabbed examples interface.
How to add examples
- Create a Go test file with a meaningful name in the current folder.
- Create a single method prefixed with
Exampleand write your test in it. - Determine the id for the example you're creating and add it as the first line of the file:
// EXAMPLE: set_and_get. - We're using the Testable Examples feature of Go to test the desired output has been written to stdout.
Special markup
See https://github.com/redis-stack/redis-stack-website#readme for more details.
How to test the examples
- Start a Redis server locally on port 6379
- CD into the
doctestsdirectory - Run
go testto test all examples in the directory. - Run
go test filename.goto test a single file