Exception: Familia::IndexBucketConflictError
- Inherits:
-
PersistenceError
- Object
- RuntimeError
- Problem
- PersistenceError
- Familia::IndexBucketConflictError
- Defined in:
- lib/familia/errors.rb
Overview
Raised by the rebuild of a multi_index when a key it must write as a bucket set cannot be used as one. The rebuild checks those keys before it deletes or writes anything.
A key conflicts when it holds a type other than set, such as the list of a record whose identifier makes its keys share the bucket prefix. It also conflicts when it holds a set that belongs to another existing record of the same class with a longer identifier, such as the set field of a record whose identifier equals a class-level index name when a field value equals that field's name.
A key also conflicts when the rebuild cannot tell whether it belongs to another record: when it has more candidate owner records than Familia::Features::Relationships::Indexing::RecordKeyOwnership::MAX_CANDIDATE_SPLITS, as a field value that repeats the delimiter and an index name can make it. This applies to the keys the rebuild writes and to the stale buckets it would delete.
+conflicts+ maps each such key to the type it holds, or to RecordKeyOwnership::TOO_MANY_CANDIDATES (+:too_many_candidate_owners+) when its owner was not checked. +owners+ maps each conflicting key that is another record's key to that record's hash key.
Such a key may be another record's data, so the rebuild does not replace it. Inspect each key in +conflicts+. The rebuild can run once none of them holds another type or belongs to another record, and none has too many candidate owners.
Instance Attribute Summary collapse
-
#conflicts ⇒ Object
readonly
Returns the value of attribute conflicts.
-
#owners ⇒ Object
readonly
Returns the value of attribute owners.
Instance Method Summary collapse
-
#initialize(conflicts, owners = {}) ⇒ IndexBucketConflictError
constructor
A new instance of IndexBucketConflictError.
Constructor Details
#initialize(conflicts, owners = {}) ⇒ IndexBucketConflictError
Returns a new instance of IndexBucketConflictError.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/familia/errors.rb', line 113 def initialize(conflicts, owners = {}) @conflicts = conflicts @owners = owners listed = conflicts.map do |key, type| "#{key.inspect} (#{conflict_detail(type, owners[key])})" end = "Multi-index bucket keys cannot be written as bucket sets: #{listed.join(', ')}. " \ 'The rebuild stopped before it deleted or wrote anything. ' \ 'It can run once none of these keys holds a type other than set or belongs to another record.' if conflicts.values.any?(Symbol) += ' A key whose owner was not checked has more candidate owner records than the rebuild checks.' end super() end |
Instance Attribute Details
#conflicts ⇒ Object (readonly)
Returns the value of attribute conflicts.
111 112 113 |
# File 'lib/familia/errors.rb', line 111 def conflicts @conflicts end |
#owners ⇒ Object (readonly)
Returns the value of attribute owners.
111 112 113 |
# File 'lib/familia/errors.rb', line 111 def owners @owners end |