Skip to content

Commit 971773c

Browse files
author
documentation-bot
committed
Updates
1 parent 976fbc2 commit 971773c

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

documentation/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
<a id="md:unsupported-redis-commands" class="tsd-anchor"></a><h3><a href="#md:unsupported-redis-commands">Unsupported Redis Commands</a></h3><p>If you want to run commands and/or use arguments that Node Redis doesn&#39;t know about (yet!) use <code>.sendCommand()</code>:</p>
9191
<pre><code class="language-typescript"><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">client</span><span class="hl-1">.</span><span class="hl-0">sendCommand</span><span class="hl-1">([</span><span class="hl-2">&quot;SET&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;key&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;value&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;NX&quot;</span><span class="hl-1">]); </span><span class="hl-8">// &#39;OK&#39;</span><br/><br/><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">client</span><span class="hl-1">.</span><span class="hl-0">sendCommand</span><span class="hl-1">([</span><span class="hl-2">&quot;HGETALL&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;key&quot;</span><span class="hl-1">]); </span><span class="hl-8">// [&#39;key1&#39;, &#39;field1&#39;, &#39;key2&#39;, &#39;field2&#39;]</span>
9292
</code><button>Copy</button></pre>
93+
<p><em>Note: the <a href="https://github.com/redis/node-redis/blob/master/docs/clustering.md#unsupported-redis-commands">API is different when using a cluster</a>.</em></p>
9394
<a id="md:transactions-multiexec" class="tsd-anchor"></a><h3><a href="#md:transactions-multiexec">Transactions (Multi/Exec)</a></h3><p>Start a <a href="https://redis.io/topics/transactions">transaction</a> by calling <code>.multi()</code>, then chaining your commands. When
9495
you&#39;re done, call <code>.exec()</code> and you&#39;ll get an array back with your results:</p>
9596
<pre><code class="language-typescript"><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">client</span><span class="hl-1">.</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-2">&quot;another-key&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;another-value&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> [</span><span class="hl-7">setKeyReply</span><span class="hl-1">, </span><span class="hl-7">otherKeyValue</span><span class="hl-1">] = </span><span class="hl-5">await</span><span class="hl-1"> </span><span class="hl-6">client</span><br/><span class="hl-1"> .</span><span class="hl-0">multi</span><span class="hl-1">()</span><br/><span class="hl-1"> .</span><span class="hl-0">set</span><span class="hl-1">(</span><span class="hl-2">&quot;key&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;value&quot;</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">get</span><span class="hl-1">(</span><span class="hl-2">&quot;another-key&quot;</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-0">exec</span><span class="hl-1">(); </span><span class="hl-8">// [&#39;OK&#39;, &#39;another-value&#39;]</span>

0 commit comments

Comments
 (0)