doc/SidekiqUniqueJobs/OnConflict/Replace.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: SidekiqUniqueJobs::OnConflict::Replace
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "SidekiqUniqueJobs::OnConflict::Replace";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (R)</a> »
<span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> » <span class='title'><span class='object_link'><a href="../OnConflict.html" title="SidekiqUniqueJobs::OnConflict (module)">OnConflict</a></span></span>
»
<span class="title">Replace</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: SidekiqUniqueJobs::OnConflict::Replace
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Strategy.html" title="SidekiqUniqueJobs::OnConflict::Strategy (class)">Strategy</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Strategy.html" title="SidekiqUniqueJobs::OnConflict::Strategy (class)">Strategy</a></span></li>
<li class="next">SidekiqUniqueJobs::OnConflict::Replace</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/on_conflict/replace.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Strategy to replace the job on conflict</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Author:</p>
<ul class="author">
<li>
<div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p>
</div>
</li>
</ul>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#lock_digest-instance_method" title="#lock_digest (instance method)">#<strong>lock_digest</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute lock_digest.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#queue-instance_method" title="#queue (instance method)">#<strong>queue</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute queue.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong> { ... } ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Replace the old job in the queue.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_job_by_digest-instance_method" title="#delete_job_by_digest (instance method)">#<strong>delete_job_by_digest</strong> ⇒ String<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Delete the job from either schedule, retry or the queue.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete_lock-instance_method" title="#delete_lock (instance method)">#<strong>delete_lock</strong> ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>Delete the keys belonging to the job.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#digests-instance_method" title="#digests (instance method)">#<strong>digests</strong> ⇒ Digests </a>
</span>
<span class="summary_desc"><div class='inline'><p>Access to the <span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item, redis_pool = nil) ⇒ Replace </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Initialize a new Replace strategy.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(item, redis_pool = nil) ⇒ <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::OnConflict::Replace (class)">Replace</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize a new Replace strategy</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>item</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>sidekiq job hash</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_redis_pool'>redis_pool</span><span class='rparen'>)</span>
<span class='ivar'>@queue</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#QUEUE-constant" title="SidekiqUniqueJobs::QUEUE (constant)">QUEUE</a></span></span><span class='rbracket'>]</span>
<span class='ivar'>@lock_digest</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#LOCK_DIGEST-constant" title="SidekiqUniqueJobs::LOCK_DIGEST (constant)">LOCK_DIGEST</a></span></span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="lock_digest-instance_method">
#<strong>lock_digest</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute lock_digest.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lock_digest'>lock_digest</span>
<span class='ivar'>@lock_digest</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="queue-instance_method">
#<strong>queue</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute queue.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_queue'>queue</span>
<span class='ivar'>@queue</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="call-instance_method">
#<strong>call</strong> { ... } ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Replace the old job in the queue</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'></span>
<div class='inline'><p>to retry the lock after deleting the old one</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40
41
42
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_deleted_job'>deleted_job</span> <span class='op'>=</span> <span class='id identifier rubyid_delete_job_by_digest'>delete_job_by_digest</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_info'>log_info</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Deleted job: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_deleted_job'>deleted_job</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_del_count'>del_count</span> <span class='op'>=</span> <span class='id identifier rubyid_delete_lock'>delete_lock</span><span class='rparen'>)</span>
<span class='id identifier rubyid_log_info'>log_info</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Deleted `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_del_count'>del_count</span><span class='embexpr_end'>}</span><span class='tstring_content'>` keys for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_lock_digest'>lock_digest</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_block'>block</span><span class='op'>&.</span><span class='id identifier rubyid_call'>call</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_job_by_digest-instance_method">
#<strong>delete_job_by_digest</strong> ⇒ <tt>String</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Delete the job from either schedule, retry or the queue</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the deleted job hash</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>when deleting nothing</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_job_by_digest'>delete_job_by_digest</span>
<span class='id identifier rubyid_call_script'>call_script</span><span class='lparen'>(</span><span class='symbol'>:delete_job_by_digest</span><span class='comma'>,</span>
<span class='label'>keys:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#QUEUE-constant" title="SidekiqUniqueJobs::QUEUE (constant)">QUEUE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_queue'>queue</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#SCHEDULE-constant" title="SidekiqUniqueJobs::SCHEDULE (constant)">SCHEDULE</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html#RETRY-constant" title="SidekiqUniqueJobs::RETRY (constant)">RETRY</a></span></span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='label'>argv:</span> <span class='lbracket'>[</span><span class='id identifier rubyid_lock_digest'>lock_digest</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete_lock-instance_method">
#<strong>delete_lock</strong> ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete the keys belonging to the job</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>the number of keys deleted</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
67
68
69</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete_lock'>delete_lock</span>
<span class='id identifier rubyid_digests'>digests</span><span class='period'>.</span><span class='id identifier rubyid_delete_by_digest'>delete_by_digest</span><span class='lparen'>(</span><span class='id identifier rubyid_lock_digest'>lock_digest</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="digests-instance_method">
#<strong>digests</strong> ⇒ <tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Access to the <span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></tt>)</span>
—
<div class='inline'><p>and instance with digests</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/on_conflict/replace.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_digests'>digests</span>
<span class='ivar'>@digests</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Digests.html#initialize-instance_method" title="SidekiqUniqueJobs::Digests#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Sep 27 15:29:09 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.2).
</div>
</div>
</body>
</html>