Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bits and pieces to clean up #2995

Merged
merged 2 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Lettuce

Lettuce is released under the Apache 2.0 license. If you would like to contribute something, or simply want to hack on the code this document should help you get started.
Lettuce is released under the MIT license. If you would like to contribute something, or simply want to hack on the code this document should help you get started.

## Code of Conduct

Expand Down
2 changes: 2 additions & 0 deletions .github/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -251,3 +251,5 @@ unix
uring
whitespace
xml
RedisJSON
MkDocs
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
<img src="https://avatars2.githubusercontent.com/u/25752188?v=4" width="50" height="50"> Lettuce - Advanced Java Redis client
===============================

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.lettuce/lettuce-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.lettuce/lettuce-core)
[![Javadocs](https://www.javadoc.io/badge/io.lettuce/lettuce-core.svg)](https://www.javadoc.io/doc/io.lettuce/lettuce-core)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
[![Integration](https://github.com/redis/lettuce/actions/workflows/integration.yml/badge.svg?branch=main)](https://github.com/redis/lettuce/actions/workflows/integration.yml)
[![codecov](https://codecov.io/gh/redis/lettuce/branch/main/graph/badge.svg?token=pAstxAAjYo)](https://codecov.io/gh/redis/lettuce)
[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/redis)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.lettuce/lettuce-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.lettuce/lettuce-core)
[![Javadocs](https://www.javadoc.io/badge/io.lettuce/lettuce-core.svg)](https://www.javadoc.io/doc/io.lettuce/lettuce-core)

[![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.gg/redis)
[![Twitch](https://img.shields.io/twitch/status/redisinc?style=social)](https://www.twitch.tv/redisinc)
[![YouTube](https://img.shields.io/youtube/channel/views/UCD78lHSwYqMlyetR0_P4Vig?style=social)](https://www.youtube.com/redisinc)
[![Twitter](https://img.shields.io/twitter/follow/redisinc?style=social)](https://twitter.com/redisinc)

Lettuce is a scalable thread-safe Redis client for synchronous,
asynchronous and reactive usage. Multiple threads may share one connection if they avoid blocking and transactional
Expand Down Expand Up @@ -43,16 +47,6 @@ See the [reference documentation](https://redis.github.io/lettuce/) and [API Ref

[Work at Redis](https://redis.com/company/careers/jobs/)

Communication
---------------

* [GitHub Discussions](https://github.com/redis/lettuce/discussions) (Q&A, Ideas, General discussion)
* Stack Overflow (Questions): [https://stackoverflow.com/questions/tagged/lettuce](https://stackoverflow.com/questions/tagged/lettuce)
* Discord: [![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.gg/redis)
* Twitter: [![Twitter](https://img.shields.io/twitter/follow/redisinc?style=social)](https://twitter.com/redisinc)
* [GitHub Issues](https://github.com/redis/lettuce/issues) (Bug reports, feature requests)


Documentation
---------------

Expand Down
7 changes: 7 additions & 0 deletions docs/new-features.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# New & Noteworthy

## What’s new in Lettuce 6.5

- [RedisJSON support](user-guide/redis-json.md) through `RedisJSONCommands` and the respective reactive, async and Kotlin APIs
- Complete support for all `CLUSTER` commands (added `CLUSTER MYSHARDID` and `CLUSTER LINKS`)
- Added support for the `CLIENT TRACKING` command
- Migrated the documentation to [MkDocs](https://www.mkdocs.org/)

## What’s new in Lettuce 6.4

- [Hash Field Expiration](https://redis.io/docs/latest/develop/data-types/hashes/#field-expiration) is now fully supported
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ public interface RedisHashReactiveCommands<K, V> {
* @param channel streaming channel that receives a call for every key.
* @param key the key.
* @return StreamScanCursor scan cursor.
* @deprecated since 7.0 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* @deprecated since 6.4 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* {@link #hscanNovalues}.
*/
@Deprecated
Expand All @@ -340,7 +340,7 @@ public interface RedisHashReactiveCommands<K, V> {
* @param key the key.
* @param scanArgs scan arguments.
* @return StreamScanCursor scan cursor.
* @deprecated since 7.0 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* @deprecated since 6.4 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* {@link #hscanNovalues}.
*/
@Deprecated
Expand Down Expand Up @@ -368,7 +368,7 @@ public interface RedisHashReactiveCommands<K, V> {
* @param scanCursor cursor to resume from a previous scan, must not be {@code null}.
* @param scanArgs scan arguments.
* @return StreamScanCursor scan cursor.
* @deprecated since 7.0 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* @deprecated since 6.4 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* {@link #hscanNovalues}.
*/
@Deprecated
Expand All @@ -394,7 +394,7 @@ public interface RedisHashReactiveCommands<K, V> {
* @param key the key.
* @param scanCursor cursor to resume from a previous scan, must not be {@code null}.
* @return StreamScanCursor scan cursor.
* @deprecated since 7.0 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* @deprecated since 6.4 in favor of consuming large results through the {@link org.reactivestreams.Publisher} returned by
* {@link #hscanNovalues}.
*/
@Deprecated
Expand Down
2 changes: 1 addition & 1 deletion src/main/kotlin/io/lettuce/core/ScanFlow.kt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ object ScanFlow {
* @param key the key.
* @param scanArgs scan arguments.
* @return `Flow<KeyValue<K, V>>` flow of key-values.
* @since 7.0
* @since 6.4
*/
fun <K : Any, V : Any> hscanNovalues(commands: RedisHashCoroutinesCommands<K, V>, key: K, scanArgs: ScanArgs? = null): Flow<K> {
val ops = when (commands) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ interface BaseRedisCoroutinesCommands<K : Any, V : Any> {
*
* @param shardChannels channel keys.
* @return array-reply a list of channels and number of subscribers for every channel.
* @since 7.0
* @since 6.4
*/
suspend fun pubsubShardNumsub(vararg shardChannels: K): Map<K, Long>?

Expand All @@ -108,7 +108,7 @@ interface BaseRedisCoroutinesCommands<K : Any, V : Any> {
* @param shardChannel the shard channel type: key.
* @param message the message type: value.
* @return Long integer-reply the number of clients that received the message.
* @since 7.0
* @since 6.4
*/
suspend fun spublish(shardChannel: K, message: V): Long?

Expand Down
Loading
Loading