spring-projects / spring-projects/spring-data-redis

Improve pipelining documentation [DATAREDIS-343]

Open
#920 0 comments 0 reactions 1 assignee View on GitHub

@christophstrobl is already working on this.

Since Dec 30, 2020.

type: documentation type: enhancement
Dominant language
Java
Stars
1.9k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

Greg Dubicki opened DATAREDIS-343 and commented

Please consider improving pipelining documentation, especially:

  1. Provide an example code for using "the standard execute method, passing true for the pipeline argument".

  2. Provide an example code for using executePipelined with various (not just RPOP) operations returning different data types and show what you will get.

  3. Clarify these two sentences "The results List contains all of the popped items. RedisTemplate uses its value, hash key, and hash value serializers to deserialize all results before returning, so the returned items in the above example will be Strings." - what is the "it" the second sentence references to? RedisTemplate? Either I don't get it or there is some error here..

  4. Why in provided example code does doInRedis() method return an Object but in fact it returns a null? Is it possible to return anything else? What is the point of it? Should it just be a void method instead?

  5. Use "list", not "queue" name for the data type on which RPOP operates on, as this is the name this type is called Redis in documentation


Affects: 1.4 M1 (Evans), 1.3.4 (Dijkstra SR4)

Reference URL: http://docs.spring.io/spring-data/redis/docs/current/reference/html/redis.html#pipeline

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.