1. Object name

Name of Redisson object stored as a key in Redis or Valkey.

Example:

  1. RMap map = redisson.getMap("mymap");
  3. map.getName(); // = mymap

2. Common methods

Each Redisson object implements RObject and RExpirable interfaces.

Below are the most commonly used methods.

  1. RObject object = ...
  3. // Copy methods
  5. object.copy("myNewCopy");
  7. object.copyAndReplace("myNewCopy");
  9. // Delete methods
  11. object.delete();
  13. object.unlink(); // works faster because it's executed  on the database side in a different thread
  15. // Rename methods
  17. object.rename("myNewName");
  19. object.renamenx("myNewName"); // rename only if the new key doesn't exist
  21. // Dump and restore methods
  23. byte[] state = object.dump();
  24. object.restore(state);

3. Listeners per Redisson object instance

Listeners can be attached per Redisson object instance. Base listeners are ExpiredObjectListener and DeletedObjectListener. Redisson objects may support specific listeners. Like RScoredSortedSet), RStream) and others.

  1. RObject object = ...
  3. // listening to expired events
  4. object.addListener((ExpiredObjectListener) name -> {
  6.    //...
  8. });
  10. // listening to delete events
  11. object.addListener((DeletedObjectListener) name -> {
  13.    //...
  15. });

4. Operations over all Redisson object instances

Operations over all objects are exposed by RKeys interface.

Usage example:

  1. RKeys keys = redisson.getKeys();
  3. // Keys iteration
  5. Iterable<String> allKeys = keys.getKeys();
  7. Iterable<String> foundedKeys = keys.getKeys(KeysScanOptions.defaults().pattern("key*"));
  9. String randomKey = keys.randomKey();
  11. long keysAmount = keys.count();
  13. long keysAmount = keys.countExists("obj1", "obj2", "obj3"); // amount of existing keys
  15. // Delete methods
  17. long delKeys = keys.delete("obj1", "obj2", "obj3");
  19. long delKeys = keys.deleteByPattern("test?");
  21. long delKeys = keys.unlink("obj1", "obj2", "obj3"); // works faster because it's executed  on the database side in a different thread
  23. long delKeys = keys.unlinkByPattern("test?"); // works faster because it's executed  on the database side in a different thread
  25. keys.flushall(); // Delete all keys of all existing databases
  27. keys.flushallParallel(); // Delete all keys of all existing databases in background without blocking server
  29. keys.flushdb(); // Delete all keys of currently selected database

5. Global listeners

Global listeners are attached to all Redisson object instances.

Available listeners:

Usage example:

  1. RKeys keys = redisson.getKeys();
  2. int id = keys.addListener((NewObjectListener) name -> {
  4.    //...
  6. });
  8. int id = keys.addListener((DeletedObjectListener) name -> {
  10.    //...
  12. });
  15. // Flush listener is executed on flushall/flushdb commands execution.
  17. int id = keys.addListener((FlushListener) address -> {
  19.    //...
  21. });
  23. keys.removeListener(id);