org.redisson.api.RKeysReactive Maven / Gradle / Ivy
/**
* Copyright 2018 Nikita Koksharov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.redisson.api;
import java.util.Collection;
import java.util.concurrent.TimeUnit;
import org.reactivestreams.Publisher;
/**
*
* @author Nikita Koksharov
*
*/
public interface RKeysReactive {
/**
* Move object to another database
*
* @param name of object
* @param database - Redis database number
* @return true if key was moved else false
*/
Publisher move(String name, int database);
/**
* Transfer object from source Redis instance to destination Redis instance
*
* @param name of object
* @param host - destination host
* @param port - destination port
* @param database - destination database
* @param timeout - maximum idle time in any moment of the communication with the destination instance in milliseconds
*/
Publisher migrate(String name, String host, int port, int database, long timeout);
/**
* Copy object from source Redis instance to destination Redis instance
*
* @param name of object
* @param host - destination host
* @param port - destination port
* @param database - destination database
* @param timeout - maximum idle time in any moment of the communication with the destination instance in milliseconds
*/
Publisher copy(String name, String host, int port, int database, long timeout);
/**
* Set a timeout for object. After the timeout has expired,
* the key will automatically be deleted.
*
* @param name of object
* @param timeToLive - timeout before object will be deleted
* @param timeUnit - timeout time unit
* @return true if the timeout was set and false if not
*/
Publisher expire(String name, long timeToLive, TimeUnit timeUnit);
/**
* Set an expire date for object. When expire date comes
* the key will automatically be deleted.
*
* @param name of object
* @param timestamp - expire date in milliseconds (Unix timestamp)
* @return true if the timeout was set and false if not
*/
Publisher expireAt(String name, long timestamp);
/**
* Clear an expire timeout or expire date for object.
*
* @param name of object
* @return true if timeout was removed
* false if object does not exist or does not have an associated timeout
*/
Publisher clearExpire(String name);
/**
* Rename object with oldName to newName
* only if new key is not exists
*
* @param oldName - old name of object
* @param newName - new name of object
* @return true if object has been renamed successfully and false otherwise
*/
Publisher renamenx(String oldName, String newName);
/**
* Rename current object key to newName
*
* @param currentName - current name of object
* @param newName - new name of object
*/
Publisher rename(String currentName, String newName);
/**
* Remaining time to live of Redisson object that has a timeout
*
* @param name of key
* @return time in milliseconds
* -2 if the key does not exist.
* -1 if the key exists but has no associated expire.
*/
Publisher remainTimeToLive(String name);
/**
* Update the last access time of an object.
*
* @param names of keys
* @return count of objects were touched
*/
Publisher touch(String... names);
/**
* Checks if provided keys exist
*
* @param names of keys
* @return amount of existing keys
*/
Publisher countExists(String... names);
/**
* Get Redis object type by key
*
* @param key - name of key
* @return type of key
*/
Publisher getType(String key);
/**
* Load keys in incrementally iterate mode.
*
* Uses SCAN Redis command.
*
* @return all keys
*/
Publisher getKeys();
/**
* Find keys by pattern and load it in incrementally iterate mode.
*
* Uses SCAN Redis command.
*
* Supported glob-style patterns:
* h?llo subscribes to hello, hallo and hxllo
* h*llo subscribes to hllo and heeeello
* h[ae]llo subscribes to hello and hallo, but not hillo
*
* @param pattern - match pattern
* @return keys
*/
Publisher getKeysByPattern(String pattern);
/**
* Get hash slot identifier for key.
* Available for cluster nodes only.
*
* Uses KEYSLOT Redis command.
*
* @param key - name of key
* @return slot number
*/
Publisher getSlot(String key);
/**
* Find keys by key search pattern by one Redis call.
*
* Uses KEYS Redis command.
*
* Supported glob-style patterns:
* h?llo subscribes to hello, hallo and hxllo
* h*llo subscribes to hllo and heeeello
* h[ae]llo subscribes to hello and hallo, but not hillo
*
* @param pattern - match pattern
* @return collection of keys
*/
Publisher> findKeysByPattern(String pattern);
/**
* Get random key
*
* Uses RANDOM_KEY Redis command.
*
* @return random key
*/
Publisher randomKey();
/**
* Delete multiple objects by a key pattern.
*
* Uses Lua script.
*
* Supported glob-style patterns:
* h?llo subscribes to hello, hallo and hxllo
* h*llo subscribes to hllo and heeeello
* h[ae]llo subscribes to hello and hallo, but not hillo
*
* @param pattern - match pattern
* @return deleted objects amount
*/
Publisher deleteByPattern(String pattern);
/**
* Delete multiple objects by name.
*
* Uses DEL Redis command.
*
* @param keys - object names
* @return deleted objects amount
*/
Publisher delete(String ... keys);
/**
* Delete multiple objects by name.
* Actual removal will happen later asynchronously.
*
* Requires Redis 4.0+
*
* @param keys of objects
* @return number of removed keys
*/
Publisher unlink(String ... keys);
/**
* Returns the number of keys in the currently-selected database
*
* @return count of keys
*/
Publisher count();
/**
* Delete all the keys of the currently selected database
*
* Uses FLUSHDB Redis command.
*
* @return void
*/
Publisher flushdb();
/**
* Delete all the keys of all the existing databases
*
* Uses FLUSHALL Redis command.
*
* @return void
*/
Publisher flushall();
}