search

nats-io / nats-server

High-Performance server for NATS.io, the cloud and edge native messaging system.
https://nats.io
Apache License 2.0
15.15k stars 1.37k forks source link

Support for Key Search with Wildcards in NATS KV Methods #5540

Open burl21 opened 3 weeks ago

burl21 commented 3 weeks ago

Proposed change

I would like to request support for wildcard searches in the following NATS KV methods: ls and rm. This feature would enhance the flexibility and usability of NATS KV by allowing users to list and delete multiple keys that match a certain pattern.

Use case

In scenarios where multiple keys follow a naming pattern, such as cache entries, logs, or configuration settings, being able to fetch or remove them all with a single wildcard query would save time and reduce code complexity. This feature is particularly useful in large-scale applications where the number of keys can be substantial.

Consider a bucket named test with the following entries:

•   test.cache1
•   test.cache2

Using the ls and rm methods with a wildcard, such as nats kv ls test "test.*" or nats kv rm test "test.*", should list and delete both test.cache1 and test.cache2, respectively. This functionality is crucial for efficiently managing related key-value pairs without having to handle each key individually.

Contribution

No response

derekcollison commented 3 weeks ago

The CLI ls is for buckets. However in the Go client, ListKeys can take a filter subject. Delete has no DeleteMulti at this point in time, but might be a good addition.

Not sure this is a server issues though. /cc @ripienaar and @piotrpio and @Jarema

ripienaar commented 3 weeks ago

nats kv ls BUCKET for keys, I will add a subject filter.

ripienaar commented 3 weeks ago

Actually, I do not see how ListKeys can take a filter - internally it always use WatchAll. We certainly could support that though.

ripienaar commented 3 weeks ago

Since delete is a put in reality, I am reluctant to do a range as we cannot do that in an atomic manner today

Jarema commented 2 weeks ago

Here is the ADR describing the new API in the clients: https://github.com/nats-io/nats-architecture-and-design/pull/288

Clients will soon follow up with implementing them. Here is the reference issue in Go client: https://github.com/nats-io/nats.go/issues/1655

This does not include delete with wildcards, as that is a more complex story that requires server changes.

Zetanova commented 5 days ago

I hade an idea to virtual-bucket that is related to this issue https://github.com/nats-io/nats-server/issues/5204#issuecomment-2081554896