Class: MultiResult

Inherits:
Object
  • Object
show all
Defined in:
lib/multi_result.rb

Overview

Represents the result of a Valkey/Redis transaction operation.

This class encapsulates the outcome of a Database transaction, providing access to both the success status and the individual command results returned by the transaction.

Examples:

Creating a MultiResult instance

result = MultiResult.new(true, ["OK", "OK"])

Checking transaction success

if result.successful?
  puts "Transaction completed successfully"
else
  puts "Transaction failed"
end

Accessing individual command results

result.results.each_with_index do |value, index|
  puts "Command #{index + 1} returned: #{value}"
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success, results) ⇒ MultiResult

Creates a new MultiResult instance.

Parameters:

  • success (Boolean) —

    Whether all commands succeeded

  • results (Array<String>) —

    The raw results from Database commands



41
42
43
44
 
# File 'lib/multi_result.rb', line 41

def initialize(success, results)
  @success = success
  @results = results
end

Instance Attribute Details

#results ⇒ Array<String> (readonly)

Returns The raw return values from the Database commands.

Returns:

  • (Array<String>) —

    The raw return values from the Database commands



29
30
31
 
# File 'lib/multi_result.rb', line 29

def results
  @results
end

#success ⇒ Boolean (readonly)

Returns true if all commands in the transaction succeeded, false otherwise.

Returns:

  • (Boolean) —

    true if all commands in the transaction succeeded, false otherwise



29
30
31
 
# File 'lib/multi_result.rb', line 29

def success
  @success
end

Instance Method Details

#size ⇒ Integer

Returns the number of results in the multi-operation.

Returns:

  • (Integer) —

    The number of individual command results returned by the transaction.



63
64
65
 
# File 'lib/multi_result.rb', line 63

def size
  results.size
end

#successful? ⇒ Boolean Also known as: success?, areyouhappynow?

Convenient method to check if the commit was successful.

Returns:

  • (Boolean) —

    true if all commands succeeded, false otherwise



74
75
76
 
# File 'lib/multi_result.rb', line 74

def successful?
  @success
end

#to_h ⇒ Object 



67
68
69
 
# File 'lib/multi_result.rb', line 67

def to_h
  { success: successful?, results: results }
end

#tuple ⇒ Array Also known as: to_a

Returns a tuple representing the result of the transaction.

Examples:

[true, ["OK", true, 1]]

Returns:

  • (Array) —

    A tuple containing the success status and the raw results. The success status is a boolean indicating if all commands succeeded. The raw results is an array of return values from the Database commands.



55
56
57
 
# File 'lib/multi_result.rb', line 55

def tuple
  [successful?, results]
end