Skip to content

Commit 478f5d6

Browse files
committed
docs: remove non-existent REDIS_USE_EXPLICIT_PIPELINE from README
The REDIS_USE_EXPLICIT_PIPELINE and REDIS_PERSECOND_USE_EXPLICIT_PIPELINE settings were documented in README but do not exist in settings.go. Removed the documentation to match the actual implementation. Signed-off-by: seonghyun <seonghyunoh@gmail.com>
1 parent dbd72e1 commit 478f5d6

File tree

1 file changed

+0
-1
lines changed

1 file changed

+0
-1
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1312,7 +1312,6 @@ For high throughput scenarios, ratelimit supports write buffering via [radix v4'
13121312

13131313
1. `REDIS_PIPELINE_WINDOW` & `REDIS_PERSECOND_PIPELINE_WINDOW`: controls how often buffered writes are flushed to the network connection. When set to a non-zero value (e.g., 150us-500us), radix v4 will buffer multiple concurrent write operations and flush them together, reducing system calls and improving throughput. If zero, each write is flushed immediately. **Required for Redis Cluster mode.**
13141314
1. `REDIS_PIPELINE_LIMIT` & `REDIS_PERSECOND_PIPELINE_LIMIT`: **DEPRECATED** - These settings have no effect in radix v4. Write buffering is controlled solely by the window settings above.
1315-
1. `REDIS_USE_EXPLICIT_PIPELINE` & `REDIS_PERSECOND_USE_EXPLICIT_PIPELINE`: controls whether to use explicit pipelining with `radix.NewPipeline()`. When `true`, commands are batched together and sent as a single pipeline request. When `false` (default), individual commands are sent with automatic write buffering via `WriteFlushInterval`. **IMPORTANT**: Explicit pipelining **CANNOT** be used with Redis Cluster mode. For cluster mode, this must be set to `false` and use `REDIS_PIPELINE_WINDOW` for write buffering instead. Only use this for single/sentinel mode when you specifically need explicit pipeline control. Default: `false`
13161315

13171316
Write buffering is disabled by default (window = 0). For optimal performance, set `REDIS_PIPELINE_WINDOW` to 150us-500us depending on your latency requirements and load patterns.
13181317

0 commit comments

Comments
 (0)