Module: Redis::Commands::Connection

Defined in:
lib/redis/commands/connection.rb

Instance Method Summary collapse

Instance Method Details

#auth(*args) ⇒ String

Authenticate to the server.

Parameters:

  • args (Array<String>) —

    includes both username and password or only password

Returns:

  • (String) —

    ‘OK`

See Also:



12
13
14
 
# File 'lib/redis/commands/connection.rb', line 12

def auth(*args)
  send_command([:auth, *args])
end

#echo(value) ⇒ String

Echo the given string.

Parameters:

  • value (String)

Returns:

  • (String) 


28
29
30
 
# File 'lib/redis/commands/connection.rb', line 28

def echo(value)
  send_command([:echo, value])
end

#ping(message = nil) ⇒ String

Ping the server.

Parameters:

  • message (optional, String) (defaults to: nil)

Returns:

  • (String) —

    ‘PONG`



20
21
22
 
# File 'lib/redis/commands/connection.rb', line 20

def ping(message = nil)
  send_command([:ping, message].compact)
end

#quit ⇒ String

Close the connection.

Returns:

  • (String) —

    ‘OK`



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/redis/commands/connection.rb', line 46

def quit
  synchronize do |client|
    begin
      client.call([:quit])
    rescue ConnectionError
    ensure
      client.disconnect
    end
  end
end

#select(db) ⇒ String

Change the selected database for the current connection.

Parameters:

  • db (Integer) —

    zero-based index of the DB to use (0 to 15)

Returns:

  • (String) —

    ‘OK`



36
37
38
39
40
41
 
# File 'lib/redis/commands/connection.rb', line 36

def select(db)
  synchronize do |client|
    client.db = db
    client.call([:select, db])
  end
end