redis.clients.jedis.commands.CommandCommands Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jedis Show documentation

Jedis is a blazingly small and sane Redis java client.

There is a newer version: 5.2.0

package redis.clients.jedis.commands;

import redis.clients.jedis.params.CommandListFilterByParams;
import redis.clients.jedis.resps.CommandDocument;
import redis.clients.jedis.resps.CommandInfo;
import redis.clients.jedis.util.KeyValue;

import java.util.List;
import java.util.Map;

public interface CommandCommands {

  /**
   * The number of total commands in this Redis server
   * @return The number of total commands
   */
  long commandCount();

  /**
   * Return documentary information about commands.
   * If not specifying commands, the reply includes all the server's commands.
   * @param commands specify the names of one or more commands
   * @return list of {@link CommandDocument}
   */

  Map commandDocs(String... commands);

  /**
   * Return list of keys from a full Redis command
   * @param command
   * @return list of keys
   */
  List commandGetKeys(String... command);

  /**
   * Return list of keys from a full Redis command and their usage flags
   * @param command
   * @return list of {@link KeyValue}
   */
  List>> commandGetKeysAndFlags(String... command);

  /**
   * Return details about multiple Redis commands
   * @param commands
   * @return list of {@link CommandInfo}
   */
  Map commandInfo(String... commands);

  /**
   * Return a list of the server's command names
   * @return commands list
   */
  List commandList();

  /**
   * Return a list of the server's command names filtered by module's name, ACL category or pattern
   * @param filterByParams {@link CommandListFilterByParams}
   * @return commands list
   */
  List commandListFilterBy(CommandListFilterByParams filterByParams);
}