ServerCommands

Abstract Value Members

abstract val DefaultCommandOptions: CommandOptions

Attributes
protected
Definition Classes
Async
abstract def async[A](body: (Client) ⇒ A)(implicit opts: CommandOptions): Future[A]

Attributes
protected
Definition Classes
Async

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bgRewriteAOF()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Asynchronously rewrites the append-only file.
Asynchronously rewrites the append-only file.

Since
1.0.0
def bgSave()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Asynchronously saves the dataset to disk.
Asynchronously saves the dataset to disk.

Since
1.0.0
Exceptions thrown
[[scredis.exceptions.RedisCommandException]]
if the background save is already in progress
def clientGetName()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Option[String]]

Get the current client name.
Get the current client name.
returns
option containing the name if it has been set, None otherwise

Since
2.6.9
def clientKill(addr: String)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Kills the connection of a client.
Kills the connection of a client.
addr
string containing ip and port separated by colon, i.e. "ip:port"

Since
2.4.0
Exceptions thrown
RedisCommandException
if the the client does not exist
def clientKillFromIpPort(ip: String, port: Int)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Kills the connection of a client.
Kills the connection of a client.
ip
ip address of the target client
port
port of the target client

Since
2.4.0
Exceptions thrown
RedisCommandException
if the the client does not exist
def clientList()(implicit opts: CommandOptions = DefaultCommandOptions): Future[List[Map[String, String]]]

Gets the list of client connections.
Gets the list of client connections.
returns
list of clients

Since
2.4.0
def clientListRaw()(implicit opts: CommandOptions = DefaultCommandOptions): Future[String]

Gets the list of client connections.
Gets the list of client connections.
returns
raw string containing the list of clients as returned by Redis

Since
2.4.0
def clientSetName(name: String)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Sets the current client name.
Sets the current client name. If the empty string is provided, the name will be unset.
name
name to associate the client to, if empty, unsets the client name

Since
2.6.9
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def configGet(pattern: String = "*")(implicit opts: CommandOptions = DefaultCommandOptions): Future[Option[Map[String, Option[String]]]]

Gets the value of a configuration parameter.
Gets the value of a configuration parameter.
pattern
name or pattern of the configuration parameter to get
returns
option containing the matched parameters, or None if no parameters are matched

Since
2.0.0
def configResetStat()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Resets the stats returned by INFO.
Resets the stats returned by INFO.

Since
2.0.0
def configSet(key: String, value: Any)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Sets a configuration parameter to the given value.
Sets a configuration parameter to the given value.
key
parameter's name
value
value to set parameter to

Since
2.0.0
Exceptions thrown
[[scredis.exceptions.RedisCommandException]]
if the parameter could not be set
def dbSize()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Long]

Return the number of keys in the selected database.
Return the number of keys in the selected database.
returns
number of keys in the selected database

Since
1.0.0
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flushAll()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Removes all keys from all databases.
Removes all keys from all databases.

Since
1.0.0
def flushDb()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Removes all keys from the current database.
Removes all keys from the current database.

Since
1.0.0
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def info()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Map[String, String]]

Gets information and statistics about the server.
Gets information and statistics about the server.
returns
map of field -> value pairs

Since
1.0.0
def infoBySection(section: String = "default")(implicit opts: CommandOptions = DefaultCommandOptions): Future[Map[String, String]]

Gets information and statistics about the server.
Gets information and statistics about the server.
section
name of the section for which data should be retrieved
returns
map of field -> value pairs that match the specified section, or an empty map if the section does not exist

Since
2.6.0
def infoBySectionRaw(section: String = "default")(implicit opts: CommandOptions = DefaultCommandOptions): Future[String]

Gets information and statistics about the server.
Gets information and statistics about the server.
section
name of the section for which data should be retrieved
returns
raw string containing lines of field:value pairs that match the specified section, as returned by Redis, or an empty string if the section does not exist

Since
2.6.0
def infoRaw()(implicit opts: CommandOptions = DefaultCommandOptions): Future[String]

Gets information and statistics about the server.
Gets information and statistics about the server.
returns
raw string containing lines of field:value pairs as returned by Redis

Since
1.0.0
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lastSave()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Long]

Gets the UNIX timestamp of the last successful save to disk.
Gets the UNIX timestamp of the last successful save to disk.
returns
UNIX timestamp

Since
1.0.0
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def save()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

Synchronously saves the dataset to disk.
Synchronously saves the dataset to disk.

Since
1.0.0
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def time()(implicit opts: CommandOptions = DefaultCommandOptions): Future[(Long, Long)]

Returns the current server time.
Returns the current server time.
returns
pair of longs containing (1) UNIX timestamp and (2) microseconds

Since
2.6.0
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait ServerCommands extends Async

Abstract Value Members

abstract val DefaultCommandOptions: CommandOptions

abstract def async[A](body: (Client) ⇒ A)(implicit opts: CommandOptions): Future[A]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def bgRewriteAOF()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def bgSave()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def clientGetName()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Option[String]]

def clientKill(addr: String)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def clientKillFromIpPort(ip: String, port: Int)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def clientList()(implicit opts: CommandOptions = DefaultCommandOptions): Future[List[Map[String, String]]]

def clientListRaw()(implicit opts: CommandOptions = DefaultCommandOptions): Future[String]

def clientSetName(name: String)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def clone(): AnyRef

def configGet(pattern: String = "*")(implicit opts: CommandOptions = DefaultCommandOptions): Future[Option[Map[String, Option[String]]]]

def configResetStat()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def configSet(key: String, value: Any)(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def dbSize()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Long]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flushAll()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

def flushDb()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

final def getClass(): Class[_]

def hashCode(): Int

def info()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Map[String, String]]

def infoBySection(section: String = "default")(implicit opts: CommandOptions = DefaultCommandOptions): Future[Map[String, String]]

def infoBySectionRaw(section: String = "default")(implicit opts: CommandOptions = DefaultCommandOptions): Future[String]

def infoRaw()(implicit opts: CommandOptions = DefaultCommandOptions): Future[String]

final def isInstanceOf[T0]: Boolean

def lastSave()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def save()(implicit opts: CommandOptions = DefaultCommandOptions): Future[Unit]

final def synchronized[T0](arg0: ⇒ T0): T0

def time()(implicit opts: CommandOptions = DefaultCommandOptions): Future[(Long, Long)]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Async

Inherited from AnyRef

Inherited from Any

Ungrouped