229 lines
No EOL
6 KiB
HTML
229 lines
No EOL
6 KiB
HTML
<!-- title: frappe.utils.redis_wrapper --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.x.x</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/utils/redis_wrapper.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>RedisWrapper</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from redis.client.Redis</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p>Redis client that will automatically prefix conf.db_name</p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="delete_key" href="#delete_key" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>delete_key</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="delete_keys" href="#delete_keys" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>delete_keys</b>
|
|
<i class="text-muted">(self, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Delete keys with wildcard <code>*</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="delete_value" href="#delete_value" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>delete_value</b>
|
|
<i class="text-muted">(self, keys, user=None, make_keys=True)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Delete value, list of values.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_all" href="#get_all" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_all</b>
|
|
<i class="text-muted">(self, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_keys" href="#get_keys" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_keys</b>
|
|
<i class="text-muted">(self, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Return keys starting with <code>key</code>.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_value" href="#get_value" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_value</b>
|
|
<i class="text-muted">(self, key, generator=None, user=None, expires=False)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns cache value. If not found and generator function is
|
|
given, it will call the generator.</p>
|
|
|
|
<p>param key: Cache key.
|
|
param generator: Function to be called to generate a value if <code>None</code> is returned.
|
|
param expires: If the key is supposed to be with an expiry, don't store it in frappe.local</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="hdel" href="#hdel" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>hdel</b>
|
|
<i class="text-muted">(self, name, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="hdel_keys" href="#hdel_keys" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>hdel_keys</b>
|
|
<i class="text-muted">(self, name_starts_with, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Delete hash names with wildcard <code>*</code> and key</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="hget" href="#hget" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>hget</b>
|
|
<i class="text-muted">(self, name, key, generator=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="hkeys" href="#hkeys" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>hkeys</b>
|
|
<i class="text-muted">(self, name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="hset" href="#hset" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>hset</b>
|
|
<i class="text-muted">(self, name, key, value)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="make_key" href="#make_key" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>make_key</b>
|
|
<i class="text-muted">(self, key, user=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="set_value" href="#set_value" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>set_value</b>
|
|
<i class="text-muted">(self, key, val, user=None, expires_in_sec=None)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Sets cache value.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>key</code></strong> - Cache key</li>
|
|
<li><strong><code>val</code></strong> - Value to be cached</li>
|
|
<li><strong><code>user</code></strong> - Prepends key with User</li>
|
|
<li><strong><code>expires_in_sec</code></strong> - Expire value of this key in X seconds</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |