Skip to content

docs: Document sending custom Redis commands#698

Open
marcelomendoncasoares wants to merge 1 commit into
serverpod:mainfrom
marcelomendoncasoares:docs/custom-redis-commands
Open

docs: Document sending custom Redis commands#698
marcelomendoncasoares wants to merge 1 commit into
serverpod:mainfrom
marcelomendoncasoares:docs/custom-redis-commands

Conversation

@marcelomendoncasoares

@marcelomendoncasoares marcelomendoncasoares commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

RedisController.getConnection() and the RedisCommand type are now exported, letting servers send Redis commands that the cache and server events APIs do not expose. The caching page had no coverage of this extension point.

Changes

  • Add a "Sending custom Redis commands" section at the end of the caching page.
  • Show reading the controller from the session, requesting a connection, and sending a command.
  • Explain that the connection is nullable when Redis is disabled or unreachable, including the development fallback case.
  • State the ownership rules: the connection is borrowed, not owned, and must not be closed or replaced.
  • Note that custom commands write directly to Redis, so keys need namespacing.
  • Replace "makes it easy to" in the page intro, per the style guide.

Reference

@marcelomendoncasoares
marcelomendoncasoares force-pushed the docs/custom-redis-commands branch from 941b14b to 105b9af Compare July 22, 2026 00:01
@marcelomendoncasoares
marcelomendoncasoares marked this pull request as ready for review July 22, 2026 00:01
@marcelomendoncasoares
marcelomendoncasoares requested a review from a team July 22, 2026 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant