123456789_123456789_123456789_123456789_123456789_

Module: Redis::Commands::Connection

Relationships & Source Files
Defined in: lib/redis/commands/connection.rb

Instance Method Summary

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:

[ GitHub ] 

  


# 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)
  
    • 





  [ GitHub ]


  

  


# 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
    

    
  
    • 





  [ GitHub ]


  

  


# 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
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/redis/commands/connection.rb', line 43



def quit
  synchronize do |client|
    client.call_v([:quit])
  rescue ConnectionError
  ensure
    client.close
  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
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/redis/commands/connection.rb', line 36



def select(db)
  send_command([:select, db])
end