diff --git a/docs/conf.py b/docs/conf.py index be6d8017ac..bad6711e84 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,6 +63,7 @@ "trio": ("https://trio.readthedocs.io/en/stable/", None), "pydantic": ("https://docs.pydantic.dev/latest/", None), "typing_extensions": ("https://typing-extensions.readthedocs.io/en/stable/", None), + "valkey": ("https://valkey-py.readthedocs.io/en/latest/", None), } napoleon_google_docstring = True @@ -102,6 +103,7 @@ (PY_CLASS, "sqlalchemy.dialects.postgresql.named_types.ENUM"), (PY_CLASS, "sqlalchemy.orm.decl_api.DeclarativeMeta"), (PY_CLASS, "sqlalchemy.sql.sqltypes.TupleType"), + (PY_CLASS, "valkey.asyncio.Valkey"), (PY_METH, "_types.TypeDecorator.process_bind_param"), (PY_METH, "_types.TypeDecorator.process_result_value"), (PY_METH, "litestar.typing.ParsedType.is_subclass_of"), diff --git a/docs/reference/stores/index.rst b/docs/reference/stores/index.rst index 8123ba1da4..23095869c3 100644 --- a/docs/reference/stores/index.rst +++ b/docs/reference/stores/index.rst @@ -8,3 +8,4 @@ stores memory redis registry + valkey diff --git a/docs/reference/stores/valkey.rst b/docs/reference/stores/valkey.rst new file mode 100644 index 0000000000..288118c2e3 --- /dev/null +++ b/docs/reference/stores/valkey.rst @@ -0,0 +1,5 @@ +valkey +====== + +.. automodule:: litestar.stores.valkey + :members: diff --git a/docs/usage/stores.rst b/docs/usage/stores.rst index e683eb81e3..253cc9deee 100644 --- a/docs/usage/stores.rst +++ b/docs/usage/stores.rst @@ -35,6 +35,12 @@ Built-in stores A store backend by `redis `_. It offers all the guarantees and features of Redis, making it suitable for almost all applications. Offers `namespacing`_. +:class:`ValKeyStore ` + A store backed by `valkey `_, a fork of Redis created as the result of Redis' license changes. + Similarly to the RedisStore, it is suitable for almost all applications and supports `namespacing`_. + At the time of writing, :class:`Valkey ` is equivalent to :class:`redis.asyncio.Redis`, + and all notes pertaining to Redis also apply to Valkey. + .. admonition:: Why not memcached? :class: info