url
stringlengths 38
157
| content
stringlengths 72
15.1M
|
|---|---|
https://redis.io/docs/latest/commands/xinfo-consumers/.html | <section class="prose w-full py-12">
<h1 class="command-name">
XINFO CONSUMERS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">XINFO CONSUMERS key group</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
5.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@stream
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This command returns the list of consumers that belong to the
<code>
<groupname>
</code>
consumer group of the stream stored at
<code>
<key>
</code>
.
</p>
<p>
The following information is provided for each consumer in the group:
</p>
<ul>
<li>
<strong>
name
</strong>
: the consumer's name
</li>
<li>
<strong>
pending
</strong>
: the number of entries in the PEL: pending messages for the consumer, which are messages that were delivered but are yet to be acknowledged
</li>
<li>
<strong>
idle
</strong>
: the number of milliseconds that have passed since the consumer's last attempted interaction (Examples:
<a href="/docs/latest/commands/xreadgroup/">
<code>
XREADGROUP
</code>
</a>
,
<a href="/docs/latest/commands/xclaim/">
<code>
XCLAIM
</code>
</a>
,
<a href="/docs/latest/commands/xautoclaim/">
<code>
XAUTOCLAIM
</code>
</a>
)
</li>
<li>
<strong>
inactive
</strong>
: the number of milliseconds that have passed since the consumer's last successful interaction (Examples:
<a href="/docs/latest/commands/xreadgroup/">
<code>
XREADGROUP
</code>
</a>
that actually read some entries into the PEL,
<a href="/docs/latest/commands/xclaim/">
<code>
XCLAIM
</code>
</a>
/
<a href="/docs/latest/commands/xautoclaim/">
<code>
XAUTOCLAIM
</code>
</a>
that actually claimed some entries)
</li>
</ul>
<p>
Note that before Redis 7.2.0,
<strong>
idle
</strong>
used to denote the time passed since last successful interaction.
In 7.2.0,
<strong>
inactive
</strong>
was added and
<strong>
idle
</strong>
was changed to denote the time passed since last attempted interaction.
</p>
<h2 id="examples">
Examples
</h2>
<pre tabindex="0"><code>> XINFO CONSUMERS mystream mygroup
1) 1) name
2) "Alice"
3) pending
4) (integer) 1
5) idle
6) (integer) 9104628
7) inactive
8) (integer) 18104698
2) 1) name
2) "Bob"
3) pending
4) (integer) 1
5) idle
6) (integer) 83841983
7) inactive
8) (integer) 993841998
</code></pre>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of consumers and their attributes.
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 7.2.0: Added the
<code>
inactive
</code>
field.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/xinfo-consumers/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/configure/shard-placement/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure shard placement
</h1>
<p class="text-lg -mt-5 mb-10">
Configure shard placement to improve performance.
</p>
<p>
In Redis Enterprise Software , the location of master and replica shards on the cluster nodes can impact the database and node performance.
Master shards and their corresponding replica shards are always placed on separate nodes for data resiliency.
The
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/shard-placement-policy/">
shard placement policy
</a>
helps to maintain optimal performance and resiliency.
</p>
<p>
In addition to the shard placement policy, considerations that determine shard placement are:
</p>
<ul>
<li>
Separation of master and replica shards
</li>
<li>
Available persistence and Auto Tiering storage
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/clusters/configure/rack-zone-awareness/">
Rack-zone awareness
</a>
</li>
<li>
Memory available to host the database when fully populated
</li>
</ul>
<p>
The shard placement policies are:
</p>
<ul>
<li>
<code>
dense
</code>
- Place as many shards as possible on the smallest number of nodes to reduce the latency between the proxy and the database shards;
Recommended for Redis on RAM databases to optimize memory resources
</li>
<li>
<code>
sparse
</code>
- Spread the shards across as many nodes in the cluster as possible to spread the traffic across cluster nodes;
Recommended for databases with Auto Tiering enabled to optimize disk resources
</li>
</ul>
<p>
When you create a Redis Enterprise Software cluster, the default shard placement policy (
<code>
dense
</code>
) is assigned to all databases that you create on the cluster.
</p>
<p>
You can:
</p>
<ul>
<li>
Change the default shard placement policy for the cluster to
<code>
sparse
</code>
so that the cluster applies that policy to all databases that you create
</li>
<li>
Change the shard placement policy for each database after the database is created
</li>
</ul>
<h2 id="default-shard-placement-policy">
Default shard placement policy
</h2>
<p>
When you create a new cluster, the cluster configuration has a
<code>
dense
</code>
default shard placement policy.
When you create a database, this default policy is applied to the new database.
</p>
<p>
To see the current default shard placement policy, run
<code>
rladmin info cluster
</code>
:
</p>
<a href="/docs/latest/images/rs/shard_placement_info_cluster.png" sdata-lightbox="/images/rs/shard_placement_info_cluster.png">
<img src="/docs/latest/images/rs/shard_placement_info_cluster.png"/>
</a>
<p>
To change the default shard placement policy so that new databases are created with the
<code>
sparse
</code>
shard placement policy, run:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster default_shards_placement <span class="o">[</span> dense <span class="p">|</span> sparse <span class="o">]</span>
</span></span></code></pre>
</div>
<h2 id="shard-placement-policy-for-a-database">
Shard placement policy for a database
</h2>
<p>
To see the shard placement policy for a database in
<code>
rladmin status
</code>
.
</p>
<a href="/docs/latest/images/rs/shard_placement_rladmin_status.png" sdata-lightbox="/images/rs/shard_placement_rladmin_status.png">
<img src="/docs/latest/images/rs/shard_placement_rladmin_status.png"/>
</a>
<p>
To change the shard placement policy for a database, run:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin placement db <span class="o">[</span> database name <span class="p">|</span> database ID <span class="o">]</span> <span class="o">[</span> dense <span class="p">|</span> sparse <span class="o">]</span>
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/configure/shard-placement/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/script-debug/.html | <section class="prose w-full py-12">
<h1 class="command-name">
SCRIPT DEBUG
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">SCRIPT DEBUG <YES | SYNC | NO></pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
3.2.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@scripting
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Set the debug mode for subsequent scripts executed with
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
. Redis includes a
complete Lua debugger, codename LDB, that can be used to make the task of
writing complex scripts much simpler. In debug mode Redis acts as a remote
debugging server and a client, such as
<code>
redis-cli
</code>
, can execute scripts step by
step, set breakpoints, inspect variables and more - for additional information
about LDB refer to the
<a href="/docs/latest/develop/interact/programmability/lua-debugging/">
Redis Lua debugger
</a>
page.
</p>
<p>
<strong>
Important note:
</strong>
avoid debugging Lua scripts using your Redis production
server. Use a development server instead.
</p>
<p>
LDB can be enabled in one of two modes: asynchronous or synchronous. In
asynchronous mode the server creates a forked debugging session that does not
block and all changes to the data are
<strong>
rolled back
</strong>
after the session
finishes, so debugging can be restarted using the same initial state. The
alternative synchronous debug mode blocks the server while the debugging session
is active and retains all changes to the data set once it ends.
</p>
<ul>
<li>
<code>
YES
</code>
. Enable non-blocking asynchronous debugging of Lua scripts (changes are discarded).
</li>
<li>
<code>
SYNC
</code>
. Enable blocking synchronous debugging of Lua scripts (saves changes to data).
</li>
<li>
<code>
NO
</code>
. Disables scripts debug mode.
</li>
</ul>
<p>
For more information about
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
scripts please refer to
<a href="/docs/latest/develop/interact/programmability/eval-intro/">
Introduction to Eval Scripts
</a>
.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/script-debug/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/get-started/vector-database/.html | <section class="prose w-full py-12">
<h1>
Redis as a vector database quick start guide
</h1>
<p class="text-lg -mt-5 mb-10">
Understand how to use Redis as a vector database
</p>
<p>
This quick start guide helps you to:
</p>
<ol>
<li>
Understand what a vector database is
</li>
<li>
Create a Redis vector database
</li>
<li>
Create vector embeddings and store vectors
</li>
<li>
Query data and perform a vector search
</li>
</ol>
<h2 id="understand-vector-databases">
Understand vector databases
</h2>
<p>
Data is often unstructured, which means that it isn't described by a well-defined schema. Examples of unstructured data include text passages, images, videos, or audio. One approach to storing and searching through unstructured data is to use vector embeddings.
</p>
<p>
<strong>
What are vectors?
</strong>
In machine learning and AI, vectors are sequences of numbers that represent data. They are the inputs and outputs of models, encapsulating underlying information in a numerical form. Vectors transform unstructured data, such as text, images, videos, and audio, into a format that machine learning models can process.
</p>
<ul>
<li>
<strong>
Why are they important?
</strong>
Vectors capture complex patterns and semantic meanings inherent in data, making them powerful tools for a variety of applications. They allow machine learning models to understand and manipulate unstructured data more effectively.
</li>
<li>
<strong>
Enhancing traditional search.
</strong>
Traditional keyword or lexical search relies on exact matches of words or phrases, which can be limiting. In contrast, vector search, or semantic search, leverages the rich information captured in vector embeddings. By mapping data into a vector space, similar items are positioned near each other based on their meaning. This approach allows for more accurate and meaningful search results, as it considers the context and semantic content of the query rather than just the exact words used.
</li>
</ul>
<h2 id="create-a-redis-vector-database">
Create a Redis vector database
</h2>
<p>
You can use
<a href="/docs/latest/operate/oss_and_stack/">
Redis Stack
</a>
as a vector database. It allows you to:
</p>
<ul>
<li>
Store vectors and the associated metadata within hashes or
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
documents
</li>
<li>
Create and configure secondary indices for search
</li>
<li>
Perform vector searches
</li>
<li>
Update vectors and metadata
</li>
<li>
Delete and cleanup
</li>
</ul>
<p>
The easiest way to get started is to use Redis Cloud:
</p>
<ol>
<li>
<p>
Create a
<a href="https://redis.com/try-free?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users">
free account
</a>
.
</p>
<img src="../img/free-cloud-db.png" width="500px"/>
</li>
<li>
<p>
Follow the instructions to create a free database.
</p>
</li>
</ol>
<p>
This free Redis Cloud database comes out of the box with all the Redis Stack features.
</p>
<p>
You can alternatively use the
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/">
installation guides
</a>
to install Redis Stack on your local machine.
</p>
<p>
You need to have the following features configured for your Redis server: JSON and Search and query.
</p>
<h2 id="install-the-required-python-packages">
Install the required Python packages
</h2>
<p>
Create a Python virtual environment and install the following dependencies using
<code>
pip
</code>
:
</p>
<ul>
<li>
<code>
redis
</code>
: You can find further details about the
<code>
redis-py
</code>
client library in the
<a href="/docs/latest/develop/clients/redis-py/">
clients
</a>
section of this documentation site.
</li>
<li>
<code>
pandas
</code>
: Pandas is a data analysis library.
</li>
<li>
<code>
sentence-transformers
</code>
: You will use the
<a href="https://www.sbert.net/">
SentenceTransformers
</a>
framework to generate embeddings on full text.
</li>
<li>
<code>
tabulate
</code>
:
<code>
pandas
</code>
uses
<code>
tabulate
</code>
to render Markdown.
</li>
</ul>
<p>
You will also need the following imports in your Python code:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepimports">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepimports" name="search_vss-stepimports" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepimports" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepimports" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepimports" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line hl"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepimports')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepimports" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h2 id="connect">
Connect
</h2>
<p>
Connect to Redis. By default, Redis returns binary responses. To decode them, you pass the
<code>
decode_responses
</code>
parameter set to
<code>
True
</code>
:
</p>
<p>
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepconnect">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepconnect" name="search_vss-stepconnect" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepconnect" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepconnect" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepconnect')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepconnect" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<br/>
<p>
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Tip:
</div>
Instead of using a local Redis Stack server, you can copy and paste the connection details from the Redis Cloud database configuration page. Here is an example connection string of a Cloud database that is hosted in the AWS region
<code>
us-east-1
</code>
and listens on port 16379:
<code>
redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com:16379
</code>
. The connection string has the format
<code>
host:port
</code>
. You must also copy and paste the username and password of your Cloud database. The line of code for connecting with the default user changes then to
<code>
client = redis.Redis(host="redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com", port=16379, password="your_password_here", decode_responses=True)
</code>
.
</div>
</div>
<h2 id="prepare-the-demo-dataset">
Prepare the demo dataset
</h2>
<p>
This quick start guide also uses the
<strong>
bikes
</strong>
dataset. Here is an example document from it:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"Kids bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"specs"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"material"</span><span class="p">:</span> <span class="s2">"aluminium"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"weight"</span><span class="p">:</span> <span class="s2">"10"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"Small and powerful, the Jigger is the best ride for the smallest of tikes! ..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<p>
The
<code>
description
</code>
field contains free-form text descriptions of bikes and will be used to create vector embeddings.
</p>
<h3 id="1-fetch-the-demo-data">
1. Fetch the demo data
</h3>
<p>
You need to first fetch the demo dataset as a JSON array:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepget_data">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepget_data" name="search_vss-stepget_data" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepget_data" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepget_data" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepget_data" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepget_data')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepget_data" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Inspect the structure of one of the bike JSON documents:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdump_data">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdump_data" name="search_vss-stepdump_data" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdump_data" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepdump_data" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdump_data" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdump_data')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepdump_data" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h3 id="2-store-the-demo-data-in-redis">
2. Store the demo data in Redis
</h3>
<p>
Now iterate over the
<code>
bikes
</code>
array to store the data as
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
documents in Redis by using the
<a href="/docs/latest/commands/json.set//">
JSON.SET
</a>
command. The below code uses a
<a href="/docs/latest/develop/use/pipelining/">
pipeline
</a>
to minimize the network round-trip times:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepload_data">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepload_data" name="search_vss-stepload_data" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepload_data" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepload_data" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepload_data" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepload_data')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepload_data" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Once loaded, you can retrieve a specific attribute from one of the JSON documents in Redis using a
<a href="https://goessner.net/articles/JsonPath/">
JSONPath
</a>
expression:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepget">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepget" name="search_vss-stepget" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepget" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepget" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepget" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepget')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepget" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h3 id="3-select-a-text-embedding-model">
3. Select a text embedding model
</h3>
<p>
<a href="https://huggingface.co">
HuggingFace
</a>
has a large catalog of text embedding models that are locally servable through the
<code>
SentenceTransformers
</code>
framework. Here we use the
<a href="https://microsoft.github.io/msmarco/">
MS MARCO
</a>
model that is widely used in search engines, chatbots, and other AI applications.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'msmarco-distilbert-base-v4'</span><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="4-generate-text-embeddings">
4. Generate text embeddings
</h3>
<p>
Iterate over all the Redis keys with the prefix
<code>
bikes:
</code>
:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepget_keys">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepget_keys" name="search_vss-stepget_keys" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepget_keys" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepget_keys" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepget_keys" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepget_keys')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepget_keys" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Use the keys as input to the
<a href="/docs/latest/commands/json.mget/">
JSON.MGET
</a>
command, along with the
<code>
$.description
</code>
field, to collect the descriptions in a list. Then, pass the list of descriptions to the
<code>
.encode()
</code>
method:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepgenerate_embeddings">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepgenerate_embeddings" name="search_vss-stepgenerate_embeddings" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepgenerate_embeddings" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepgenerate_embeddings" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepgenerate_embeddings" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line hl"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepgenerate_embeddings')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepgenerate_embeddings" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Insert the vectorized descriptions to the bike documents in Redis using the
<a href="/docs/latest/commands/json.set">
JSON.SET
</a>
command. The following command inserts a new field into each of the documents under the JSONPath
<code>
$.description_embeddings
</code>
. Once again, do this using a pipeline to avoid unnecessary network round-trips:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepload_embeddings">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepload_embeddings" name="search_vss-stepload_embeddings" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepload_embeddings" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepload_embeddings" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepload_embeddings" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepload_embeddings')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepload_embeddings" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Inspect one of the updated bike documents using the
<a href="/docs/latest/commands/json.get">
JSON.GET
</a>
command:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdump_example">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdump_example" name="search_vss-stepdump_example" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdump_example" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepdump_example" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdump_example" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdump_example')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepdump_example" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
When storing a vector embedding within a JSON document, the embedding is stored as a JSON array. In the example above, the array was shortened considerably for the sake of readability.
</div>
</div>
<h2 id="create-an-index">
Create an index
</h2>
<h3 id="1-create-an-index-with-a-vector-field">
1. Create an index with a vector field
</h3>
<p>
You must create an index to query document metadata or to perform vector searches. Use the
<a href="/docs/latest/commands/ft.create">
FT.CREATE
</a>
command:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepcreate_index">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_vss-stepcreate_index" name="search_vss-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_vss-stepcreate_index" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_vss-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_vss-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">FT.CREATE idx:bikes_vss ON JSON
</span></span><span class="line hl"><span class="cl"> PREFIX 1 bikes: SCORE 1.0
</span></span><span class="line hl"><span class="cl"> SCHEMA
</span></span><span class="line hl"><span class="cl"> $.model TEXT WEIGHT 1.0 NOSTEM
</span></span><span class="line hl"><span class="cl"> $.brand TEXT WEIGHT 1.0 NOSTEM
</span></span><span class="line hl"><span class="cl"> $.price NUMERIC
</span></span><span class="line hl"><span class="cl"> $.type TAG SEPARATOR ","
</span></span><span class="line hl"><span class="cl"> $.description AS description TEXT WEIGHT 1.0
</span></span><span class="line hl"><span class="cl"> $.description_embeddings AS vector VECTOR FLAT 6 TYPE FLOAT32 DIM 768 DISTANCE_METRIC COSINE</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_vss-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepcreate_index" name="search_vss-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepcreate_index" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">},</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">),</span>
</span></span><span class="line hl"><span class="cl"><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepcreate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Here is a breakdown of the
<code>
VECTOR
</code>
field definition:
</p>
<ul>
<li>
<code>
$.description_embeddings AS vector
</code>
: The vector field's JSON path and its field alias
<code>
vector
</code>
.
</li>
<li>
<code>
FLAT
</code>
: Specifies the indexing method, which is either a flat index or a hierarchical navigable small world graph (
<a href="https://arxiv.org/ftp/arxiv/papers/1603/1603.09320.pdf">
HNSW
</a>
).
</li>
<li>
<code>
TYPE FLOAT32
</code>
: Sets the float precision of a vector component, in this case a 32-bit floating point number.
</li>
<li>
<code>
DIM 768
</code>
: The length or dimension of the embeddings, determined by the chosen embedding model.
</li>
<li>
<code>
DISTANCE_METRIC COSINE
</code>
: The chosen distance function:
<a href="https://en.wikipedia.org/wiki/Cosine_similarity">
cosine distance
</a>
.
</li>
</ul>
<p>
You can find further details about all these options in the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/">
vector reference documentation
</a>
.
</p>
<h3 id="2-check-the-state-of-the-index">
2. Check the state of the index
</h3>
<p>
As soon as you execute the
<a href="/docs/latest/commands/ft.create">
FT.CREATE
</a>
command, the indexing process runs in the background. In a short time, all JSON documents should be indexed and ready to be queried. To validate that, you can use the
<a href="/docs/latest/commands/ft.info">
FT.INFO
</a>
command, which provides details and statistics about the index. Of particular interest are the number of documents successfully indexed and the number of failures:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepvalidate_index">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_vss-stepvalidate_index" name="search_vss-stepvalidate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_vss-stepvalidate_index" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_vss-stepvalidate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_vss-stepvalidate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">FT.INFO idx:bikes_vss</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_vss-stepvalidate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepvalidate_index" name="search_vss-stepvalidate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepvalidate_index" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepvalidate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepvalidate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line hl"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepvalidate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepvalidate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h2 id="perform-vector-searches">
Perform vector searches
</h2>
<p>
This quick start guide focuses on vector search. However, you can learn more about how to query based on document metadata in the
<a href="/docs/latest/develop/get-started/document-database/">
document database quick start guide
</a>
.
</p>
<h3 id="1-embed-your-queries">
1. Embed your queries
</h3>
<p>
The following code snippet shows a list of text queries you will use to perform vector search in Redis:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdef_bulk_queries">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdef_bulk_queries" name="search_vss-stepdef_bulk_queries" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdef_bulk_queries" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepdef_bulk_queries" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdef_bulk_queries" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdef_bulk_queries')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepdef_bulk_queries" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
First, encode each input query as a vector embedding using the same SentenceTransformers model:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepenc_bulk_queries">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepenc_bulk_queries" name="search_vss-stepenc_bulk_queries" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepenc_bulk_queries" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepenc_bulk_queries" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepenc_bulk_queries" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepenc_bulk_queries')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepenc_bulk_queries" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<br/>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Tip:
</div>
It is vital that you use the same embedding model to embed your queries as you did your documents. Using a different model will result in poor semantic search results or error.
</div>
</div>
<h3 id="2-k-nearest-neighbors-knn-search">
2. K-nearest neighbors (KNN) search
</h3>
<p>
The KNN algorithm calculates the distance between the query vector and each vector in Redis based on the chosen distance function. It then returns the top K items with the smallest distances to the query vector. These are the most semantically similar items.
</p>
<p>
Now construct a query to do just that:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s1">'(*)=>[KNN 3 @vector $query_vector AS vector_score]'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s1">'vector_score'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s1">'vector_score'</span><span class="p">,</span> <span class="s1">'id'</span><span class="p">,</span> <span class="s1">'brand'</span><span class="p">,</span> <span class="s1">'model'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<p>
Let's break down the above query template:
</p>
<ul>
<li>
The filter expression
<code>
(*)
</code>
means
<code>
all
</code>
. In other words, no filtering was applied. You could replace it with an expression that filters by additional metadata.
</li>
<li>
The
<code>
KNN
</code>
part of the query searches for the top 3 nearest neighbors.
</li>
<li>
The query vector must be passed in as the param
<code>
query_vector
</code>
.
</li>
<li>
The distance to the query vector is returned as
<code>
vector_score
</code>
.
</li>
<li>
The results are sorted by this
<code>
vector_score
</code>
.
</li>
<li>
Finally, it returns the fields
<code>
vector_score
</code>
,
<code>
id
</code>
,
<code>
brand
</code>
,
<code>
model
</code>
, and
<code>
description
</code>
for each result.
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
To utilize a vector query with the
<a href="/docs/latest/commands/ft.search/">
<code>
FT.SEARCH
</code>
</a>
command, you must specify DIALECT 2 or greater.
</div>
</div>
<p>
You must pass the vectorized query as a byte array with the param name
<code>
query_vector
</code>
. The following code creates a Python NumPy array from the query vector and converts it into a compact, byte-level representation that can be passed as a parameter to the query:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s1">'idx:bikes_vss'</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span></code></pre>
</div>
<p>
With the template for the query in place, you can execute all queries in a loop. Notice that the script calculates the
<code>
vector_score
</code>
for each result as
<code>
1 - doc.vector_score
</code>
. Because the cosine distance is used as the metric, the items with the smallest distance are closer and, therefore, more similar to the query.
</p>
<p>
Then, loop over the matched documents and create a list of results that can be converted into a Pandas table to visualize the results:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-stepdefine_bulk_query">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-stepdefine_bulk_query" name="search_vss-stepdefine_bulk_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-stepdefine_bulk_query" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-stepdefine_bulk_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-stepdefine_bulk_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line hl"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line hl"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-stepdefine_bulk_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-stepdefine_bulk_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
The query results show the individual queries' top three matches (our K parameter) along with the bike's id, brand, and model for each query.
</p>
<p>
For example, for the query "Best Mountain bikes for kids", the highest similarity score (
<code>
0.54
</code>
) and, therefore the closest match was the 'Nord' brand 'Chook air 5' bike model, described as:
</p>
<blockquote>
<p>
The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails. The Chook Air 5 is the perfect intro to mountain biking.
</p>
</blockquote>
<p>
From the description, this bike is an excellent match for younger children, and the embeddings accurately captured the semantics of the description.
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_vss-steprun_knn_query">
<input checked="" class="radiotab w-0 h-0" data-lang="python" id="Python_search_vss-steprun_knn_query" name="search_vss-steprun_knn_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_vss-steprun_knn_query" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_vss-steprun_knn_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_vss-steprun_knn_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for vector database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/vector-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">json</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">time</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">requests</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">sentence_transformers</span> <span class="kn">import</span> <span class="n">SentenceTransformer</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">URL</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"https://raw.githubusercontent.com/bsbodden/redis_vss_getting_started"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"/main/data/bikes.json"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">URL</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bikes</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">bikes</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">indent</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">client</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">bike</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bikes</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"bikes:</span><span class="si">{</span><span class="n">i</span><span class="si">:</span><span class="s2">03</span><span class="si">}</span><span class="s2">"</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">redis_key</span><span class="p">,</span> <span class="s2">"$"</span><span class="p">,</span> <span class="n">bike</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">,</span> <span class="s2">"$.model"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['Summit']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">keys</span><span class="p">(</span><span class="s2">"bikes:*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> ['bikes:001', 'bikes:002', ..., 'bikes:011']</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">mget</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="s2">"$.description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">descriptions</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">sublist</span> <span class="ow">in</span> <span class="n">descriptions</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sublist</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">embedder</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s2">"msmarco-distilbert-base-v4"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">embeddings</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">descriptions</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tolist</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">VECTOR_DIMENSION</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">embeddings</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 768</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">pipeline</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">embedding</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">embeddings</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">pipeline</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s2">"$.description_embeddings"</span><span class="p">,</span> <span class="n">embedding</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">pipeline</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [True, True, True, True, True, True, True, True, True, True, True]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"bikes:010"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1"># {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model": "Summit",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand": "nHill",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price": 1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "type": "Mountain Bike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "specs": {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "material": "alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "weight": "11.3"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description": "This budget mountain bike from nHill performs well..."</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description_embeddings": [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.538114607334137,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.49465855956077576,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># -0.025176964700222015,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">no_stem</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.type"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"type"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">VectorField</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"$.description_embeddings"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"FLAT"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"TYPE"</span><span class="p">:</span> <span class="s2">"FLOAT32"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DIM"</span><span class="p">:</span> <span class="n">VECTOR_DIMENSION</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"DISTANCE_METRIC"</span><span class="p">:</span> <span class="s2">"COSINE"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">as_name</span><span class="o">=</span><span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">definition</span> <span class="o">=</span> <span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bikes:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span><span class="n">fields</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span> <span class="n">definition</span><span class="o">=</span><span class="n">definition</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 'OK'</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">info</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"><span class="n">num_docs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"num_docs"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="n">indexing_failures</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s2">"hash_indexing_failures"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(f"{num_docs} documents indexed with {indexing_failures} failures")</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11 documents indexed with 0 failures</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950', 'description_embeddings': ...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:008',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Soothe Electric bike',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '1950'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># },</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@brand:Peaknetic @price:[0 1000]"</span><span class="p">)</span><span class="o">.</span><span class="n">return_fields</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"price"</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">query</span><span class="p">)</span><span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"><span class="c1"># print(res)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bikes:009',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'brand': 'Peaknetic',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'model': 'Secto',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'price': '430'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">queries</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Bike for small kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Best Mountain bikes for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Cheap Mountain bike for kids"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Female specific mountain bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Road bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Commuter bike for people over 60"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable commuter bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Good bike for college students"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Mountain bike for beginners"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Vintage bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Comfortable city bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">encoded_queries</span> <span class="o">=</span> <span class="n">embedder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">len</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> 11</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">def</span> <span class="nf">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">,</span> <span class="n">extra_params</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2"> Creates a query table.
</span></span></span><span class="line"><span class="cl"><span class="s2"> """</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span> <span class="o">=</span> <span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">encoded_query</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">encoded_queries</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">result_docs</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">client</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bikes_vss"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">query</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"query_vector"</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">encoded_query</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span><span class="o">.</span><span class="n">tobytes</span><span class="p">()}</span>
</span></span><span class="line"><span class="cl"> <span class="o">|</span> <span class="p">(</span><span class="n">extra_params</span> <span class="k">if</span> <span class="n">extra_params</span> <span class="k">else</span> <span class="p">{}),</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">docs</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">doc</span> <span class="ow">in</span> <span class="n">result_docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">vector_score</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span><span class="mi">1</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">doc</span><span class="o">.</span><span class="n">vector_score</span><span class="p">),</span> <span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">results_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"query"</span><span class="p">:</span> <span class="n">queries</span><span class="p">[</span><span class="n">i</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"score"</span><span class="p">:</span> <span class="n">vector_score</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"id"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">brand</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">model</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="n">doc</span><span class="o">.</span><span class="n">description</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1"># Optional: convert the table to Markdown using Pandas</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">results_list</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">by</span><span class="o">=</span><span class="p">[</span><span class="s2">"query"</span><span class="p">,</span> <span class="s2">"score"</span><span class="p">],</span> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">],</span> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"query"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">groupby</span><span class="p">(</span><span class="s2">"query"</span><span class="p">)[</span><span class="s2">"query"</span><span class="p">]</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">+</span> <span class="p">[</span><span class="s2">""</span><span class="p">]</span> <span class="o">*</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span> <span class="o">=</span> <span class="n">queries_table</span><span class="p">[</span><span class="s2">"description"</span><span class="p">]</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="p">(</span><span class="n">x</span><span class="p">[:</span><span class="mi">497</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"..."</span><span class="p">)</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">500</span> <span class="k">else</span> <span class="n">x</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">queries_table</span><span class="o">.</span><span class="n">to_markdown</span><span class="p">(</span><span class="n">index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(*)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="p">)</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.54 | bikes:003...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">hybrid_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@brand:Peaknetic)=>[KNN 3 @vector $query_vector AS vector_score]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span><span class="n">hybrid_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">,</span> <span class="n">encoded_queries</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Best Mountain bikes for kids | 0.3 | bikes:008...</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">range_query</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@vector:[VECTOR_RANGE $range $query_vector]=>"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"{$YIELD_DISTANCE_AS: vector_score}"</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">sort_by</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">return_fields</span><span class="p">(</span><span class="s2">"vector_score"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">,</span> <span class="s2">"brand"</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">,</span> <span class="s2">"description"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">paging</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">table</span> <span class="o">=</span> <span class="n">create_query_table</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">range_query</span><span class="p">,</span> <span class="n">queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">encoded_queries</span><span class="p">[:</span><span class="mi">1</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"range"</span><span class="p">:</span> <span class="mf">0.55</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">table</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> | Bike for small kids | 0.52 | bikes:001 | Velorim |...</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_vss-steprun_knn_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_vss-steprun_knn_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_vss.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<table>
<thead>
<tr>
<th style="text-align:left">
query
</th>
<th style="text-align:left">
score
</th>
<th style="text-align:left">
id
</th>
<th style="text-align:left">
brand
</th>
<th style="text-align:left">
model
</th>
<th style="text-align:left">
description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
Best Mountain bikes for kids
</td>
<td style="text-align:left">
0.54
</td>
<td style="text-align:left">
bikes:003
</td>
<td style="text-align:left">
Nord
</td>
<td style="text-align:left">
Chook air 5
</td>
<td style="text-align:left">
The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails. The Chook Air 5 is the perfect intro to mountain biking.
</td>
</tr>
<tr>
<td style="text-align:left">
</td>
<td style="text-align:left">
0.51
</td>
<td style="text-align:left">
bikes:010
</td>
<td style="text-align:left">
nHill
</td>
<td style="text-align:left">
Summit
</td>
<td style="text-align:left">
This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail riding on the weekends or you’re just after a stable,...
</td>
</tr>
<tr>
<td style="text-align:left">
</td>
<td style="text-align:left">
0.46
</td>
<td style="text-align:left">
bikes:001
</td>
<td style="text-align:left">
Velorim
</td>
<td style="text-align:left">
Jigger
</td>
<td style="text-align:left">
Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go. We say rare because this smokin’ little bike is not ideal for a nervous first-time rider, but it’s a true giddy up for a true speedster. The Jigger is a 12 inch lightweight kids bicycle and it will meet your little one’s need for speed. It’s a single...
</td>
</tr>
</tbody>
</table>
<h2 id="next-steps">
Next steps
</h2>
<ol>
<li>
You can learn more about the query options, such as filters and vector range queries, by reading the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/">
vector reference documentation
</a>
.
</li>
<li>
The complete
<a href="/docs/latest/develop/interact/search-and-query/">
Redis Query Engine documentation
</a>
might be interesting for you.
</li>
<li>
If you want to follow the code examples more interactively, then you can use the
<a href="https://github.com/RedisVentures/redis-vss-getting-started/blob/main/vector_similarity_with_redis.ipynb">
Jupyter notebook
</a>
that inspired this quick start guide.
</li>
<li>
If you want to see more advanced examples of a Redis vector database in action, visit the
<a href="https://github.com/redis-developer/redis-ai-resources">
Redis AI Resources
</a>
page on GitHub.
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/get-started/vector-database/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/zrem/.html | <section class="prose w-full py-12">
<h1 class="command-name">
ZREM
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">ZREM key member [member ...]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
1.2.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@sortedset
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Removes the specified members from the sorted set stored at
<code>
key
</code>
.
Non existing members are ignored.
</p>
<p>
An error is returned when
<code>
key
</code>
exists and does not hold a sorted set.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> ZADD myzset 1 "one"
(integer) 1
redis> ZADD myzset 2 "two"
(integer) 1
redis> ZADD myzset 3 "three"
(integer) 1
redis> ZREM myzset "two"
(integer) 1
redis> ZRANGE myzset 0 -1 WITHSCORES
1) "one"
2) "1"
3) "three"
4) "3"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the number of members removed from the sorted set, not including non-existing members.
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 2.4.0: Accepts multiple elements.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/zrem/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/debug_info/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin cluster debug_info
</h1>
<p class="text-lg -mt-5 mb-10">
Creates a support package.
</p>
<p>
Downloads a support package to the specified path. If you do not specify a path, it downloads the package to the default path specified in the cluster configuration file.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster debug_info
</span></span><span class="line"><span class="cl"> <span class="o">[</span> node <ID> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> path <path> <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
node
</td>
<td>
integer
</td>
<td>
Downloads a support package for the specified node
</td>
</tr>
<tr>
<td>
path
</td>
<td>
filepath
</td>
<td>
Specifies the location where the support package should download
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Reports the progress of the support package download.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin cluster debug_info node <span class="m">1</span>
</span></span><span class="line"><span class="cl">Preparing the debug info files package
</span></span><span class="line"><span class="cl">Downloading...
</span></span><span class="line"><span class="cl"><span class="o">[==================================================]</span>
</span></span><span class="line"><span class="cl">Downloading complete. File /tmp/debuginfo.20220511-215637.node-1.tar.gz is saved.
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/debug_info/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/shard/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Shard object
</h1>
<p class="text-lg -mt-5 mb-10">
An object that represents a database shard
</p>
<p>
An API object that represents a Redis shard in a database.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
string
</td>
<td>
Cluster unique ID of shard
</td>
</tr>
<tr>
<td>
assigned_slots
</td>
<td>
string
</td>
<td>
Shards hash slot range
</td>
</tr>
<tr>
<td>
backup
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/shard/backup/">
backup
</a>
object
</td>
<td>
Current status of scheduled periodic backup process
</td>
</tr>
<tr>
<td>
bdb_uid
</td>
<td>
integer
</td>
<td>
The ID of the database this shard belongs to
</td>
</tr>
<tr>
<td>
bigstore_ram_weight
</td>
<td>
number
</td>
<td>
Shards RAM distribution weight
</td>
</tr>
<tr>
<td>
detailed_status
</td>
<td>
'busy'
<br/>
'down'
<br/>
'importing'
<br/>
'loading'
<br/>
'ok'
<br/>
'timeout'
<br/>
'trimming'
<br/>
'unknown'
</td>
<td>
A more detailed status of the shard
</td>
</tr>
<tr>
<td>
loading
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/shard/loading/">
loading
</a>
object
</td>
<td>
Current status of dump file loading
</td>
</tr>
<tr>
<td>
node_uid
</td>
<td>
string
</td>
<td>
The ID of the node this shard is located on
</td>
</tr>
<tr>
<td>
redis_info
</td>
<td>
redis_info object
</td>
<td>
A sub-dictionary of the
<a href="/docs/latest/commands/info/">
Redis INFO command
</a>
</td>
</tr>
<tr>
<td>
report_timestamp
</td>
<td>
string
</td>
<td>
The time in which the shard's info was collected (read-only)
</td>
</tr>
<tr>
<td>
role
</td>
<td>
'master'
<br/>
'slave'
</td>
<td>
Role of this shard
</td>
</tr>
<tr>
<td>
status
</td>
<td>
'active'
<br/>
'inactive'
<br/>
'trimming'
</td>
<td>
The current status of the shard
</td>
</tr>
<tr>
<td>
sync
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/shard/sync/">
sync
</a>
object
</td>
<td>
Shard's current sync status and progress
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/shard/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/installation/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Installation
</h1>
<p class="text-lg -mt-5 mb-10">
Learn how to install RDI
</p>
<p>
The guides in this section explain the options you have for installing RDI.
Before you use RDI, you must also configure your source database to use the CDC connector. See the
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/prepare-dbs/">
Prepare source databases
</a>
section to learn how to do this.
</p>
<nav>
<a href="/docs/latest/integrate/redis-data-integration/installation/install-vm/">
Install on VMs
</a>
<p>
Learn how to install RDI on one or more VMs
</p>
<a href="/docs/latest/integrate/redis-data-integration/installation/install-k8s/">
Install on Kubernetes
</a>
<p>
Learn how to install RDI on Kubernetes
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/installation/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Current node database debug info requests
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the Redis Enterprise Software REST API debuginfo/node/bdb requests.
</p>
<div class="banner-article rounded-md" style="background-color: ">
<p>
This REST API path is deprecated as of Redis Enterprise Software version 7.4.2. Use the new path
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo/">
<code>
/v1/bdbs/debuginfo
</code>
</a>
instead.
</p>
</div>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-debuginfo-node-bdb">
GET
</a>
</td>
<td>
<code>
/v1/debuginfo/node/bdb/{bdb_uid}
</code>
</td>
<td>
Get debug info for the current node regarding a specific database
</td>
</tr>
</tbody>
</table>
<h2 id="get-debuginfo-node-bdb">
Get database debug info for current node
</h2>
<pre><code>GET /v1/debuginfo/node/bdb/{int: bdb_uid}
</code></pre>
<p>
Downloads a tar file that contains debug info for the specified database (
<code>
bdb_uid
</code>
) from the current node.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_debugging_info">
view_debugging_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /debuginfo/node/bdb/1
</code></pre>
<h3 id="get-response">
Response
</h3>
<p>
Downloads the debug info in a tar file called
<code>
filename.tar.gz
</code>
. Extract the files from the tar file to access the debug info.
</p>
<h4 id="response-headers">
Response headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Content-Type
</td>
<td>
application/x-gzip
</td>
<td>
Media type of request/response body
</td>
</tr>
<tr>
<td>
Content-Length
</td>
<td>
653350
</td>
<td>
Length of the response body in octets
</td>
</tr>
<tr>
<td>
Content-Disposition
</td>
<td>
attachment; filename=debuginfo.tar.gz
</td>
<td>
Display response in browser
</td>
</tr>
</tbody>
</table>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">
500 Internal Server Error
</a>
</td>
<td>
Failed to get debug info.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.explain.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.EXPLAIN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.EXPLAIN index query
[DIALECT dialect]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Return the execution plan for a complex query
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
index
</code>
</summary>
<p>
is index name. You must first create the index using
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
.
</p>
</details>
<details open="">
<summary>
<code>
query
</code>
</summary>
<p>
is query string, as if sent to FT.SEARCH`.
</p>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
DIALECT {dialect_version}
</code>
</summary>
<p>
is dialect version under which to execute the query. If not specified, the query executes under the default dialect version set during module initial loading or via
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
command.
</p>
</details>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Notes:
</div>
<ul>
<li>
In the returned response, a
<code>
+
</code>
on a term is an indication of stemming.
</li>
<li>
Use
<code>
redis-cli --raw
</code>
to properly read line-breaks in the returned response.
</li>
</ul>
</div>
</div>
<h2 id="return">
Return
</h2>
<p>
FT.EXPLAIN returns a string representing the execution plan.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Return the execution plan for a complex query
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">$ redis-cli --raw
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">127.0.0.1:6379> FT.EXPLAIN rd <span class="s2">"(foo bar)|(hello world) @date:[100 200]|@date:[500 +inf]"</span>
</span></span><span class="line"><span class="cl">INTERSECT <span class="o">{</span>
</span></span><span class="line"><span class="cl"> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl"> INTERSECT <span class="o">{</span>
</span></span><span class="line"><span class="cl"> foo
</span></span><span class="line"><span class="cl"> bar
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> INTERSECT <span class="o">{</span>
</span></span><span class="line"><span class="cl"> hello
</span></span><span class="line"><span class="cl"> world
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl"> NUMERIC <span class="o">{</span>100.000000 <<span class="o">=</span> x <<span class="o">=</span> 200.000000<span class="o">}</span>
</span></span><span class="line"><span class="cl"> NUMERIC <span class="o">{</span>500.000000 <<span class="o">=</span> x <<span class="o">=</span> inf<span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
|
<a href="/docs/latest/commands/ft.search/">
<code>
FT.SEARCH
</code>
</a>
|
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.explain/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/compatibility/config-settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Compatibility with Redis Community Edition configuration settings
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Community Edition configuration settings supported by Redis Enterprise.
</p>
<p>
Redis Enterprise Software and
<a href="/docs/latest/operate/rc/">
Redis Cloud
</a>
only support a subset of
<a href="/docs/latest/operate/oss_and_stack/management/config/">
Redis Community Edition configuration settings
</a>
. Using
<a href="/docs/latest/commands/config-get/">
<code>
CONFIG GET
</code>
</a>
or
<a href="/docs/latest/commands/config-set/">
<code>
CONFIG SET
</code>
</a>
with unsupported configuration settings returns an error.
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Setting
</th>
<th style="text-align:left">
Redis
<br/>
Enterprise
</th>
<th style="text-align:left">
Redis
<br/>
Cloud
</th>
<th style="text-align:left">
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
activerehashing
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
busy-reply-threshold
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Value must be between 0 and 60000 milliseconds.
</td>
</tr>
<tr>
<td style="text-align:left">
hash-max-listpack-entries
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
hash-max-listpack-value
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
hash-max-ziplist-entries
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
hash-max-ziplist-value
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
hll-sparse-max-bytes
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
list-compress-depth
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
list-max-listpack-size
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
list-max-ziplist-size
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
lua-time-limit
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Value must be between 0 and 60000 milliseconds.
</td>
</tr>
<tr>
<td style="text-align:left">
notify-keyspace-events
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
set-max-intset-entries
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
slowlog-log-slower-than
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Value must be larger than 1000 microseconds.
</td>
</tr>
<tr>
<td style="text-align:left">
slowlog-max-len
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Value must be between 128 and 1024.
</td>
</tr>
<tr>
<td style="text-align:left">
stream-node-max-bytes
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
stream-node-max-entries
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
zset-max-listpack-entries
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
zset-max-listpack-value
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
zset-max-ziplist-entries
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
zset-max-ziplist-value
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/compatibility/config-settings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/objects/services_configuration/cm_server/.html | <section class="prose w-full py-12 max-w-none">
<h1>
CM server object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the cm_server object used with Redis Enterprise Software REST API calls.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
operating_mode
</td>
<td>
'disabled'
<br/>
'enabled'
</td>
<td>
Enable/disable the CM server
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/objects/services_configuration/cm_server/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-stop/.html | <section class="prose w-full py-12">
<h1>
redis-di stop
</h1>
<p class="text-lg -mt-5 mb-10">
Stops the pipeline
</p>
<h2 id="usage">
Usage
</h2>
<pre tabindex="0"><code>Usage: redis-di stop [OPTIONS]
</code></pre>
<h2 id="options">
Options
</h2>
<ul>
<li>
<p>
<code>
log_level
</code>
:
</p>
<ul>
<li>
Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
</li>
<li>
Default:
<code>
info
</code>
</li>
<li>
Usage:
<code>
--log-level -l
</code>
</li>
</ul>
</li>
<li>
<p>
<code>
rdi_host
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-host
</code>
</li>
</ul>
<p>
Host/IP of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_port
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: <IntRange 1<=x<=65535>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-port
</code>
</li>
</ul>
<p>
Port of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_user
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-user
</code>
</li>
</ul>
<p>
RDI Database Username
</p>
</li>
<li>
<p>
<code>
rdi_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-password
</code>
</li>
</ul>
<p>
RDI Database Password
</p>
</li>
<li>
<p>
<code>
rdi_key
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key
</code>
</li>
</ul>
<p>
Private key file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cert
</code>
</li>
</ul>
<p>
Client certificate file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cacert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cacert
</code>
</li>
</ul>
<p>
CA certificate file to verify with
</p>
</li>
<li>
<p>
<code>
rdi_key_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key-password
</code>
</li>
</ul>
<p>
Password for unlocking an encrypted private key
</p>
</li>
<li>
<p>
<code>
help
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--help
</code>
</li>
</ul>
<p>
Show this message and exit.
</p>
</li>
</ul>
<h2 id="cli-help">
CLI help
</h2>
<pre tabindex="0"><code>Usage: redis-di stop [OPTIONS]
Stops the pipeline
Options:
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--rdi-host TEXT Host/IP of RDI Database [required]
--rdi-port INTEGER RANGE Port of RDI Database [1<=x<=65535;
required]
--rdi-user TEXT RDI Database Username
--rdi-password TEXT RDI Database Password
--rdi-key TEXT Private key file to authenticate with
--rdi-cert TEXT Client certificate file to authenticate with
--rdi-cacert TEXT CA certificate file to verify with
--rdi-key-password TEXT Password for unlocking an encrypted private
key
--help Show this message and exit.
</code></pre>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-stop/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgears/redisgears-1.0-release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisGears 1.0 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
First GA release of RedisGears. Built-in C-API and Python interpreter. Run a serverless engine in memory next to your Redis data.
</p>
<p>
Here's what's changed recently in RedisGears.
</p>
<p>
To learn more, see the linked pull requests.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RedisGears v1.0.9 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 6.0.0
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 6.0.0
</li>
</ul>
<h2 id="v109-january-2022">
v1.0.9 (January 2022)
</h2>
<p>
This is a maintenance release for RedisGears 1.0
</p>
<p>
Update urgency:
<code>
LOW
</code>
: No need to upgrade unless there are new features you want to use.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Improvements:
</p>
<ul>
<li>
<a href="https://github.com/RedisGears/RedisGears/pull/652">
#652
</a>
Support for keys space notifications coming from other modules.
</li>
</ul>
</li>
</ul>
<h2 id="v108-november-2021">
v1.0.8 (November 2021)
</h2>
<p>
This is a maintenance release for RedisGears 1.0.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
- Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Minor features:
</p>
<ul>
<li>
<a href="https://github.com/RedisGears/RedisGears/pull/624">
#624
</a>
,
<a href="https://github.com/RedisGears/RedisGears/pull/626">
#626
</a>
Update Python interpreter version to 3.7.12
</li>
</ul>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/610">
#610
</a>
Fix symbol collision with RediSearch and RedisGraph that causes deadlock
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/609">
#609
</a>
,
<a href="https://github.com/RedisGears/RedisGears/pull/611">
#611
</a>
Crash on stream reader where stream is deleted during read
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/612">
#612
</a>
Return error when GearsBuilder is used after
<code>
registered
</code>
or
<code>
run
</code>
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/613">
#613
</a>
Rare issue where stream reader might trigger executions on replica
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/629">
#629
</a>
Rare deadlock on stream reader
</p>
</li>
</ul>
</li>
</ul>
<h2 id="v107-august-2021">
v1.0.7 (August 2021)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<p>
Update urgency:
<code>
LOW
</code>
- No need to upgrade unless there are new features you want to use.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Minor Features:
</p>
<ul>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/594">
#594
</a>
Added RedisGears info section to Redis info command
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/587">
#587
</a>
<code>
inorder
</code>
option for the command reader
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisGears/RedisGears/pull/592">
#592
</a>
,
<a href="https://github.com/RedisGears/RedisGears/pull/586">
#586
</a>
Background executions will now appear on Redis slowlog, available in Redis 6.2 and above.
</p>
</li>
</ul>
</li>
</ul>
<h2 id="v106-march-2021">
v1.0.6 (March 2021)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<ul>
<li>
<p>
Update urgency: Medium
</p>
</li>
<li>
<p>
Highlights:
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/496">
496
</a>
Allow parallel execution on Command Reader.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/505">
505
</a>
Crash on a client that sends cluster set and disconnects.
</p>
</li>
</ul>
</li>
</ul>
<h2 id="v105-18-january-2021">
v1.0.5 (18 January 2021)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<ul>
<li>
<p>
Update urgency: High
</p>
</li>
<li>
<p>
Highlights:
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/480">
480
</a>
Crash when map/accumulate/accumulateby raises an error which causes the same pyobject to be freed twice.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/480">
480
</a>
'Cluster set' happened before resending hello request, which caused a crash.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/480">
480
</a>
Memory leaks on 'cluster set'.
</p>
</li>
</ul>
</li>
</ul>
<h2 id="v104-17-january-2021">
v1.0.4 (17 January 2021)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<ul>
<li>
<p>
Highights:
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/458">
458
</a>
Crash on StreamReader when the stream is dropped during processing of the function.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/477">
477
</a>
Rare crash on accumulate step.
</p>
</li>
</ul>
</li>
</ul>
<h2 id="v103-november-2020">
v1.0.3 (November 2020)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<ul>
<li>
<p>
Highlights:
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/427">
427
</a>
Rare issue where messages might get lost and cause executions timeouts.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/434">
434
</a>
Triggering an execution on uninitialized cluster state should raise a cluster uninitialized error.
</p>
</li>
</ul>
</li>
</ul>
<h2 id="v102-october-2020">
v1.0.2 (October 2020)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<ul>
<li>
<p>
Highlights:
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
</li>
<li>
<p>
Details:
</p>
<ul>
<li>
<p>
Minor Features:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/368">
368
</a>
Support for buffer input on
<code>
createTensorFromBlob
</code>
when integrating with
<a href="https://github.com/RedisAI/RedisAI">
RedisAI
</a>
API.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/373">
373
</a>
Registered execution plans will not re-send their metadata when they are triggered (this feature reduces network overhead and improve performance of distributed registrations).
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/371">
371
</a>
Full details on import requirement failure.
</p>
</li>
</ul>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/374">
374
</a>
Fix RedisAI
<code>
toFlatList
</code>
function to handle long long encoding.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/375">
375
</a>
Call
<code>
OnRegister
</code>
on RDBLoad.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/388">
388
</a>
Fix crash on hello request failure (internal protocol between shards), a retry will be triggered after 1 second.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/395">
395
</a>
Fix rare wrong results on
<code>
aggregate
</code>
and
<code>
aggregateby
</code>
. Use deep copy on the zero value to avoid those incorrect results.
</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="v101-july-2020">
v1.0.1 (July 2020)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<ul>
<li>
<p>
Highlights:
</p>
<ul>
<li>
<p>
<em>
Import and Export requirements
</em>
- With this capability, you can export the python requirements present in RedisGears and import them into another instance using
<a href="https://github.com/RedisGears/gears-cli">
gears-cli
</a>
.
</p>
<p>
This enables, amongst others, to import requirements to environments without internet access. Notice that the requirement should be exported from and imported into machines with the same OS and version. This is the recommended tool to use for productionising RedisGears functions (for example to be used in your CI).
</p>
</li>
<li>
<p>
<em>
Optimised requirements installation mechanism
</em>
- requirements will now be distributed once to each shard and not each time an execution is triggered.
</p>
</li>
<li>
<p>
<em>
RedisAI API fixes and additions
</em>
- fixes/additions related to the integration with RedisAI.
</p>
</li>
</ul>
</li>
<li>
<p>
Details:
</p>
<ul>
<li>
<p>
Features:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/330">
330
</a>
<code>
SendMsgRetries
</code>
configuration parameter indicating how many times RedisGears should try sending messages between shards.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/330">
330
</a>
<code>
PythonInstallReqMaxIdleTime
</code>
configuration parameter for the maximum amount of time to wait for requirements to be installed.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/330">
330
</a>
<code>
RG.PYDUMPREQ
</code>
command that output all the currently available python requirements.
</p>
</li>
<li>
<p>
Added the following API functionality to the RedisAI integration:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/346">
346
</a>
Script run will now return a list of tensors.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/347">
347
</a>
Allow tensor creation from bytes.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/350">
350
</a>
Added mget and mset to get/set multiple tensors from/to the keyspace.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/345">
345
</a>
Free python GIL before calling redisAI model/script run.
</p>
</li>
</ul>
</li>
</ul>
</li>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/325">
325
</a>
Circular reference that caused a logical memory leak.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/330">
330
</a>
Crash on wrong reply status.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/345">
345
</a>
Crash on python session (private data on rg.dumpregistration) 'tostr' function when there is no requirements.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/pull/334">
334
</a>
Type check to RedisAI API to prevent potential crashes.
</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="v100-may-2020">
v1.0.0 (May 2020)
</h2>
<p>
This is the first general availability (GA) release of RedisGears (v1.0.0).
</p>
<ul>
<li>
<p>
Highlights:
</p>
<ul>
<li>
<p>
Program everything you want in Redis - With a built-in C-API and Python interpreter, RedisGears lets you use full-fledged Python scripts and libraries to process data inside Redis.
</p>
</li>
<li>
<p>
Write once, deploy anywhere - Write your functions against a standalone Redis database and deploy them to production clusters—with no changes required.
</p>
</li>
<li>
<p>
Run your serverless engine where your data lives - RedisGears lets you process events and streams faster by running in memory next to your data in Redis.
</p>
</li>
</ul>
<p>
Bug fixes (compared to RC1):
</p>
<ul>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/issues/288">
288
</a>
dependencies with version will not crash the server.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/issues/309">
309
</a>
, #
<a href="https://github.com/RedisGears/RedisGears/issues/313">
313
</a>
Prevent crashes on RedisAI intergration and update the low level C api of RedisAI.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/issues/311">
311
</a>
Fix out-of-order reply in certain situations.
</p>
</li>
<li>
<p>
#
<a href="https://github.com/RedisGears/RedisGears/issues/321">
321
</a>
Return error when unknown argument is given.
</p>
</li>
</ul>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<ul>
<li>
The version inside Redis will be 10000 or 1.0.0 in semantic versioning.
</li>
<li>
This version requires the Redis version to be 6.0 and above.
</li>
</ul>
</div>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisgears/redisgears-1.0-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/json.clear.html | <section class="prose w-full py-12">
<h1 class="command-name">
JSON.CLEAR
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">JSON.CLEAR key [path]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/json">
JSON 2.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) when path is evaluated to a single value where N is the size of the values, O(N) when path is evaluated to multiple values, where N is the size of the key
</dd>
</dl>
<p>
Clear container values (arrays/objects) and set numeric values to
<code>
0
</code>
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is key to parse.
</p>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
path
</code>
</summary>
<p>
is JSONPath to specify. Default is root
<code>
$
</code>
. Nonexisting paths are ignored.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
JSON.CLEAR returns an integer reply specifying the number of matching JSON arrays and objects cleared + number of matching JSON numerical values zeroed.
For more information about replies, see
<a href="/docs/latest/develop/reference/protocol-spec/">
Redis serialization protocol specification
</a>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Already cleared values are ignored for empty containers and zero numbers.
</div>
</div>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Clear container values and set numeric values to
<code>
0
</code>
</b>
</summary>
<p>
Create a JSON document.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.SET doc $ <span class="s1">'{"obj":{"a":1, "b":2}, "arr":[1,2,3], "str": "foo", "bool": true, "int": 42, "float": 3.14}'</span>
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<p>
Clear all container values. This returns the number of objects with cleared values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.CLEAR doc $.*
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">4</span></span></span></code></pre>
</div>
<p>
Get the updated document. Note that numeric values have been set to
<code>
0
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.GET doc $
</span></span><span class="line"><span class="cl"><span class="s2">"[{\"obj\":{},\"arr\":[],\"str\":\"foo\",\"bool\":true,\"int\":0,\"float\":0}]"</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/json.arrindex/">
<code>
JSON.ARRINDEX
</code>
</a>
|
<a href="/docs/latest/commands/json.arrinsert/">
<code>
JSON.ARRINSERT
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/data-types/json/">
RedisJSON
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/indexing/">
Index and search JSON documents
</a>
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/json.clear/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/quickstart/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisGears JVM quick start
</h1>
<p class="text-lg -mt-5 mb-10">
A quick start to learn how to use RedisGears with Java.
</p>
<h2 id="prerequisites">
Prerequisites
</h2>
<p>
For this quick start, you need:
</p>
<ul>
<li>
A Redis Enterprise cluster with the
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears/#install-redisgears">
RedisGears module and JVM plugin installed
</a>
and
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/install/">
enabled on a database
</a>
</li>
<li>
<code>
redis-cli
</code>
with connectivity to a Redis database
</li>
</ul>
<h2 id="tutorial">
Tutorial
</h2>
<h3 id="create-a-maven-project">
Create a Maven project
</h3>
<ol>
<li>
<p>
Create a new
<a href="https://maven.apache.org/guides/getting-started/index.html#">
Maven project
</a>
.
</p>
</li>
<li>
<p>
Add the following sections to the
<a href="https://maven.apache.org/guides/introduction/introduction-to-the-pom.html">
pom.xml
</a>
file:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-xml" data-lang="xml"><span class="line"><span class="cl"><span class="nt"><repositories></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><repository></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><id></span>snapshots-repo<span class="nt"></id></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><url></span>https://oss.sonatype.org/content/repositories/snapshots<span class="nt"></url></span>
</span></span><span class="line"><span class="cl"> <span class="nt"></repository></span>
</span></span><span class="line"><span class="cl"><span class="nt"></repositories></span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nt"><dependencies></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><dependency></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><groupId></span>com.redislabs<span class="nt"></groupId></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><artifactId></span>gear_runtime<span class="nt"></artifactId></span>
</span></span><span class="line"><span class="cl"> <span class="nt"><version></span>0.0.3-SNAPSHOT<span class="nt"></version></span>
</span></span><span class="line"><span class="cl"> <span class="nt"></dependency></span>
</span></span><span class="line"><span class="cl"><span class="nt"></dependencies></span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Add example code for either
<a href="#batch-processing">
batch processing
</a>
or
<a href="#event-processing">
event processing
</a>
to your project's
<code>
main
</code>
function.
</p>
</li>
</ol>
<h3 id="build-a-jar">
Build a JAR
</h3>
<p>
Use the Maven command-line tool or an IDE plugin to compile and package your code into a JAR file:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ mvn package
</span></span></code></pre>
</div>
<h3 id="upload-the-jar">
Upload the JAR
</h3>
<p>
Upload your JAR file to a node in the Redis Enterprise cluster. You will need to use the destination filepath when you run your code.
</p>
<h3 id="run-redisgears-java-code">
Run RedisGears Java code
</h3>
<p>
Use the
<code>
RG.JEXECUTE
</code>
command to run your code:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ redis-cli -x -h <span class="o">{</span>host<span class="o">}</span> -p <span class="o">{</span>port<span class="o">}</span> RG.JEXECUTE <span class="o">{</span>package.MainClass<span class="o">}</span> < <span class="o">{</span>filepath<span class="o">}</span>/<span class="o">{</span>JAR name<span class="o">}</span>.jar
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
When you use
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsbuilder/run/">
<code>
GearsBuilder.run()
</code>
</a>
,
<code>
RG.JEXECUTE
</code>
runs your code immediately.
<br/>
<br/>
However, if you use
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsbuilder/register/">
<code>
GearsBuilder.register()
</code>
</a>
,
<code>
RG.JEXECUTE
</code>
only outputs an
<code>
OK
</code>
message if it registers successfully. Your registered code will run whenever certain database events occur.
</div>
</div>
<h2 id="example-code">
Example code
</h2>
<p>
You can use these code examples with your own Maven project to try out batch processing or event processing with the RedisGears JVM plugin.
</p>
<h3 id="batch-processing">
Batch processing
</h3>
<p>
If you use the
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsbuilder/run/">
<code>
GearsBuilder.run()
</code>
</a>
function within your code, then the functions you add to the pipeline will run exactly once when you use
<code>
RG.JEXECUTE
</code>
with your JAR file.
</p>
<p>
The following example calculates the average rating of all restaurant reviews stored in your database.
</p>
<h4 id="add-data-to-the-database">
Add data to the database
</h4>
<ol>
<li>
<p>
Connect to your database with
<code>
redis-cli
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ redis-cli -h <host> -p <port>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Add a few review hashes to the database with the
<code>
HSET
</code>
command:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:12000> HSET review:1 user <span class="s2">"Alex L"</span> message <span class="s2">"My new favorite restaurant!"</span> rating <span class="m">5</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">127.0.0.1:12000> HSET review:2 user <span class="s2">"Anonymous user"</span> message <span class="s2">"Kind of overpriced"</span> rating <span class="m">2</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">127.0.0.1:12000> HSET review:3 user <span class="s2">"Francis J"</span> message <span class="s2">"They have a really unique menu."</span> rating <span class="m">4</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">127.0.0.1:12000> <span class="nb">exit</span>
</span></span></code></pre>
</div>
</li>
</ol>
<h4 id="example-code-1">
Example code
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.io.Serializable</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">gears.GearsBuilder</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">gears.readers.KeysReader</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">gears.records.KeysReaderRecord</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">Reviews</span> <span class="kd">implements</span> <span class="n">Serializable</span>
</span></span><span class="line"><span class="cl"><span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">private</span> <span class="kd">static</span> <span class="kd">final</span> <span class="kt">long</span> <span class="n">serialVersionUID</span> <span class="o">=</span> <span class="mi">1L</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kt">int</span> <span class="n">count</span><span class="o">;</span> <span class="c1">// Total number of reviews
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kt">int</span> <span class="n">ratingsSum</span><span class="o">;</span> <span class="c1">// Sum of all review ratings
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Reviews constructor
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kd">public</span> <span class="nf">Reviews</span><span class="o">(</span><span class="kt">int</span> <span class="n">count</span><span class="o">,</span> <span class="kt">int</span> <span class="n">ratingsSum</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">count</span> <span class="o">=</span> <span class="n">count</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">ratingsSum</span> <span class="o">=</span> <span class="n">ratingsSum</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span> <span class="n">args</span><span class="o">[])</span>
</span></span><span class="line"><span class="cl"> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Create the reader that will pass data to the pipe
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">KeysReader</span> <span class="n">reader</span> <span class="o">=</span> <span class="k">new</span> <span class="n">KeysReader</span><span class="o">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Create the data pipe builder
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">GearsBuilder</span><span class="o"><</span><span class="n">KeysReaderRecord</span><span class="o">></span> <span class="n">gb</span> <span class="o">=</span> <span class="n">GearsBuilder</span><span class="o">.</span><span class="na">CreateGearsBuilder</span><span class="o">(</span><span class="n">reader</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">gb</span><span class="o">.</span><span class="na">filter</span><span class="o">(</span><span class="n">r</span><span class="o">->{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Filter out any keys that are not reviews
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="na">getKey</span><span class="o">().</span><span class="na">startsWith</span><span class="o">(</span><span class="s">"review:"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}).</span><span class="na">map</span><span class="o">(</span><span class="n">r</span><span class="o">->{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Extract the rating field
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="na">getHashVal</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="s">"rating"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="o">})</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">accumulate</span><span class="o">(</span><span class="k">new</span> <span class="n">Reviews</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="mi">0</span><span class="o">),</span> <span class="o">(</span><span class="n">accumulator</span><span class="o">,</span> <span class="n">record</span><span class="o">)-></span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Count the reviews and add up all of their ratings
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">accumulator</span><span class="o">.</span><span class="na">count</span><span class="o">++;</span>
</span></span><span class="line"><span class="cl"> <span class="n">accumulator</span><span class="o">.</span><span class="na">ratingsSum</span> <span class="o">+=</span> <span class="n">Integer</span><span class="o">.</span><span class="na">parseInt</span><span class="o">(</span><span class="n">record</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">accumulator</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}).</span><span class="na">map</span><span class="o">(</span><span class="n">r</span><span class="o">->{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Calculate the average rating
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">return</span> <span class="n">Double</span><span class="o">.</span><span class="na">valueOf</span><span class="o">(((</span><span class="kt">double</span><span class="o">)</span> <span class="n">r</span><span class="o">.</span><span class="na">ratingsSum</span><span class="o">)</span> <span class="o">/</span> <span class="n">r</span><span class="o">.</span><span class="na">count</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="o">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Run the data through the pipeline immediately
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">gb</span><span class="o">.</span><span class="na">run</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span></code></pre>
</div>
<h4 id="example-output">
Example output
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ redis-cli -x -h <span class="o">{</span>host<span class="o">}</span> -p <span class="o">{</span>port<span class="o">}</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> RG.JEXECUTE com.domain.packagename.Reviews < /tmp/rgjvmtest-0.0.1-SNAPSHOT.jar
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"3.6666666666666665"</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>empty array<span class="o">)</span>
</span></span></code></pre>
</div>
<h3 id="event-processing">
Event processing
</h3>
<p>
If you use the
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsbuilder/register/">
<code>
GearsBuilder.register()
</code>
</a>
function in your code, then the functions you add to the pipeline will run every time a certain database event occurs.
</p>
<p>
The following example registers a pipeline of functions to automatically update the maximum age every time you add a new person hash to your database.
</p>
<h4 id="example-code-2">
Example code
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">gears.GearsBuilder</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">gears.readers.KeysReader</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">gears.records.KeysReaderRecord</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">App</span>
</span></span><span class="line"><span class="cl"><span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span> <span class="n">args</span><span class="o">[])</span>
</span></span><span class="line"><span class="cl"> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Create the reader that will pass data to the pipe
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">KeysReader</span> <span class="n">reader</span> <span class="o">=</span> <span class="k">new</span> <span class="n">KeysReader</span><span class="o">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Create the data pipe builder
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">GearsBuilder</span><span class="o"><</span><span class="n">KeysReaderRecord</span><span class="o">></span> <span class="n">gb</span> <span class="o">=</span> <span class="n">GearsBuilder</span><span class="o">.</span><span class="na">CreateGearsBuilder</span><span class="o">(</span><span class="n">reader</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Only process keys that start with "person:"
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">gb</span><span class="o">.</span><span class="na">filter</span><span class="o">(</span><span class="n">r</span><span class="o">->{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="na">getKey</span><span class="o">().</span><span class="na">startsWith</span><span class="o">(</span><span class="s">"person:"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="o">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Compare each person's age to the current maximum age
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">gb</span><span class="o">.</span><span class="na">foreach</span><span class="o">(</span><span class="n">r</span><span class="o">->{</span>
</span></span><span class="line"><span class="cl"> <span class="n">String</span> <span class="n">newAgeStr</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="na">getHashVal</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="s">"age"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">int</span> <span class="n">newAge</span> <span class="o">=</span> <span class="n">Integer</span><span class="o">.</span><span class="na">parseInt</span><span class="o">(</span><span class="n">newAgeStr</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Get the current maximum age
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">String</span> <span class="n">maxAgeKey</span> <span class="o">=</span> <span class="s">"age:maximum"</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">String</span> <span class="n">maxAgeStr</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">GearsBuilder</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"GET"</span><span class="o">,</span> <span class="n">maxAgeKey</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">int</span> <span class="n">maxAge</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="c1">// Initialize to 0
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">if</span> <span class="o">(</span><span class="n">maxAgeStr</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Convert the maximum age to an integer
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">maxAge</span> <span class="o">=</span> <span class="n">Integer</span><span class="o">.</span><span class="na">parseInt</span><span class="o">(</span><span class="n">maxAgeStr</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Update the maximum age if a new age is higher
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">if</span> <span class="o">(</span><span class="n">newAge</span> <span class="o">></span> <span class="n">maxAge</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">GearsBuilder</span><span class="o">.</span><span class="na">execute</span><span class="o">(</span><span class="s">"SET"</span><span class="o">,</span> <span class="n">maxAgeKey</span><span class="o">,</span> <span class="n">newAgeStr</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="o">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Store this pipeline of functions and
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// run them when a new person key is added
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">gb</span><span class="o">.</span><span class="na">register</span><span class="o">(</span><span class="n">ExecutionMode</span><span class="o">.</span><span class="na">SYNC</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Note: ExecutionMode defaults to ASYNC
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// if you call register() without any arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span></code></pre>
</div>
<h4 id="example-event-processing">
Example event processing
</h4>
<p>
After you register your code with the
<code>
RG.JEXECUTE
</code>
command, add some data to the database and check the value of
<code>
age:maximum
</code>
to verify that it runs correctly.
</p>
<ol>
<li>
<p>
Connect to your database with
<code>
redis-cli
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ redis-cli -h <host> -p <port>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Add a hash that represents a person with
<code>
HSET
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:12000> HSET person:1 name <span class="s2">"Alex"</span> age <span class="m">24</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
The current value of
<code>
age:maximum
</code>
should match Alex's age:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:12000> GET age:maximum
</span></span><span class="line"><span class="cl"><span class="s2">"24"</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Add another person with a higher age and then check that
<code>
age:maximum
</code>
updated automatically:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:12000> HSET person:2 name <span class="s2">"Morgan"</span> age <span class="m">45</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl">127.0.0.1:12000> GET age:maximum
</span></span><span class="line"><span class="cl"><span class="s2">"45"</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Add a person with a lower age and verify that
<code>
age:maximum
</code>
did not change:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:12000> HSET person:3 name <span class="s2">"Lee"</span> age <span class="m">31</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl">127.0.0.1:12000> GET age:maximum
</span></span><span class="line"><span class="cl"><span class="s2">"45"</span>
</span></span></code></pre>
</div>
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/gears-v1/jvm/quickstart/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/tools/insight/rdi-connector/.html | <section class="prose w-full py-12">
<h1>
RDI in Redis Insight
</h1>
<p class="text-lg -mt-5 mb-10">
Connect to RDI from Redis Insight, configure pipelines, and more.
</p>
<p>
Redis Data Integration (RDI) and its
<a href="/docs/latest/integrate/redis-data-integration/">
ingest pipeline capability
</a>
is an end-to-end solution for mirroring your application's primary database in Redis. RDI employs a capture data change mechanism and a stream processor to map and transform source data such as relational tables into fast Redis data structures that match your use cases.
You can read more about RDI's ingest architecture
<a href="/docs/latest/integrate/redis-data-integration/architecture/">
on these pages
</a>
.
</p>
<p>
As of version
<code>
2.54.0
</code>
, Redis Insight includes RDI connectivity, which allows you to connect to
<a href="/docs/latest/integrate/redis-data-integration/architecture/#how-rdi-is-deployed">
RDI management planes
</a>
, create, test, and deploy
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/data-pipelines/">
RDI pipelines
</a>
, and view RDI statistics.
</p>
<h2 id="connect">
Connect
</h2>
<p>
Open Redis Insight, click on the
<strong>
Redis Data Integration
</strong>
tab, and then click on one of the two
<strong>
+ Add RDI Endpoint
</strong>
buttons as shown below.
</p>
<img src="../images/ri-rdi-add-endpoint1.png"/>
<p>
Enter your RDI server details in the provided dialog. The
<strong>
RDI Alias
</strong>
field can be any name you choose and it will be used as the primary name in the
<strong>
RDI Instances
</strong>
list view.
</p>
<img src="../images/ri-rdi-add-endpoint2.png"/>
<p>
You'll receive notification if your connection is successful.
</p>
<img src="../images/ri-rdi-endpoint-added.png"/>
<h2 id="create-test-and-deploy-rdi-pipelines">
Create, test, and deploy RDI pipelines
</h2>
<p>
Begin by clicking the alias of your newly configured RDI endpoint in the
<strong>
RDI Instances
</strong>
view (for example,
<strong>
Test connection
</strong>
in the above image). You'll see the following dialog in the center of the screen.
</p>
<img src="../images/ri-rdi-pl-start.png"/>
<p>
Choose from the following options:
</p>
<ul>
<li>
<strong>
Download from server
</strong>
- Download an existing pipeline from your RDI configuration.
</li>
<li>
<strong>
Upload from file
</strong>
- Upload YAML pipeline files from your local computer in zip format.
</li>
<li>
<strong>
Create new pipeline
</strong>
- Use Redis Insight's built-in editors to create a new pipeline either from scratch or using one of the built-in templates.
</li>
</ul>
<p>
Each of these menu options will be described in more detail in subsequent sections.
</p>
<p>
There are also equivalent buttons at the top of the editor pane for the first two of these functions.
</p>
<img src="../images/ri-rdi-pl-editor-minibuttons.png"/>
<p>
If you'd rather start with an empty configuration, exit the dialog, which will leave you in the
<strong>
Configuration file
</strong>
editor where you can begin editing the configuration component of your pipeline; the
<code>
config.yaml
</code>
file.
</p>
<h3 id="download-a-pipeline-from-your-rdi-configuration">
Download a pipeline from your RDI configuration
</h3>
<p>
Click the
<strong>
Download from server
</strong>
button in the
<strong>
Start with your pipeline
</strong>
dialog to download a previously defined pipeline from your RDI configuration. The downloaded pipeline will be displayed in the
<strong>
Pipeline management
</strong>
pane. As shown below, each pipeline consists of a configuration file (
<code>
config.yaml
</code>
) and zero or more
<code>
job
</code>
YAML files. The configuration file will be displayed in the center editor panel.
</p>
<img src="../images/ri-rdi-pl-dl.png"/>
<h3 id="upload-a-pipeline-from-your-local-machine">
Upload a pipeline from your local machine
</h3>
<p>
Click the
<strong>
Upload from file
</strong>
button in the
<strong>
Start with your pipeline
</strong>
dialog to upload your configuration and job YAML files from your local machine. The files must be stored in a zip file that has the following structure.
</p>
<pre tabindex="0"><code>├── config.yaml
└── jobs
└── job1.yaml
</code></pre>
<p>
The
<code>
config.yaml
</code>
file, your configuration YAML file, is required. The
<code>
jobs
</code>
directory can be empty, as job pipelines are not required, but the empty directory must exist in the zip file. Otherwise, the
<code>
jobs
</code>
folder might contain one or more job YAML files.
</p>
<h3 id="create-a-new-configuration-file-using-the-built-in-editor">
Create a new configuration file using the built-in editor
</h3>
<p>
Click the
<strong>
Create new pipeline
</strong>
button in the
<strong>
Start with your pipeline
</strong>
dialog to create a new pipeline using the built-in editors. After doing so, you'll enter the
<strong>
Configuration file
</strong>
editor and you'll see an open
<strong>
Select a template
</strong>
dialog in the upper right-hand corner of the editor.
</p>
<img src="../images/ri-rdi-pl-editor-dlg.png"/>
<p>
Make your selections in the provided fields:
</p>
<ul>
<li>
<strong>
Pipeline type
</strong>
is set to
<strong>
Ingest
</strong>
by default.
</li>
<li>
<strong>
Database type
</strong>
has six options:
<ul>
<li>
mongodb
</li>
<li>
cassandra
</li>
<li>
mysql
</li>
<li>
oracle
</li>
<li>
postgresql
</li>
<li>
sqlserver
</li>
</ul>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The options listed in the above menus depend on the capabilities of your RDI configuration.
</div>
</div>
<p>
After you make your selections and click
<strong>
Apply
</strong>
, Redis Insight will populate the editor window with an appropriate template. To start from scratch, click
<strong>
Cancel
</strong>
.
</p>
<p>
See the
<a href="/docs/latest/integrate/redis-data-integration/reference/config-yaml-reference/">
RDI documentation
</a>
for information about required fields.
</p>
<img src="../images/ri-rdi-pl-editor-template.png"/>
<h3 id="test-your-target-database-connection">
Test your target database connection
</h3>
<p>
After you've created your
<strong>
Target database configuration
</strong>
, you can test the connection using the
<strong>
Test Connection
</strong>
button in the bottom right of the editor pane. A new panel will open to the right containing the test results as shown below.
</p>
<img src="../images/ri-rdi-pl-test-cxn.png"/>
<h3 id="create-a-new-transformation-job-file-using-the-built-in-editor">
Create a new transformation job file using the built-in editor
</h3>
<p>
In the
<strong>
Pipeline Management
</strong>
pane, click the
<code>
+
</code>
next to the
<strong>
Jobs
</strong>
folder and enter a name for the new transformation job.
Next, click the job name you just created.
This will take you to the job editor with the template selection menu open. Make your selection and click
<strong>
Apply
</strong>
. Redis Insight will populate the editor window with an appropriate template. To start from scratch, click
<strong>
Cancel
</strong>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The options listed in the above menu depend on the capabilities of your RDI configuration.
</div>
</div>
<p>
The
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/transform-examples/">
RDI documentation
</a>
has several examples of transformation jobs that can help get you started. Note: RDI uses a very specific YAML format for job files. See
<a href="/docs/latest/integrate/redis-data-integration/data-pipelines/data-pipelines/#job-files">
here
</a>
for more information.
</p>
<img src="../images/ri-rdi-job-editor-template.png"/>
<h2 id="use-the-built-in-editors">
Use the built-in editors
</h2>
<p>
The Redis Insight pipeline file editors are context-aware. They provide auto-completion, syntax highlighting, and error detection for:
</p>
<ul>
<li>
YAML files in the configuration and job file editors
</li>
<li>
JMESPath and SQL function snippets in a dedicated editor. To open the JMESPath and SQL editor, click the
<strong>
SQL and JMESPathEditor
</strong>
button as shown above. A new editor window will open in the lower half of the screen.
</li>
</ul>
<p>
If you decided to write your own configuration pipeline without using a template, you would see auto-completion prompts such as the one shown below.
</p>
<img src="../images/ri-rdi-pl-editor-autoc.png"/>
<p>
While this isn't a replacement for the RDI documentation, it can help speed you along after you have basic familiarity with the building blocks of RDI pipeline files.
</p>
<p>
Redis Insight will also highlight any errors as shown below.
</p>
<img src="../images/ri-rdi-pl-editor-errs.png"/>
<p>
Here's an example showing the SQL and JMESPath editor pane. Note the toggle in the bottom left corner of this editor pane. Clicking it allows you to select from:
</p>
<ul>
<li>
SQLite functions
</li>
<li>
JMESPath
</li>
</ul>
<p>
After constructing your SQLite or JMESPath code, copy it to the main editor window. Here's a
<a href="/docs/latest/integrate/redis-data-integration/reference/jmespath-custom-functions/">
reference
</a>
to the supported JMESPath extension functions and expressions that you can use in your job files.
</p>
<img src="../images/ri-rdi-pl-editor-sql-minie.png"/>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Any changes you make in the editors will be lost if you exit Redis Insight without saving your work. To save any changes you made to your pipeline files, deploy them to your RDI server (see below) or download the modified files as a zip file to your local disk using the
<strong>
Download
</strong>
button in the top right of the RDI window. Redis Insight will prepend a green circle on unsaved/undeployed files.
<p>
</p>
<img src="../images/ri-rdi-pl-unsaved.png"/>
</div>
</div>
<h2 id="dry-run-transformation-job-pipelines">
Dry run transformation job pipelines
</h2>
<p>
After you've created a transformation job pipeline, you can execute a dry run on the RDI server. To do that, click on
<strong>
Dry Run
</strong>
in the lower right side of the editor pane. A new
<strong>
Test transformation logic
</strong>
panel will open to the side. There are two vertically-stacked panes:
<strong>
Input
</strong>
and
<strong>
Results
</strong>
. In the
<strong>
Input
</strong>
section, enter JSON data that will trigger the transformation. Any results will be displayed in the
<strong>
Results
</strong>
section.
</p>
<p>
There are two tabs in the
<strong>
Results
</strong>
section:
</p>
<ol>
<li>
<strong>
Transformations
</strong>
- this is where you'll see JSON output from your dry run.
</li>
<li>
<strong>
Output
</strong>
- (not shown) this is where you'll see the Redis commands that would have been run in a real scenario.
</li>
</ol>
<p>
Here's an example.
</p>
<img src="../images/ri-rdi-pl-dryrun.png"/>
<h2 id="deploy-pipelines-and-add-target-db-to-redis-insight">
Deploy pipelines and add target DB to Redis Insight
</h2>
<p>
If you're satisfied with your configuration and transformation job pipelines, you can deploy them to the RDI management plane. Click the
<strong>
Deploy Pipeline
</strong>
button to proceed.
</p>
<p>
After your pipelines have been deployed, you can add the RDI target Redis database defined in your
<code>
config.yaml
</code>
file to Redis Insight.
Doing so will allow you to monitor key creation from your RDI pipeline over time.
</p>
<h2 id="view-rdi-statistics">
View RDI statistics
</h2>
<p>
You can view various statistics for your RDI deployment. To do so, click the
<strong>
Pipeline Status
</strong>
menu button in the left side menu panel.
</p>
<img src="../images/ri-rdi-stats-view.png"/>
<p>
Each statistics section is either static or refreshed automatically at a particular interval that you set.
The first section,
<strong>
Processing performance information
</strong>
is set by default to refresh every 5 seconds.
The other sections are static and need to be refreshed manually by pressing the refresh button at the top right of each section.
You can also set up automatic refresh for the other sections.
</p>
<p>
To set up automatic refresh for one or more statistics sections, click on the downward arrow at the end of the
<strong>
Last refresh
</strong>
line.
Then enable the
<strong>
Auto Refresh
</strong>
setting and set your desired refresh interval in seconds. This is shown in the previous image.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/tools/insight/rdi-connector/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/upgrade-paths/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Supported upgrade paths for Redis Software
</h1>
<p class="text-lg -mt-5 mb-10">
Supported paths to upgrade a Redis Software cluster.
</p>
<h2 id="supported-upgrade-paths">
Supported upgrade paths
</h2>
<p>
<span title="Check mark icon">
✅
</span>
Supported – You can upgrade directly from the current Redis Software cluster version.
</p>
<p>
<span title="X icon">
❌
</span>
Not supported – You cannot upgrade directly from the current Redis Software cluster version. You must first upgrade to a supported intermediate version.
</p>
<table>
<thead>
<tr>
<th style="text-align:center">
Current Redis Software cluster version
</th>
<th style="text-align:center">
Upgrade to Redis Software 6.2.x
</th>
<th style="text-align:center">
Upgrade to Redis Software 6.4.x
</th>
<th style="text-align:center">
Upgrade to Redis Software 7.2.x
</th>
<th style="text-align:center">
Upgrade to Redis Software 7.4.x
</th>
<th style="text-align:center">
Upgrade to Redis Software 7.8.x
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:center">
6.0.x
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Not supported">
❌
</span>
</td>
<td style="text-align:center">
<span title="Not supported">
❌
</span>
</td>
</tr>
<tr>
<td style="text-align:center">
6.2.4
<br/>
6.2.8
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Not supported">
❌
</span>
</td>
</tr>
<tr>
<td style="text-align:center">
6.2.10
<br/>
6.2.12
<br/>
6.2.18
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td style="text-align:center">
6.4.x
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td style="text-align:center">
7.2.x
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td style="text-align:center">
7.4.x
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
-
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
</tbody>
</table>
<p>
For detailed upgrade instructions, see
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/upgrading/upgrade-cluster/">
Upgrade a Redis Enterprise Software cluster
</a>
.
</p>
<p>
See the
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/product-lifecycle/">
Redis Enterprise Software product lifecycle
</a>
for more information about release numbers and the end-of-life schedule.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/upgrade-paths/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ldap_mappings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
LDAP mappings requests
</h1>
<p class="text-lg -mt-5 mb-10">
LDAP mappings requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-ldap_mappings">
GET
</a>
</td>
<td>
<code>
/v1/ldap_mappings
</code>
</td>
<td>
Get all LDAP mappings
</td>
</tr>
<tr>
<td>
<a href="#get-ldap_mapping">
GET
</a>
</td>
<td>
<code>
/v1/ldap_mappings/{uid}
</code>
</td>
<td>
Get a single LDAP mapping
</td>
</tr>
<tr>
<td>
<a href="#put-ldap_mapping">
PUT
</a>
</td>
<td>
<code>
/v1/ldap_mappings/{uid}
</code>
</td>
<td>
Update an LDAP mapping
</td>
</tr>
<tr>
<td>
<a href="#post-ldap_mappings">
POST
</a>
</td>
<td>
<code>
/v1/ldap_mappings
</code>
</td>
<td>
Create a new LDAP mapping
</td>
</tr>
<tr>
<td>
<a href="#delete-ldap_mappings">
DELETE
</a>
</td>
<td>
<code>
/v1/ldap_mappings/{uid}
</code>
</td>
<td>
Delete an LDAP mapping
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-ldap_mappings">
Get all LDAP mappings
</h2>
<pre><code>GET /v1/ldap_mappings
</code></pre>
<p>
Get all LDAP mappings.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_all_ldap_mappings_info">
view_all_ldap_mappings_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /ldap_mappings
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a JSON array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/ldap_mapping/">
LDAP mapping objects
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span></code></pre>
</div>
<h3 id="get-all-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<h2 id="get-ldap_mapping">
Get LDAP mapping
</h2>
<pre><code>GET /v1/ldap_mappings/{int: uid}
</code></pre>
<p>
Get a specific LDAP mapping.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_ldap_mapping_info">
view_ldap_mapping_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>GET /ldap_mappings/1
</code></pre>
<h4 id="request-headers-1">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The object's unique ID.
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns an
<a href="/docs/latest/operate/rs/references/rest-api/objects/ldap_mapping/">
LDAP mapping object
</a>
.
</p>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
ldap_mapping_not_exist
</td>
<td>
An object does not exist
</td>
</tr>
</tbody>
</table>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">
403 Forbidden
</a>
</td>
<td>
Operation is forbidden.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
ldap_mapping does not exist.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mappings yet.
</td>
</tr>
</tbody>
</table>
<h2 id="put-ldap_mapping">
Update LDAP mapping
</h2>
<pre><code>PUT /v1/ldap_mappings/{int: uid}
</code></pre>
<p>
Update an existing ldap_mapping object.
</p>
<h4 id="required-permissions-2">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#update_ldap_mapping">
update_ldap_mapping
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="put-request">
Request
</h3>
<h4 id="example-http-request-2">
Example HTTP request
</h4>
<pre><code>PUT /ldap_mappings/17
</code></pre>
<h4 id="example-json-body-2">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers-2">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="request-body">
Request body
</h4>
<p>
Include an
<a href="/docs/latest/operate/rs/references/rest-api/objects/ldap_mapping/">
LDAP mapping object
</a>
with updated fields in the request body.
</p>
<h3 id="put-response">
Response
</h3>
<h4 id="example-json-body-3">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email_alerts"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdbs_email_alerts"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">,</span><span class="s2">"2"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster_email_alerts"</span><span class="p">:</span> <span class="kc">true</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="put-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
name_already_exists
</td>
<td>
An object of the same type and name exists
</td>
</tr>
<tr>
<td>
ldap_mapping_not_exist
</td>
<td>
An object does not exist
</td>
</tr>
<tr>
<td>
invalid_dn_param
</td>
<td>
A dn parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_name_param
</td>
<td>
A name parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_role_uids_param
</td>
<td>
A role_uids parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_account_id_param
</td>
<td>
An account_id parameter has an illegal value
</td>
</tr>
</tbody>
</table>
<h3 id="put-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success, LDAP mapping is created.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Bad or missing configuration parameters.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Attempting to change a non-existing LDAP mapping.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mapping yet.
</td>
</tr>
</tbody>
</table>
<h2 id="post-ldap_mappings">
Create LDAP mapping
</h2>
<pre><code>POST /v1/ldap_mappings
</code></pre>
<p>
Create a new LDAP mapping.
</p>
<h4 id="required-permissions-3">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#create_ldap_mapping">
create_ldap_mapping
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="post-request">
Request
</h3>
<h4 id="example-http-request-3">
Example HTTP request
</h4>
<pre><code>POST /ldap_mappings
</code></pre>
<h4 id="example-json-body-4">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers-3">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="request-body-1">
Request body
</h4>
<p>
Include an
<a href="/docs/latest/operate/rs/references/rest-api/objects/ldap_mapping/">
LDAP mapping object
</a>
in the request body.
</p>
<h3 id="post-response">
Response
</h3>
<h4 id="example-json-body-5">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Admins"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"dn"</span><span class="p">:</span> <span class="s2">"OU=ops.group,DC=redislabs,DC=com"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"[email protected]"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role_uids"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"1"</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="post-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
name_already_exists
</td>
<td>
An object of the same type and name exists
</td>
</tr>
<tr>
<td>
missing_field
</td>
<td>
A needed field is missing
</td>
</tr>
<tr>
<td>
invalid_dn_param
</td>
<td>
A dn parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_name_param
</td>
<td>
A name parameter has an illegal value
</td>
</tr>
<tr>
<td>
invalid_role_uids_param
</td>
<td>
A role_uids parameter has an illegal value
</td>
</tr>
</tbody>
</table>
<h3 id="post-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success, an LDAP-mapping object is created.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Bad or missing configuration parameters.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mappings yet.
</td>
</tr>
</tbody>
</table>
<h2 id="delete-ldap_mappings">
Delete LDAP mapping
</h2>
<pre><code>DELETE /v1/ldap_mappings/{int: uid}
</code></pre>
<p>
Delete an LDAP mapping object.
</p>
<h4 id="required-permissions-4">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#delete_ldap_mapping">
delete_ldap_mapping
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="delete-request">
Request
</h3>
<h4 id="example-http-request-4">
Example HTTP request
</h4>
<pre><code>DELETE /ldap_mappings/1
</code></pre>
<h4 id="request-headers-4">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters-1">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The ldap_mapping unique ID.
</td>
</tr>
</tbody>
</table>
<h3 id="delete-response">
Response
</h3>
<p>
Returns a status code. If an error occurs, the response body may include a more specific error code and message.
</p>
<h3 id="delete-error-codes">
Error codes
</h3>
<p>
Possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
unsupported_resource
</td>
<td>
The cluster is not yet able to handle this resource type. This could happen in a partially upgraded cluster, where some of the nodes are still on a previous version.
</td>
</tr>
<tr>
<td>
ldap_mapping_not_exist
</td>
<td>
An object does not exist
</td>
</tr>
</tbody>
</table>
<h3 id="delete-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
Success, the ldap_mapping is deleted.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
The request is not acceptable.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2">
501 Not Implemented
</a>
</td>
<td>
Cluster doesn't support LDAP mappings yet.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/ldap_mappings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/hkeys/.html | <section class="prose w-full py-12">
<h1 class="command-name">
HKEYS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">HKEYS key</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the size of the hash.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@hash
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Returns all field names in the hash stored at
<code>
key
</code>
.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> HSET myhash field1 "Hello"
(integer) 1
redis> HSET myhash field2 "World"
(integer) 1
redis> HKEYS myhash
1) "field1"
2) "field2"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of fields in the hash, or an empty list when the key does not exist
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of fields in the hash, or an empty list when the key does not exist.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/hkeys/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.alter.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.ALTER
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.ALTER {index} [SKIPINITIALSCAN] SCHEMA ADD {attribute} {options} ...
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of keys in the keyspace
</dd>
</dl>
<p>
Add a new attribute to the index. Adding an attribute to the index causes any future document updates to use the new attribute when indexing and reindexing existing documents.
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
index
</code>
</summary>
<p>
is index name to create.
</p>
</details>
<details open="">
<summary>
<code>
SKIPINITIALSCAN
</code>
</summary>
<p>
if set, does not scan and index.
</p>
</details>
<details open="">
<summary>
<code>
SCHEMA ADD {attribute} {options} ...
</code>
</summary>
<p>
after the SCHEMA keyword, declares which fields to add:
</p>
<ul>
<li>
<code>
attribute
</code>
is attribute to add.
</li>
<li>
<code>
options
</code>
are attribute options. Refer to
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
for more information.
</li>
</ul>
<p>
<note>
<b>
Note:
</b>
</note>
</p>
<p>
Depending on how the index was created, you may be limited by the number of additional text
attributes which can be added to an existing index. If the current index contains fewer than 32
text attributes, then
<code>
SCHEMA ADD
</code>
will only be able to add attributes up to 32 total attributes (meaning that the
index will only ever be able to contain 32 total text attributes). If you wish for the index to
contain more than 32 attributes, create it with the
<code>
MAXTEXTFIELDS
</code>
option.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.ALTER returns a simple string reply
<code>
OK
</code>
if executed correctly, or an error reply otherwise.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Alter an index
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.ALTER idx SCHEMA ADD id2 NUMERIC SORTABLE
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.alter/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/delete/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Delete databases
</h1>
<p class="text-lg -mt-5 mb-10">
Delete a database from the Cluster Manager UI.
</p>
<p>
When you delete a database, both the database configuration and data are removed.
</p>
<p>
To delete a database from the Cluster Manager UI:
</p>
<ol>
<li>
<p>
From the
<strong>
Databases
</strong>
list, select the database, then select
<strong>
Configuration
</strong>
.
</p>
</li>
<li>
<p>
Select
<a href="/docs/latest/images/rs/icons/delete-icon.png#no-click" sdata-lightbox="/images/rs/icons/delete-icon.png#no-click">
<img alt="Delete button" class="inline" src="/docs/latest/images/rs/icons/delete-icon.png#no-click" width="22px"/>
</a>
<strong>
Delete
</strong>
.
</p>
</li>
<li>
<p>
In the
<strong>
Delete database
</strong>
dialog, confirm deletion.
</p>
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/delete/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Time series
</h1>
<p>
You can manage time series data in Redis Enterprise with Redis Stack.
</p>
<h2 id="features">
Features
</h2>
<ul>
<li>
Query by start time and end-time
</li>
<li>
Query by labels sets
</li>
<li>
Aggregated queries (Min, Max, Avg, Sum, Range, Count, First, Last) for any time bucket
</li>
<li>
Configurable max retention period
</li>
<li>
Compaction/Roll-ups - automatically updated aggregated time series
</li>
<li>
labels index - each key has labels which allows query by labels
</li>
</ul>
<h2 id="memory-model">
Memory model
</h2>
<p>
A time series is a linked list of memory chunks.
Each chunk has a predefined size of samples.
Each sample is a tuple of the time and the value of 128 bits,
64 bits for the timestamp and 64 bits for the value.
</p>
<h2 id="time-series-capabilities">
Time series capabilities
</h2>
<p>
Redis Stack provides a new data type that uses chunks of memory of fixed size for time series samples, indexed by the same Radix Tree implementation as Redis streams. With streams, you can create
<a href="/docs/latest/develop/data-types/streams/#capped-streams">
a capped stream
</a>
, effectively limiting the number of messages by count. For time series, you can apply a retention policy in milliseconds. This is better for time series use cases, because they are typically interested in the data during a given time window, rather than a fixed number of samples.
</p>
<h3 id="downsamplingcompaction">
Downsampling/compaction
</h3>
<table>
<thead>
<tr>
<th>
Before Downsampling
</th>
<th>
After Downsampling
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/images/rs/TimeSeries-downsampling1.png" sdata-lightbox="/images/rs/TimeSeries-downsampling1.png">
<img src="/docs/latest/images/rs/TimeSeries-downsampling1.png"/>
</a>
</td>
<td>
<a href="/docs/latest/images/rs/TimeSeries-downsampling2.png" sdata-lightbox="/images/rs/TimeSeries-downsampling2.png">
<img src="/docs/latest/images/rs/TimeSeries-downsampling2.png"/>
</a>
</td>
</tr>
</tbody>
</table>
<p>
If you want to keep all of your raw data points indefinitely, your data set grows linearly over time. However, if your use case allows you to have less fine-grained data further back in time, downsampling can be applied. This allows you to keep fewer historical data points by aggregating raw data for a given time window using a given aggregation function. Time series support
<a href="/docs/latest/develop/data-types/timeseries/quickstart#aggregation">
downsampling
</a>
with the following aggregations: avg, sum, min, max, range, count, first, and last.
</p>
<h3 id="secondary-indexing">
Secondary indexing
</h3>
<p>
When using Redis’ core data structures, you can only retrieve a time series by knowing the exact key holding the time series. Unfortunately, for many time series use cases (such as root cause analysis or monitoring), your application won’t know the exact key it’s looking for. These use cases typically want to query a set of time series that relate to each other in a couple of dimensions to extract the insight you need. You could create your own secondary index with core Redis data structures to help with this, but it would come with a high development cost and require you to manage edge cases to make sure the index is correct.
</p>
<p>
Redis does this indexing for you based on
<code>
field value
</code>
pairs called
<a href="/docs/latest/develop/data-types/timeseries/quickstart#labels">
labels
</a>
. You can add labels to each time series and use them to
<a href="/docs/latest/develop/data-types/timeseries/quickstart#filtering">
filter
</a>
at query time.
</p>
<p>
Here’s an example of creating a time series with two labels (sensor_id and area_id are the fields with values 2 and 32 respectively) and a retention window of 60,000 milliseconds:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"> TS.CREATE temperature RETENTION <span class="m">60000</span> LABELS sensor_id <span class="m">2</span> area_id <span class="m">32</span>
</span></span></code></pre>
</div>
<h3 id="aggregation-at-read-time">
Aggregation at read time
</h3>
<p>
When you need to query a time series, it’s cumbersome to stream all raw data points if you’re only interested in, say, an average over a given time interval. Time series only transfer the minimum required data to ensure lowest latency.
</p>
<p>
Here's an example of
<a href="/docs/latest/develop/data-types/timeseries/quickstart#aggregation">
aggregation
</a>
over time buckets of 5,000 milliseconds:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"> 127.0.0.1:12543> TS.RANGE temperature:3:32 <span class="m">1548149180000</span> <span class="m">1548149210000</span> AGGREGATION avg <span class="m">5000</span>
</span></span><span class="line"><span class="cl"> 1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"26.199999999999999"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"27.399999999999999"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149190000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"24.800000000000001"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149195000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"23.199999999999999"</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149200000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"25.199999999999999"</span>
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149205000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"28"</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149210000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"20"</span>
</span></span></code></pre>
</div>
<h3 id="integrations">
Integrations
</h3>
<p>
Redis Stack comes with several integrations into existing time series tools. One such integration is our
<a href="https://github.com/RedisTimeSeries/prometheus-redistimeseries-adapter">
RedisTimeSeries adapter
</a>
for
<a href="https://prometheus.io/">
Prometheus
</a>
, which keeps all your monitoring metrics inside time series while leveraging the entire
<a href="https://prometheus.io/docs/prometheus/latest/storage/#remote-storage-integrations">
Prometheus ecosystem
</a>
.
</p>
<a href="/docs/latest/images/rs/TimeSeries-integrations.png" sdata-lightbox="/images/rs/TimeSeries-integrations.png">
<img src="/docs/latest/images/rs/TimeSeries-integrations.png"/>
</a>
<p>
Furthermore, we also created direct integrations for
<a href="https://github.com/RedisTimeSeries/grafana-redistimeseries">
Grafana
</a>
.
<a href="https://github.com/RedisTimeSeries/prometheus-demos">
This repository
</a>
contains a docker-compose setup of RedisTimeSeries, its remote write adaptor, Prometheus and
<a href="https://grafana.com/">
Grafana
</a>
. It also comes with a set of data generators and pre-built Grafana dashboards.
</p>
<h2 id="time-series-modeling-approaches-with-redis">
Time series modeling approaches with Redis
</h2>
<h3 id="data-modeling-approaches">
Data modeling approaches
</h3>
<p>
Redis streams allow you to add several field value pairs in a message for a given timestamp. For each device, we collected 10 metrics that were modeled as 10 separate fields in a single stream message.
</p>
<a href="/docs/latest/images/rs/TimeSeries-modeling1.png" sdata-lightbox="/images/rs/TimeSeries-modeling1.png">
<img src="/docs/latest/images/rs/TimeSeries-modeling1.png"/>
</a>
<p>
For sorted sets, we modeled the data in two different ways. For “Sorted set per device”, we concatenated the metrics and separated them out by colons, e.g.
<code>
“<timestamp>:<metric1>:<metric2>: … :<metric10>”
</code>
.
</p>
<a href="/docs/latest/images/rs/TimeSeries-modeling2.png" sdata-lightbox="/images/rs/TimeSeries-modeling2.png">
<img src="/docs/latest/images/rs/TimeSeries-modeling2.png"/>
</a>
<p>
Of course, this consumes less memory but needs more CPU cycles to get the correct metric at read time. It also implies that changing the number of metrics per device isn’t straightforward, which is why we also benchmarked a second sorted set approach. In “Sorted set per metric,” we kept each metric in its own sorted set and had 10 sorted sets per device. We logged values in the format
<code>
“<timestamp>:<metric>”
</code>
.
</p>
<a href="/docs/latest/images/rs/TimeSeries-modeling3.png" sdata-lightbox="/images/rs/TimeSeries-modeling3.png">
<img src="/docs/latest/images/rs/TimeSeries-modeling3.png"/>
</a>
<p>
Another alternative approach would be to normalize the data by creating a hash with a unique key to track all measurements for a given device for a given timestamp. This key would then be the value in the sorted set. However, having to access many hashes to read a time series would come at a huge cost during read time, so we abandoned this path.
</p>
<p>
Each time series holds a single metric. We chose this design to maintain the Redis principle that a larger number of small keys is better than a fewer number of large keys.
</p>
<a href="/docs/latest/images/rs/TimeSeries-modeling4.png" sdata-lightbox="/images/rs/TimeSeries-modeling4.png">
<img src="/docs/latest/images/rs/TimeSeries-modeling4.png"/>
</a>
<p>
Our benchmark did not utilize the out-of-the-box secondary indexing capabilities of time series. Redis keeps a partial secondary index in each shard, and since the index inherits the same hash-slot of the key it indexes, it is always hosted on the same shard. This approach would make the setup for native data structures even more complex to model, so for the sake of simplicity, we decided not to include it in our benchmarks. Additionally, while Redis Enterprise can use the
<a href="https://redis.com/redis-enterprise/technology/redis-enterprise-cluster-architecture/">
proxy
</a>
to fan out requests for commands like
<a href="/docs/latest/commands/ts.mget">
TS.MGET
</a>
and
<a href="/docs/latest/commands/ts.mrange">
TS.MRANGE
</a>
to all the shards and aggregate the results, we chose not to exploit this advantage in the benchmark either.
</p>
<h3 id="data-ingestion">
Data ingestion
</h3>
<p>
For the data ingestion part of our benchmark, we compared the four approaches by measuring how many devices’ data we could ingest per second. Our client side had 8 worker threads with 50 connections each, and a pipeline of 50 commands per request.
</p>
<p>
Ingestion details of each approach:
</p>
<table>
<thead>
<tr>
<th>
</th>
<th>
<strong>
Redis streams
</strong>
</th>
<th>
<strong>
Time series
</strong>
</th>
<th>
<strong>
Sorted set
<br/>
per device
</strong>
</th>
<th>
<strong>
Sorted set
<br/>
per metric
</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Command
</strong>
</td>
<td>
XADD
</td>
<td>
TS.MADD
</td>
<td>
ZADD
</td>
<td>
ZADD
</td>
</tr>
<tr>
<td>
<strong>
Pipeline
</strong>
</td>
<td>
50
</td>
<td>
50
</td>
<td>
50
</td>
<td>
50
</td>
</tr>
<tr>
<td>
<strong>
Metrics per request
</strong>
</td>
<td>
5000
</td>
<td>
5000
</td>
<td>
5000
</td>
<td>
500
</td>
</tr>
<tr>
<td>
<strong>
# keys
</strong>
</td>
<td>
4000
</td>
<td>
40000
</td>
<td>
4000
</td>
<td>
40000
</td>
</tr>
</tbody>
</table>
<a href="/docs/latest/images/rs/TimeSeries-DataIngestion.png" sdata-lightbox="/images/rs/TimeSeries-DataIngestion.png">
<img src="/docs/latest/images/rs/TimeSeries-DataIngestion.png"/>
</a>
<p>
All our ingestion operations were executed at sub-millisecond latency. Although both used the same Rax data structure, the time series approach has slightly higher throughput than Redis streams.
</p>
<p>
Each approach yields different results, which shows the value of prototyping against specific use cases. As we see on query performance, the sorted set per device comes with improved write throughput but at the expense of query performance. It’s a trade off between ingestion, query performance, and flexibility (remember the earlier data modeling remark).
</p>
<h3 id="read-performance">
Read performance
</h3>
<p>
The read query we used in this benchmark queried a single time series and aggregated it in one-hour time buckets by keeping the maximum observed CPU percentage in each bucket. The time range we considered in the query was exactly one hour, so a single maximum value was returned. For time series, this is out of the box functionality.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"> 127.0.0.1:12543> TS.RANGE cpu_usage_user<span class="o">{</span>1340993056<span class="o">}</span> <span class="m">1451606390000</span> <span class="m">1451609990000</span> AGGREGATION max <span class="m">3600000</span>
</span></span></code></pre>
</div>
<p>
For the Redis streams and sorted sets approaches, we created
<a href="https://gist.github.com/itamarhaber/0107020b91c71cb52e57e9a9c890c24e">
the following LUA scripts
</a>
. The client once again had 8 threads and 50 connections each. Since we executed the same query, only a single shard was hit, and in all four cases this shard maxed out at 100% CPU.
</p>
<a href="/docs/latest/images/rs/TimeSeries-ReadQueries.png" sdata-lightbox="/images/rs/TimeSeries-ReadQueries.png">
<img src="/docs/latest/images/rs/TimeSeries-ReadQueries.png"/>
</a>
<p>
This is where you can see the real power of having dedicated data structure for a given use case with a toolbox that runs alongside it. Using time series exceeds all other approaches and is the only one to achieve sub-millisecond response times.
</p>
<h3 id="memory-utilization">
Memory utilization
</h3>
<p>
For both the Redis streams and sorted set approaches, the samples were stored as strings, while time series stored them as doubles. In this specific data set, we chose a CPU measurement with rounded integer values between 0-100, which thus consumes two bytes of memory as a string. With time series, each metric had 64-bit precision.
</p>
<p>
Time series can dramatically reduce the memory consumption when compared against both sorted set approaches. Given the unbounded nature of time series data, this is typically a critical criteria to evaluate - the overall data set size that needs to be retained in memory. Redis streams reduces the memory consumption further but would be equal or higher than time series when more digits for a higher precision would be required.
</p>
<a href="/docs/latest/images/rs/TimeSeries-UsedMemory.png" sdata-lightbox="/images/rs/TimeSeries-UsedMemory.png">
<img src="/docs/latest/images/rs/TimeSeries-UsedMemory.png"/>
</a>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
<a href="/docs/latest/develop/data-types/timeseries/quickstart/">
Time series quick start
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/commands/">
Time series commands
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/config/">
Time series configuration
</a>
</li>
<li>
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries">
RedisTimeSeries source
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/active-active/global-config/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Set global database configurations
</h1>
<p class="text-lg -mt-5 mb-10">
The REAADB contains the field '.spec.globalConfigurations' and through this the database configurations are set.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
This feature is supported for general availability in releases 6.4.2-6 and later. Some of these features were available as a preview in 6.4.2-4 and 6.4.2-5. Please upgrade to 6.4.2-6 for the full set of general availability features and bug fixes.
</div>
</div>
<p>
The Redis Enterprise Active-Active database (REAADB) custom resource contains the field
<code>
.spec.globalConfigurations
</code>
. This field sets configurations for the Active-Active database across all participating clusters, such as memory size, shard count, and the global database secrets.
</p>
<p>
The
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_active_active_database_api/">
REAADB API reference
</a>
contains a full list of available fields.
</p>
<h2 id="edit-global-configurations">
Edit global configurations
</h2>
<ol>
<li>
<p>
Edit or patch the REAADB custom resource with your global configuration changes.
</p>
<p>
The example command below patches the REAADB named
<code>
reaadb-boeing
</code>
to set the global memory size to 200MB:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl patch reaadb reaadb-boeing --type merge --patch <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span><span class="s1">'{"spec": {"globalConfigurations": {"memorySize": "200mb"}}}'</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Verify the status is
<code>
active
</code>
and the spec status is
<code>
Valid
</code>
.
</p>
<p>
This example shows the status for the
<code>
reaadb-boeing
</code>
database.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl get reaadb reaadb-boeing
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">NAME STATUS SPEC STATUS GLOBAL CONFIGURATIONS REDB LINKED REDBS
</span></span><span class="line"><span class="cl">reaadb-boeing active Valid
</span></span></code></pre>
</div>
</li>
<li>
<p>
View the global configurations on each participating cluster to verify they are synced.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl get reaadb <reaadb-name> -o yaml
</span></span></code></pre>
</div>
</li>
</ol>
<h2 id="edit-global-configuration-secrets">
Edit global configuration secrets
</h2>
<p>
This section edits the secrets under the REAADB
<code>
.spec.globalConfigurations
</code>
section. For more information and all available fields, see the
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_active_active_database_api/">
REAADB API reference
</a>
.
</p>
<ol>
<li>
<p>
On an existing participating cluster, generate a YAML file containing the database secret with the relevant data.
</p>
<p>
This example shoes a secret named
<code>
my-db-secret
</code>
with the password
<code>
my-password
</code>
encoded in base 64.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l">v1</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">data</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l">bXktcGFzcw</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l">Secret</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">metadata</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">my-db-secret</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l">Opaque</span><span class="w">
</span></span></span></code></pre>
</div>
</li>
<li>
<p>
Apply the secret file from the previous step, substituting your own value for
<code>
<db-secret-file>
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl apply -f <db-secret-file>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Patch the REAADB custom resource to specify the database secret, substituting your own values for
<code>
<reaadb-name>
</code>
and
<code>
<secret-name>
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl patch reaadb <reaadb-name> --type merge --patch <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span><span class="s1">'{"spec": {"globalConfigurations": {"databaseSecretName": "secret-name"}}}'</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Check the REAADB status for an
<code>
active
</code>
status and
<code>
Valid
</code>
spec status.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl get reaadb <reaadb-name>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">NAME STATUS SPEC STATUS GLOBAL CONFIGURATIONS REDB LINKED REDBS
</span></span><span class="line"><span class="cl">reaadb-boeing active Valid
</span></span></code></pre>
</div>
</li>
<li>
<p>
On each other participating cluster, check the secret status.
</p>
<p>
``sh
kubectl get reaadb
<reaadb-name>
-o=jsonpath='{.status.secretsStatus}'
</reaadb-name>
</p>
<pre tabindex="0"><code>
The output should show the status as `Invalid`.
```sh
[{"name":"my-db-secret","status":"Invalid"}]
</code></pre>
</li>
<li>
<p>
Sync the secret on each participating cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl apply -f <db-secret-file>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Repeat the previous two steps on every participating cluster.
</p>
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/active-active/global-config/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/riot/quick-start/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Quick Start
</h1>
<p class="text-lg -mt-5 mb-10">
RIOT quick start guide
</p>
<p>
You can launch RIOT with the following command:
</p>
<pre tabindex="0"><code>riot
</code></pre>
<p>
This will show usage help, which you can also get by running:
</p>
<pre tabindex="0"><code>riot --help
</code></pre>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Tip:
</div>
You can use
<code>
--help
</code>
on any command and sub-command:
</div>
</div>
<pre tabindex="0"><code>riot command --help
riot command sub-command --help
</code></pre>
<p>
Full documentation is available at
<a href="https://redis.github.io/riot/">
redis.github.io/riot
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/riot/quick-start/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/hpexpire/.html | <section class="prose w-full py-12">
<h1 class="command-name">
HPEXPIRE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">HPEXPIRE key milliseconds [NX | XX | GT | LT] FIELDS numfields
field [field ...]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
7.4.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of arguments to the command
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@hash
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This command works like
<a href="/docs/latest/commands/hexpire/">
<code>
HEXPIRE
</code>
</a>
, but the expiration of a field is
specified in milliseconds instead of seconds.
</p>
<h2 id="options">
Options
</h2>
<p>
The
<code>
HPEXPIRE
</code>
command supports a set of options:
</p>
<ul>
<li>
<code>
NX
</code>
-- For each specified field, set expiration only when the field has no expiration.
</li>
<li>
<code>
XX
</code>
-- For each specified field, set expiration only when the field has an existing expiration.
</li>
<li>
<code>
GT
</code>
-- For each specified field, set expiration only when the new expiration is greater than current one.
</li>
<li>
<code>
LT
</code>
-- For each specified field, set expiration only when the new expiration is less than current one.
</li>
</ul>
<p>
A non-volatile key is treated as an infinite TTL for the purposes of
<code>
GT
</code>
and
<code>
LT
</code>
.
The
<code>
NX
</code>
,
<code>
XX
</code>
,
<code>
GT
</code>
, and
<code>
LT
</code>
options are mutually exclusive.
</p>
<h2 id="example">
Example
</h2>
<pre tabindex="0"><code>redis> HSET mykey field1 "hello" field2 "world"
(integer 2)
redis> HPEXPIRE mykey 2000 FIELDS 2 field1 field2
1) (integer) 1
2) (integer) 1
redis> HGETALL mykey
(empty array)
</code></pre>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
. For each field:
<ul>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
:
<code>
-2
</code>
if no such field exists in the provided hash key, or the provided key does not exist.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
:
<code>
0
</code>
if the specified NX, XX, GT, or LT condition has not been met.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
:
<code>
1
</code>
if the expiration time was set/updated.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
:
<code>
2
</code>
when
<code>
HEXPIRE
</code>
or
<code>
HPEXPIRE
</code>
is called with 0 seconds or milliseconds, or when
<code>
HEXPIREAT
</code>
or
<code>
HPEXPIREAT
</code>
is called with a past Unix time in seconds or milliseconds.
</li>
</ul>
</li>
<li>
<a href="../../develop/reference/protocol-spec#simple-errors">
Simple error reply
</a>
:
<ul>
<li>
if parsing failed, mandatory arguments are missing, unknown arguments are specified, or argument values are of the wrong type or out of range.
</li>
<li>
if the provided key exists but is not a hash.
</li>
</ul>
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/hpexpire/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.1-release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RediSearch 1.1 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
Aggregations engine.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RediSearch v1.1.0 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 4.0.0
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 5.0.0
</li>
</ul>
<h2 id="redisearch-110-april-2018">
RediSearch 1.1.0 (April 2018)
</h2>
<p>
This is a major version (we almost named it 2.0), which includes months of work, mostly on the brand new aggregations engine.
</p>
<h3 id="aggregations">
Aggregations
</h3>
<p>
Aggregations are a way to process the results of a search query, group, sort and transform them - and extract analytic insights from them. Much like aggregation queries in other databases and search engines, they can be used to create analytics report, or to perform Faceted Search style queries.
</p>
<h4 id="example-aggregation-request">
Example aggregation request
</h4>
<p>
For example, indexing a web-server's logs, we can create report for unique users by hour. Suppose our schema includes the
<strong>
SORTABLE
</strong>
fields
<code>
timestamp
</code>
(Unix-timestamp) and
<code>
userId
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">FT.AGGREGATE idx <span class="s2">"*"</span>
</span></span><span class="line"><span class="cl"> APPLY hour<span class="o">(</span>@timestamp<span class="o">)</span> AS hour
</span></span><span class="line"><span class="cl"> GROUPBY <span class="m">1</span> @hour
</span></span><span class="line"><span class="cl"> REDUCE COUNT_DISTINCT <span class="m">1</span> @userId AS unique_users
</span></span><span class="line"><span class="cl"> SORTBY <span class="m">2</span> @hour ASC
</span></span></code></pre>
</div>
<p>
See
<a href="http://redisearch.io/Aggregations/">
the full documentation on aggregations for more details
</a>
</p>
<h3 id="bug-fixes-over-1010">
Bug fixes over 1.0.10
</h3>
<ul>
<li>
<p>
Fixed #
<a href="https://github.com/RediSearch/RediSearch/issues/313">
313
</a>
- removed -mpopcnt compile flag.
</p>
</li>
<li>
<p>
Fixed #
<a href="https://github.com/RediSearch/RediSearch/issues/312">
312
</a>
- crash on highlighting
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisearch/redisearch-1.1-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/stemming/.html | <section class="prose w-full py-12">
<h1>
Stemming
</h1>
<p class="text-lg -mt-5 mb-10">
Stemming support
</p>
<p>
RediSearch supports stemming - that is adding the base form of a word to the index. This allows the query for "
<code>
hiring
</code>
" to also return results for "
<code>
hire
</code>
" and "
<code>
hired
</code>
", for example.
</p>
<p>
The current stemming support is based on the Snowball stemmer library, which supports most European languages, as well as Arabic and other. See the "
<a href="#supported-languages">
Supported languages
</a>
" section below. We hope to include more languages soon (if you need a specific language support, please open an issue).
</p>
<p>
For further details see the
<a href="https://snowballstem.org/">
Snowball Stemmer website
</a>
.
</p>
<h2 id="how-it-works">
How it works?
</h2>
<p>
Stemming maps different forms of the same word to a common root - "stem" - for example, the English stemmer maps
<em>
studied
</em>
,
<em>
studies
</em>
and
<em>
study
</em>
to
<em>
studi
</em>
. So a searching for
<em>
studied
</em>
would also find documents which only have the other forms.
</p>
<p>
In order to define which language the Stemmer should apply when building the index, you need to specify the
<code>
LANGUAGE
</code>
parameter for the entire index or for the specific field. For more details check the
<a href="/docs/latest/develop/commands/ft.create">
FT.CREATE
</a>
syntax.
</p>
<p>
<strong>
Create a index with language definition
</strong>
</p>
<p>
Create a index for words in German "
<code>
wort:
</code>
" with a single
<code>
TEXT
</code>
field "
<code>
wort
</code>
"
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> FT.CREATE idx:german ON HASH PREFIX <span class="m">1</span> <span class="s2">"wort:"</span> LANGUAGE GERMAN SCHEMA wort TEXT</span></span></code></pre>
</div>
<p>
<strong>
Adding words
</strong>
</p>
<p>
Adding some words with same stem in German, all variations of the word
<code>
stück
</code>
(
<code>
piece
</code>
in english):
<code>
stück stücke stuck stucke
</code>
=>
<code>
stuck
</code>
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> HSET wort:1 wort stück
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">redis> HSET wort:2 wort stücke
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">redis> HSET wort:3 wort stuck
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">redis> HSET wort:4 wort stucke
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span></span></span></code></pre>
</div>
<p>
<strong>
Searching for a common stem
</strong>
</p>
<p>
Search for "stuck" (german for "piece"). As of v2.10, it's only necessary to specify the
<code>
LANGUAGE
</code>
argument when it wasn't specified to create the index being used to search.
Note the results for words that contains "
<code>
ü
</code>
" are encoded in UTF-8.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> FT.SEARCH idx:german <span class="s1">'@wort:(stuck)'</span> German
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">4</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"wort:3"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"wort"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"stuck"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"wort:4"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"wort"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"stucke"</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> <span class="s2">"wort:1"</span>
</span></span><span class="line"><span class="cl">7<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"wort"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"st\xc3\xbcck"</span>
</span></span><span class="line"><span class="cl">8<span class="o">)</span> <span class="s2">"wort:2"</span>
</span></span><span class="line"><span class="cl">9<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"wort"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"st\xc3\xbccke"</span></span></span></code></pre>
</div>
<h2 id="supported-languages">
Supported languages
</h2>
<p>
The following languages are supported and can be passed to the engine when indexing or querying using lowercase:
</p>
<ul>
<li>
arabic
</li>
<li>
armenian
</li>
<li>
danish
</li>
<li>
dutch
</li>
<li>
english
</li>
<li>
finnish
</li>
<li>
french
</li>
<li>
german
</li>
<li>
hungarian
</li>
<li>
italian
</li>
<li>
norwegian
</li>
<li>
portuguese
</li>
<li>
romanian
</li>
<li>
russian
</li>
<li>
serbian
</li>
<li>
spanish
</li>
<li>
swedish
</li>
<li>
tamil
</li>
<li>
turkish
</li>
<li>
yiddish
</li>
<li>
chinese (see below)
</li>
</ul>
<h2 id="chinese-support">
Chinese support
</h2>
<p>
Indexing a Chinese document is different than indexing a document in most other languages because of how tokens are extracted. While most languages can have their tokens distinguished by separation characters and whitespace, this is not common in Chinese.
</p>
<p>
Chinese tokenization is done by scanning the input text and checking every character or sequence of characters against a dictionary of predefined terms and determining the most likely match based on the surrounding terms and characters.
</p>
<p>
Redis Stack makes use of the
<a href="https://github.com/lionsoul2014/friso">
Friso
</a>
chinese tokenization library for this purpose. This is largely transparent to the user and often no additional configuration is required.
</p>
<h2 id="using-custom-dictionaries">
Using custom dictionaries
</h2>
<p>
If you wish to use a custom dictionary, you can do so at the module level when loading the module. The
<code>
FRISOINI
</code>
setting can point to the location of a
<code>
friso.ini
</code>
file which contains the relevant settings and paths to the dictionary files.
</p>
<p>
Note that there is no default
<code>
friso.ini
</code>
file location. RedisSearch comes with its own
<code>
friso.ini
</code>
and dictionary files that are compiled into the module binary at build-time.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/stemming/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/client/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLIENT
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLIENT</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.4.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
Depends on subcommand.
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This is a container command for client connection commands.
</p>
<p>
To see the list of available commands you can call
<a href="/docs/latest/commands/client-help/">
<code>
CLIENT HELP
</code>
</a>
.
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/client/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.spellcheck/.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.SPELLCHECK
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.SPELLCHECK index query
[DISTANCE distance]
[TERMS INCLUDE | EXCLUDE dictionary [terms [terms ...]]]
[DIALECT dialect]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.4.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Perform spelling correction on a query, returning suggestions for misspelled terms
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
index
</code>
</summary>
<p>
is index with the indexed terms.
</p>
</details>
<details open="">
<summary>
<code>
query
</code>
</summary>
<p>
is search query.
</p>
</details>
<p>
See
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/spellcheck/">
Spellchecking
</a>
for more details.
</p>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
TERMS
</code>
</summary>
<p>
specifies an inclusion (
<code>
INCLUDE
</code>
) or exclusion (
<code>
EXCLUDE
</code>
) of a custom dictionary. To learn more about managing custom dictionaries, see
<a href="/docs/latest/commands/ft.dictadd/">
<code>
FT.DICTADD
</code>
</a>
,
<a href="/docs/latest/commands/ft.dictdel/">
<code>
FT.DICTDEL
</code>
</a>
, and
<a href="/docs/latest/commands/ft.dictdump/">
<code>
FT.DICTDUMP
</code>
</a>
.
</p>
<p>
You can specify multiple inclusion and exclusion
<code>
TERMS
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
DISTANCE
</code>
</summary>
<p>
is maximum Levenshtein distance for spelling suggestions (default: 1, max: 4).
</p>
</details>
<details open="">
<summary>
<code>
DIALECT {dialect_version}
</code>
</summary>
<p>
selects the dialect version under which to execute the query. If not specified, the query will execute under the default dialect version set during module initial loading or via
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
command.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.SPELLCHECK returns an array reply, in which each element represents a misspelled term from the query. The misspelled terms are ordered by their order of appearance in the query.
Each misspelled term, in turn, is a 3-element array consisting of the constant string
<code>
TERM
</code>
, the term itself and an array of suggestions for spelling corrections.
Each element in the spelling corrections array consists of the score of the suggestion and the suggestion itself. The suggestions array, per misspelled term, is ordered in descending order by score.
The score is calculated by dividing the number of documents in which the suggested term exists by the total number of documents in the index. Results can be normalized by dividing scores by the highest score.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Perform spelling correction on a query
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SPELLCHECK idx held DISTANCE <span class="m">2</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"TERM"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"held"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"0.66666666666666663"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"hello"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"0.33333333333333331"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"help"</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
|
<a href="/docs/latest/commands/ft.dictadd/">
<code>
FT.DICTADD
</code>
</a>
|
<a href="/docs/latest/commands/ft.dictdel/">
<code>
FT.DICTDEL
</code>
</a>
|
<a href="/docs/latest/commands/ft.dictdump/">
<code>
FT.DICTDUMP
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/spellcheck/">
Spellchecking
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.spellcheck/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/changelog/2023/april-2023/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Cloud changelog (April 2023)
</h1>
<p class="text-lg -mt-5 mb-10">
New features, enhancements, and other changes added to Redis Cloud during April 2023.
</p>
<p>
This changelog lists new features, enhancements, and other changes added to Redis Cloud during April 2023.
</p>
<h2 id="new-features-and-enhancements">
New features and enhancements
</h2>
<ul>
<li>
<p>
Exposed advanced capabilities when creating a new database
</p>
</li>
<li>
<p>
Bug fixes and enhancements
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/changelog/2023/april-2023/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis cleanup job settings object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the redis_cleanup_job_settings object used with Redis Enterprise Software REST API calls.
</p>
<p>
Deprecated and replaced with
<code>
persistence_cleanup_scan_interval
</code>
.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
cron_expression
</td>
<td>
string
</td>
<td>
<a href="https://en.wikipedia.org/wiki/Cron#CRON_expression">
CRON expression
</a>
that defines the Redis cleanup schedule
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/job_scheduler/redis_cleanup_job_settings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.config-get.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.CONFIG GET
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.CONFIG GET option
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Retrieve configuration options
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
option
</code>
</summary>
<p>
is name of the configuration option, or '*' for all.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.CONFIG GET returns an array reply of the configuration name and value.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Retrieve configuration options
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.CONFIG GET TIMEOUT
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> TIMEOUT
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">42</span></span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.CONFIG GET *
</span></span><span class="line"><span class="cl"> 1<span class="o">)</span> 1<span class="o">)</span> EXTLOAD
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> 1<span class="o">)</span> SAFEMODE
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">true</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> 1<span class="o">)</span> CONCURRENT_WRITE_MODE
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">false</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> 1<span class="o">)</span> NOGC
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">false</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> 1<span class="o">)</span> MINPREFIX
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> 1<span class="o">)</span> FORKGC_SLEEP_BEFORE_EXIT
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> 1<span class="o">)</span> MAXDOCTABLESIZE
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">1000000</span>
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> 1<span class="o">)</span> MAXSEARCHRESULTS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">1000000</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> 1<span class="o">)</span> MAXAGGREGATERESULTS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> unlimited
</span></span><span class="line"><span class="cl">10<span class="o">)</span> 1<span class="o">)</span> MAXEXPANSIONS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">11<span class="o">)</span> 1<span class="o">)</span> MAXPREFIXEXPANSIONS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">12<span class="o">)</span> 1<span class="o">)</span> TIMEOUT
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">42</span>
</span></span><span class="line"><span class="cl">13<span class="o">)</span> 1<span class="o">)</span> INDEX_THREADS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">8</span>
</span></span><span class="line"><span class="cl">14<span class="o">)</span> 1<span class="o">)</span> SEARCH_THREADS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">20</span>
</span></span><span class="line"><span class="cl">15<span class="o">)</span> 1<span class="o">)</span> FRISOINI
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">16<span class="o">)</span> 1<span class="o">)</span> ON_TIMEOUT
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="k">return</span>
</span></span><span class="line"><span class="cl">17<span class="o">)</span> 1<span class="o">)</span> GCSCANSIZE
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">18<span class="o">)</span> 1<span class="o">)</span> MIN_PHONETIC_TERM_LEN
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">19<span class="o">)</span> 1<span class="o">)</span> GC_POLICY
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> fork
</span></span><span class="line"><span class="cl">20<span class="o">)</span> 1<span class="o">)</span> FORK_GC_RUN_INTERVAL
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">30</span>
</span></span><span class="line"><span class="cl">21<span class="o">)</span> 1<span class="o">)</span> FORK_GC_CLEAN_THRESHOLD
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">22<span class="o">)</span> 1<span class="o">)</span> FORK_GC_RETRY_INTERVAL
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">5</span>
</span></span><span class="line"><span class="cl">23<span class="o">)</span> 1<span class="o">)</span> FORK_GC_CLEAN_NUMERIC_EMPTY_NODES
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">true</span>
</span></span><span class="line"><span class="cl">24<span class="o">)</span> 1<span class="o">)</span> _FORK_GC_CLEAN_NUMERIC_EMPTY_NODES
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">true</span>
</span></span><span class="line"><span class="cl">25<span class="o">)</span> 1<span class="o">)</span> _MAX_RESULTS_TO_UNSORTED_MODE
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">26<span class="o">)</span> 1<span class="o">)</span> UNION_ITERATOR_HEAP
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">20</span>
</span></span><span class="line"><span class="cl">27<span class="o">)</span> 1<span class="o">)</span> CURSOR_MAX_IDLE
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300000</span>
</span></span><span class="line"><span class="cl">28<span class="o">)</span> 1<span class="o">)</span> NO_MEM_POOLS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">false</span>
</span></span><span class="line"><span class="cl">29<span class="o">)</span> 1<span class="o">)</span> PARTIAL_INDEXED_DOCS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">false</span>
</span></span><span class="line"><span class="cl">30<span class="o">)</span> 1<span class="o">)</span> UPGRADE_INDEX
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> Upgrade config <span class="k">for</span> upgrading
</span></span><span class="line"><span class="cl">31<span class="o">)</span> 1<span class="o">)</span> _NUMERIC_COMPRESS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">false</span>
</span></span><span class="line"><span class="cl">32<span class="o">)</span> 1<span class="o">)</span> _FREE_RESOURCE_ON_THREAD
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">true</span>
</span></span><span class="line"><span class="cl">33<span class="o">)</span> 1<span class="o">)</span> _PRINT_PROFILE_CLOCK
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">true</span>
</span></span><span class="line"><span class="cl">34<span class="o">)</span> 1<span class="o">)</span> RAW_DOCID_ENCODING
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="nb">false</span>
</span></span><span class="line"><span class="cl">35<span class="o">)</span> 1<span class="o">)</span> _NUMERIC_RANGES_PARENTS
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl">36<span class="o">)</span> 1<span class="o">)</span> MINSTEMLEN
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">4</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.config-set/">
<code>
FT.CONFIG SET
</code>
</a>
|
<a href="/docs/latest/commands/ft.config-help/">
<code>
FT.CONFIG HELP
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.config-get/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Proxy object
</h1>
<p class="text-lg -mt-5 mb-10">
An object that represents a proxy in the cluster
</p>
<p>
An API object that represents a
<a href="https://en.wikipedia.org/wiki/Proxy_server">
proxy
</a>
in the cluster.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
Unique ID of the proxy (read-only)
</td>
</tr>
<tr>
<td>
backlog
</td>
<td>
integer
</td>
<td>
TCP listen queue backlog
</td>
</tr>
<tr>
<td>
client_keepcnt
</td>
<td>
integer
</td>
<td>
Client TCP keepalive count
</td>
</tr>
<tr>
<td>
client_keepidle
</td>
<td>
integer
</td>
<td>
Client TCP keepalive idle
</td>
</tr>
<tr>
<td>
client_keepintvl
</td>
<td>
integer
</td>
<td>
Client TCP keepalive interval
</td>
</tr>
<tr>
<td>
conns
</td>
<td>
integer
</td>
<td>
Number of connections
</td>
</tr>
<tr>
<td>
duration_usage_threshold
</td>
<td>
integer,
<nobr>
(range: 10-300)
</nobr>
</td>
<td>
Max number of threads
</td>
</tr>
<tr>
<td>
dynamic_threads_scaling
</td>
<td>
boolean
</td>
<td>
Automatically adjust the number of threads
</td>
</tr>
<tr>
<td>
ignore_bdb_cconn_limit
</td>
<td>
boolean
</td>
<td>
Ignore client connection limits
</td>
</tr>
<tr>
<td>
ignore_bdb_cconn_output_buff_limits
</td>
<td>
boolean
</td>
<td>
Ignore buffer limit
</td>
</tr>
<tr>
<td>
log_level
</td>
<td>
<code>
crit
</code>
<br/>
<code>
error
</code>
<br/>
<code>
warn
</code>
<br/>
<code>
info
</code>
<br/>
<code>
trace
</code>
<br/>
<code>
debug
</code>
</td>
<td>
Minimum log level to log. Only logs with this level or greater will be logged.
</td>
</tr>
<tr>
<td>
max_listeners
</td>
<td>
integer
</td>
<td>
Max number of listeners
</td>
</tr>
<tr>
<td>
max_servers
</td>
<td>
integer
</td>
<td>
Max number of Redis servers
</td>
</tr>
<tr>
<td>
max_threads
</td>
<td>
integer,
<nobr>
(range: 1-256)
</nobr>
</td>
<td>
Max number of threads
</td>
</tr>
<tr>
<td>
max_worker_client_conns
</td>
<td>
integer
</td>
<td>
Max client connections per thread
</td>
</tr>
<tr>
<td>
max_worker_server_conns
</td>
<td>
integer
</td>
<td>
Max server connections per thread
</td>
</tr>
<tr>
<td>
max_worker_txns
</td>
<td>
integer
</td>
<td>
Max in-flight transactions per thread
</td>
</tr>
<tr>
<td>
threads
</td>
<td>
integer,
<nobr>
(range: 1-256)
</nobr>
</td>
<td>
Number of threads
</td>
</tr>
<tr>
<td>
threads_usage_threshold
</td>
<td>
integer,
<nobr>
(range: 50-99)
</nobr>
</td>
<td>
Max number of threads
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/proxy/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/architecture.html | <section class="prose w-full py-12 max-w-none">
<h1>
Architecture
</h1>
<p class="text-lg -mt-5 mb-10">
Discover the main components of RDI
</p>
<h2 id="overview">
Overview
</h2>
<p>
RDI implements a
<a href="https://en.wikipedia.org/wiki/Change_data_capture">
change data capture
</a>
(CDC) pattern that tracks changes to the data in a
non-Redis
<em>
source
</em>
database and makes corresponding changes to a Redis
<em>
target
</em>
database. You can use the target as a cache to improve performance
because it will typically handle read queries much faster than the source.
</p>
<p>
To use RDI, you define a
<em>
dataset
</em>
that specifies which data items
you want to capture from the source and how you want to
represent them in the target. For example, if the source is a
relational database then you specify which table columns you want
to capture but you don't need to store them in an equivalent table
structure in the target. This means you can choose whatever target
representation is most suitable for your app. To convert from the
source to the target representation, RDI applies
<em>
transformations
</em>
to the data after capture.
</p>
<p>
RDI synchronizes the dataset between the source and target using
a
<em>
data pipeline
</em>
that implements several processing steps
in sequence:
</p>
<ol>
<li>
<p>
A
<em>
CDC collector
</em>
captures changes to the source database. RDI
currently uses an open source collector called
<a href="https://debezium.io/">
Debezium
</a>
for this step.
</p>
</li>
<li>
<p>
The collector records the captured changes using Redis streams
in the RDI database.
</p>
</li>
<li>
<p>
A
<em>
stream processor
</em>
reads data from the streams and applies
any transformations that you have defined (if you don't need
any custom transformations then it uses defaults).
It then writes the data to the target database for your app to use.
</p>
</li>
</ol>
<p>
Note that the RDI control processes run on dedicated virtual machines (VMs)
outside the Redis
Enterprise cluster where the target database is kept. However, RDI keeps
its state and configuration data and also the change data streams in a Redis database on the same cluster as the target. The following diagram shows the pipeline steps and the path the data takes on its way from the source to the target:
</p>
<a href="/docs/latest/images/rdi/ingest/ingest-dataflow.png" sdata-lightbox="/images/rdi/ingest/ingest-dataflow.png">
<img src="/docs/latest/images/rdi/ingest/ingest-dataflow.png"/>
</a>
<p>
When you first start RDI, the target database is empty and so all
of the data in the source database is essentially "change" data.
RDI collects this data in a phase called
<em>
initial cache loading
</em>
,
which can take minutes or hours to finish, depending on the size
of the source data. Once the initial cache loading is complete,
there is a
<em>
snapshot
</em>
dataset in the target that will gradually
change when new data gets captured from the source. At this point,
RDI automatically enters a second phase called
<em>
change streaming
</em>
, where
changes in the data are captured as they happen. Changes are usually
added to the target within a few seconds after capture.
</p>
<h2 id="backpressure-mechanism">
Backpressure mechanism
</h2>
<p>
Sometimes, data records can get added to the streams faster than RDI can
process them. This can happen if the target is slowed or disconnected
or simply if the source quickly generates a lot of change data.
If this continues, then the streams will eventually occupy all the
available memory. When RDI detects this situation, it applies a
<em>
backpressure
</em>
mechanism to slow or stop the flow of incoming data.
Change data is held at the source until RDI clears the backlog and has
enough free memory to resume streaming.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The Debezium log sometimes reports that RDI has run out
of memory (usually while creating the initial snapshot). This is not
an error, just an informative message to note that RDI has applied
the backpressure mechanism.
</div>
</div>
<h3 id="supported-sources">
Supported sources
</h3>
<p>
RDI supports the following database sources using
<a href="https://debezium.io/documentation/reference/stable/operations/debezium-server.html">
Debezium Server
</a>
connectors:
</p>
<table>
<thead>
<tr>
<th>
Database
</th>
<th>
Versions
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Oracle
</td>
<td>
12c, 19c, 21c
</td>
</tr>
<tr>
<td>
MariaDB
</td>
<td>
>= 10.5
</td>
</tr>
<tr>
<td>
MySQL
</td>
<td>
5.7, 8.0.x
</td>
</tr>
<tr>
<td>
Postgres
</td>
<td>
10, 11, 12, 13, 14, 15
</td>
</tr>
<tr>
<td>
SQL Server
</td>
<td>
2017, 2019
</td>
</tr>
<tr>
<td>
Google Cloud SQL MySQL
</td>
<td>
8.0
</td>
</tr>
<tr>
<td>
Google Cloud SQL Postgres
</td>
<td>
15
</td>
</tr>
<tr>
<td>
Google Cloud SQL SQL Server
</td>
<td>
2019
</td>
</tr>
<tr>
<td>
Google Cloud AlloyDB for PostgreSQL
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h2 id="how-rdi-is-deployed">
How RDI is deployed
</h2>
<p>
RDI is designed with two
<em>
planes
</em>
that provide its services.
The
<em>
control plane
</em>
contains the processes that keep RDI active.
It includes:
</p>
<ul>
<li>
An
<em>
operator
</em>
process that schedules the CDC collector and the
stream processor to implement the two phases of the pipeline
lifecycle (initial cache loading and change streaming)
</li>
<li>
A
<a href="https://prometheus.io/">
Prometheus
</a>
endpoint to supply metrics about RDI
</li>
<li>
A REST API to control the VM.
</li>
</ul>
<p>
The
<em>
management plane
</em>
provides tools that let you interact
with the control plane. Use the CLI tool to install and administer RDI
and to deploy and manage a pipeline. Use the pipeline editor
(included in Redis Insight) to design or edit a pipeline. The
diagram below shows the components of the control and management
planes and the connections between them:
</p>
<a href="/docs/latest/images/rdi/ingest/ingest-control-plane.png" sdata-lightbox="/images/rdi/ingest/ingest-control-plane.png">
<img src="/docs/latest/images/rdi/ingest/ingest-control-plane.png"/>
</a>
<p>
The following sections describe the VM configurations you can use to
deploy RDI.
</p>
<h3 id="rdi-on-your-own-vms">
RDI on your own VMs
</h3>
<p>
For this deployment, you must provide two VMs. The
collector and stream processor are active on one VM while the other is a standby to provide high availability. The operators run on both VMs and use an algorithm to decide which is the active one (the "leader").
Both the active VM and the standby
need access to the authentication secrets that RDI uses to encrypt network
traffic. The diagram below shows this configuration:
</p>
<a href="/docs/latest/images/rdi/ingest/ingest-active-passive-vms.png" sdata-lightbox="/images/rdi/ingest/ingest-active-passive-vms.png">
<img src="/docs/latest/images/rdi/ingest/ingest-active-passive-vms.png"/>
</a>
<p>
See
<a href="/docs/latest/integrate/redis-data-integration/installation/install-vm/">
Install on VMs
</a>
for more information.
</p>
<h3 id="rdi-on-kubernetes">
RDI on Kubernetes
</h3>
<p>
You can use the RDI
<a href="https://helm.sh/docs/topics/charts/">
Helm chart
</a>
to install
on
<a href="https://kubernetes.io/">
Kubernetes (K8s)
</a>
, including Red Hat
<a href="https://docs.openshift.com/">
OpenShift
</a>
. This creates:
</p>
<ul>
<li>
A K8s
<a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/">
namespace
</a>
named
<code>
rdi
</code>
.
</li>
<li>
<a href="https://kubernetes.io/docs/concepts/workloads/controllers/deployment/">
Deployments
</a>
for the
<a href="/docs/latest/integrate/redis-data-integration/architecture/#how-rdi-is-deployed">
RDI operator
</a>
,
<a href="/docs/latest/integrate/redis-data-integration/observability/">
metrics exporter
</a>
, and API server.
</li>
<li>
A
<a href="https://kubernetes.io/docs/concepts/security/service-accounts/">
service account
</a>
along with a
<a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/#restrictions-on-role-creation-or-update">
role
</a>
and
<a href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding">
role binding
</a>
for the RDI operator.
</li>
<li>
A
<a href="https://kubernetes.io/docs/concepts/configuration/configmap/">
Configmap
</a>
for the different components with RDI Redis database details.
</li>
<li>
<a href="https://kubernetes.io/docs/concepts/configuration/secret/">
Secrets
</a>
with the RDI Redis database credentials and TLS certificates.
</li>
</ul>
<p>
See
<a href="/docs/latest/integrate/redis-data-integration/installation/install-k8s/">
Install on Kubernetes
</a>
for more information.
</p>
<h3 id="secrets-and-security-considerations">
Secrets and security considerations
</h3>
<p>
RDI encrypts all network connections with
<a href="https://en.wikipedia.org/wiki/Transport_Layer_Security">
TLS
</a>
or
<a href="https://en.wikipedia.org/wiki/Mutual_authentication#mTLS">
mTLS
</a>
.
The credentials for the connections are saved as secrets and you
can choose how to provide these secrets to RDI. Note that RDI stores
all state and configuration data inside the Redis Enterprise cluster
and does not store any other data on your RDI VMs or anywhere else
outside the cluster.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/architecture/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.2-release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisBloom 2.2 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
BF.INFO returns bloom filter details. CF.INFO returns cuckoo filter details. Scalable bloom and cuckoo filters. Configurable bucket size for cuckoo filters. CMS.INCRBY returns count.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RedisBloom v2.2.18 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 4.0.0
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 5.0.0
</li>
</ul>
<h2 id="v2218-july-2022">
v2.2.18 (July 2022)
</h2>
<p>
This is a maintenance release for RedisBloom 2.2.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/issues/481">
#481
</a>
CF crashes on expansion 0
</li>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/478">
#478
</a>
<a href="/docs/latest/commands/bf.info">
<code>
BF.INFO
</code>
</a>
reports an inaccurate result about the memory footprint
</li>
</ul>
</li>
</ul>
<h2 id="v2217-june-2022">
v2.2.17 (June 2022)
</h2>
<p>
This is a maintenance release for RedisBloom 2.2.
</p>
<p>
Update urgency:
<code>
HIGH
</code>
: There is a critical bug that may affect a subset of users. Upgrade!
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/451">
#451
</a>
<a href="/docs/latest/commands/topk.incrby">
<code>
TOPK.INCRBY
</code>
</a>
: fix calculation when old fingerprint count is reduced to 0
</li>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/462">
#462
</a>
<a href="/docs/latest/commands/cf.reserve">
<code>
CF.RESERVE
</code>
</a>
: fix potential crash on incorrect number of parameters
</li>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/434">
#434
</a>
<a href="/docs/latest/commands/cf.insert">
<code>
CF.INSERT
</code>
</a>
: fix crash when capacity is negative
</li>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/450">
#450
</a>
<a href="/docs/latest/commands/topk.incrby">
<code>
TOPK.INCRBY
</code>
</a>
: limit increment to 100,000 to prevent potential long freezes
</li>
</ul>
</li>
</ul>
<h2 id="v2215-may-2022">
v2.2.15 (May 2022)
</h2>
<p>
This is a maintenance release for RedisBloom 2.2.
</p>
<p>
Update urgency: None.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Enhancements:
</p>
<ul>
<li>
Added support for RedisBloom for AArch64 Linux
</li>
</ul>
</li>
</ul>
<h2 id="v2214-march-2022">
v2.2.14 (March 2022)
</h2>
<p>
This is a maintenance release for RedisBloom 2.2.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/419">
#419
</a>
<code>
CMS.INCRBY
</code>
now returns an error on overflow
</li>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/412">
#412
</a>
Fixed macOS build
</li>
</ul>
</li>
</ul>
<h2 id="v2212-february-2022">
v2.2.12 (February 2022)
</h2>
<p>
This is a maintenance release for RedisBloom 2.2.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/392">
#392
</a>
Fixed a potential crash on Bloom filter expansion when loading from
<a href="/docs/latest/operate/oss_and_stack/management/persistence/">
AOF
</a>
</li>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/404">
#404
</a>
Fixed a potential crash on Cuckoo filter when calling
<code>
CF.LOADCHUNK
</code>
on a filter with
<code>
EXPANSION
</code>
greater than 1
</li>
</ul>
</li>
</ul>
<h2 id="v229-november-2021">
v2.2.9 (November 2021)
</h2>
<p>
This is a maintenance release for RedisBloom 2.2.
</p>
<p>
Update urgency:
<code>
MODERATE
</code>
: Program an upgrade of the server, but it's not urgent.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bug fixes:
</p>
<ul>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/pull/281">
#281
</a>
Memory leak when loading TOPK keys from RDB.
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/pull/303">
#303
</a>
<code>
CMS.INCRBY
</code>
for negative or non-number
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/pull/354">
#354
</a>
TOPK List Duplicate entries
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/pull/369">
#369
</a>
Free only latest filter on
<code>
CF.COMPACT
</code>
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/pull/371">
#371
</a>
<code>
CF.SCANDUMP
</code>
for cuckoo filter
</p>
</li>
<li>
<p>
<a href="https://github.com/RedisBloom/RedisBloom/pull/374">
#374
</a>
ReplicateVerbatim for
<code>
CF.LOADCHUNK
</code>
(similar to
<a href="https://github.com/RedisBloom/RedisBloom/pull/309">
#309
</a>
)
</p>
</li>
</ul>
</li>
<li>
<p>
Improvements:
</p>
<ul>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/331">
#331
</a>
Add
<code>
WITHCOUNT
</code>
flag to
<code>
TOPK.LIST
</code>
</li>
</ul>
</li>
</ul>
<h2 id="v226-august-2021">
v2.2.6 (August 2021)
</h2>
<p>
This is a maintenance release for version 1.0.
</p>
<p>
Update urgency:
<code>
LOW
</code>
- No need to upgrade unless there are new features you want to use.
</p>
<p>
Details:
</p>
<ul>
<li>
Enhancements:
<ul>
<li>
#
<a href="https://github.com/redisbloom/redisbloom/issues/333">
333
</a>
Support inter shards TLS capability
</li>
</ul>
</li>
</ul>
<h2 id="v224-july-2020">
v2.2.4 (July 2020)
</h2>
<p>
Headlines:
</p>
<ul>
<li>
This release improves overall stability and provides fixes for found issues.
</li>
</ul>
<p>
Details:
</p>
<ul>
<li>
Bug fixes:
<ul>
<li>
#
<a href="https://github.com/redisbloom/redisbloom/issues/215">
215
</a>
Count-Min-Sketch CMS.INCRBY command to reply with correct min result.
</li>
<li>
#
<a href="https://github.com/redisbloom/redisbloom/issues/219">
219
</a>
Cuckoo Filter CF.DEBUG correct response formatting.
</li>
</ul>
</li>
</ul>
<h2 id="v223-july-2020">
v2.2.3 (July 2020)
</h2>
<p>
Headlines:
</p>
<ul>
<li>
This release improves overall stability and provides fixes for found issues.
</li>
</ul>
<p>
Details:
</p>
<ul>
<li>
Bug fixes:
<ul>
<li>
<a href="https://github.com/RedisBloom/RedisBloom/pull/217">
#217
</a>
Client hung on
<code>
BF.INSERT
</code>
with multiple new items when a non-scaling filter is full.
</li>
</ul>
</li>
</ul>
<h2 id="v222-march-2020">
v2.2.2 (March 2020)
</h2>
<p>
Headlines:
</p>
<ul>
<li>
This release improves overall stability and provides fixes for issues found after the previous release.
</li>
</ul>
<p>
Details:
</p>
<ul>
<li>
Minor enhancements:
<ul>
<li>
Bloom
<ul>
<li>
#
<a href="https://github.com/redisbloom/redisbloom/issues/180">
180
</a>
Removed the upper limit on Bloom Filter capacity.
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="v221-january-2020">
v2.2.1 (January 2020)
</h2>
<p>
Headlines:
</p>
<ul>
<li>
This release improves overall stability and provides fixes for issues found after the previous release.
</li>
</ul>
<p>
Details:
</p>
<ul>
<li>
Minor Enhancements:
<ul>
<li>
Bloom
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/179">
179
</a>
Allow storing filters with size over 4294967295 (UINT32_MAX). Now 64 bits.
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/177">
177
</a>
Prevent passing both
<code>
EXPANSION
</code>
<em>
and
</em>
<code>
NONSCALING
</code>
parameters to
<code>
BF.RESERVE
</code>
.
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="v220-december-2019">
v2.2.0 (December 2019)
</h2>
<ul>
<li>
<p>
Added functionality
</p>
<ul>
<li>
Bloom
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/149">
149
</a>
<code>
BF.INFO
</code>
returns details about a specific bloom filter
</li>
<li>
Scalable
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/153">
153
</a>
Ability to change the
<code>
EXPANSION
</code>
rate. This means each subsequent sub-filter will be
<code>
expansion
</code>
times larger as the previous one.
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/160">
160
</a>
Optimise the scaling up of filter according to the
<a href="https://core.ac.uk/download/pdf/55607643.pdf">
Scalable Bloom Filter
</a>
paper
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/161">
161
</a>
Optional
<code>
NONSCALING
</code>
argument to disable scaling. (This saves space since less hash functions are used)
</li>
</ul>
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/155">
155
</a>
Disabling rounding up functionality
</li>
</ul>
</li>
<li>
Cuckoo
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/149">
149
</a>
<code>
CF.INFO
</code>
returns details about a specific cuckoo filter
</li>
<li>
Scalable
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/138">
138
</a>
Configurable
<code>
EXPANSION
</code>
. When an additional filter is created, its size will be the size of the current filter multiplied by the
<code>
expansion
</code>
. Higher expansion rates will result in lower error rates.
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/142">
142
</a>
The maximum number of expansions limited to 32.
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/131">
131
</a>
Configurable
<code>
MAXITERATIONS
</code>
. Number of attempts to swap buckets before declaring filter as full and creating an additional filter.
</li>
</ul>
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/135">
135
</a>
Configurable
<code>
BUCKETSIZE
</code>
. Number of items in each bucket. Higher bucket size value improves the fill rate but result in a higher error rate and slightly slower operation speed.
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/142">
142
</a>
use of 64bit hash function
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/136">
136
</a>
expose compaction of filters in the API
</li>
</ul>
</li>
<li>
CMS
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/97">
97
</a>
<code>
CMS.INCRBY
</code>
returns count instead of ‘OK’
</li>
</ul>
</li>
</ul>
</li>
<li>
<p>
Minor bug fixes
</p>
<ul>
<li>
Bloom
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/154">
154
</a>
Check error rate is 1< (cannot be equal)
</li>
</ul>
</li>
<li>
Cuckoo
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/134">
134
</a>
Added
<code>
CuckooInsert_MemAllocFailed
</code>
exception
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/130">
130
</a>
Number of deletes wasn’t saved to RDB
</li>
</ul>
</li>
<li>
General
<ul>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/117">
117
</a>
Using
<code>
RMUtil_RegisterWriteDenyOOMCmd
</code>
</li>
<li>
#
<a href="https://github.com/RedisBloom/RedisBloom/issues/121">
121
</a>
Moved
<code>
ReplicaVerbatim
</code>
to end of functions
</li>
</ul>
</li>
</ul>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redisbloom/redisbloom-2.2-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/interact/search-and-query/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Query Engine
</h1>
<p class="text-lg -mt-5 mb-10">
Searching and querying Redis data using the Redis Query Engine
</p>
<p>
The Redis Query Engine offers an enhanced Redis experience via the following search and query features:
</p>
<ul>
<li>
A rich query language
</li>
<li>
Incremental indexing on JSON and hash documents
</li>
<li>
Vector search
</li>
<li>
Full-text search
</li>
<li>
Geospatial queries
</li>
<li>
Aggregations
</li>
</ul>
<p>
You can find a complete list of features in the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/">
reference documentation
</a>
.
</p>
<p>
The Redis Query Engine features allow you to use Redis as a:
</p>
<ul>
<li>
Document database
</li>
<li>
Vector database
</li>
<li>
Secondary index
</li>
<li>
Search engine
</li>
</ul>
<p>
Here are the next steps to get you started:
</p>
<ol>
<li>
Follow our
<a href="/docs/latest/develop/get-started/document-database/">
quick start guide
</a>
to get some initial hands-on experience.
</li>
<li>
Learn how to
<a href="/docs/latest/develop/interact/search-and-query/indexing/">
create an index
</a>
.
</li>
<li>
Learn how to
<a href="/docs/latest/develop/interact/search-and-query/query/">
query your data
</a>
.
</li>
<li>
<a href="/docs/latest/operate/redisinsight/">
Install Redis Insight
</a>
, connect it to your Redis database, and then use
<a href="/docs/latest/develop/tools/insight/#redis-copilot">
Redis Copilot
</a>
to help you learn how to execute complex queries against your own data using simple, plain language prompts.
</li>
</ol>
<h2 id="enable-the-redis-query-engine">
Enable the Redis Query Engine
</h2>
<p>
The Redis Query Engine is not available by default in the basic Redis server, so you
should install Redis Stack or Redis Enterprise,
both of which include Redis search and other useful modules.
See
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/">
Install Redis Stack
</a>
or
<a href="/docs/latest/operate/rs/installing-upgrading/install/">
Install Redis Enterprise
</a>
for full installation instructions.
</p>
<h2 id="license-and-source-code">
License and source code
</h2>
<p>
The Redis Query Engine features of Redis Stack are available under the Source Available License 2.0 (RSALv2) or the Server Side Public License v1 (SSPLv1). Please read the
<a href="https://raw.githubusercontent.com/RediSearch/RediSearch/master/LICENSE.txt">
license file
</a>
for further details. The source code and the
<a href="https://github.com/RediSearch/RediSearch/releases">
detailed release notes
</a>
are available on
<a href="https://github.com/RediSearch/RediSearch">
GitHub
</a>
.
</p>
<p>
Do you have questions? Feel free to ask at the
<a href="https://forum.redis.com/c/modules/redisearch/">
RediSearch forum
</a>
.
</p>
<p>
Redis Ltd. provides commercial support for Redis Stack. Please see the
<a href="https://redis.com/redis-enterprise/technology/redis-search/#sds">
Redis Ltd. website
</a>
for more details and contact information.
</p>
<br/>
<nav>
<a href="/docs/latest/develop/interact/search-and-query/basic-constructs/">
Basic constructs
</a>
<p>
Basic constructs for searching and querying Redis data
</p>
<a href="/docs/latest/develop/interact/search-and-query/indexing/">
Indexing
</a>
<p>
How to index and search JSON documents
</p>
<a href="/docs/latest/develop/interact/search-and-query/query/">
Query data
</a>
<p>
Understand how to query, search, and aggregate Redis data
</p>
<a href="/docs/latest/develop/interact/search-and-query/query-use-cases/">
Use cases
</a>
<p>
Redis Query Engine use cases
</p>
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/">
Advanced concepts
</a>
<p>
Details about query syntax, aggregation, scoring, and other search and query options
</p>
<a href="/docs/latest/develop/interact/search-and-query/administration/">
Administration
</a>
<p>
Redis Query Engine Administration
</p>
<a href="/docs/latest/develop/interact/search-and-query/deprecated/">
Deprecated
</a>
<p>
Deprecated features
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/interact/search-and-query/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/get-started/document-database/.html | <section class="prose w-full py-12">
<h1>
Redis as a document database quick start guide
</h1>
<p class="text-lg -mt-5 mb-10">
Understand how to use Redis as a document database
</p>
<p>
This quick start guide shows you how to:
</p>
<ol>
<li>
Create a secondary index
</li>
<li>
Add
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
documents
</li>
<li>
Search and query your data
</li>
</ol>
<p>
The examples in this article refer to a simple bicycle inventory that contains JSON documents with the following structure:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"brand"</span><span class="p">:</span> <span class="s2">"brand name"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"condition"</span><span class="p">:</span> <span class="s2">"new | used | refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"description"</span><span class="p">:</span> <span class="s2">"description"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"model"</span><span class="p">:</span> <span class="s2">"model"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"price"</span><span class="p">:</span> <span class="mi">0</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h2 id="setup">
Setup
</h2>
<p>
The easiest way to get started with
<a href="/docs/latest/operate/oss_and_stack/">
Redis Stack
</a>
is to use Redis Cloud:
</p>
<ol>
<li>
<p>
Create a
<a href="https://redis.com/try-free?utm_source=redisio&utm_medium=referral&utm_campaign=2023-09-try_free&utm_content=cu-redis_cloud_users">
free account
</a>
.
</p>
<img src="../img/free-cloud-db.png" width="500px"/>
</li>
<li>
<p>
Follow the instructions to create a free database.
</p>
</li>
</ol>
<p>
This free Redis Cloud database comes out of the box with all the Redis Stack features.
</p>
<p>
You can alternatively use the
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/">
installation guides
</a>
to install Redis Stack on your local machine.
</p>
<h2 id="connect">
Connect
</h2>
<p>
The first step is to connect to your Redis Stack database. You can find further details about the connection options in this documentation site's
<a href="/docs/latest/develop/tools/">
Tools section
</a>
. The following example shows how to connect to a Redis Stack server that runs on localhost (
<code>
-h 127.0.0.1
</code>
) and listens on the default port (
<code>
-p 6379
</code>
):
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_quickstart-stepconnect">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_quickstart-stepconnect" name="search_quickstart-stepconnect" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_quickstart-stepconnect" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_quickstart-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_quickstart-stepconnect" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> redis-cli -h 127.0.0.1 -p 6379</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_quickstart-stepconnect')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_quickstart-stepconnect" name="search_quickstart-stepconnect" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_quickstart-stepconnect" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_quickstart-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_quickstart-stepconnect" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for document database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/document-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.aggregation</span> <span class="k">as</span> <span class="nn">aggregations</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.reducers</span> <span class="k">as</span> <span class="nn">reducers</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.json.path</span> <span class="kn">import</span> <span class="n">Path</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="n">NumericField</span><span class="p">,</span> <span class="n">TagField</span><span class="p">,</span> <span class="n">TextField</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bicycle</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Small and powerful, the Jigger is the best ride "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"for the smallest of tikes! This is the tiniest "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"kids’ pedal bike on the market available without"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a coaster brake, the Jigger is the vehicle of "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"choice for the rare tenacious little rider "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycle</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Kids want to ride with as little weight as possible."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Especially on an incline! They may be at the age "</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'when a 27.5" wheel bike is just too clumsy coming '</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'off a 24" bike. The Hillcraft 26 is just the solution'</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The Chook Air 5 gives kids aged six years and older "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"a durable and uberlight mountain bike for their first"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" experience on tracks and easy cruising through forests"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and fields. The lower top tube makes it easy to mount"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and dismount in any situation, giving your kids greater"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The sister company to Nord, Eva launched in 2005 as the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" first and only women-dedicated bicycle brand. Designed"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" by women for women, allEva bikes are optimized for the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" feminine physique using analytics from a body metrics"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" database. If you like 29ers, try the Eva 291. It’s a "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand new bike for 2022.. This full-suspension, "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"cross-country ride has been designed for velocity. The"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 291 has 100mm of front and rear travel, a superlight "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Whether you want to try your hand at XC racing or are "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"looking for a lively trail bike that's just as inspiring"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" on the climbs as it is over rougher ground, the Wilder"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" is one heck of a bike built specifically for short women."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Both the frames and components have been tweaked to "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"include a women’s saddle, different bars and unique "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" not to say that it’s a basic machine. With an internal "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Claris gears from Shimano’s, this is a bike which doesn’t"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The WattBike is the best e-bike for people who still feel young"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" more than 60 miles on one charge. It’s great for tackling hilly"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" terrain or if you just fancy a more leisurely ride. With three"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" working modes, you can choose between E-bike, assisted bicycle,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"If you struggle with stiff fingers or a kinked neck or back after"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a few minutes on the road, this lightweight, aluminum bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" alleviates those issues and allows you to enjoy the ride. From"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" the ergonomic grips to the lumbar-supporting seat position, the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" tube facilitates stability by allowing you to put a foot on the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" ground to balance at a stop, and the low step-over frame makes it"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" accessible for all ability and mobility levels. The saddle is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" very soft, with a wide back to support your hip joints and a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" cutout in the center to redistribute that pressure. Rim brakes"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" deliver satisfactory braking control, and the wide tires provide"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" commuter, and the BMX-like handlebar offers space for mounting a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"This budget mountain bike from nHill performs well both on bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" paths and on the trail. The fork with 100mm of travel absorbs"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" gears for finding a comfortable pace to ride uphill, and the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" affordable bike that you can take to work, but also take trail in"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mountains on the weekends or you’re just after a stable,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" comfortable ride for the bike path, the Summit gives a good value"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"An artsy, retro-inspired bicycle that’s as functional as it is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 9-speed drivetrain has enough gears for coasting in the city, but"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" you from mud, and a rear basket lets you transport groceries,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flowers and books. The ThrillCycle comes with a limited lifetime"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.condition"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"condition"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">index</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">index</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">definition</span><span class="o">=</span><span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bicycle:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">bid</span><span class="p">,</span> <span class="n">bicycle</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bicycles</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">"bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">Path</span><span class="o">.</span><span class="n">root_path</span><span class="p">(),</span> <span class="n">bicycle</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Documents found:"</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:0',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Velorim",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Jigger",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":270,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">)</span><span class="o">.</span><span class="n">return_field</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_field</span><span class="o">=</span><span class="s2">"price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [Document {'id': 'bicycle:0', 'payload': None, 'price': '270'}]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"basic @price:[500 1000]"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:5',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Breakout",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"XBN 2.1 Alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":810,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s1">'@brand:"Noka Bikes"'</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:4',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Noka Bikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Kahuna",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%a</span><span class="s2">nalitics%"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note the typo in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%%</span><span class="s2">analitycs</span><span class="si">%%</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note 2 typos in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:hill*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:1',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:*bike"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:6',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"ScramBikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"WattBike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":2300,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"w'H?*craft'"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">()</span><span class="o">.</span><span class="n">scorer</span><span class="p">(</span><span class="s2">"BM25"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">req</span> <span class="o">=</span> <span class="n">aggregations</span><span class="o">.</span><span class="n">AggregateRequest</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="o">.</span><span class="n">group_by</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@condition"</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">"count"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">req</span><span class="p">)</span><span class="o">.</span><span class="n">rows</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [['condition', 'refurbished', 'count', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'count', '4'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'count', '5']]</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_quickstart-stepconnect')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_quickstart-stepconnect" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_quickstart.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="javascript" id="Nodejs_search_quickstart-stepconnect" name="search_quickstart-stepconnect" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Nodejs_search_quickstart-stepconnect" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-search_quickstart-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_search_quickstart-stepconnect" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">AggregateGroupByReducers</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">createClient</span><span class="p">,</span> <span class="nx">SchemaFieldTypes</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line hl"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycle1</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Velorim'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Small and powerful, the Jigger is the best '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ride for the smallest of tikes! This is the tiniest kids\u2019 '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'pedal bike on the market available without a coaster brake, the '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Jigger is the vehicle of choice for the rare tenacious little'</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'rider raring to go.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycle1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Bicyk'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Hillcraft'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Nord'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Chook air 5'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Eva'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Eva 291'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Noka Bikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Kahuna'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Breakout'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'XBN 2.1 Alloy'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'ScramBikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'WattBike'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Peaknetic'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Secto'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'nHill'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Summit'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'ThrillCycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'BikeShind'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'refurbished'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">];</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.brand'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">SORTABLE</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'brand'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.model'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'model'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.description'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.price'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">NUMERIC</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'price'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.condition'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TAG</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'condition'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">try</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="nx">schema</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ON</span><span class="o">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PREFIX</span><span class="o">:</span> <span class="s1">'bicycle:'</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">message</span> <span class="o">===</span> <span class="s1">'Index already exists'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Index exists already, skipped creation.'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Something went wrong, perhaps RediSearch isn't installed...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">process</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycles</span><span class="p">.</span><span class="nx">map</span><span class="p">((</span><span class="nx">bicycle</span><span class="p">,</span> <span class="nx">i</span><span class="p">)</span> <span class="p">=></span> <span class="nx">client</span><span class="p">.</span><span class="nx">json</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="sb">`bicycle:</span><span class="si">${</span><span class="nx">i</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span> <span class="s1">'$'</span><span class="p">,</span> <span class="nx">bicycle</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 10,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": ...
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@model:Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:0",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Velorim",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Jigger",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 270,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "new"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm"> */</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@brand:"Noka Bikes"'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:4",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Noka Bikes",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Kahuna",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 3200,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "used"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Nodejs_search_quickstart-stepconnect')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Nodejs_search_quickstart-stepconnect" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/nodejs/" tabindex="1" title="Quick-Start">
Node.js Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/node-redis/tree/emb-examples/doctests/search-quickstart.js" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="java" id="Java_search_quickstart-stepconnect" name="search_quickstart-stepconnect" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Java_search_quickstart-stepconnect" title="Open example">
Java
</label>
<div aria-labelledby="tab-search_quickstart-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_search_quickstart-stepconnect" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nn">io.redis.examples</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.math.BigDecimal</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.exceptions.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.aggr.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.schemafields.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">class</span> <span class="nc">Bicycle</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="nf">Bicycle</span><span class="o">(</span><span class="n">String</span> <span class="n">brand</span><span class="o">,</span> <span class="n">String</span> <span class="n">model</span><span class="o">,</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">,</span> <span class="n">String</span> <span class="n">condition</span><span class="o">,</span> <span class="n">String</span> <span class="n">description</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">brand</span> <span class="o">=</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">price</span> <span class="o">=</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">condition</span> <span class="o">=</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SearchQuickstartExample</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// UnifiedJedis jedis = new UnifiedJedis("redis://localhost:6379");
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="n">JedisPooled</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JedisPooled</span><span class="o">(</span><span class="s">"localhost"</span><span class="o">,</span> <span class="mi">6379</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">SchemaField</span><span class="o">[]</span> <span class="n">schema</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.brand"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"brand"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.model"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"model"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.description"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"description"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.price"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"price"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.condition"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">ftCreate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span><span class="o">.</span><span class="na">createParams</span><span class="o">()</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">on</span><span class="o">(</span><span class="n">IndexDataType</span><span class="o">.</span><span class="na">JSON</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">addPrefix</span><span class="o">(</span><span class="s">"bicycle:"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span>
</span></span><span class="line"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Bicycle</span><span class="o">[]</span> <span class="n">bicycles</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Velorim"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Jigger"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">270</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Bicyk"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Hillcraft"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Nord"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Chook air 5"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva 291"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3400</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It's a "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Noka Bikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kahuna"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Breakout"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"XBN 2.1 Alloy"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">810</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ScramBikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"WattBike"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">2300</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Peaknetic"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Secto"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">430</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"nHill"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Summit"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ThrillCycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"BikeShind"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"refurbished"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">bicycles</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">jsonSetWithEscape</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"bicycle:%d"</span><span class="o">,</span> <span class="n">i</span><span class="o">),</span> <span class="n">bicycles</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"*"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query1</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Documents found:"</span> <span class="o">+</span> <span class="n">result1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query2</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result2</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Velorim","model":"Jigger","price":270,"description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">).</span><span class="na">returnFields</span><span class="o">(</span><span class="s">"price"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query3</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result3</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null, properties:[price=270]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query4</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"basic @price:[500 1000]"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query4</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result4</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:5, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Breakout","model":"XBN 2.1 Alloy","price":810,"description":"The XBN 2.1 Alloy is our entry-level road bike – but that’s not to say that it’s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which doesn’t break the bank and delivers craved performance.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query5</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@brand:\"Noka Bikes\""</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result5</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query5</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result5</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:4, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Noka Bikes","model":"Kahuna","price":3200,"description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","condition":"used"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationBuilder</span> <span class="n">ab</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">).</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@condition"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">count</span><span class="o">().</span><span class="na">as</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">ar</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftAggregate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">ab</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">();</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span> <span class="o">+</span> <span class="s">" - "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// refurbished - 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// used - 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// new - 4
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">assertEquals</span><span class="o">(</span><span class="s">"Validate aggregation results"</span><span class="o">,</span> <span class="mi">3</span><span class="o">,</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">());</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Java_search_quickstart-stepconnect')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Java_search_quickstart-stepconnect" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/java/jedis/" tabindex="1" title="Quick-Start">
Java Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/jedis/tree/master/src/test/java/io/redis/examples/SearchQuickstartExample.java" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="dotnet" id="Csharp_search_quickstart-stepconnect" name="search_quickstart-stepconnect" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Csharp_search_quickstart-stepconnect" title="Open example">
C#
</label>
<div aria-labelledby="tab-search_quickstart-stepconnect" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_search_quickstart-stepconnect" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-C#" data-lang="C#"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.RedisStackCommands</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Aggregation</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Literals.Enums</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Tests</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">StackExchange.Redis</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">public</span> <span class="k">class</span> <span class="nc">SearchQuickstartExample</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">public</span> <span class="k">void</span> <span class="n">run</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">redis</span> <span class="p">=</span> <span class="n">ConnectionMultiplexer</span><span class="p">.</span><span class="n">Connect</span><span class="p">(</span><span class="s">"localhost:6379"</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">db</span> <span class="p">=</span> <span class="n">redis</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">ft</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">();</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">json</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">JSON</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bike1</span> <span class="p">=</span> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">270</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bicycles</span> <span class="p">=</span> <span class="k">new</span> <span class="kt">object</span><span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">bike1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3400</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It’s a "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">810</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">2300</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">430</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">schema</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Schema</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Brand"</span><span class="p">,</span> <span class="s">"Brand"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Model"</span><span class="p">,</span> <span class="s">"Model"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Description"</span><span class="p">,</span> <span class="s">"Description"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddNumericField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Price"</span><span class="p">,</span> <span class="s">"Price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTagField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Condition"</span><span class="p">,</span> <span class="s">"Condition"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">ft</span><span class="p">.</span><span class="n">Create</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"idx:bicycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">().</span><span class="n">On</span><span class="p">(</span><span class="n">IndexDataType</span><span class="p">.</span><span class="n">JSON</span><span class="p">).</span><span class="n">Prefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">bicycles</span><span class="p">.</span><span class="n">Length</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">json</span><span class="p">.</span><span class="n">Set</span><span class="p">(</span><span class="s">$"bicycle:{i}"</span><span class="p">,</span> <span class="s">"$"</span><span class="p">,</span> <span class="n">bicycles</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query1</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"*"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query1</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res1</span><span class="p">.</span><span class="n">Count</span><span class="p">()));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query2</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query2</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res2</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query3</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"basic @Price:[500 1000]"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query3</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res3</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query4</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Brand:\"Noka Bikes\""</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query4</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res4</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query5</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">).</span><span class="n">ReturnFields</span><span class="p">(</span><span class="s">"Price"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res5</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query5</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res5</span><span class="p">.</span><span class="n">First</span><span class="p">()[</span><span class="s">"Price"</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: 270</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">request</span> <span class="p">=</span> <span class="k">new</span> <span class="n">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">).</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"@Condition"</span><span class="p">,</span> <span class="n">Reducers</span><span class="p">.</span><span class="n">Count</span><span class="p">().</span><span class="n">As</span><span class="p">(</span><span class="s">"Count"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Aggregate</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">request</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">var</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">result</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">row</span> <span class="p">=</span> <span class="n">result</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"{row["</span><span class="n">Condition</span><span class="s">"]} - {row["</span><span class="n">Count</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// refurbished - 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// used - 5</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// new - 4</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Csharp_search_quickstart-stepconnect')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Csharp_search_quickstart-stepconnect" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/dotnet/" tabindex="1" title="Quick-Start">
C# Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/NRedisStack/tree/master/tests/Doc/SearchQuickstartExample.cs" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<br/>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Tip:
</div>
You can copy and paste the connection details from the Redis Cloud database configuration page. Here is an example connection string of a Cloud database that is hosted in the AWS region
<code>
us-east-1
</code>
and listens on port 16379:
<code>
redis-16379.c283.us-east-1-4.ec2.cloud.redislabs.com:16379
</code>
. The connection string has the format
<code>
host:port
</code>
. You must also copy and paste your Cloud database's username and password and then pass the credentials to your client or use the
<a href="/docs/latest/commands/auth/">
AUTH command
</a>
after the connection is established.
</div>
</div>
<h2 id="create-an-index">
Create an index
</h2>
<p>
As explained in the
<a href="/docs/latest/develop/get-started/data-store/">
in-memory data store
</a>
quick start guide, Redis allows you to access an item directly via its key. You also learned how to scan the keyspace. Whereby you can use other data structures (e.g., hashes and sorted sets) as secondary indexes, your application would need to maintain those indexes manually. Redis Stack turns Redis into a document database by allowing you to declare which fields are auto-indexed. Redis Stack currently supports secondary index creation on the
<a href="/docs/latest/develop/data-types/hashes/">
hashes
</a>
and
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
documents.
</p>
<p>
The following example shows an
<a href="/docs/latest/commands/ft.create">
FT.CREATE
</a>
command that creates an index with some text fields, a numeric field (price), and a tag field (condition). The text fields have a weight of 1.0, meaning they have the same relevancy in the context of full-text searches. The field names follow the
<a href="/docs/latest/develop/data-types/json/path/">
JSONPath
</a>
notion. Each such index field maps to a property within the JSON document.
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_quickstart-stepcreate_index">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_quickstart-stepcreate_index" name="search_quickstart-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_quickstart-stepcreate_index" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_quickstart-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_quickstart-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> FT.CREATE idx:bicycle ON JSON PREFIX 1 bicycle: SCORE 1.0 SCHEMA $.brand AS brand TEXT WEIGHT 1.0 $.model AS model TEXT WEIGHT 1.0 $.description AS description TEXT WEIGHT 1.0 $.price AS price NUMERIC $.condition AS condition TAG SEPARATOR ,
</span></span><span class="line hl"><span class="cl">OK</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_quickstart-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_quickstart-stepcreate_index" name="search_quickstart-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_quickstart-stepcreate_index" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_quickstart-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_quickstart-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for document database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/document-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.aggregation</span> <span class="k">as</span> <span class="nn">aggregations</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.reducers</span> <span class="k">as</span> <span class="nn">reducers</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.json.path</span> <span class="kn">import</span> <span class="n">Path</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="n">NumericField</span><span class="p">,</span> <span class="n">TagField</span><span class="p">,</span> <span class="n">TextField</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bicycle</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Small and powerful, the Jigger is the best ride "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"for the smallest of tikes! This is the tiniest "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"kids’ pedal bike on the market available without"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a coaster brake, the Jigger is the vehicle of "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"choice for the rare tenacious little rider "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycle</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Kids want to ride with as little weight as possible."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Especially on an incline! They may be at the age "</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'when a 27.5" wheel bike is just too clumsy coming '</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'off a 24" bike. The Hillcraft 26 is just the solution'</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The Chook Air 5 gives kids aged six years and older "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"a durable and uberlight mountain bike for their first"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" experience on tracks and easy cruising through forests"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and fields. The lower top tube makes it easy to mount"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and dismount in any situation, giving your kids greater"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The sister company to Nord, Eva launched in 2005 as the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" first and only women-dedicated bicycle brand. Designed"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" by women for women, allEva bikes are optimized for the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" feminine physique using analytics from a body metrics"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" database. If you like 29ers, try the Eva 291. It’s a "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand new bike for 2022.. This full-suspension, "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"cross-country ride has been designed for velocity. The"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 291 has 100mm of front and rear travel, a superlight "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Whether you want to try your hand at XC racing or are "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"looking for a lively trail bike that's just as inspiring"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" on the climbs as it is over rougher ground, the Wilder"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" is one heck of a bike built specifically for short women."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Both the frames and components have been tweaked to "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"include a women’s saddle, different bars and unique "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" not to say that it’s a basic machine. With an internal "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Claris gears from Shimano’s, this is a bike which doesn’t"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The WattBike is the best e-bike for people who still feel young"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" more than 60 miles on one charge. It’s great for tackling hilly"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" terrain or if you just fancy a more leisurely ride. With three"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" working modes, you can choose between E-bike, assisted bicycle,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"If you struggle with stiff fingers or a kinked neck or back after"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a few minutes on the road, this lightweight, aluminum bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" alleviates those issues and allows you to enjoy the ride. From"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" the ergonomic grips to the lumbar-supporting seat position, the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" tube facilitates stability by allowing you to put a foot on the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" ground to balance at a stop, and the low step-over frame makes it"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" accessible for all ability and mobility levels. The saddle is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" very soft, with a wide back to support your hip joints and a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" cutout in the center to redistribute that pressure. Rim brakes"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" deliver satisfactory braking control, and the wide tires provide"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" commuter, and the BMX-like handlebar offers space for mounting a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"This budget mountain bike from nHill performs well both on bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" paths and on the trail. The fork with 100mm of travel absorbs"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" gears for finding a comfortable pace to ride uphill, and the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" affordable bike that you can take to work, but also take trail in"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mountains on the weekends or you’re just after a stable,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" comfortable ride for the bike path, the Summit gives a good value"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"An artsy, retro-inspired bicycle that’s as functional as it is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 9-speed drivetrain has enough gears for coasting in the city, but"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" you from mud, and a rear basket lets you transport groceries,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flowers and books. The ThrillCycle comes with a limited lifetime"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.condition"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"condition"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"><span class="p">)</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">index</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">index</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">schema</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">definition</span><span class="o">=</span><span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bicycle:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">bid</span><span class="p">,</span> <span class="n">bicycle</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bicycles</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">"bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">Path</span><span class="o">.</span><span class="n">root_path</span><span class="p">(),</span> <span class="n">bicycle</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Documents found:"</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:0',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Velorim",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Jigger",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":270,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">)</span><span class="o">.</span><span class="n">return_field</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_field</span><span class="o">=</span><span class="s2">"price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [Document {'id': 'bicycle:0', 'payload': None, 'price': '270'}]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"basic @price:[500 1000]"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:5',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Breakout",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"XBN 2.1 Alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":810,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s1">'@brand:"Noka Bikes"'</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:4',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Noka Bikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Kahuna",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%a</span><span class="s2">nalitics%"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note the typo in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%%</span><span class="s2">analitycs</span><span class="si">%%</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note 2 typos in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:hill*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:1',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:*bike"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:6',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"ScramBikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"WattBike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":2300,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"w'H?*craft'"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">()</span><span class="o">.</span><span class="n">scorer</span><span class="p">(</span><span class="s2">"BM25"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">req</span> <span class="o">=</span> <span class="n">aggregations</span><span class="o">.</span><span class="n">AggregateRequest</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="o">.</span><span class="n">group_by</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@condition"</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">"count"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">req</span><span class="p">)</span><span class="o">.</span><span class="n">rows</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [['condition', 'refurbished', 'count', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'count', '4'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'count', '5']]</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_quickstart-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_quickstart-stepcreate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_quickstart.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="javascript" id="Nodejs_search_quickstart-stepcreate_index" name="search_quickstart-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Nodejs_search_quickstart-stepcreate_index" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-search_quickstart-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_search_quickstart-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">AggregateGroupByReducers</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">createClient</span><span class="p">,</span> <span class="nx">SchemaFieldTypes</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycle1</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Velorim'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Small and powerful, the Jigger is the best '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ride for the smallest of tikes! This is the tiniest kids\u2019 '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'pedal bike on the market available without a coaster brake, the '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Jigger is the vehicle of choice for the rare tenacious little'</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'rider raring to go.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycle1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Bicyk'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Hillcraft'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Nord'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Chook air 5'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Eva'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Eva 291'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Noka Bikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Kahuna'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Breakout'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'XBN 2.1 Alloy'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'ScramBikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'WattBike'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Peaknetic'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Secto'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'nHill'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Summit'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'ThrillCycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'BikeShind'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'refurbished'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">];</span>
</span></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'$.brand'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">SORTABLE</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'brand'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">},</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'$.model'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'model'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">},</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'$.description'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">},</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'$.price'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">NUMERIC</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'price'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">},</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'$.condition'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TAG</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'condition'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"><span class="p">};</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="k">try</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="nx">schema</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">ON</span><span class="o">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">PREFIX</span><span class="o">:</span> <span class="s1">'bicycle:'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">});</span>
</span></span><span class="line hl"><span class="cl"><span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">message</span> <span class="o">===</span> <span class="s1">'Index already exists'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Index exists already, skipped creation.'</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Something went wrong, perhaps RediSearch isn't installed...
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">process</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycles</span><span class="p">.</span><span class="nx">map</span><span class="p">((</span><span class="nx">bicycle</span><span class="p">,</span> <span class="nx">i</span><span class="p">)</span> <span class="p">=></span> <span class="nx">client</span><span class="p">.</span><span class="nx">json</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="sb">`bicycle:</span><span class="si">${</span><span class="nx">i</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span> <span class="s1">'$'</span><span class="p">,</span> <span class="nx">bicycle</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 10,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": ...
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@model:Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:0",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Velorim",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Jigger",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 270,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "new"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm"> */</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@brand:"Noka Bikes"'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:4",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Noka Bikes",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Kahuna",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 3200,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "used"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Nodejs_search_quickstart-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Nodejs_search_quickstart-stepcreate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/nodejs/" tabindex="1" title="Quick-Start">
Node.js Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/node-redis/tree/emb-examples/doctests/search-quickstart.js" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="java" id="Java_search_quickstart-stepcreate_index" name="search_quickstart-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Java_search_quickstart-stepcreate_index" title="Open example">
Java
</label>
<div aria-labelledby="tab-search_quickstart-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_search_quickstart-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nn">io.redis.examples</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.math.BigDecimal</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.exceptions.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.aggr.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.schemafields.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">class</span> <span class="nc">Bicycle</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="nf">Bicycle</span><span class="o">(</span><span class="n">String</span> <span class="n">brand</span><span class="o">,</span> <span class="n">String</span> <span class="n">model</span><span class="o">,</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">,</span> <span class="n">String</span> <span class="n">condition</span><span class="o">,</span> <span class="n">String</span> <span class="n">description</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">brand</span> <span class="o">=</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">price</span> <span class="o">=</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">condition</span> <span class="o">=</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SearchQuickstartExample</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// UnifiedJedis jedis = new UnifiedJedis("redis://localhost:6379");
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">JedisPooled</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JedisPooled</span><span class="o">(</span><span class="s">"localhost"</span><span class="o">,</span> <span class="mi">6379</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="n">SchemaField</span><span class="o">[]</span> <span class="n">schema</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.brand"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"brand"</span><span class="o">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.model"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"model"</span><span class="o">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.description"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"description"</span><span class="o">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">NumericField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.price"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"price"</span><span class="o">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">TagField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.condition"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">};</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">ftCreate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">FTCreateParams</span><span class="o">.</span><span class="na">createParams</span><span class="o">()</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">on</span><span class="o">(</span><span class="n">IndexDataType</span><span class="o">.</span><span class="na">JSON</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">addPrefix</span><span class="o">(</span><span class="s">"bicycle:"</span><span class="o">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">schema</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Bicycle</span><span class="o">[]</span> <span class="n">bicycles</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Velorim"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Jigger"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">270</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Bicyk"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Hillcraft"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Nord"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Chook air 5"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva 291"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3400</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It's a "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Noka Bikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kahuna"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Breakout"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"XBN 2.1 Alloy"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">810</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ScramBikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"WattBike"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">2300</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Peaknetic"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Secto"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">430</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"nHill"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Summit"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ThrillCycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"BikeShind"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"refurbished"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">bicycles</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">jsonSetWithEscape</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"bicycle:%d"</span><span class="o">,</span> <span class="n">i</span><span class="o">),</span> <span class="n">bicycles</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"*"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query1</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Documents found:"</span> <span class="o">+</span> <span class="n">result1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query2</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result2</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Velorim","model":"Jigger","price":270,"description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">).</span><span class="na">returnFields</span><span class="o">(</span><span class="s">"price"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query3</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result3</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null, properties:[price=270]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query4</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"basic @price:[500 1000]"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query4</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result4</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:5, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Breakout","model":"XBN 2.1 Alloy","price":810,"description":"The XBN 2.1 Alloy is our entry-level road bike – but that’s not to say that it’s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which doesn’t break the bank and delivers craved performance.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query5</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@brand:\"Noka Bikes\""</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result5</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query5</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result5</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:4, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Noka Bikes","model":"Kahuna","price":3200,"description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","condition":"used"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationBuilder</span> <span class="n">ab</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">).</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@condition"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">count</span><span class="o">().</span><span class="na">as</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">ar</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftAggregate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">ab</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">();</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span> <span class="o">+</span> <span class="s">" - "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// refurbished - 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// used - 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// new - 4
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">assertEquals</span><span class="o">(</span><span class="s">"Validate aggregation results"</span><span class="o">,</span> <span class="mi">3</span><span class="o">,</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">());</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Java_search_quickstart-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Java_search_quickstart-stepcreate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/java/jedis/" tabindex="1" title="Quick-Start">
Java Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/jedis/tree/master/src/test/java/io/redis/examples/SearchQuickstartExample.java" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="dotnet" id="Csharp_search_quickstart-stepcreate_index" name="search_quickstart-stepcreate_index" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Csharp_search_quickstart-stepcreate_index" title="Open example">
C#
</label>
<div aria-labelledby="tab-search_quickstart-stepcreate_index" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_search_quickstart-stepcreate_index" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-C#" data-lang="C#"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.RedisStackCommands</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Aggregation</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Literals.Enums</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Tests</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">StackExchange.Redis</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">public</span> <span class="k">class</span> <span class="nc">SearchQuickstartExample</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">public</span> <span class="k">void</span> <span class="n">run</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">redis</span> <span class="p">=</span> <span class="n">ConnectionMultiplexer</span><span class="p">.</span><span class="n">Connect</span><span class="p">(</span><span class="s">"localhost:6379"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">db</span> <span class="p">=</span> <span class="n">redis</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">ft</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">json</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">JSON</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bike1</span> <span class="p">=</span> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">270</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bicycles</span> <span class="p">=</span> <span class="k">new</span> <span class="kt">object</span><span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">bike1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3400</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It’s a "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">810</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">2300</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">430</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">schema</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Schema</span><span class="p">()</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Brand"</span><span class="p">,</span> <span class="s">"Brand"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Model"</span><span class="p">,</span> <span class="s">"Model"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Description"</span><span class="p">,</span> <span class="s">"Description"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">AddNumericField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Price"</span><span class="p">,</span> <span class="s">"Price"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">AddTagField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Condition"</span><span class="p">,</span> <span class="s">"Condition"</span><span class="p">));</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="n">ft</span><span class="p">.</span><span class="n">Create</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s">"idx:bicycle"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">().</span><span class="n">On</span><span class="p">(</span><span class="n">IndexDataType</span><span class="p">.</span><span class="n">JSON</span><span class="p">).</span><span class="n">Prefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">schema</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">bicycles</span><span class="p">.</span><span class="n">Length</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">json</span><span class="p">.</span><span class="n">Set</span><span class="p">(</span><span class="s">$"bicycle:{i}"</span><span class="p">,</span> <span class="s">"$"</span><span class="p">,</span> <span class="n">bicycles</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query1</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"*"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query1</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res1</span><span class="p">.</span><span class="n">Count</span><span class="p">()));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query2</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query2</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res2</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query3</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"basic @Price:[500 1000]"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query3</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res3</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query4</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Brand:\"Noka Bikes\""</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query4</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res4</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query5</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">).</span><span class="n">ReturnFields</span><span class="p">(</span><span class="s">"Price"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res5</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query5</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res5</span><span class="p">.</span><span class="n">First</span><span class="p">()[</span><span class="s">"Price"</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: 270</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">request</span> <span class="p">=</span> <span class="k">new</span> <span class="n">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">).</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"@Condition"</span><span class="p">,</span> <span class="n">Reducers</span><span class="p">.</span><span class="n">Count</span><span class="p">().</span><span class="n">As</span><span class="p">(</span><span class="s">"Count"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Aggregate</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">request</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">var</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">result</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">row</span> <span class="p">=</span> <span class="n">result</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"{row["</span><span class="n">Condition</span><span class="s">"]} - {row["</span><span class="n">Count</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// refurbished - 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// used - 5</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// new - 4</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Csharp_search_quickstart-stepcreate_index')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Csharp_search_quickstart-stepcreate_index" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/dotnet/" tabindex="1" title="Quick-Start">
C# Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/NRedisStack/tree/master/tests/Doc/SearchQuickstartExample.cs" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Any pre-existing JSON documents with a key prefix
<code>
bicycle:
</code>
are automatically added to the index. Additionally, any JSON documents with that prefix created or modified after index creation are added or re-added to the index.
</p>
<h2 id="add-json-documents">
Add JSON documents
</h2>
<p>
The example below shows you how to use the
<a href="/docs/latest/commands/json.set">
JSON.SET
</a>
command to create new JSON documents:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_quickstart-stepadd_documents">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_quickstart-stepadd_documents" name="search_quickstart-stepadd_documents" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_quickstart-stepadd_documents" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_quickstart-stepadd_documents" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_quickstart-stepadd_documents" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> JSON.SET "bicycle:0" "." "{\"brand\": \"Velorim\", \"model\": \"Jigger\", \"price\": 270, \"description\": \"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids\\u2019 pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.\", \"condition\": \"new\"}"
</span></span><span class="line hl"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:1" "." "{\"brand\": \"Bicyk\", \"model\": \"Hillcraft\", \"price\": 1200, \"description\": \"Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\\\" wheel bike is just too clumsy coming off a 24\\\" bike. The Hillcraft 26 is just the solution they need!\", \"condition\": \"used\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:2" "." "{\"brand\": \"Nord\", \"model\": \"Chook air 5\", \"price\": 815, \"description\": \"The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.\", \"condition\": \"used\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:3" "." "{\"brand\": \"Eva\", \"model\": \"Eva 291\", \"price\": 3400, \"description\": \"The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!\", \"condition\": \"used\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:4" "." "{\"brand\": \"Noka Bikes\", \"model\": \"Kahuna\", \"price\": 3200, \"description\": \"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\\u2019s saddle, different bars and unique colourway.\", \"condition\": \"used\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:5" "." "{\"brand\": \"Breakout\", \"model\": \"XBN 2.1 Alloy\", \"price\": 810, \"description\": \"The XBN 2.1 Alloy is our entry-level road bike \\u2013 but that\\u2019s not to say that it\\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\\u2019s, this is a bike which doesn\\u2019t break the bank and delivers craved performance.\", \"condition\": \"new\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:6" "." "{\"brand\": \"ScramBikes\", \"model\": \"WattBike\", \"price\": 2300, \"description\": \"The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.\", \"condition\": \"new\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:7" "." "{\"brand\": \"Peaknetic\", \"model\": \"Secto\", \"price\": 430, \"description\": \"If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.\", \"condition\": \"new\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:8" "." "{\"brand\": \"nHill\", \"model\": \"Summit\", \"price\": 1200, \"description\": \"This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.\", \"condition\": \"new\"}"
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">> JSON.SET "bicycle:9" "." "{\"model\": \"ThrillCycle\", \"brand\": \"BikeShind\", \"price\": 815, \"description\": \"An artsy, retro-inspired bicycle that\\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.\", \"condition\": \"refurbished\"}"
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_quickstart-stepadd_documents')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_redis-cli_search_quickstart-stepadd_documents" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_quickstart-stepadd_documents" name="search_quickstart-stepadd_documents" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_quickstart-stepadd_documents" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_quickstart-stepadd_documents" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_quickstart-stepadd_documents" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for document database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/document-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.aggregation</span> <span class="k">as</span> <span class="nn">aggregations</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.reducers</span> <span class="k">as</span> <span class="nn">reducers</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.json.path</span> <span class="kn">import</span> <span class="n">Path</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="n">NumericField</span><span class="p">,</span> <span class="n">TagField</span><span class="p">,</span> <span class="n">TextField</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bicycle</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Small and powerful, the Jigger is the best ride "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"for the smallest of tikes! This is the tiniest "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"kids’ pedal bike on the market available without"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a coaster brake, the Jigger is the vehicle of "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"choice for the rare tenacious little rider "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycle</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Kids want to ride with as little weight as possible."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Especially on an incline! They may be at the age "</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'when a 27.5" wheel bike is just too clumsy coming '</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'off a 24" bike. The Hillcraft 26 is just the solution'</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The Chook Air 5 gives kids aged six years and older "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"a durable and uberlight mountain bike for their first"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" experience on tracks and easy cruising through forests"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and fields. The lower top tube makes it easy to mount"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and dismount in any situation, giving your kids greater"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The sister company to Nord, Eva launched in 2005 as the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" first and only women-dedicated bicycle brand. Designed"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" by women for women, allEva bikes are optimized for the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" feminine physique using analytics from a body metrics"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" database. If you like 29ers, try the Eva 291. It’s a "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand new bike for 2022.. This full-suspension, "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"cross-country ride has been designed for velocity. The"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 291 has 100mm of front and rear travel, a superlight "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Whether you want to try your hand at XC racing or are "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"looking for a lively trail bike that's just as inspiring"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" on the climbs as it is over rougher ground, the Wilder"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" is one heck of a bike built specifically for short women."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Both the frames and components have been tweaked to "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"include a women’s saddle, different bars and unique "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" not to say that it’s a basic machine. With an internal "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Claris gears from Shimano’s, this is a bike which doesn’t"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The WattBike is the best e-bike for people who still feel young"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" more than 60 miles on one charge. It’s great for tackling hilly"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" terrain or if you just fancy a more leisurely ride. With three"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" working modes, you can choose between E-bike, assisted bicycle,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"If you struggle with stiff fingers or a kinked neck or back after"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a few minutes on the road, this lightweight, aluminum bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" alleviates those issues and allows you to enjoy the ride. From"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" the ergonomic grips to the lumbar-supporting seat position, the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" tube facilitates stability by allowing you to put a foot on the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" ground to balance at a stop, and the low step-over frame makes it"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" accessible for all ability and mobility levels. The saddle is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" very soft, with a wide back to support your hip joints and a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" cutout in the center to redistribute that pressure. Rim brakes"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" deliver satisfactory braking control, and the wide tires provide"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" commuter, and the BMX-like handlebar offers space for mounting a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"This budget mountain bike from nHill performs well both on bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" paths and on the trail. The fork with 100mm of travel absorbs"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" gears for finding a comfortable pace to ride uphill, and the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" affordable bike that you can take to work, but also take trail in"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mountains on the weekends or you’re just after a stable,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" comfortable ride for the bike path, the Summit gives a good value"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"An artsy, retro-inspired bicycle that’s as functional as it is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 9-speed drivetrain has enough gears for coasting in the city, but"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" you from mud, and a rear basket lets you transport groceries,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flowers and books. The ThrillCycle comes with a limited lifetime"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.condition"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"condition"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">index</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">index</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">definition</span><span class="o">=</span><span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bicycle:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="k">for</span> <span class="n">bid</span><span class="p">,</span> <span class="n">bicycle</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bicycles</span><span class="p">):</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">"bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">Path</span><span class="o">.</span><span class="n">root_path</span><span class="p">(),</span> <span class="n">bicycle</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Documents found:"</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:0',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Velorim",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Jigger",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":270,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">)</span><span class="o">.</span><span class="n">return_field</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_field</span><span class="o">=</span><span class="s2">"price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [Document {'id': 'bicycle:0', 'payload': None, 'price': '270'}]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"basic @price:[500 1000]"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:5',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Breakout",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"XBN 2.1 Alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":810,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s1">'@brand:"Noka Bikes"'</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:4',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Noka Bikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Kahuna",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%a</span><span class="s2">nalitics%"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note the typo in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%%</span><span class="s2">analitycs</span><span class="si">%%</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note 2 typos in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:hill*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:1',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:*bike"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:6',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"ScramBikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"WattBike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":2300,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"w'H?*craft'"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">()</span><span class="o">.</span><span class="n">scorer</span><span class="p">(</span><span class="s2">"BM25"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">req</span> <span class="o">=</span> <span class="n">aggregations</span><span class="o">.</span><span class="n">AggregateRequest</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="o">.</span><span class="n">group_by</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@condition"</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">"count"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">req</span><span class="p">)</span><span class="o">.</span><span class="n">rows</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [['condition', 'refurbished', 'count', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'count', '4'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'count', '5']]</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_quickstart-stepadd_documents')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_quickstart-stepadd_documents" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_quickstart.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="javascript" id="Nodejs_search_quickstart-stepadd_documents" name="search_quickstart-stepadd_documents" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Nodejs_search_quickstart-stepadd_documents" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-search_quickstart-stepadd_documents" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_search_quickstart-stepadd_documents" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">AggregateGroupByReducers</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">createClient</span><span class="p">,</span> <span class="nx">SchemaFieldTypes</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycle1</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Velorim'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Small and powerful, the Jigger is the best '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ride for the smallest of tikes! This is the tiniest kids\u2019 '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'pedal bike on the market available without a coaster brake, the '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Jigger is the vehicle of choice for the rare tenacious little'</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'rider raring to go.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycle1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Bicyk'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Hillcraft'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Nord'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Chook air 5'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Eva'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Eva 291'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Noka Bikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Kahuna'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Breakout'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'XBN 2.1 Alloy'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'ScramBikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'WattBike'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Peaknetic'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Secto'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'nHill'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Summit'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'ThrillCycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'BikeShind'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'refurbished'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">];</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.brand'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">SORTABLE</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'brand'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.model'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'model'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.description'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.price'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">NUMERIC</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'price'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.condition'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TAG</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'condition'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">try</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="nx">schema</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ON</span><span class="o">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PREFIX</span><span class="o">:</span> <span class="s1">'bicycle:'</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">message</span> <span class="o">===</span> <span class="s1">'Index already exists'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Index exists already, skipped creation.'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Something went wrong, perhaps RediSearch isn't installed...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">process</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kr">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">bicycles</span><span class="p">.</span><span class="nx">map</span><span class="p">((</span><span class="nx">bicycle</span><span class="p">,</span> <span class="nx">i</span><span class="p">)</span> <span class="p">=></span> <span class="nx">client</span><span class="p">.</span><span class="nx">json</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="sb">`bicycle:</span><span class="si">${</span><span class="nx">i</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span> <span class="s1">'$'</span><span class="p">,</span> <span class="nx">bicycle</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 10,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": ...
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@model:Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:0",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Velorim",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Jigger",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 270,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "new"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm"> */</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@brand:"Noka Bikes"'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:4",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Noka Bikes",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Kahuna",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 3200,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "used"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Nodejs_search_quickstart-stepadd_documents')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Nodejs_search_quickstart-stepadd_documents" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/nodejs/" tabindex="1" title="Quick-Start">
Node.js Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/node-redis/tree/emb-examples/doctests/search-quickstart.js" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="java" id="Java_search_quickstart-stepadd_documents" name="search_quickstart-stepadd_documents" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Java_search_quickstart-stepadd_documents" title="Open example">
Java
</label>
<div aria-labelledby="tab-search_quickstart-stepadd_documents" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_search_quickstart-stepadd_documents" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nn">io.redis.examples</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.math.BigDecimal</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.exceptions.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.aggr.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.schemafields.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">class</span> <span class="nc">Bicycle</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="nf">Bicycle</span><span class="o">(</span><span class="n">String</span> <span class="n">brand</span><span class="o">,</span> <span class="n">String</span> <span class="n">model</span><span class="o">,</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">,</span> <span class="n">String</span> <span class="n">condition</span><span class="o">,</span> <span class="n">String</span> <span class="n">description</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">brand</span> <span class="o">=</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">price</span> <span class="o">=</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">condition</span> <span class="o">=</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SearchQuickstartExample</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// UnifiedJedis jedis = new UnifiedJedis("redis://localhost:6379");
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">JedisPooled</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JedisPooled</span><span class="o">(</span><span class="s">"localhost"</span><span class="o">,</span> <span class="mi">6379</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">SchemaField</span><span class="o">[]</span> <span class="n">schema</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.brand"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"brand"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.model"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"model"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.description"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"description"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.price"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"price"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.condition"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">ftCreate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span><span class="o">.</span><span class="na">createParams</span><span class="o">()</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">on</span><span class="o">(</span><span class="n">IndexDataType</span><span class="o">.</span><span class="na">JSON</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">addPrefix</span><span class="o">(</span><span class="s">"bicycle:"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span>
</span></span><span class="line"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Bicycle</span><span class="o">[]</span> <span class="n">bicycles</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Velorim"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Jigger"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">270</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Bicyk"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Hillcraft"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Nord"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Chook air 5"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva 291"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3400</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It's a "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Noka Bikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kahuna"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Breakout"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"XBN 2.1 Alloy"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">810</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ScramBikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"WattBike"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">2300</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Peaknetic"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Secto"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">430</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"nHill"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Summit"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ThrillCycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"BikeShind"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"refurbished"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">bicycles</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">jsonSetWithEscape</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"bicycle:%d"</span><span class="o">,</span> <span class="n">i</span><span class="o">),</span> <span class="n">bicycles</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"*"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query1</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Documents found:"</span> <span class="o">+</span> <span class="n">result1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query2</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result2</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Velorim","model":"Jigger","price":270,"description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">).</span><span class="na">returnFields</span><span class="o">(</span><span class="s">"price"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query3</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result3</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null, properties:[price=270]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query4</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"basic @price:[500 1000]"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query4</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result4</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:5, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Breakout","model":"XBN 2.1 Alloy","price":810,"description":"The XBN 2.1 Alloy is our entry-level road bike – but that’s not to say that it’s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which doesn’t break the bank and delivers craved performance.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query5</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@brand:\"Noka Bikes\""</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result5</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query5</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result5</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:4, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Noka Bikes","model":"Kahuna","price":3200,"description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","condition":"used"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationBuilder</span> <span class="n">ab</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">).</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@condition"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">count</span><span class="o">().</span><span class="na">as</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">ar</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftAggregate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">ab</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">();</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span> <span class="o">+</span> <span class="s">" - "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// refurbished - 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// used - 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// new - 4
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">assertEquals</span><span class="o">(</span><span class="s">"Validate aggregation results"</span><span class="o">,</span> <span class="mi">3</span><span class="o">,</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">());</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Java_search_quickstart-stepadd_documents')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Java_search_quickstart-stepadd_documents" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/java/jedis/" tabindex="1" title="Quick-Start">
Java Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/jedis/tree/master/src/test/java/io/redis/examples/SearchQuickstartExample.java" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="dotnet" id="Csharp_search_quickstart-stepadd_documents" name="search_quickstart-stepadd_documents" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Csharp_search_quickstart-stepadd_documents" title="Open example">
C#
</label>
<div aria-labelledby="tab-search_quickstart-stepadd_documents" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_search_quickstart-stepadd_documents" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-C#" data-lang="C#"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.RedisStackCommands</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Aggregation</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Literals.Enums</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Tests</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">StackExchange.Redis</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">public</span> <span class="k">class</span> <span class="nc">SearchQuickstartExample</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">public</span> <span class="k">void</span> <span class="n">run</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">redis</span> <span class="p">=</span> <span class="n">ConnectionMultiplexer</span><span class="p">.</span><span class="n">Connect</span><span class="p">(</span><span class="s">"localhost:6379"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">db</span> <span class="p">=</span> <span class="n">redis</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">ft</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">json</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">JSON</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bike1</span> <span class="p">=</span> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">270</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bicycles</span> <span class="p">=</span> <span class="k">new</span> <span class="kt">object</span><span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">bike1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3400</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It’s a "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">810</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">2300</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">430</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">schema</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Schema</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Brand"</span><span class="p">,</span> <span class="s">"Brand"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Model"</span><span class="p">,</span> <span class="s">"Model"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Description"</span><span class="p">,</span> <span class="s">"Description"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddNumericField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Price"</span><span class="p">,</span> <span class="s">"Price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTagField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Condition"</span><span class="p">,</span> <span class="s">"Condition"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">ft</span><span class="p">.</span><span class="n">Create</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"idx:bicycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">().</span><span class="n">On</span><span class="p">(</span><span class="n">IndexDataType</span><span class="p">.</span><span class="n">JSON</span><span class="p">).</span><span class="n">Prefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">bicycles</span><span class="p">.</span><span class="n">Length</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">json</span><span class="p">.</span><span class="n">Set</span><span class="p">(</span><span class="s">$"bicycle:{i}"</span><span class="p">,</span> <span class="s">"$"</span><span class="p">,</span> <span class="n">bicycles</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query1</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"*"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query1</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res1</span><span class="p">.</span><span class="n">Count</span><span class="p">()));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query2</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query2</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res2</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query3</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"basic @Price:[500 1000]"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query3</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res3</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query4</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Brand:\"Noka Bikes\""</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query4</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res4</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query5</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">).</span><span class="n">ReturnFields</span><span class="p">(</span><span class="s">"Price"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res5</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query5</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res5</span><span class="p">.</span><span class="n">First</span><span class="p">()[</span><span class="s">"Price"</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: 270</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">request</span> <span class="p">=</span> <span class="k">new</span> <span class="n">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">).</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"@Condition"</span><span class="p">,</span> <span class="n">Reducers</span><span class="p">.</span><span class="n">Count</span><span class="p">().</span><span class="n">As</span><span class="p">(</span><span class="s">"Count"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Aggregate</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">request</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">var</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">result</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">row</span> <span class="p">=</span> <span class="n">result</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"{row["</span><span class="n">Condition</span><span class="s">"]} - {row["</span><span class="n">Count</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// refurbished - 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// used - 5</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// new - 4</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Csharp_search_quickstart-stepadd_documents')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Csharp_search_quickstart-stepadd_documents" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/dotnet/" tabindex="1" title="Quick-Start">
C# Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/NRedisStack/tree/master/tests/Doc/SearchQuickstartExample.cs" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h2 id="search-and-query-using-the-redis-query-engine">
Search and query using the Redis Query Engine
</h2>
<h3 id="wildcard-query">
Wildcard query
</h3>
<p>
You can retrieve all indexed documents using the
<a href="/docs/latest/commands/ft.search">
FT.SEARCH
</a>
command. Note the
<code>
LIMIT
</code>
clause below, which allows result pagination.
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_quickstart-stepwildcard_query">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_quickstart-stepwildcard_query" name="search_quickstart-stepwildcard_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_quickstart-stepwildcard_query" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_quickstart-stepwildcard_query" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_quickstart-stepwildcard_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> FT.SEARCH "idx:bicycle" "*" LIMIT 0 10
</span></span><span class="line hl"><span class="cl">1) (integer) 10
</span></span><span class="line hl"><span class="cl"> 2) "bicycle:1"
</span></span><span class="line hl"><span class="cl"> 3) 1) "$"
</span></span><span class="line hl"><span class="cl"> 2) "{\"brand\":\"Bicyk\",\"model\":\"Hillcraft\",\"price\":1200,\"description\":\"Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\\\" wheel bike is just too clumsy coming off a 24\\\" bike. The Hillcraft 26 is just the solution they need!\",\"condition\":\"used\"}"
</span></span><span class="line hl"><span class="cl"> 4) "bicycle:2"
</span></span><span class="line hl"><span class="cl"> 5) 1) "$"
</span></span><span class="line hl"><span class="cl"> 2) "{\"brand\":\"Nord\",\"model\":\"Chook air 5\",\"price\":815,\"description\":\"The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.\",\"condition\":\"used\"}"
</span></span><span class="line hl"><span class="cl"> 6) "bicycle:4"
</span></span><span class="line hl"><span class="cl"> 7) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"Noka Bikes\",\"model\":\"Kahuna\",\"price\":3200,\"description\":\"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\xe2\x80\x99s saddle, different bars and unique colourway.\",\"condition\":\"used\"}"
</span></span><span class="line"><span class="cl"> 8) "bicycle:5"
</span></span><span class="line"><span class="cl"> 9) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"Breakout\",\"model\":\"XBN 2.1 Alloy\",\"price\":810,\"description\":\"The XBN 2.1 Alloy is our entry-level road bike \xe2\x80\x93 but that\xe2\x80\x99s not to say that it\xe2\x80\x99s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\xe2\x80\x99s, this is a bike which doesn\xe2\x80\x99t break the bank and delivers craved performance.\",\"condition\":\"new\"}"
</span></span><span class="line"><span class="cl">10) "bicycle:0"
</span></span><span class="line"><span class="cl">11) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"Velorim\",\"model\":\"Jigger\",\"price\":270,\"description\":\"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids\xe2\x80\x99 pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.\",\"condition\":\"new\"}"
</span></span><span class="line"><span class="cl">12) "bicycle:6"
</span></span><span class="line"><span class="cl">13) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"ScramBikes\",\"model\":\"WattBike\",\"price\":2300,\"description\":\"The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\xe2\x80\x99s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.\",\"condition\":\"new\"}"
</span></span><span class="line"><span class="cl">14) "bicycle:7"
</span></span><span class="line"><span class="cl">15) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"Peaknetic\",\"model\":\"Secto\",\"price\":430,\"description\":\"If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.\",\"condition\":\"new\"}"
</span></span><span class="line"><span class="cl">16) "bicycle:9"
</span></span><span class="line"><span class="cl">17) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"model\":\"ThrillCycle\",\"brand\":\"BikeShind\",\"price\":815,\"description\":\"An artsy, retro-inspired bicycle that\xe2\x80\x99s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\xe2\x80\x99t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.\",\"condition\":\"refurbished\"}"
</span></span><span class="line"><span class="cl">18) "bicycle:3"
</span></span><span class="line"><span class="cl">19) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"Eva\",\"model\":\"Eva 291\",\"price\":3400,\"description\":\"The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\xe2\x80\x99s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!\",\"condition\":\"used\"}"
</span></span><span class="line"><span class="cl">20) "bicycle:8"
</span></span><span class="line"><span class="cl">21) 1) "$"
</span></span><span class="line"><span class="cl"> 2) "{\"brand\":\"nHill\",\"model\":\"Summit\",\"price\":1200,\"description\":\"This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\xe2\x80\x99re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.\",\"condition\":\"new\"}"</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_quickstart-stepwildcard_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_redis-cli_search_quickstart-stepwildcard_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_quickstart-stepwildcard_query" name="search_quickstart-stepwildcard_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_quickstart-stepwildcard_query" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_quickstart-stepwildcard_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_quickstart-stepwildcard_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for document database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/document-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.aggregation</span> <span class="k">as</span> <span class="nn">aggregations</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.reducers</span> <span class="k">as</span> <span class="nn">reducers</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.json.path</span> <span class="kn">import</span> <span class="n">Path</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="n">NumericField</span><span class="p">,</span> <span class="n">TagField</span><span class="p">,</span> <span class="n">TextField</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bicycle</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Small and powerful, the Jigger is the best ride "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"for the smallest of tikes! This is the tiniest "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"kids’ pedal bike on the market available without"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a coaster brake, the Jigger is the vehicle of "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"choice for the rare tenacious little rider "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycle</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Kids want to ride with as little weight as possible."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Especially on an incline! They may be at the age "</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'when a 27.5" wheel bike is just too clumsy coming '</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'off a 24" bike. The Hillcraft 26 is just the solution'</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The Chook Air 5 gives kids aged six years and older "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"a durable and uberlight mountain bike for their first"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" experience on tracks and easy cruising through forests"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and fields. The lower top tube makes it easy to mount"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and dismount in any situation, giving your kids greater"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The sister company to Nord, Eva launched in 2005 as the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" first and only women-dedicated bicycle brand. Designed"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" by women for women, allEva bikes are optimized for the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" feminine physique using analytics from a body metrics"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" database. If you like 29ers, try the Eva 291. It’s a "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand new bike for 2022.. This full-suspension, "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"cross-country ride has been designed for velocity. The"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 291 has 100mm of front and rear travel, a superlight "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Whether you want to try your hand at XC racing or are "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"looking for a lively trail bike that's just as inspiring"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" on the climbs as it is over rougher ground, the Wilder"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" is one heck of a bike built specifically for short women."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Both the frames and components have been tweaked to "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"include a women’s saddle, different bars and unique "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" not to say that it’s a basic machine. With an internal "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Claris gears from Shimano’s, this is a bike which doesn’t"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The WattBike is the best e-bike for people who still feel young"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" more than 60 miles on one charge. It’s great for tackling hilly"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" terrain or if you just fancy a more leisurely ride. With three"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" working modes, you can choose between E-bike, assisted bicycle,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"If you struggle with stiff fingers or a kinked neck or back after"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a few minutes on the road, this lightweight, aluminum bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" alleviates those issues and allows you to enjoy the ride. From"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" the ergonomic grips to the lumbar-supporting seat position, the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" tube facilitates stability by allowing you to put a foot on the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" ground to balance at a stop, and the low step-over frame makes it"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" accessible for all ability and mobility levels. The saddle is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" very soft, with a wide back to support your hip joints and a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" cutout in the center to redistribute that pressure. Rim brakes"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" deliver satisfactory braking control, and the wide tires provide"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" commuter, and the BMX-like handlebar offers space for mounting a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"This budget mountain bike from nHill performs well both on bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" paths and on the trail. The fork with 100mm of travel absorbs"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" gears for finding a comfortable pace to ride uphill, and the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" affordable bike that you can take to work, but also take trail in"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mountains on the weekends or you’re just after a stable,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" comfortable ride for the bike path, the Summit gives a good value"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"An artsy, retro-inspired bicycle that’s as functional as it is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 9-speed drivetrain has enough gears for coasting in the city, but"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" you from mud, and a rear basket lets you transport groceries,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flowers and books. The ThrillCycle comes with a limited lifetime"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.condition"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"condition"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">index</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">index</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">definition</span><span class="o">=</span><span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bicycle:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">bid</span><span class="p">,</span> <span class="n">bicycle</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bicycles</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">"bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">Path</span><span class="o">.</span><span class="n">root_path</span><span class="p">(),</span> <span class="n">bicycle</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"*"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Documents found:"</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:0',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Velorim",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Jigger",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":270,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">)</span><span class="o">.</span><span class="n">return_field</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_field</span><span class="o">=</span><span class="s2">"price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [Document {'id': 'bicycle:0', 'payload': None, 'price': '270'}]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"basic @price:[500 1000]"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:5',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Breakout",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"XBN 2.1 Alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":810,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s1">'@brand:"Noka Bikes"'</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:4',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Noka Bikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Kahuna",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%a</span><span class="s2">nalitics%"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note the typo in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%%</span><span class="s2">analitycs</span><span class="si">%%</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note 2 typos in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:hill*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:1',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:*bike"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:6',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"ScramBikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"WattBike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":2300,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"w'H?*craft'"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">()</span><span class="o">.</span><span class="n">scorer</span><span class="p">(</span><span class="s2">"BM25"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">req</span> <span class="o">=</span> <span class="n">aggregations</span><span class="o">.</span><span class="n">AggregateRequest</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="o">.</span><span class="n">group_by</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@condition"</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">"count"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">req</span><span class="p">)</span><span class="o">.</span><span class="n">rows</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [['condition', 'refurbished', 'count', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'count', '4'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'count', '5']]</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_quickstart-stepwildcard_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_quickstart-stepwildcard_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_quickstart.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="javascript" id="Nodejs_search_quickstart-stepwildcard_query" name="search_quickstart-stepwildcard_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Nodejs_search_quickstart-stepwildcard_query" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-search_quickstart-stepwildcard_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_search_quickstart-stepwildcard_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">AggregateGroupByReducers</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">createClient</span><span class="p">,</span> <span class="nx">SchemaFieldTypes</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycle1</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Velorim'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Small and powerful, the Jigger is the best '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ride for the smallest of tikes! This is the tiniest kids\u2019 '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'pedal bike on the market available without a coaster brake, the '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Jigger is the vehicle of choice for the rare tenacious little'</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'rider raring to go.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycle1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Bicyk'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Hillcraft'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Nord'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Chook air 5'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Eva'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Eva 291'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Noka Bikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Kahuna'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Breakout'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'XBN 2.1 Alloy'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'ScramBikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'WattBike'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Peaknetic'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Secto'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'nHill'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Summit'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'ThrillCycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'BikeShind'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'refurbished'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">];</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.brand'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">SORTABLE</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'brand'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.model'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'model'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.description'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.price'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">NUMERIC</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'price'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.condition'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TAG</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'condition'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">try</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="nx">schema</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ON</span><span class="o">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PREFIX</span><span class="o">:</span> <span class="s1">'bicycle:'</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">message</span> <span class="o">===</span> <span class="s1">'Index already exists'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Index exists already, skipped creation.'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Something went wrong, perhaps RediSearch isn't installed...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">process</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycles</span><span class="p">.</span><span class="nx">map</span><span class="p">((</span><span class="nx">bicycle</span><span class="p">,</span> <span class="nx">i</span><span class="p">)</span> <span class="p">=></span> <span class="nx">client</span><span class="p">.</span><span class="nx">json</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="sb">`bicycle:</span><span class="si">${</span><span class="nx">i</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span> <span class="s1">'$'</span><span class="p">,</span> <span class="nx">bicycle</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kd">let</span> <span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"><span class="p">});</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="cm">/*
</span></span></span><span class="line hl"><span class="cl"><span class="cm">{
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "total": 10,
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "documents": ...
</span></span></span><span class="line hl"><span class="cl"><span class="cm">}
</span></span></span><span class="line hl"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@model:Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:0",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Velorim",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Jigger",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 270,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "new"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm"> */</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@brand:"Noka Bikes"'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:4",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Noka Bikes",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Kahuna",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 3200,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "used"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Nodejs_search_quickstart-stepwildcard_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Nodejs_search_quickstart-stepwildcard_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/nodejs/" tabindex="1" title="Quick-Start">
Node.js Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/node-redis/tree/emb-examples/doctests/search-quickstart.js" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="java" id="Java_search_quickstart-stepwildcard_query" name="search_quickstart-stepwildcard_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Java_search_quickstart-stepwildcard_query" title="Open example">
Java
</label>
<div aria-labelledby="tab-search_quickstart-stepwildcard_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_search_quickstart-stepwildcard_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nn">io.redis.examples</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.math.BigDecimal</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.exceptions.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.aggr.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.schemafields.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">class</span> <span class="nc">Bicycle</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="nf">Bicycle</span><span class="o">(</span><span class="n">String</span> <span class="n">brand</span><span class="o">,</span> <span class="n">String</span> <span class="n">model</span><span class="o">,</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">,</span> <span class="n">String</span> <span class="n">condition</span><span class="o">,</span> <span class="n">String</span> <span class="n">description</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">brand</span> <span class="o">=</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">price</span> <span class="o">=</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">condition</span> <span class="o">=</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SearchQuickstartExample</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// UnifiedJedis jedis = new UnifiedJedis("redis://localhost:6379");
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">JedisPooled</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JedisPooled</span><span class="o">(</span><span class="s">"localhost"</span><span class="o">,</span> <span class="mi">6379</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">SchemaField</span><span class="o">[]</span> <span class="n">schema</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.brand"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"brand"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.model"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"model"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.description"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"description"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.price"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"price"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.condition"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">ftCreate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span><span class="o">.</span><span class="na">createParams</span><span class="o">()</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">on</span><span class="o">(</span><span class="n">IndexDataType</span><span class="o">.</span><span class="na">JSON</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">addPrefix</span><span class="o">(</span><span class="s">"bicycle:"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span>
</span></span><span class="line"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Bicycle</span><span class="o">[]</span> <span class="n">bicycles</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Velorim"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Jigger"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">270</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Bicyk"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Hillcraft"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Nord"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Chook air 5"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva 291"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3400</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It's a "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Noka Bikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kahuna"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Breakout"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"XBN 2.1 Alloy"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">810</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ScramBikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"WattBike"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">2300</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Peaknetic"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Secto"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">430</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"nHill"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Summit"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ThrillCycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"BikeShind"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"refurbished"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">bicycles</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">jsonSetWithEscape</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"bicycle:%d"</span><span class="o">,</span> <span class="n">i</span><span class="o">),</span> <span class="n">bicycles</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="n">Query</span> <span class="n">query1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"*"</span><span class="o">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query1</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Documents found:"</span> <span class="o">+</span> <span class="n">result1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Prints: Documents found: 10
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query2</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result2</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Velorim","model":"Jigger","price":270,"description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">).</span><span class="na">returnFields</span><span class="o">(</span><span class="s">"price"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query3</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result3</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null, properties:[price=270]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query4</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"basic @price:[500 1000]"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query4</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result4</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:5, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Breakout","model":"XBN 2.1 Alloy","price":810,"description":"The XBN 2.1 Alloy is our entry-level road bike – but that’s not to say that it’s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which doesn’t break the bank and delivers craved performance.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query5</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@brand:\"Noka Bikes\""</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result5</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query5</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result5</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:4, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Noka Bikes","model":"Kahuna","price":3200,"description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","condition":"used"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationBuilder</span> <span class="n">ab</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">).</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@condition"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">count</span><span class="o">().</span><span class="na">as</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">ar</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftAggregate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">ab</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">();</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span> <span class="o">+</span> <span class="s">" - "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// refurbished - 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// used - 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// new - 4
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">assertEquals</span><span class="o">(</span><span class="s">"Validate aggregation results"</span><span class="o">,</span> <span class="mi">3</span><span class="o">,</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">());</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Java_search_quickstart-stepwildcard_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Java_search_quickstart-stepwildcard_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/java/jedis/" tabindex="1" title="Quick-Start">
Java Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/jedis/tree/master/src/test/java/io/redis/examples/SearchQuickstartExample.java" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="dotnet" id="Csharp_search_quickstart-stepwildcard_query" name="search_quickstart-stepwildcard_query" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Csharp_search_quickstart-stepwildcard_query" title="Open example">
C#
</label>
<div aria-labelledby="tab-search_quickstart-stepwildcard_query" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_search_quickstart-stepwildcard_query" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-C#" data-lang="C#"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.RedisStackCommands</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Aggregation</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Literals.Enums</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Tests</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">StackExchange.Redis</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">public</span> <span class="k">class</span> <span class="nc">SearchQuickstartExample</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">public</span> <span class="k">void</span> <span class="n">run</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">redis</span> <span class="p">=</span> <span class="n">ConnectionMultiplexer</span><span class="p">.</span><span class="n">Connect</span><span class="p">(</span><span class="s">"localhost:6379"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">db</span> <span class="p">=</span> <span class="n">redis</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">ft</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">json</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">JSON</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bike1</span> <span class="p">=</span> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">270</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bicycles</span> <span class="p">=</span> <span class="k">new</span> <span class="kt">object</span><span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">bike1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3400</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It’s a "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">810</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">2300</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">430</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">schema</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Schema</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Brand"</span><span class="p">,</span> <span class="s">"Brand"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Model"</span><span class="p">,</span> <span class="s">"Model"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Description"</span><span class="p">,</span> <span class="s">"Description"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddNumericField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Price"</span><span class="p">,</span> <span class="s">"Price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTagField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Condition"</span><span class="p">,</span> <span class="s">"Condition"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">ft</span><span class="p">.</span><span class="n">Create</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"idx:bicycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">().</span><span class="n">On</span><span class="p">(</span><span class="n">IndexDataType</span><span class="p">.</span><span class="n">JSON</span><span class="p">).</span><span class="n">Prefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">bicycles</span><span class="p">.</span><span class="n">Length</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">json</span><span class="p">.</span><span class="n">Set</span><span class="p">(</span><span class="s">$"bicycle:{i}"</span><span class="p">,</span> <span class="s">"$"</span><span class="p">,</span> <span class="n">bicycles</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">query1</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"*"</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query1</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res1</span><span class="p">.</span><span class="n">Count</span><span class="p">()));</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Prints: Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query2</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query2</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res2</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query3</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"basic @Price:[500 1000]"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query3</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res3</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query4</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Brand:\"Noka Bikes\""</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query4</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res4</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query5</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">).</span><span class="n">ReturnFields</span><span class="p">(</span><span class="s">"Price"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res5</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query5</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res5</span><span class="p">.</span><span class="n">First</span><span class="p">()[</span><span class="s">"Price"</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: 270</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">request</span> <span class="p">=</span> <span class="k">new</span> <span class="n">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">).</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"@Condition"</span><span class="p">,</span> <span class="n">Reducers</span><span class="p">.</span><span class="n">Count</span><span class="p">().</span><span class="n">As</span><span class="p">(</span><span class="s">"Count"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Aggregate</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">request</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">var</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">result</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">row</span> <span class="p">=</span> <span class="n">result</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"{row["</span><span class="n">Condition</span><span class="s">"]} - {row["</span><span class="n">Count</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// refurbished - 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// used - 5</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// new - 4</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Csharp_search_quickstart-stepwildcard_query')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Csharp_search_quickstart-stepwildcard_query" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/dotnet/" tabindex="1" title="Quick-Start">
C# Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/NRedisStack/tree/master/tests/Doc/SearchQuickstartExample.cs" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h3 id="single-term-full-text-query">
Single-term full-text query
</h3>
<p>
The following command shows a simple single-term query for finding all bicycles with a specific model:
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_quickstart-stepquery_single_term">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_quickstart-stepquery_single_term" name="search_quickstart-stepquery_single_term" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_quickstart-stepquery_single_term" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_single_term" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_quickstart-stepquery_single_term" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> FT.SEARCH "idx:bicycle" "@model:Jigger" LIMIT 0 10
</span></span><span class="line hl"><span class="cl">1) (integer) 1
</span></span><span class="line hl"><span class="cl">2) "bicycle:0"
</span></span><span class="line hl"><span class="cl">3) 1) "$"
</span></span><span class="line hl"><span class="cl"> 2) "{\"brand\":\"Velorim\",\"model\":\"Jigger\",\"price\":270,\"description\":\"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids\xe2\x80\x99 pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.\",\"condition\":\"new\"}"</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_quickstart-stepquery_single_term')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_quickstart-stepquery_single_term" name="search_quickstart-stepquery_single_term" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_quickstart-stepquery_single_term" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_single_term" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_quickstart-stepquery_single_term" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for document database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/document-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.aggregation</span> <span class="k">as</span> <span class="nn">aggregations</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.reducers</span> <span class="k">as</span> <span class="nn">reducers</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.json.path</span> <span class="kn">import</span> <span class="n">Path</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="n">NumericField</span><span class="p">,</span> <span class="n">TagField</span><span class="p">,</span> <span class="n">TextField</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bicycle</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Small and powerful, the Jigger is the best ride "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"for the smallest of tikes! This is the tiniest "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"kids’ pedal bike on the market available without"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a coaster brake, the Jigger is the vehicle of "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"choice for the rare tenacious little rider "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycle</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Kids want to ride with as little weight as possible."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Especially on an incline! They may be at the age "</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'when a 27.5" wheel bike is just too clumsy coming '</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'off a 24" bike. The Hillcraft 26 is just the solution'</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The Chook Air 5 gives kids aged six years and older "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"a durable and uberlight mountain bike for their first"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" experience on tracks and easy cruising through forests"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and fields. The lower top tube makes it easy to mount"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and dismount in any situation, giving your kids greater"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The sister company to Nord, Eva launched in 2005 as the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" first and only women-dedicated bicycle brand. Designed"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" by women for women, allEva bikes are optimized for the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" feminine physique using analytics from a body metrics"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" database. If you like 29ers, try the Eva 291. It’s a "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand new bike for 2022.. This full-suspension, "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"cross-country ride has been designed for velocity. The"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 291 has 100mm of front and rear travel, a superlight "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Whether you want to try your hand at XC racing or are "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"looking for a lively trail bike that's just as inspiring"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" on the climbs as it is over rougher ground, the Wilder"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" is one heck of a bike built specifically for short women."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Both the frames and components have been tweaked to "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"include a women’s saddle, different bars and unique "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" not to say that it’s a basic machine. With an internal "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Claris gears from Shimano’s, this is a bike which doesn’t"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The WattBike is the best e-bike for people who still feel young"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" more than 60 miles on one charge. It’s great for tackling hilly"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" terrain or if you just fancy a more leisurely ride. With three"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" working modes, you can choose between E-bike, assisted bicycle,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"If you struggle with stiff fingers or a kinked neck or back after"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a few minutes on the road, this lightweight, aluminum bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" alleviates those issues and allows you to enjoy the ride. From"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" the ergonomic grips to the lumbar-supporting seat position, the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" tube facilitates stability by allowing you to put a foot on the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" ground to balance at a stop, and the low step-over frame makes it"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" accessible for all ability and mobility levels. The saddle is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" very soft, with a wide back to support your hip joints and a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" cutout in the center to redistribute that pressure. Rim brakes"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" deliver satisfactory braking control, and the wide tires provide"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" commuter, and the BMX-like handlebar offers space for mounting a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"This budget mountain bike from nHill performs well both on bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" paths and on the trail. The fork with 100mm of travel absorbs"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" gears for finding a comfortable pace to ride uphill, and the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" affordable bike that you can take to work, but also take trail in"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mountains on the weekends or you’re just after a stable,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" comfortable ride for the bike path, the Summit gives a good value"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"An artsy, retro-inspired bicycle that’s as functional as it is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 9-speed drivetrain has enough gears for coasting in the city, but"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" you from mud, and a rear basket lets you transport groceries,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flowers and books. The ThrillCycle comes with a limited lifetime"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.condition"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"condition"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">index</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">index</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">definition</span><span class="o">=</span><span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bicycle:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">bid</span><span class="p">,</span> <span class="n">bicycle</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bicycles</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">"bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">Path</span><span class="o">.</span><span class="n">root_path</span><span class="p">(),</span> <span class="n">bicycle</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Documents found:"</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># 'id': 'bicycle:0',</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "brand":"Velorim",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "model":"Jigger",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "price":270,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">)</span><span class="o">.</span><span class="n">return_field</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_field</span><span class="o">=</span><span class="s2">"price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [Document {'id': 'bicycle:0', 'payload': None, 'price': '270'}]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"basic @price:[500 1000]"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:5',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Breakout",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"XBN 2.1 Alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":810,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s1">'@brand:"Noka Bikes"'</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:4',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Noka Bikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Kahuna",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%a</span><span class="s2">nalitics%"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note the typo in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%%</span><span class="s2">analitycs</span><span class="si">%%</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note 2 typos in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:hill*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:1',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:*bike"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:6',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"ScramBikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"WattBike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":2300,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"w'H?*craft'"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">()</span><span class="o">.</span><span class="n">scorer</span><span class="p">(</span><span class="s2">"BM25"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">req</span> <span class="o">=</span> <span class="n">aggregations</span><span class="o">.</span><span class="n">AggregateRequest</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="o">.</span><span class="n">group_by</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@condition"</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">"count"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">req</span><span class="p">)</span><span class="o">.</span><span class="n">rows</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [['condition', 'refurbished', 'count', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'count', '4'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'count', '5']]</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_quickstart-stepquery_single_term')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_quickstart-stepquery_single_term" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_quickstart.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="javascript" id="Nodejs_search_quickstart-stepquery_single_term" name="search_quickstart-stepquery_single_term" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Nodejs_search_quickstart-stepquery_single_term" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_single_term" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_search_quickstart-stepquery_single_term" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">AggregateGroupByReducers</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">createClient</span><span class="p">,</span> <span class="nx">SchemaFieldTypes</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycle1</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Velorim'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Small and powerful, the Jigger is the best '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ride for the smallest of tikes! This is the tiniest kids\u2019 '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'pedal bike on the market available without a coaster brake, the '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Jigger is the vehicle of choice for the rare tenacious little'</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'rider raring to go.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycle1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Bicyk'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Hillcraft'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Nord'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Chook air 5'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Eva'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Eva 291'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Noka Bikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Kahuna'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Breakout'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'XBN 2.1 Alloy'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'ScramBikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'WattBike'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Peaknetic'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Secto'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'nHill'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Summit'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'ThrillCycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'BikeShind'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'refurbished'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">];</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.brand'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">SORTABLE</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'brand'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.model'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'model'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.description'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.price'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">NUMERIC</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'price'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.condition'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TAG</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'condition'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">try</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="nx">schema</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ON</span><span class="o">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PREFIX</span><span class="o">:</span> <span class="s1">'bicycle:'</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">message</span> <span class="o">===</span> <span class="s1">'Index already exists'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Index exists already, skipped creation.'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Something went wrong, perhaps RediSearch isn't installed...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">process</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycles</span><span class="p">.</span><span class="nx">map</span><span class="p">((</span><span class="nx">bicycle</span><span class="p">,</span> <span class="nx">i</span><span class="p">)</span> <span class="p">=></span> <span class="nx">client</span><span class="p">.</span><span class="nx">json</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="sb">`bicycle:</span><span class="si">${</span><span class="nx">i</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span> <span class="s1">'$'</span><span class="p">,</span> <span class="nx">bicycle</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 10,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": ...
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'@model:Jigger'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"><span class="p">});</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line hl"><span class="cl"><span class="cm">/*
</span></span></span><span class="line hl"><span class="cl"><span class="cm">{
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "id": "bicycle:0",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "brand": "Velorim",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "model": "Jigger",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "price": 270,
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "condition": "new"
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> }
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line hl"><span class="cl"><span class="cm">}
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> */</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@brand:"Noka Bikes"'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:4",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Noka Bikes",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Kahuna",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 3200,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "used"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Nodejs_search_quickstart-stepquery_single_term')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Nodejs_search_quickstart-stepquery_single_term" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/nodejs/" tabindex="1" title="Quick-Start">
Node.js Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/node-redis/tree/emb-examples/doctests/search-quickstart.js" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="java" id="Java_search_quickstart-stepquery_single_term" name="search_quickstart-stepquery_single_term" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Java_search_quickstart-stepquery_single_term" title="Open example">
Java
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_single_term" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_search_quickstart-stepquery_single_term" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nn">io.redis.examples</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.math.BigDecimal</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.exceptions.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.aggr.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.schemafields.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">class</span> <span class="nc">Bicycle</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="nf">Bicycle</span><span class="o">(</span><span class="n">String</span> <span class="n">brand</span><span class="o">,</span> <span class="n">String</span> <span class="n">model</span><span class="o">,</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">,</span> <span class="n">String</span> <span class="n">condition</span><span class="o">,</span> <span class="n">String</span> <span class="n">description</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">brand</span> <span class="o">=</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">price</span> <span class="o">=</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">condition</span> <span class="o">=</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SearchQuickstartExample</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// UnifiedJedis jedis = new UnifiedJedis("redis://localhost:6379");
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">JedisPooled</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JedisPooled</span><span class="o">(</span><span class="s">"localhost"</span><span class="o">,</span> <span class="mi">6379</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">SchemaField</span><span class="o">[]</span> <span class="n">schema</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.brand"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"brand"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.model"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"model"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.description"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"description"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.price"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"price"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.condition"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">ftCreate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span><span class="o">.</span><span class="na">createParams</span><span class="o">()</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">on</span><span class="o">(</span><span class="n">IndexDataType</span><span class="o">.</span><span class="na">JSON</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">addPrefix</span><span class="o">(</span><span class="s">"bicycle:"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span>
</span></span><span class="line"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Bicycle</span><span class="o">[]</span> <span class="n">bicycles</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Velorim"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Jigger"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">270</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Bicyk"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Hillcraft"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Nord"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Chook air 5"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva 291"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3400</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It's a "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Noka Bikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kahuna"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Breakout"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"XBN 2.1 Alloy"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">810</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ScramBikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"WattBike"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">2300</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Peaknetic"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Secto"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">430</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"nHill"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Summit"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ThrillCycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"BikeShind"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"refurbished"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">bicycles</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">jsonSetWithEscape</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"bicycle:%d"</span><span class="o">,</span> <span class="n">i</span><span class="o">),</span> <span class="n">bicycles</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"*"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query1</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Documents found:"</span> <span class="o">+</span> <span class="n">result1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Query</span> <span class="n">query2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query2</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result2</span><span class="o">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null,
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Velorim","model":"Jigger","price":270,"description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">).</span><span class="na">returnFields</span><span class="o">(</span><span class="s">"price"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query3</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result3</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null, properties:[price=270]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query4</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"basic @price:[500 1000]"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query4</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result4</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:5, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Breakout","model":"XBN 2.1 Alloy","price":810,"description":"The XBN 2.1 Alloy is our entry-level road bike – but that’s not to say that it’s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which doesn’t break the bank and delivers craved performance.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query5</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@brand:\"Noka Bikes\""</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result5</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query5</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result5</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:4, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Noka Bikes","model":"Kahuna","price":3200,"description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","condition":"used"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationBuilder</span> <span class="n">ab</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">).</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@condition"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">count</span><span class="o">().</span><span class="na">as</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">ar</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftAggregate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">ab</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">();</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span> <span class="o">+</span> <span class="s">" - "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// refurbished - 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// used - 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// new - 4
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">assertEquals</span><span class="o">(</span><span class="s">"Validate aggregation results"</span><span class="o">,</span> <span class="mi">3</span><span class="o">,</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">());</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Java_search_quickstart-stepquery_single_term')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Java_search_quickstart-stepquery_single_term" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/java/jedis/" tabindex="1" title="Quick-Start">
Java Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/jedis/tree/master/src/test/java/io/redis/examples/SearchQuickstartExample.java" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="dotnet" id="Csharp_search_quickstart-stepquery_single_term" name="search_quickstart-stepquery_single_term" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Csharp_search_quickstart-stepquery_single_term" title="Open example">
C#
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_single_term" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_search_quickstart-stepquery_single_term" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-C#" data-lang="C#"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.RedisStackCommands</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Aggregation</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Literals.Enums</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Tests</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">StackExchange.Redis</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">public</span> <span class="k">class</span> <span class="nc">SearchQuickstartExample</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">public</span> <span class="k">void</span> <span class="n">run</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">redis</span> <span class="p">=</span> <span class="n">ConnectionMultiplexer</span><span class="p">.</span><span class="n">Connect</span><span class="p">(</span><span class="s">"localhost:6379"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">db</span> <span class="p">=</span> <span class="n">redis</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">ft</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">json</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">JSON</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bike1</span> <span class="p">=</span> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">270</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bicycles</span> <span class="p">=</span> <span class="k">new</span> <span class="kt">object</span><span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">bike1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3400</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It’s a "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">810</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">2300</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">430</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">schema</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Schema</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Brand"</span><span class="p">,</span> <span class="s">"Brand"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Model"</span><span class="p">,</span> <span class="s">"Model"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Description"</span><span class="p">,</span> <span class="s">"Description"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddNumericField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Price"</span><span class="p">,</span> <span class="s">"Price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTagField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Condition"</span><span class="p">,</span> <span class="s">"Condition"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">ft</span><span class="p">.</span><span class="n">Create</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"idx:bicycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">().</span><span class="n">On</span><span class="p">(</span><span class="n">IndexDataType</span><span class="p">.</span><span class="n">JSON</span><span class="p">).</span><span class="n">Prefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">bicycles</span><span class="p">.</span><span class="n">Length</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">json</span><span class="p">.</span><span class="n">Set</span><span class="p">(</span><span class="s">$"bicycle:{i}"</span><span class="p">,</span> <span class="s">"$"</span><span class="p">,</span> <span class="n">bicycles</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query1</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"*"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query1</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res1</span><span class="p">.</span><span class="n">Count</span><span class="p">()));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">query2</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query2</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res2</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query3</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"basic @Price:[500 1000]"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query3</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res3</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query4</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Brand:\"Noka Bikes\""</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query4</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res4</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query5</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">).</span><span class="n">ReturnFields</span><span class="p">(</span><span class="s">"Price"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res5</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query5</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res5</span><span class="p">.</span><span class="n">First</span><span class="p">()[</span><span class="s">"Price"</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: 270</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">request</span> <span class="p">=</span> <span class="k">new</span> <span class="n">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">).</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"@Condition"</span><span class="p">,</span> <span class="n">Reducers</span><span class="p">.</span><span class="n">Count</span><span class="p">().</span><span class="n">As</span><span class="p">(</span><span class="s">"Count"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Aggregate</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">request</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">var</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">result</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">row</span> <span class="p">=</span> <span class="n">result</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"{row["</span><span class="n">Condition</span><span class="s">"]} - {row["</span><span class="n">Count</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// refurbished - 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// used - 5</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// new - 4</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Csharp_search_quickstart-stepquery_single_term')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Csharp_search_quickstart-stepquery_single_term" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/dotnet/" tabindex="1" title="Quick-Start">
C# Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/NRedisStack/tree/master/tests/Doc/SearchQuickstartExample.cs" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<h3 id="exact-match-query">
Exact match query
</h3>
<p>
Below is a command to perform an exact match query that finds all bicycles with the brand name
<code>
Noka Bikes
</code>
. You must use double quotes around the search term when constructing an exact match query on a text field.
</p>
<div class="codetabs cli group flex justify-start items-center flex-wrap box-border rounded-lg mt-0 mb-0 mx-auto bg-slate-900" id="search_quickstart-stepquery_exact_matching">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_search_quickstart-stepquery_exact_matching" name="search_quickstart-stepquery_exact_matching" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="redis-cli_search_quickstart-stepquery_exact_matching" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_exact_matching" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_search_quickstart-stepquery_exact_matching" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> FT.SEARCH "idx:bicycle" "@brand:\"Noka Bikes\"" LIMIT 0 10
</span></span><span class="line hl"><span class="cl">1) (integer) 1
</span></span><span class="line hl"><span class="cl">2) "bicycle:4"
</span></span><span class="line hl"><span class="cl">3) 1) "$"
</span></span><span class="line hl"><span class="cl"> 2) "{\"brand\":\"Noka Bikes\",\"model\":\"Kahuna\",\"price\":3200,\"description\":\"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\xe2\x80\x99s saddle, different bars and unique colourway.\",\"condition\":\"used\"}"</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_redis-cli_search_quickstart-stepquery_exact_matching')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<div class="flex-1 text-xs text-white overflow-ellipsis">
Are you tired of using redis-cli? Try Redis Insight - the developer GUI for Redis.
</div>
<div class="text-right">
<a class="rounded rounded-mx px-2 py-1 flex items-center text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.com/redis-enterprise/redis-insight/" tabindex="1" title="Get Redis Insight">
<svg class="w-4 h-4 mr-1" fill="none" height="14" viewbox="0 0 14 14" width="14" xmlns="http://www.w3.org/2000/svg">
<path d="M2.26236 5.66895L1.21732 6.07172L7.00018 8.65693V7.79842L2.26236 5.66895Z" fill="#fca5a5">
</path>
<path d="M2.26236 8.02271L1.21732 8.42548L7.00018 11.0119V10.1516L2.26236 8.02271Z" fill="#fca5a5">
</path>
<path d="M1.21732 3.7175L7.00018 6.30392V2.87805L8.66273 2.13423L7.00018 1.49512L1.21732 3.7175Z" fill="#fca5a5">
</path>
<path d="M7.00018 2.8781V6.30366L1.21732 3.71724V5.20004L7.00018 7.79705V8.65526L1.21732 6.07217V7.55496L7.00018 10.1553V11.0135L1.21732 8.42376V9.90656H1.18878L7.00018 12.5051L8.66273 11.7613V2.13428L7.00018 2.8781Z" fill="#f87171">
</path>
<path d="M9.07336 11.5777L10.7359 10.8338V4.01538L9.07336 4.7592V11.5777Z" fill="#f87171">
</path>
<path d="M9.07336 4.75867L10.7359 4.01485L9.07336 3.37573V4.75867Z" fill="#fca5a5">
</path>
<path d="M11.1481 10.6497L12.8112 9.90591V5.896L11.1487 6.63982L11.1481 10.6497Z" fill="#f87171">
</path>
<path d="M11.1481 6.63954L12.8112 5.89572L11.1481 5.25781V6.63954Z" fill="#fca5a5">
</path>
</svg>
<span>
Get Redis Insight
</span>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="python" id="Python_search_quickstart-stepquery_exact_matching" name="search_quickstart-stepquery_exact_matching" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Python_search_quickstart-stepquery_exact_matching" title="Open example">
Python
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_exact_matching" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_search_quickstart-stepquery_exact_matching" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="s2">"""
</span></span></span><span class="line"><span class="cl"><span class="s2">Code samples for document database quickstart pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/get-started/document-database/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.aggregation</span> <span class="k">as</span> <span class="nn">aggregations</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.commands.search.reducers</span> <span class="k">as</span> <span class="nn">reducers</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.json.path</span> <span class="kn">import</span> <span class="n">Path</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.field</span> <span class="kn">import</span> <span class="n">NumericField</span><span class="p">,</span> <span class="n">TagField</span><span class="p">,</span> <span class="n">TextField</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.indexDefinition</span> <span class="kn">import</span> <span class="n">IndexDefinition</span><span class="p">,</span> <span class="n">IndexType</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.query</span> <span class="kn">import</span> <span class="n">Query</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">r</span> <span class="o">=</span> <span class="n">redis</span><span class="o">.</span><span class="n">Redis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">6379</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">decode_responses</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">bicycle</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Small and powerful, the Jigger is the best ride "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"for the smallest of tikes! This is the tiniest "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"kids’ pedal bike on the market available without"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a coaster brake, the Jigger is the vehicle of "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"choice for the rare tenacious little rider "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycle</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Kids want to ride with as little weight as possible."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Especially on an incline! They may be at the age "</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'when a 27.5" wheel bike is just too clumsy coming '</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'off a 24" bike. The Hillcraft 26 is just the solution'</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The Chook Air 5 gives kids aged six years and older "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"a durable and uberlight mountain bike for their first"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" experience on tracks and easy cruising through forests"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and fields. The lower top tube makes it easy to mount"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and dismount in any situation, giving your kids greater"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The sister company to Nord, Eva launched in 2005 as the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" first and only women-dedicated bicycle brand. Designed"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" by women for women, allEva bikes are optimized for the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" feminine physique using analytics from a body metrics"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" database. If you like 29ers, try the Eva 291. It’s a "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand new bike for 2022.. This full-suspension, "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"cross-country ride has been designed for velocity. The"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 291 has 100mm of front and rear travel, a superlight "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"Whether you want to try your hand at XC racing or are "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"looking for a lively trail bike that's just as inspiring"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" on the climbs as it is over rougher ground, the Wilder"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" is one heck of a bike built specifically for short women."</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Both the frames and components have been tweaked to "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"include a women’s saddle, different bars and unique "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" not to say that it’s a basic machine. With an internal "</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Claris gears from Shimano’s, this is a bike which doesn’t"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"The WattBike is the best e-bike for people who still feel young"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" more than 60 miles on one charge. It’s great for tackling hilly"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" terrain or if you just fancy a more leisurely ride. With three"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" working modes, you can choose between E-bike, assisted bicycle,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"If you struggle with stiff fingers or a kinked neck or back after"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a few minutes on the road, this lightweight, aluminum bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" alleviates those issues and allows you to enjoy the ride. From"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" the ergonomic grips to the lumbar-supporting seat position, the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" tube facilitates stability by allowing you to put a foot on the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" ground to balance at a stop, and the low step-over frame makes it"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" accessible for all ability and mobility levels. The saddle is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" very soft, with a wide back to support your hip joints and a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" cutout in the center to redistribute that pressure. Rim brakes"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" deliver satisfactory braking control, and the wide tires provide"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" commuter, and the BMX-like handlebar offers space for mounting a"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"This budget mountain bike from nHill performs well both on bike"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" paths and on the trail. The fork with 100mm of travel absorbs"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" gears for finding a comfortable pace to ride uphill, and the"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" affordable bike that you can take to work, but also take trail in"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" mountains on the weekends or you’re just after a stable,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" comfortable ride for the bike path, the Summit gives a good value"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"description"</span><span class="p">:</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"An artsy, retro-inspired bicycle that’s as functional as it is"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" 9-speed drivetrain has enough gears for coasting in the city, but"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" you from mud, and a rear basket lets you transport groceries,"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" flowers and books. The ThrillCycle comes with a limited lifetime"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"condition"</span><span class="p">:</span> <span class="s2">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.brand"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"brand"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.model"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"model"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="p">(</span><span class="s2">"$.description"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"description"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"price"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="p">(</span><span class="s2">"$.condition"</span><span class="p">,</span> <span class="n">as_name</span><span class="o">=</span><span class="s2">"condition"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">index</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">ft</span><span class="p">(</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">index</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">definition</span><span class="o">=</span><span class="n">IndexDefinition</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="p">[</span><span class="s2">"bicycle:"</span><span class="p">],</span> <span class="n">index_type</span><span class="o">=</span><span class="n">IndexType</span><span class="o">.</span><span class="n">JSON</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">bid</span><span class="p">,</span> <span class="n">bicycle</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">bicycles</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="sa">f</span><span class="s2">"bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="n">Path</span><span class="o">.</span><span class="n">root_path</span><span class="p">(),</span> <span class="n">bicycle</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"Documents found:"</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:0',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Velorim",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Jigger",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":270,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:Jigger"</span><span class="p">)</span><span class="o">.</span><span class="n">return_field</span><span class="p">(</span><span class="s2">"$.price"</span><span class="p">,</span> <span class="n">as_field</span><span class="o">=</span><span class="s2">"price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [Document {'id': 'bicycle:0', 'payload': None, 'price': '270'}]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"basic @price:[500 1000]"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:5',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Breakout",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"XBN 2.1 Alloy",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":810,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s1">'@brand:"Noka Bikes"'</span><span class="p">))</span>
</span></span><span class="line hl"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># 'id': 'bicycle:4',</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "brand":"Noka Bikes",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "model":"Kahuna",</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "price":3200,</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%a</span><span class="s2">nalitics%"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note the typo in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:</span><span class="si">%%</span><span class="s2">analitycs</span><span class="si">%%</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span> <span class="c1"># Note 2 typos in the word "analytics"</span>
</span></span><span class="line"><span class="cl"> <span class="mi">2</span>
</span></span><span class="line"><span class="cl"> <span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:3',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Eva",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Eva 291",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":3400,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "description":"...using analytics from a body metrics database...",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:hill*"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:1',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"@model:*bike"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> Result{1 total, docs: [</span>
</span></span><span class="line"><span class="cl"><span class="c1"># Document {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'id': 'bicycle:6',</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'payload': None,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># 'json': '{</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"ScramBikes",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"WattBike",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":2300,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"new"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }'</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }]}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"w'H?*craft'"</span><span class="p">)</span><span class="o">.</span><span class="n">dialect</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">json</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> {</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "brand":"Bicyk",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "model":"Hillcraft",</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "price":1200,</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ...</span>
</span></span><span class="line"><span class="cl"><span class="c1"># "condition":"used"</span>
</span></span><span class="line"><span class="cl"><span class="c1"># }</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">())</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">Query</span><span class="p">(</span><span class="s2">"mountain"</span><span class="p">)</span><span class="o">.</span><span class="n">with_scores</span><span class="p">()</span><span class="o">.</span><span class="n">scorer</span><span class="p">(</span><span class="s2">"BM25"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">sr</span> <span class="ow">in</span> <span class="n">res</span><span class="o">.</span><span class="n">docs</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">id</span><span class="si">}</span><span class="s2">: score=</span><span class="si">{</span><span class="n">sr</span><span class="o">.</span><span class="n">score</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">req</span> <span class="o">=</span> <span class="n">aggregations</span><span class="o">.</span><span class="n">AggregateRequest</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="o">.</span><span class="n">group_by</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"@condition"</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">count</span><span class="p">()</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s2">"count"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">res</span> <span class="o">=</span> <span class="n">index</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">req</span><span class="p">)</span><span class="o">.</span><span class="n">rows</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="c1"># >>> [['condition', 'refurbished', 'count', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'count', '4'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'count', '5']]</span>
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Python_search_quickstart-stepquery_exact_matching')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Python_search_quickstart-stepquery_exact_matching" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/python/redis-py/" tabindex="1" title="Quick-Start">
Python Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/redis-py/tree/master/doctests/search_quickstart.py" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="javascript" id="Nodejs_search_quickstart-stepquery_exact_matching" name="search_quickstart-stepquery_exact_matching" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Nodejs_search_quickstart-stepquery_exact_matching" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_exact_matching" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_search_quickstart-stepquery_exact_matching" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">AggregateGroupByReducers</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">createClient</span><span class="p">,</span> <span class="nx">SchemaFieldTypes</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'redis'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">client</span> <span class="o">=</span> <span class="nx">createClient</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">on</span><span class="p">(</span><span class="s1">'error'</span><span class="p">,</span> <span class="nx">err</span> <span class="p">=></span> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Redis Client Error'</span><span class="p">,</span> <span class="nx">err</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycle1</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Velorim'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">270</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Small and powerful, the Jigger is the best '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ride for the smallest of tikes! This is the tiniest kids\u2019 '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'pedal bike on the market available without a coaster brake, the '</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Jigger is the vehicle of choice for the rare tenacious little'</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'rider raring to go.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycle1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Bicyk'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Hillcraft'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Nord'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Chook air 5'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Eva'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Eva 291'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3400</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Noka Bikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Kahuna'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">3200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'used'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Breakout'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'XBN 2.1 Alloy'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">810</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'ScramBikes'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'WattBike'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">2300</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'Peaknetic'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Secto'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">430</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'nHill'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'Summit'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">1200</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'new'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">model</span><span class="o">:</span> <span class="s1">'ThrillCycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">brand</span><span class="o">:</span> <span class="s1">'BikeShind'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">price</span><span class="o">:</span> <span class="mi">815</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">description</span><span class="o">:</span> <span class="s1">'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">condition</span><span class="o">:</span> <span class="s1">'refurbished'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">];</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.brand'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">SORTABLE</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'brand'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.model'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'model'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.description'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TEXT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.price'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">NUMERIC</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'price'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'$.condition'</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">SchemaFieldTypes</span><span class="p">.</span><span class="nx">TAG</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">AS</span><span class="o">:</span> <span class="s1">'condition'</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">try</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="nx">schema</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ON</span><span class="o">:</span> <span class="s1">'JSON'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PREFIX</span><span class="o">:</span> <span class="s1">'bicycle:'</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">message</span> <span class="o">===</span> <span class="s1">'Index already exists'</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Index exists already, skipped creation.'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Something went wrong, perhaps RediSearch isn't installed...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">process</span><span class="p">.</span><span class="nx">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kr">await</span> <span class="nb">Promise</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="nx">bicycles</span><span class="p">.</span><span class="nx">map</span><span class="p">((</span><span class="nx">bicycle</span><span class="p">,</span> <span class="nx">i</span><span class="p">)</span> <span class="p">=></span> <span class="nx">client</span><span class="p">.</span><span class="nx">json</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="sb">`bicycle:</span><span class="si">${</span><span class="nx">i</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span> <span class="s1">'$'</span><span class="p">,</span> <span class="nx">bicycle</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 10,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": ...
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'@model:Jigger'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"><span class="cm">/*
</span></span></span><span class="line"><span class="cl"><span class="cm">{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line"><span class="cl"><span class="cm"> "id": "bicycle:0",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line"><span class="cl"><span class="cm"> "brand": "Velorim",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "model": "Jigger",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "price": 270,
</span></span></span><span class="line"><span class="cl"><span class="cm"> "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
</span></span></span><span class="line"><span class="cl"><span class="cm"> "condition": "new"
</span></span></span><span class="line"><span class="cl"><span class="cm"> }
</span></span></span><span class="line"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line"><span class="cl"><span class="cm">}
</span></span></span><span class="line"><span class="cl"><span class="cm"> */</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="nx">result</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">ft</span><span class="p">.</span><span class="nx">search</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'idx:bicycle'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'@brand:"Noka Bikes"'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">LIMIT</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">from</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">size</span><span class="o">:</span> <span class="mi">10</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}</span>
</span></span><span class="line hl"><span class="cl"><span class="p">);</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">result</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="mi">2</span><span class="p">));</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="cm">/*
</span></span></span><span class="line hl"><span class="cl"><span class="cm">{
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "total": 1,
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "documents": [{
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "id": "bicycle:4",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "value": {
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "brand": "Noka Bikes",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "model": "Kahuna",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "price": 3200,
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.",
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> "condition": "used"
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> }
</span></span></span><span class="line hl"><span class="cl"><span class="cm"> }]
</span></span></span><span class="line hl"><span class="cl"><span class="cm">}
</span></span></span><span class="line hl"><span class="cl"><span class="cm">*/</span>
</span></span><span class="line"><span class="cl">
</span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Nodejs_search_quickstart-stepquery_exact_matching')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Nodejs_search_quickstart-stepquery_exact_matching" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/nodejs/" tabindex="1" title="Quick-Start">
Node.js Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/node-redis/tree/emb-examples/doctests/search-quickstart.js" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="java" id="Java_search_quickstart-stepquery_exact_matching" name="search_quickstart-stepquery_exact_matching" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Java_search_quickstart-stepquery_exact_matching" title="Open example">
Java
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_exact_matching" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_search_quickstart-stepquery_exact_matching" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nn">io.redis.examples</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.math.BigDecimal</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.exceptions.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.aggr.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.search.schemafields.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">class</span> <span class="nc">Bicycle</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="n">String</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="nf">Bicycle</span><span class="o">(</span><span class="n">String</span> <span class="n">brand</span><span class="o">,</span> <span class="n">String</span> <span class="n">model</span><span class="o">,</span> <span class="n">BigDecimal</span> <span class="n">price</span><span class="o">,</span> <span class="n">String</span> <span class="n">condition</span><span class="o">,</span> <span class="n">String</span> <span class="n">description</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">brand</span> <span class="o">=</span> <span class="n">brand</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">model</span> <span class="o">=</span> <span class="n">model</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">price</span> <span class="o">=</span> <span class="n">price</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">condition</span> <span class="o">=</span> <span class="n">condition</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">this</span><span class="o">.</span><span class="na">description</span> <span class="o">=</span> <span class="n">description</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SearchQuickstartExample</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// UnifiedJedis jedis = new UnifiedJedis("redis://localhost:6379");
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">JedisPooled</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JedisPooled</span><span class="o">(</span><span class="s">"localhost"</span><span class="o">,</span> <span class="mi">6379</span><span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">SchemaField</span><span class="o">[]</span> <span class="n">schema</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.brand"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"brand"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.model"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"model"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TextField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.description"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"description"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">NumericField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.price"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"price"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">TagField</span><span class="o">.</span><span class="na">of</span><span class="o">(</span><span class="s">"$.condition"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">ftCreate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span><span class="o">.</span><span class="na">createParams</span><span class="o">()</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">on</span><span class="o">(</span><span class="n">IndexDataType</span><span class="o">.</span><span class="na">JSON</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">addPrefix</span><span class="o">(</span><span class="s">"bicycle:"</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span>
</span></span><span class="line"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Bicycle</span><span class="o">[]</span> <span class="n">bicycles</span> <span class="o">=</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Velorim"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Jigger"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">270</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Bicyk"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Hillcraft"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Nord"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Chook air 5"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Eva 291"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3400</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It's a "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Noka Bikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Kahuna"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">3200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"used"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Breakout"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"XBN 2.1 Alloy"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">810</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ScramBikes"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"WattBike"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">2300</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Peaknetic"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Secto"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">430</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"nHill"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"Summit"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">1200</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"new"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">Bicycle</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"ThrillCycle"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"BikeShind"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">BigDecimal</span><span class="o">(</span><span class="mi">815</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="s">"refurbished"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="o">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span>
</span></span><span class="line"><span class="cl"> <span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="o">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">bicycles</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">jsonSetWithEscape</span><span class="o">(</span><span class="n">String</span><span class="o">.</span><span class="na">format</span><span class="o">(</span><span class="s">"bicycle:%d"</span><span class="o">,</span> <span class="n">i</span><span class="o">),</span> <span class="n">bicycles</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query1</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"*"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query1</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="s">"Documents found:"</span> <span class="o">+</span> <span class="n">result1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query2</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query2</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result2</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Velorim","model":"Jigger","price":270,"description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query3</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@model:Jigger"</span><span class="o">).</span><span class="na">returnFields</span><span class="o">(</span><span class="s">"price"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query3</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result3</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:0, score: 1.0, payload:null, properties:[price=270]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">Query</span> <span class="n">query4</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"basic @price:[500 1000]"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query4</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result4</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: [id:bicycle:5, score: 1.0, payload:null,
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Breakout","model":"XBN 2.1 Alloy","price":810,"description":"The XBN 2.1 Alloy is our entry-level road bike – but that’s not to say that it’s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which doesn’t break the bank and delivers craved performance.","condition":"new"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Query</span> <span class="n">query5</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Query</span><span class="o">(</span><span class="s">"@brand:\"Noka Bikes\""</span><span class="o">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">Document</span><span class="o">></span> <span class="n">result5</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftSearch</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">query5</span><span class="o">).</span><span class="na">getDocuments</span><span class="o">();</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">result5</span><span class="o">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Prints: [id:bicycle:4, score: 1.0, payload:null,
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// properties:[$={"brand":"Noka Bikes","model":"Kahuna","price":3200,"description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","condition":"used"}]]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationBuilder</span> <span class="n">ab</span> <span class="o">=</span> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">).</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@condition"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">count</span><span class="o">().</span><span class="na">as</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">ar</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">ftAggregate</span><span class="o">(</span><span class="s">"idx:bicycle"</span><span class="o">,</span> <span class="n">ab</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">();</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"condition"</span><span class="o">)</span> <span class="o">+</span> <span class="s">" - "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="n">ar</span><span class="o">.</span><span class="na">getRow</span><span class="o">(</span><span class="n">i</span><span class="o">).</span><span class="na">getString</span><span class="o">(</span><span class="s">"count"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// refurbished - 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// used - 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// new - 4
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="n">assertEquals</span><span class="o">(</span><span class="s">"Validate aggregation results"</span><span class="o">,</span> <span class="mi">3</span><span class="o">,</span> <span class="n">ar</span><span class="o">.</span><span class="na">getTotalResults</span><span class="o">());</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">jedis</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Java_search_quickstart-stepquery_exact_matching')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Java_search_quickstart-stepquery_exact_matching" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/java/jedis/" tabindex="1" title="Quick-Start">
Java Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/jedis/tree/master/src/test/java/io/redis/examples/SearchQuickstartExample.java" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
<input class="radiotab w-0 h-0" data-lang="dotnet" id="Csharp_search_quickstart-stepquery_exact_matching" name="search_quickstart-stepquery_exact_matching" tabindex="1" type="radio"/>
<label class="justify-left label ml-4 pt-3.5 px-3 pb-1 cursor-pointer text-sm text-center bg-redis-ink-900 hover:text-redis-red-600 rounded rounded-mx transition duration-150 ease-in-out" for="Csharp_search_quickstart-stepquery_exact_matching" title="Open example">
C#
</label>
<div aria-labelledby="tab-search_quickstart-stepquery_exact_matching" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_search_quickstart-stepquery_exact_matching" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-C#" data-lang="C#"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.RedisStackCommands</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Aggregation</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Search.Literals.Enums</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack.Tests</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">StackExchange.Redis</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">public</span> <span class="k">class</span> <span class="nc">SearchQuickstartExample</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">public</span> <span class="k">void</span> <span class="n">run</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">redis</span> <span class="p">=</span> <span class="n">ConnectionMultiplexer</span><span class="p">.</span><span class="n">Connect</span><span class="p">(</span><span class="s">"localhost:6379"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">db</span> <span class="p">=</span> <span class="n">redis</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">ft</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">();</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">json</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">JSON</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bike1</span> <span class="p">=</span> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Velorim"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Jigger"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">270</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Small and powerful, the Jigger is the best ride "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"for the smallest of tikes! This is the tiniest "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"kids’ pedal bike on the market available without"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a coaster brake, the Jigger is the vehicle of "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"choice for the rare tenacious little rider "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"raring to go."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">bicycles</span> <span class="p">=</span> <span class="k">new</span> <span class="kt">object</span><span class="p">[]</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">bike1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Bicyk"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Hillcraft"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Kids want to ride with as little weight as possible."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Especially on an incline! They may be at the age "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"when a 27.5 inch wheel bike is just too clumsy coming "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"off a 24 inch bike. The Hillcraft 26 is just the solution"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" they need!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Nord"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Chook air 5"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The Chook Air 5 gives kids aged six years and older "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"a durable and uberlight mountain bike for their first"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" experience on tracks and easy cruising through forests"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and fields. The lower top tube makes it easy to mount"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and dismount in any situation, giving your kids greater"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" safety on the trails."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Eva"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Eva 291"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3400</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The sister company to Nord, Eva launched in 2005 as the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" first and only women-dedicated bicycle brand. Designed"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" by women for women, allEva bikes are optimized for the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" feminine physique using analytics from a body metrics"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" database. If you like 29ers, try the Eva 291. It’s a "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"brand new bike for 2022.. This full-suspension, "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"cross-country ride has been designed for velocity. The"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 291 has 100mm of front and rear travel, a superlight "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"aluminum frame and fast-rolling 29-inch wheels. Yippee!"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Noka Bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Kahuna"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">3200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"Whether you want to try your hand at XC racing or are "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"looking for a lively trail bike that's just as inspiring"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" on the climbs as it is over rougher ground, the Wilder"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" is one heck of a bike built specifically for short women."</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Both the frames and components have been tweaked to "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"include a women’s saddle, different bars and unique "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"colourway."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"used"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Breakout"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"XBN 2.1 Alloy"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">810</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The XBN 2.1 Alloy is our entry-level road bike – but that’s"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" not to say that it’s a basic machine. With an internal "</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">"weld aluminium frame, a full carbon fork, and the slick-shifting"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Claris gears from Shimano’s, this is a bike which doesn’t"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" break the bank and delivers craved performance."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"ScramBikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"WattBike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">2300</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"The WattBike is the best e-bike for people who still feel young"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" at heart. It has a Bafang 1000W mid-drive system and a 48V"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" more than 60 miles on one charge. It’s great for tackling hilly"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" terrain or if you just fancy a more leisurely ride. With three"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" working modes, you can choose between E-bike, assisted bicycle,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and normal bike modes."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"Peaknetic"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Secto"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">430</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"If you struggle with stiff fingers or a kinked neck or back after"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a few minutes on the road, this lightweight, aluminum bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" alleviates those issues and allows you to enjoy the ride. From"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" the ergonomic grips to the lumbar-supporting seat position, the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Roll Low-Entry offers incredible comfort. The rear-inclined seat"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" tube facilitates stability by allowing you to put a foot on the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" ground to balance at a stop, and the low step-over frame makes it"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" accessible for all ability and mobility levels. The saddle is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" very soft, with a wide back to support your hip joints and a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" cutout in the center to redistribute that pressure. Rim brakes"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" deliver satisfactory braking control, and the wide tires provide"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" a smooth, stable ride on paved roads and gravel. Rack and fender"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mounts facilitate setting up the Roll Low-Entry as your preferred"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" commuter, and the BMX-like handlebar offers space for mounting a"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flashlight, bell, or phone holder."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"nHill"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"Summit"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">1200</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"This budget mountain bike from nHill performs well both on bike"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" paths and on the trail. The fork with 100mm of travel absorbs"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" rough terrain. Fat Kenda Booster tires give you grip in corners"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" and on wet trails. The Shimano Tourney drivetrain offered enough"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" gears for finding a comfortable pace to ride uphill, and the"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" Tektro hydraulic disc brakes break smoothly. Whether you want an"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" affordable bike that you can take to work, but also take trail in"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" mountains on the weekends or you’re just after a stable,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" comfortable ride for the bike path, the Summit gives a good value"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" for money."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"new"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">Model</span> <span class="p">=</span> <span class="s">"ThrillCycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Brand</span> <span class="p">=</span> <span class="s">"BikeShind"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Price</span> <span class="p">=</span> <span class="m">815</span><span class="n">M</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Description</span> <span class="p">=</span> <span class="s">"An artsy, retro-inspired bicycle that’s as functional as it is"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" pretty: The ThrillCycle steel frame offers a smooth ride. A"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" 9-speed drivetrain has enough gears for coasting in the city, but"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" we wouldn’t suggest taking it to the mountains. Fenders protect"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" you from mud, and a rear basket lets you transport groceries,"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" flowers and books. The ThrillCycle comes with a limited lifetime"</span> <span class="p">+</span>
</span></span><span class="line"><span class="cl"> <span class="s">" warranty, so this little guy will last you long past graduation."</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Condition</span> <span class="p">=</span> <span class="s">"refurbished"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">};</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">schema</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Schema</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Brand"</span><span class="p">,</span> <span class="s">"Brand"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Model"</span><span class="p">,</span> <span class="s">"Model"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTextField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Description"</span><span class="p">,</span> <span class="s">"Description"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddNumericField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Price"</span><span class="p">,</span> <span class="s">"Price"</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddTagField</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"$.Condition"</span><span class="p">,</span> <span class="s">"Condition"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">ft</span><span class="p">.</span><span class="n">Create</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"idx:bicycle"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">().</span><span class="n">On</span><span class="p">(</span><span class="n">IndexDataType</span><span class="p">.</span><span class="n">JSON</span><span class="p">).</span><span class="n">Prefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">schema</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">bicycles</span><span class="p">.</span><span class="n">Length</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">json</span><span class="p">.</span><span class="n">Set</span><span class="p">(</span><span class="s">$"bicycle:{i}"</span><span class="p">,</span> <span class="s">"$"</span><span class="p">,</span> <span class="n">bicycles</span><span class="p">[</span><span class="n">i</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query1</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"*"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query1</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res1</span><span class="p">.</span><span class="n">Count</span><span class="p">()));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: Documents found: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query2</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query2</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res2</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query3</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"basic @Price:[500 1000]"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query3</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res3</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">query4</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Brand:\"Noka Bikes\""</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="kt">var</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query4</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="kt">string</span><span class="p">.</span><span class="n">Join</span><span class="p">(</span><span class="s">"\n"</span><span class="p">,</span> <span class="n">res4</span><span class="p">.</span><span class="n">Select</span><span class="p">(</span><span class="n">x</span> <span class="p">=></span> <span class="n">x</span><span class="p">[</span><span class="s">"json"</span><span class="p">])));</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// Prints: {"Brand":"Moore PLC","Model":"Award Race","Price":3790.76,</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// "Description":"This olive folding bike features a carbon frame</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// and 27.5 inch wheels. This folding bike is perfect for compact</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// storage and transportation.","Condition":"new"}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">query5</span> <span class="p">=</span> <span class="k">new</span> <span class="n">Query</span><span class="p">(</span><span class="s">"@Model:Jigger"</span><span class="p">).</span><span class="n">ReturnFields</span><span class="p">(</span><span class="s">"Price"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">res5</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Search</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">query5</span><span class="p">).</span><span class="n">Documents</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res5</span><span class="p">.</span><span class="n">First</span><span class="p">()[</span><span class="s">"Price"</span><span class="p">]);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints: 270</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">request</span> <span class="p">=</span> <span class="k">new</span> <span class="n">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">).</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"@Condition"</span><span class="p">,</span> <span class="n">Reducers</span><span class="p">.</span><span class="n">Count</span><span class="p">().</span><span class="n">As</span><span class="p">(</span><span class="s">"Count"</span><span class="p">));</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">result</span> <span class="p">=</span> <span class="n">ft</span><span class="p">.</span><span class="n">Aggregate</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">request</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="p">(</span><span class="kt">var</span> <span class="n">i</span> <span class="p">=</span> <span class="m">0</span><span class="p">;</span> <span class="n">i</span> <span class="p"><</span> <span class="n">result</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">;</span> <span class="n">i</span><span class="p">++)</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kt">var</span> <span class="n">row</span> <span class="p">=</span> <span class="n">result</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"{row["</span><span class="n">Condition</span><span class="s">"]} - {row["</span><span class="n">Count</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Prints:</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// refurbished - 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// used - 5</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// new - 4</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre>
</div>
<button class="clipboard-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-10 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="copyCodeToClipboard('#panel_Csharp_search_quickstart-stepquery_exact_matching')" tabindex="1" title="Copy to clipboard">
<svg fill="currentColor" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M9 43.95q-1.2 0-2.1-.9-.9-.9-.9-2.1V10.8h3v30.15h23.7v3Zm6-6q-1.2 0-2.1-.9-.9-.9-.9-2.1v-28q0-1.2.9-2.1.9-.9 2.1-.9h22q1.2 0 2.1.9.9.9.9 2.1v28q0 1.2-.9 2.1-.9.9-2.1.9Zm0-3h22v-28H15v28Zm0 0v-28 28Z">
</path>
</svg>
<div class="tooltip relative inline-block">
<span class="tooltiptext hidden bg-slate-200 rounded rounded-mx text-slate-800 text-center text-xs p-1 absolute right-6 bottom-4">
Copied!
</span>
</div>
</button>
<button aria-controls="panel_Csharp_search_quickstart-stepquery_exact_matching" class="visibility-button text-neutral-400 hover:text-slate-100 bg-slate-600 absolute -top-8 right-2 h-7 w-7 mr-2 mt-2 p-1 rounded rounded-mx" onclick="toggleVisibleLines(this)" tabindex="1" title="Toggle visibility">
<svg class="hidden" fill="currentColor" id="visibility-off" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="m31.45 27.05-2.2-2.2q1.3-3.55-1.35-5.9-2.65-2.35-5.75-1.2l-2.2-2.2q.85-.55 1.9-.8 1.05-.25 2.15-.25 3.55 0 6.025 2.475Q32.5 19.45 32.5 23q0 1.1-.275 2.175-.275 1.075-.775 1.875Zm6.45 6.45-2-2q2.45-1.8 4.275-4.025Q42 25.25 42.85 23q-2.5-5.55-7.5-8.775Q30.35 11 24.5 11q-2.1 0-4.3.4-2.2.4-3.45.95L14.45 10q1.75-.8 4.475-1.4Q21.65 8 24.25 8q7.15 0 13.075 4.075Q43.25 16.15 46 23q-1.3 3.2-3.35 5.85-2.05 2.65-4.75 4.65Zm2.9 11.3-8.4-8.25q-1.75.7-3.95 1.075T24 38q-7.3 0-13.25-4.075T2 23q1-2.6 2.775-5.075T9.1 13.2L2.8 6.9l2.1-2.15L42.75 42.6ZM11.15 15.3q-1.85 1.35-3.575 3.55Q5.85 21.05 5.1 23q2.55 5.55 7.675 8.775Q17.9 35 24.4 35q1.65 0 3.25-.2t2.4-.6l-3.2-3.2q-.55.25-1.35.375T24 31.5q-3.5 0-6-2.45T15.5 23q0-.75.125-1.5T16 20.15Zm15.25 7.1Zm-5.8 2.9Z">
</path>
</svg>
<svg fill="currentColor" id="visibility-on" viewbox="0 0 48 48" xmlns="http://www.w3.org/2000/svg">
<path d="M24 31.5q3.55 0 6.025-2.475Q32.5 26.55 32.5 23q0-3.55-2.475-6.025Q27.55 14.5 24 14.5q-3.55 0-6.025 2.475Q15.5 19.45 15.5 23q0 3.55 2.475 6.025Q20.45 31.5 24 31.5Zm0-2.9q-2.35 0-3.975-1.625T18.4 23q0-2.35 1.625-3.975T24 17.4q2.35 0 3.975 1.625T29.6 23q0 2.35-1.625 3.975T24 28.6Zm0 9.4q-7.3 0-13.2-4.15Q4.9 29.7 2 23q2.9-6.7 8.8-10.85Q16.7 8 24 8q7.3 0 13.2 4.15Q43.1 16.3 46 23q-2.9 6.7-8.8 10.85Q31.3 38 24 38Zm0-15Zm0 12q6.05 0 11.125-3.275T42.85 23q-2.65-5.45-7.725-8.725Q30.05 11 24 11t-11.125 3.275Q7.8 17.55 5.1 23q2.7 5.45 7.775 8.725Q17.95 35 24 35Z">
</path>
</svg>
</button>
<div class="cli-footer flex items-center justify-between rounded-b-md bg-slate-900 mt-0 px-4 pt-0 mb-0 transition-opacity ease-in-out duration-300 opacity-0 invisible group-hover:opacity-100 group-hover:visible">
<a class="rounded rounded-mx px-3 py-1 text-white text-xs hover:text-white hover:bg-slate-600 hover:border-transparent focus:outline-none focus:ring-2 focus:white focus:border-slate-500" href="https://redis.io/docs/latest/develop/connect/clients/dotnet/" tabindex="1" title="Quick-Start">
C# Quick-Start
</a>
<div class="w-1/2">
</div>
<div class="flex-1 text-right">
<a class="button text-neutral-400 hover:text-slate-100 h-6 w-6 p-1" href="https://github.com/redis/NRedisStack/tree/master/tests/Doc/SearchQuickstartExample.cs" tabindex="1" title="Improve this code example">
<svg fill="github" height="16" viewbox="0 0 18 16" width="18" xmlns="http://www.w3.org/2000/svg">
<path clip-rule="evenodd" d="M8.99953 1.43397e-06C7.09918 -0.000897921 5.26058 0.674713 3.81295 1.90585C2.36533 3.13699 1.40324 4.84324 1.09896 6.71907C0.794684 8.5949 1.1681 10.5178 2.15233 12.1434C3.13657 13.769 4.66734 14.9912 6.47053 15.591C6.87053 15.664 7.01653 15.417 7.01653 15.205C7.01653 15.015 7.00953 14.512 7.00553 13.845C4.78053 14.328 4.31053 12.772 4.31053 12.772C4.16325 12.2887 3.84837 11.8739 3.42253 11.602C2.69653 11.102 3.47753 11.116 3.47753 11.116C3.73043 11.1515 3.97191 11.2442 4.18365 11.3869C4.39539 11.5297 4.57182 11.7189 4.69953 11.94C4.80755 12.1377 4.95378 12.3119 5.12972 12.4526C5.30567 12.5933 5.50782 12.6976 5.72442 12.7595C5.94103 12.8214 6.16778 12.8396 6.39148 12.813C6.61519 12.7865 6.83139 12.7158 7.02753 12.605C7.06381 12.1992 7.24399 11.8197 7.53553 11.535C5.75953 11.335 3.89153 10.647 3.89153 7.581C3.88005 6.78603 4.17513 6.01716 4.71553 5.434C4.47318 4.74369 4.50322 3.98693 4.79953 3.318C4.79953 3.318 5.47053 3.103 6.99953 4.138C8.31074 3.77905 9.69432 3.77905 11.0055 4.138C12.5325 3.103 13.2055 3.318 13.2055 3.318C13.5012 3.9877 13.5294 4.74513 13.2845 5.435C13.8221 6.01928 14.114 6.78817 14.0995 7.582C14.0995 10.655 12.2285 11.332 10.4465 11.53C10.6375 11.724 10.7847 11.9566 10.8784 12.2123C10.972 12.4679 11.0099 12.7405 10.9895 13.012C10.9895 14.081 10.9795 14.944 10.9795 15.206C10.9795 15.42 11.1235 15.669 11.5295 15.591C13.3328 14.9911 14.8636 13.7689 15.8479 12.1432C16.8321 10.5175 17.2054 8.59447 16.901 6.71858C16.5966 4.84268 15.6343 3.13642 14.1865 1.90536C12.7387 0.674306 10.9 -0.0011359 8.99953 1.43397e-06Z" fill="white" fill-rule="evenodd">
</path>
</svg>
</a>
</div>
</div>
</div>
</div>
<p>
Please see the
<a href="/docs/latest/develop/interact/search-and-query/query/">
query documentation
</a>
to learn how to make more advanced queries.
</p>
<h2 id="next-steps">
Next steps
</h2>
<p>
You can learn more about how to use Redis Stack as a vector database in the following quick start guide:
</p>
<ul>
<li>
<a href="/docs/latest/develop/get-started/vector-database/">
Redis as a vector database
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/get-started/document-database/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/security/recommended-security-practices/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Recommended security practices
</h1>
<h2 id="deployment-security">
Deployment security
</h2>
<p>
When deploying Redis Enterprise Software to production, we recommend the following practices:
</p>
<ul>
<li>
<p>
<strong>
Deploy Redis Enterprise inside a trusted network
</strong>
: Redis Enterprise is database software and should be deployed on a trusted network not accessible to the public internet. Deploying Redis Enterprise in a trusted network reduces the likelihood that someone can obtain unauthorized access to your data or the ability to manage your database configuration.
</p>
</li>
<li>
<p>
<strong>
Implement anti-virus exclusions
</strong>
: To ensure that anti-virus solutions that scan files or intercept processes to protect memory do not interfere with Redis Enterprise software, you should ensure that anti-virus exclusions are implemented across all nodes in their Redis Enterprise cluster in a consistent policy. This helps ensure that anti-virus software does not impact the availability of your Redis Enterprise cluster.
</p>
<p>
If you are replacing your existing antivirus solution or installing/supporting Redis Enterprise, make sure that the below paths are excluded:
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
For antivirus solutions that intercept processes, binary files may have to be excluded directly depending on the requirements of your anti-virus vendor.
</div>
</div>
<table>
<thead>
<tr>
<th>
<strong>
Path
</strong>
</th>
<th>
<strong>
Description
</strong>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
/opt/redislabs
</td>
<td>
Main installation directory for all Redis Enterprise Software binaries
</td>
</tr>
<tr>
<td>
/opt/redislabs/bin
</td>
<td>
Binaries for all the utilities for command line access and managements such as "rladmin" or "redis-cli"
</td>
</tr>
<tr>
<td>
/opt/redislabs/config
</td>
<td>
System configuration files
</td>
</tr>
<tr>
<td>
/opt/redislabs/lib
</td>
<td>
System library files
</td>
</tr>
<tr>
<td>
/opt/redislabs/sbin
</td>
<td>
System binaries for tweaking provisioning
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
<strong>
Send logs to a remote logging server
</strong>
: Redis Enterprise is configured to send logs by default to syslog. To send these logs to a remote logging server you must
<a href="/docs/latest/operate/rs/7.4/clusters/logging/log-security/">
configure syslog
</a>
based the requirements of the remote logging server vendor. Remote logging helps ensure that the logs are not deleted so that you can rotate the logs to prevent your server disk from filling up.
</p>
</li>
<li>
<p>
<strong>
Deploy clusters with an odd number of 3 or more nodes
</strong>
: Redis is an available and partition-tolerant database. We recommend that Redis Enterprise be deployed in a cluster of an odd number of 3 or more nodes so that you are able to successfully failover in the event of a failure.
</p>
</li>
<li>
<p>
<strong>
Reboot nodes in a sequence rather than all at once
</strong>
: It is best practice to frequently maintain reboot schedules. If you reboot too many servers at once, it is possible to cause a quorum failure that results in loss of availability of the database. We recommend that rebooting be done in a phased manner so that quorum is not lost. For example, to maintain quorum in a 3 node cluster, at least 2 nodes must be up at all times. Only one server should be rebooted at any given time to maintain quorum.
</p>
</li>
<li>
<p>
<strong>
Implement client-side encryption
</strong>
: Client-side encryption, or the practice of encrypting data within an application before storing it in a database, such as Redis, is the most widely adopted method to achieve encryption in memory. Redis is an in-memory database and stores data in-memory. If you require encryption in memory, better known as encryption in use, then client side encryption may be the right solution for you. Please be aware that database functions that need to operate on data — such as simple searching functions, comparisons, and incremental operations — don’t work with client-side encryption.
</p>
</li>
</ul>
<h2 id="cluster-security">
Cluster security
</h2>
<ul>
<li>
<p>
<strong>
Control the level of access to your system
</strong>
: Redis Enterprise lets you decide which users can access the cluster, which users can access databases, and which users can access both. We recommend preventing database users from accessing the cluster. See
<a href="/docs/latest/operate/rs/7.4/security/access-control/">
Access control
</a>
for more information.
</p>
</li>
<li>
<p>
<strong>
Enable LDAP authentication
</strong>
: If your organization uses the Lightweight Directory Access Protocol (LDAP), we recommend enabling Redis Enterprise Software support for role-based LDAP authentication.
</p>
</li>
<li>
<p>
<strong>
Require HTTPS for API endpoints
</strong>
: Redis Enterprise comes with a REST API to help automate tasks. This API is available in both an encrypted and unencrypted endpoint for backward compatibility. You can
<a href="/docs/latest/operate/rs/7.4/references/rest-api/encryption/#require-https-for-api-endpoints">
disable the unencrypted endpoint
</a>
with no loss in functionality.
</p>
</li>
</ul>
<h2 id="database-security">
Database security
</h2>
<p>
Redis Enterprise offers several database security controls to help protect your data against unauthorized access and to improve the operational security of your database. The following section details configurable security controls available for implementation.
</p>
<ul>
<li>
<p>
<strong>
Use strong Redis passwords
</strong>
: A frequent recommendation in the security industry is to use strong passwords to authenticate users. This helps to prevent brute force password guessing attacks against your database. Its important to check that your password aligns with your organizations security policy.
</p>
</li>
<li>
<p>
<strong>
Deactivate default user access
</strong>
: Redis Enterprise comes with a "default" user for backwards compatibility with applications designed with versions of Redis prior to Redis Enterprise 6. The default user is turned on by default. This allows you to access the database without specifying a username and only using a shared secret. For applications designed to use access control lists, we recommend that you
<a href="/docs/latest/operate/rs/7.4/security/access-control/manage-users/default-user/#deactivate-default-user">
deactivate default user access
</a>
.
</p>
</li>
<li>
<p>
<strong>
Configure Transport Layer Security (TLS)
</strong>
: Similar to the control plane, you can also
<a href="/docs/latest/operate/rs/7.4/security/encryption/tls/tls-protocols/">
configure TLS protocols
</a>
to help support your security and compliance needs.
</p>
</li>
<li>
<p>
<strong>
Enable client certificate authentication
</strong>
: To prevent unauthorized access to your data, Redis Enterprise databases support the
<a href="/docs/latest/operate/rs/7.4/security/encryption/tls/#client-certificate-authentication">
TLS protocol
</a>
, which includes authentication and encryption. Client certificate authentication can be used to ensure only authorized hosts can access the database.
</p>
</li>
<li>
<p>
<strong>
Install trusted certificates
</strong>
: Redis implements self-signed certificates for the database proxy and replication service, but many organizations prefer to
<a href="/docs/latest/operate/rs/7.4/security/certificates/create-certificates/">
use their own certificates
</a>
.
</p>
</li>
<li>
<p>
<strong>
Configure and verify database backups
</strong>
: Implementing a disaster recovery strategy is an important part of data security. Redis Enterprise supports
<a href="/docs/latest/operate/rs/7.4/databases/import-export/schedule-backups/">
database backups to many destinations
</a>
.
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/security/recommended-security-practices/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Alert settings object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the alert_settings object used with Redis Enterprise Software REST API calls.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
cluster_certs_about_to_expire
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Cluster certificate will expire in x days
</td>
</tr>
<tr>
<td>
cluster_even_node_count
</td>
<td>
boolean (default: false)
</td>
<td>
True high availability requires an odd number of nodes in the cluster
</td>
</tr>
<tr>
<td>
cluster_flash_overcommit
</td>
<td>
boolean (default: false)
</td>
<td>
Flash memory committed to databases is larger than cluster total flash memory
</td>
</tr>
<tr>
<td>
cluster_inconsistent_redis_sw
</td>
<td>
boolean (default: false)
</td>
<td>
Some shards in the cluster are running different versions of Redis software
</td>
</tr>
<tr>
<td>
cluster_inconsistent_rl_sw
</td>
<td>
boolean (default: false)
</td>
<td>
Some nodes in the cluster are running different versions of Redis Enterprise software
</td>
</tr>
<tr>
<td>
cluster_internal_bdb
</td>
<td>
boolean (default: false)
</td>
<td>
Issues with internal cluster databases
</td>
</tr>
<tr>
<td>
cluster_multiple_nodes_down
</td>
<td>
boolean (default: false)
</td>
<td>
Multiple cluster nodes are down (this might cause data loss)
</td>
</tr>
<tr>
<td>
cluster_node_joined
</td>
<td>
boolean (default: false)
</td>
<td>
New node joined the cluster
</td>
</tr>
<tr>
<td>
cluster_node_remove_abort_completed
</td>
<td>
boolean (default: false)
</td>
<td>
Cancel node remove operation completed
</td>
</tr>
<tr>
<td>
cluster_node_remove_abort_failed
</td>
<td>
boolean (default: false)
</td>
<td>
Cancel node remove operation failed
</td>
</tr>
<tr>
<td>
cluster_node_remove_completed
</td>
<td>
boolean (default: false)
</td>
<td>
Node removed from the cluster
</td>
</tr>
<tr>
<td>
cluster_node_remove_failed
</td>
<td>
boolean (default: false)
</td>
<td>
Failed to remove a node from the cluster
</td>
</tr>
<tr>
<td>
cluster_ocsp_query_failed
</td>
<td>
boolean (default: false)
</td>
<td>
Failed to query the OCSP server
</td>
</tr>
<tr>
<td>
cluster_ocsp_status_revoked
</td>
<td>
boolean (default: false)
</td>
<td>
OCSP certificate status is REVOKED
</td>
</tr>
<tr>
<td>
cluster_ram_overcommit
</td>
<td>
boolean (default: false)
</td>
<td>
RAM committed to databases is larger than cluster total RAM
</td>
</tr>
<tr>
<td>
cluster_too_few_nodes_for_replication
</td>
<td>
boolean (default: false)
</td>
<td>
Replication requires at least 2 nodes in the cluster
</td>
</tr>
<tr>
<td>
node_aof_slow_disk_io
</td>
<td>
boolean (default: false)
</td>
<td>
AOF reaching disk I/O limits
</td>
</tr>
<tr>
<td>
node_checks_error
</td>
<td>
boolean (default: false)
</td>
<td>
Some node checks have failed
</td>
</tr>
<tr>
<td>
node_cpu_utilization
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Node CPU utilization has reached the threshold value (% of the utilization limit)
</td>
</tr>
<tr>
<td>
node_ephemeral_storage
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Node ephemeral storage has reached the threshold value (% of the storage limit)
</td>
</tr>
<tr>
<td>
node_failed
</td>
<td>
boolean (default: false)
</td>
<td>
Node failed
</td>
</tr>
<tr>
<td>
node_free_flash
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Node flash storage has reached the threshold value (% of the storage limit)
</td>
</tr>
<tr>
<td>
node_insufficient_disk_aofrw
</td>
<td>
boolean (default: false)
</td>
<td>
Insufficient AOF disk space
</td>
</tr>
<tr>
<td>
node_internal_certs_about_to_expire
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Internal certificate on node will expire in x days
</td>
</tr>
<tr>
<td>
node_memory
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Node memory has reached the threshold value (% of the memory limit)
</td>
</tr>
<tr>
<td>
node_net_throughput
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Node network throughput has reached the threshold value (bytes/s)
</td>
</tr>
<tr>
<td>
node_persistent_storage
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/cluster_alert_settings_with_threshold/">
cluster_alert_settings_with_threshold
</a>
object
</td>
<td>
Node persistent storage has reached the threshold value (% of the storage limit)
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/restart/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin restart
</h1>
<p class="text-lg -mt-5 mb-10">
Restarts Redis Enterprise Software processes for a specific database.
</p>
<p>
Schedules a restart of the Redis Enterprise Software processes on primary and replica instances of a specific database.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin restart db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>preserve_roles<span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>discard_data<span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span>force_discard<span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Restarts Redis Enterprise Software processes for the specified database
</td>
</tr>
<tr>
<td>
discard_data
</td>
<td>
</td>
<td>
Allows discarding data if there is no persistence or replication
</td>
</tr>
<tr>
<td>
force_discard
</td>
<td>
</td>
<td>
Forcibly discards data even if there is persistence or replication
</td>
</tr>
<tr>
<td>
preserve_roles
</td>
<td>
</td>
<td>
Performs an additional failover to maintain shard roles
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns
<code>
Done
</code>
if the restart completed successfully. Otherwise, it returns an error.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin restart db db:5 preserve_roles
</span></span><span class="line"><span class="cl">Monitoring 1db07491-35da-4bb6-9bc1-56949f4c312a
</span></span><span class="line"><span class="cl">active - SMUpgradeBDB init
</span></span><span class="line"><span class="cl">active - SMUpgradeBDB stop_forwarding
</span></span><span class="line"><span class="cl">active - SMUpgradeBDB stop_active_expire
</span></span><span class="line"><span class="cl">active - SMUpgradeBDB check_slave
</span></span><span class="line"><span class="cl">oactive - SMUpgradeBDB stop_active_expire
</span></span><span class="line"><span class="cl">active - SMUpgradeBDB second_failover
</span></span><span class="line"><span class="cl">completed - SMUpgradeBDB
</span></span><span class="line"><span class="cl">Done
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/restart/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/reference/clients/.html | <section class="prose w-full py-12">
<h1>
Redis client handling
</h1>
<p class="text-lg -mt-5 mb-10">
How the Redis server manages client connections
</p>
<p>
This document provides information about how Redis handles clients at the network layer level: connections, timeouts, buffers, and other similar topics are covered here.
</p>
<p>
The information contained in this document is
<strong>
only applicable to Redis version 2.6 or greater
</strong>
.
</p>
<h2 id="accepting-client-connections">
Accepting Client Connections
</h2>
<p>
Redis accepts clients connections on the configured TCP port and on the Unix socket if enabled. When a new client connection is accepted the following operations are performed:
</p>
<ul>
<li>
The client socket is put in the non-blocking state since Redis uses multiplexing and non-blocking I/O.
</li>
<li>
The
<code>
TCP_NODELAY
</code>
option is set in order to ensure that there are no delays to the connection.
</li>
<li>
A
<em>
readable
</em>
file event is created so that Redis is able to collect the client queries as soon as new data is available to read on the socket.
</li>
</ul>
<p>
After the client is initialized, Redis checks if it is already at the limit
configured for the number of simultaneous clients (configured using the
<code>
maxclients
</code>
configuration directive, see the next section of this document for further information).
</p>
<p>
When Redis can't accept a new client connection because the maximum number of clients
has been reached, it tries to send an error to the client in order to
make it aware of this condition, closing the connection immediately.
The error message will reach the client even if the connection is
closed immediately by Redis because the new socket output buffer is usually
big enough to contain the error, so the kernel will handle transmission
of the error.
</p>
<h2 id="what-order-are-client-requests-served-in">
What Order are Client Requests Served In?
</h2>
<p>
The order is determined by a combination of the client socket file descriptor
number and order in which the kernel reports events, so the order should be
considered as unspecified.
</p>
<p>
However, Redis does the following two things when serving clients:
</p>
<ul>
<li>
It only performs a single
<code>
read()
</code>
system call every time there is something new to read from the client socket. This ensures that if we have multiple clients connected, and a few send queries at a high rate, other clients are not penalized and will not experience latency issues.
</li>
<li>
However once new data is read from a client, all the queries contained in the current buffers are processed sequentially. This improves locality and does not need iterating a second time to see if there are clients that need some processing time.
</li>
</ul>
<h2 id="maximum-concurrent-connected-clients">
Maximum Concurrent Connected Clients
</h2>
<p>
In Redis 2.4 there was a hard-coded limit for the maximum number of clients
that could be handled simultaneously.
</p>
<p>
In Redis 2.6 and newer, this limit is configurable using the
<code>
maxclients
</code>
directive in
<code>
redis.conf
</code>
. The default is 10,000 clients.
</p>
<p>
However, Redis checks with the kernel what the maximum number of file
descriptors that we are able to open is (the
<em>
soft limit
</em>
is checked). If the
limit is less than the maximum number of clients we want to handle, plus
32 (that is the number of file descriptors Redis reserves for internal uses),
then the maximum number of clients is updated to match the number
of clients it is
<em>
really able to handle
</em>
under the current operating system
limit.
</p>
<p>
When
<code>
maxclients
</code>
is set to a number greater than Redis can support, a message is logged at startup:
</p>
<pre tabindex="0"><code>$ ./redis-server --maxclients 100000
[41422] 23 Jan 11:28:33.179 # Unable to set the max number of files limit to 100032 (Invalid argument), setting the max clients configuration to 10112.
</code></pre>
<p>
When Redis is configured in order to handle a specific number of clients it
is a good idea to make sure that the operating system limit for the maximum
number of file descriptors per process is also set accordingly.
</p>
<p>
Under Linux these limits can be set both in the current session and as a
system-wide setting with the following commands:
</p>
<ul>
<li>
<code>
ulimit -Sn 100000 # This will only work if hard limit is big enough.
</code>
</li>
<li>
<code>
sysctl -w fs.file-max=100000
</code>
</li>
</ul>
<h2 id="output-buffer-limits">
Output Buffer Limits
</h2>
<p>
Redis needs to handle a variable-length output buffer for every client, since
a command can produce a large amount of data that needs to be transferred to the
client.
</p>
<p>
However it is possible that a client sends more commands producing more output
to serve at a faster rate than that which Redis can send the existing output to the
client. This is especially true with Pub/Sub clients in case a client is not
able to process new messages fast enough.
</p>
<p>
Both conditions will cause the client output buffer to grow and consume
more and more memory. For this reason by default Redis sets limits to the
output buffer size for different kind of clients. When the limit is reached
the client connection is closed and the event logged in the Redis log file.
</p>
<p>
There are two kind of limits Redis uses:
</p>
<ul>
<li>
The
<strong>
hard limit
</strong>
is a fixed limit that when reached will make Redis close the client connection as soon as possible.
</li>
<li>
The
<strong>
soft limit
</strong>
instead is a limit that depends on the time, for instance a soft limit of 32 megabytes per 10 seconds means that if the client has an output buffer bigger than 32 megabytes for, continuously, 10 seconds, the connection gets closed.
</li>
</ul>
<p>
Different kind of clients have different default limits:
</p>
<ul>
<li>
<strong>
Normal clients
</strong>
have a default limit of 0, that means, no limit at all, because most normal clients use blocking implementations sending a single command and waiting for the reply to be completely read before sending the next command, so it is always not desirable to close the connection in case of a normal client.
</li>
<li>
<strong>
Pub/Sub clients
</strong>
have a default hard limit of 32 megabytes and a soft limit of 8 megabytes per 60 seconds.
</li>
<li>
<strong>
Replicas
</strong>
have a default hard limit of 256 megabytes and a soft limit of 64 megabyte per 60 seconds.
</li>
</ul>
<p>
It is possible to change the limit at runtime using the
<a href="/docs/latest/commands/config-set/">
<code>
CONFIG SET
</code>
</a>
command or in a permanent way using the Redis configuration file
<code>
redis.conf
</code>
. See the example
<code>
redis.conf
</code>
in the Redis distribution for more information about how to set the limit.
</p>
<h2 id="query-buffer-hard-limit">
Query Buffer Hard Limit
</h2>
<p>
Every client is also subject to a query buffer limit. This is a non-configurable hard limit that will close the connection when the client query buffer (that is the buffer we use to accumulate commands from the client) reaches 1 GB, and is actually only an extreme limit to avoid a server crash in case of client or server software bugs.
</p>
<h2 id="client-eviction">
Client Eviction
</h2>
<p>
Redis is built to handle a very large number of client connections.
Client connections tend to consume memory, and when there are many of them, the aggregate memory consumption can be extremely high, leading to data eviction or out-of-memory errors.
These cases can be mitigated to an extent using
<a href="#output-buffer-limits">
output buffer limits
</a>
, but Redis allows us a more robust configuration to limit the aggregate memory used by all clients' connections.
</p>
<p>
This mechanism is called
<strong>
client eviction
</strong>
, and it's essentially a safety mechanism that will disconnect clients once the aggregate memory usage of all clients is above a threshold.
The mechanism first attempts to disconnect clients that use the most memory.
It disconnects the minimal number of clients needed to return below the
<code>
maxmemory-clients
</code>
threshold.
</p>
<p>
<code>
maxmemory-clients
</code>
defines the maximum aggregate memory usage of all clients connected to Redis.
The aggregation takes into account all the memory used by the client connections: the
<a href="#query-buffer-hard-limit">
query buffer
</a>
, the output buffer, and other intermediate buffers.
</p>
<p>
Note that replica and master connections aren't affected by the client eviction mechanism. Therefore, such connections are never evicted.
</p>
<p>
<code>
maxmemory-clients
</code>
can be set permanently in the configuration file (
<code>
redis.conf
</code>
) or via the
<a href="/docs/latest/commands/config-set/">
<code>
CONFIG SET
</code>
</a>
command.
This setting can either be 0 (meaning no limit), a size in bytes (possibly with
<code>
mb
</code>
/
<code>
gb
</code>
suffix),
or a percentage of
<code>
maxmemory
</code>
by using the
<code>
%
</code>
suffix (e.g. setting it to
<code>
10%
</code>
would mean 10% of the
<code>
maxmemory
</code>
configuration).
</p>
<p>
The default setting is 0, meaning client eviction is turned off by default.
However, for any large production deployment, it is highly recommended to configure some non-zero
<code>
maxmemory-clients
</code>
value.
A value
<code>
5%
</code>
, for example, can be a good place to start.
</p>
<p>
It is possible to flag a specific client connection to be excluded from the client eviction mechanism.
This is useful for control path connections.
If, for example, you have an application that monitors the server via the
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
command and alerts you in case of a problem, you might want to make sure this connection isn't evicted.
You can do so using the following command (from the relevant client's connection):
</p>
<p>
<a href="/docs/latest/commands/client-no-evict/">
<code>
CLIENT NO-EVICT
</code>
</a>
<code>
on
</code>
</p>
<p>
And you can revert that with:
</p>
<p>
<a href="/docs/latest/commands/client-no-evict/">
<code>
CLIENT NO-EVICT
</code>
</a>
<code>
off
</code>
</p>
<p>
For more information and an example refer to the
<code>
maxmemory-clients
</code>
section in the default
<code>
redis.conf
</code>
file.
</p>
<p>
Client eviction is available from Redis 7.0.
</p>
<h2 id="client-timeouts">
Client Timeouts
</h2>
<p>
By default recent versions of Redis don't close the connection with the client
if the client is idle for many seconds: the connection will remain open forever.
</p>
<p>
However if you don't like this behavior, you can configure a timeout, so that
if the client is idle for more than the specified number of seconds, the client connection will be closed.
</p>
<p>
You can configure this limit via
<code>
redis.conf
</code>
or simply using
<code>
CONFIG SET timeout <value>
</code>
.
</p>
<p>
Note that the timeout only applies to normal clients and it
<strong>
does not apply to Pub/Sub clients
</strong>
, since a Pub/Sub connection is a
<em>
push style
</em>
connection so a client that is idle is the norm.
</p>
<p>
Even if by default connections are not subject to timeout, there are two conditions when it makes sense to set a timeout:
</p>
<ul>
<li>
Mission critical applications where a bug in the client software may saturate the Redis server with idle connections, causing service disruption.
</li>
<li>
As a debugging mechanism in order to be able to connect with the server if a bug in the client software saturates the server with idle connections, making it impossible to interact with the server.
</li>
</ul>
<p>
Timeouts are not to be considered very precise: Redis avoids setting timer events or running O(N) algorithms in order to check idle clients, so the check is performed incrementally from time to time. This means that it is possible that while the timeout is set to 10 seconds, the client connection will be closed, for instance, after 12 seconds if many clients are connected at the same time.
</p>
<h2 id="the-client-command">
The CLIENT Command
</h2>
<p>
The Redis
<a href="/docs/latest/commands/client/">
<code>
CLIENT
</code>
</a>
command allows you to inspect the state of every connected client, to kill a specific client, and to name connections. It is a very powerful debugging tool if you use Redis at scale.
</p>
<p>
<a href="/docs/latest/commands/client-list/">
<code>
CLIENT LIST
</code>
</a>
is used in order to obtain a list of connected clients and their state:
</p>
<pre tabindex="0"><code>redis 127.0.0.1:6379> client list
addr=127.0.0.1:52555 fd=5 name= age=855 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=32768 obl=0 oll=0 omem=0 events=r cmd=client
addr=127.0.0.1:52787 fd=6 name= age=6 idle=5 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=ping
</code></pre>
<p>
In the above example two clients are connected to the Redis server. Let's look at what some of the data returned represents:
</p>
<ul>
<li>
<strong>
addr
</strong>
: The client address, that is, the client IP and the remote port number it used to connect with the Redis server.
</li>
<li>
<strong>
fd
</strong>
: The client socket file descriptor number.
</li>
<li>
<strong>
name
</strong>
: The client name as set by
<a href="/docs/latest/commands/client-setname/">
<code>
CLIENT SETNAME
</code>
</a>
.
</li>
<li>
<strong>
age
</strong>
: The number of seconds the connection existed for.
</li>
<li>
<strong>
idle
</strong>
: The number of seconds the connection is idle.
</li>
<li>
<strong>
flags
</strong>
: The kind of client (N means normal client, check the
<a href="/docs/latest/commands/client-list/">
full list of flags
</a>
).
</li>
<li>
<strong>
omem
</strong>
: The amount of memory used by the client for the output buffer.
</li>
<li>
<strong>
cmd
</strong>
: The last executed command.
</li>
</ul>
<p>
See the [
<a href="/docs/latest/commands/client-list/">
<code>
CLIENT LIST
</code>
</a>
](/commands/client-list) documentation for the full listing of fields and their purpose.
</p>
<p>
Once you have the list of clients, you can close a client's connection using the
<a href="/docs/latest/commands/client-kill/">
<code>
CLIENT KILL
</code>
</a>
command, specifying the client address as its argument.
</p>
<p>
The commands
<a href="/docs/latest/commands/client-setname/">
<code>
CLIENT SETNAME
</code>
</a>
and
<a href="/docs/latest/commands/client-getname/">
<code>
CLIENT GETNAME
</code>
</a>
can be used to set and get the connection name. Starting with Redis 4.0, the client name is shown in the
<a href="/docs/latest/commands/slowlog/">
<code>
SLOWLOG
</code>
</a>
output, to help identify clients that create latency issues.
</p>
<h2 id="tcp-keepalive">
TCP keepalive
</h2>
<p>
From version 3.2 onwards, Redis has TCP keepalive (
<code>
SO_KEEPALIVE
</code>
socket option) enabled by default and set to about 300 seconds. This option is useful in order to detect dead peers (clients that cannot be reached even if they look connected). Moreover, if there is network equipment between clients and servers that need to see some traffic in order to take the connection open, the option will prevent unexpected connection closed events.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/reference/clients/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/networking/private-public-endpoints/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Enable private and public database endpoints
</h1>
<p class="text-lg -mt-5 mb-10">
Describes how to enable public and private endpoints for databases on a cluster.
</p>
<p>
Each node in Redis Enterprise can be configured with
<a href="/docs/latest/operate/rs/networking/multi-ip-ipv6/">
private and external IP addresses
</a>
. By default, Redis Enterprise Software databases expose a single endpoint, e.g. cluster.com (FQDN), using the external IP addresses, making it available to the public network (e.g. the internet). Additionally, the cluster can be configured to expose a private FQDN, which utilizes the private IP addresses for access from the private network only (e.g. VPC or an internal network).
</p>
<p>
When you create a cluster via the UI, you can configure it to expose private and public endpoints.
This is common for environments such as cloud platforms and enterprises.
</p>
<p>
When doing so, the cluster creates an additional FQDN, e.g. internal.cluster.com for private network (e.g. VPC or an internal network), while the cluster.com FQDN can be used by a public network (e.g. the internet).
</p>
<p>
You can enable public and private endpoints during cluster creation only.
However, you can still add an additional FQDN in a different domain (cluster.io, for example) after cluster creation.
</p>
<p>
To enable private and public endpoints:
</p>
<ol>
<li>
<p>
Verify the IP addresses are bound to the server or instance.
</p>
</li>
<li>
<p>
During cluster setup, turn on
<strong>
Enable public endpoints support
</strong>
in the
<strong>
Cluster
</strong>
screen's
<strong>
Configuration
</strong>
section.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/enable-public-endpoints.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/enable-public-endpoints.png">
<img alt="The endpoint support setting appears in the **Configuration section** of the **Cluster** setup screen." src="/docs/latest/images/rs/screenshots/cluster/setup/enable-public-endpoints.png" width="75%"/>
</a>
<p>
If this setting is not enabled when the cluster is created, databases on the cluster support only a single endpoint.
</p>
</li>
<li>
<p>
Select
<strong>
Next
</strong>
to proceed to
<strong>
Node
</strong>
configuration.
</p>
</li>
<li>
<p>
In the
<strong>
Network configuration
</strong>
section:
</p>
<ol>
<li>
<p>
Configure the machine's public IP address for external traffic.
</p>
</li>
<li>
<p>
Configure the private IP address for both internal and external traffic so it can be used for private database endpoints.
</p>
</li>
</ol>
</li>
</ol>
<p>
After cluster creation, both sets of endpoints are available for databases in the cluster.
</p>
<p>
To view and copy public and private endpoints for a database in the cluster, see the database's
<strong>
Configuration > General
</strong>
section.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/config-general-endpoints.png" sdata-lightbox="/images/rs/screenshots/databases/config-general-endpoints.png">
<img alt="View public and private endpoints from the General section of the database's Configuration screen." src="/docs/latest/images/rs/screenshots/databases/config-general-endpoints.png" width="75%"/>
</a>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/networking/private-public-endpoints/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-dump-support-package/.html | <section class="prose w-full py-12">
<h1>
redis-di dump-support-package
</h1>
<p class="text-lg -mt-5 mb-10">
Dumps RDI support package
</p>
<h2 id="usage">
Usage
</h2>
<pre tabindex="0"><code>Usage: redis-di dump-support-package [OPTIONS]
</code></pre>
<h2 id="options">
Options
</h2>
<ul>
<li>
<p>
<code>
log_level
</code>
:
</p>
<ul>
<li>
Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
</li>
<li>
Default:
<code>
info
</code>
</li>
<li>
Usage:
<code>
--log-level -l
</code>
</li>
</ul>
</li>
<li>
<p>
<code>
rdi_host
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-host
</code>
</li>
</ul>
<p>
Host/IP of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_port
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: <IntRange 1<=x<=65535>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-port
</code>
</li>
</ul>
<p>
Port of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_user
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-user
</code>
</li>
</ul>
<p>
RDI Database Username
</p>
</li>
<li>
<p>
<code>
rdi_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-password
</code>
</li>
</ul>
<p>
RDI Database Password
</p>
</li>
<li>
<p>
<code>
rdi_key
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key
</code>
</li>
</ul>
<p>
Private key file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cert
</code>
</li>
</ul>
<p>
Client certificate file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cacert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cacert
</code>
</li>
</ul>
<p>
CA certificate file to verify with
</p>
</li>
<li>
<p>
<code>
rdi_key_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key-password
</code>
</li>
</ul>
<p>
Password for unlocking an encrypted private key
</p>
</li>
<li>
<p>
<code>
directory
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
.
</code>
</li>
<li>
Usage:
<code>
--dir
</code>
</li>
</ul>
<p>
Directory where the support file should be generated
</p>
</li>
<li>
<p>
<code>
dump_rejected
</code>
:
</p>
<ul>
<li>
Type: INT
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--dump-rejected
</code>
</li>
</ul>
<p>
Dumps rejected records
</p>
</li>
<li>
<p>
<code>
trace_timeout
</code>
:
</p>
<ul>
<li>
Type: <IntRange 1<=x<=600>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--trace-timeout
</code>
</li>
</ul>
<p>
Stops the trace after exceeding this timeout (in seconds)
</p>
</li>
<li>
<p>
<code>
max_change_records
</code>
:
</p>
<ul>
<li>
Type:
<intrange x="">
=1>
</intrange>
</li>
<li>
Default:
<code>
10
</code>
</li>
<li>
Usage:
<code>
--max-change-records
</code>
</li>
</ul>
<p>
Maximum traced change records
</p>
</li>
<li>
<p>
<code>
trace_only_rejected
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--trace-only-rejected
</code>
</li>
</ul>
<p>
Trace only rejected change records
</p>
</li>
<li>
<p>
<code>
help
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--help
</code>
</li>
</ul>
<p>
Show this message and exit.
</p>
</li>
</ul>
<h2 id="cli-help">
CLI help
</h2>
<pre tabindex="0"><code>Usage: redis-di dump-support-package [OPTIONS]
Dumps RDI support package
Options:
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--rdi-host TEXT Host/IP of RDI Database [required]
--rdi-port INTEGER RANGE Port of RDI Database [1<=x<=65535;
required]
--rdi-user TEXT RDI Database Username
--rdi-password TEXT RDI Database Password
--rdi-key TEXT Private key file to authenticate with
--rdi-cert TEXT Client certificate file to authenticate with
--rdi-cacert TEXT CA certificate file to verify with
--rdi-key-password TEXT Password for unlocking an encrypted private
key
--dir TEXT Directory where the support file should be
generated [default: .]
--dump-rejected INTEGER Dumps rejected records
--trace-timeout INTEGER RANGE Stops the trace after exceeding this timeout
(in seconds) [1<=x<=600]
--max-change-records INTEGER RANGE
Maximum traced change records [x>=1]
--trace-only-rejected Trace only rejected change records
--help Show this message and exit.
</code></pre>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-dump-support-package/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/compatibility/commands/cluster/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster management commands compatibility
</h1>
<p class="text-lg -mt-5 mb-10">
Cluster management commands compatible with Redis Enterprise.
</p>
<p>
<a href="/docs/latest/operate/rs/databases/durability-ha/clustering/">
Clustering in Redis Enterprise Software
</a>
and
<a href="/docs/latest/operate/rc/databases/configuration/clustering/">
Redis Cloud
</a>
differs from the
<a href="/docs/latest/operate/oss_and_stack/management/scaling/">
Redis Community Edition cluster
</a>
and works with all standard Redis clients.
</p>
<p>
Redis Enterprise blocks most
<a href="/docs/latest/commands/?group=cluster">
cluster commands
</a>
. If you try to use a blocked cluster command, it returns an error.
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Command
</th>
<th style="text-align:left">
Redis
<br/>
Enterprise
</th>
<th style="text-align:left">
Redis
<br/>
Cloud
</th>
<th style="text-align:left">
Notes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/asking/">
ASKING
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-addslots/">
CLUSTER ADDSLOTS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-addslotsrange/">
CLUSTER ADDSLOTSRANGE
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-bumpepoch/">
CLUSTER BUMPEPOCH
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-count-failure-reports/">
CLUSTER COUNT-FAILURE-REPORTS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-countkeysinslot/">
CLUSTER COUNTKEYSINSLOT
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-delslots/">
CLUSTER DELSLOTS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-delslotsrange/">
CLUSTER DELSLOTSRANGE
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-failover/">
CLUSTER FAILOVER
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-flushslots/">
CLUSTER FLUSHSLOTS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-forget/">
CLUSTER FORGET
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-getkeysinslot/">
CLUSTER GETKEYSINSLOT
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-help/">
CLUSTER HELP
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Only supported with the
<a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/">
OSS cluster API
</a>
.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-info/">
CLUSTER INFO
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Only supported with the
<a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/">
OSS cluster API
</a>
.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-keyslot/">
CLUSTER KEYSLOT
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Only supported with the
<a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/">
OSS cluster API
</a>
.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-links/">
CLUSTER LINKS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-meet/">
CLUSTER MEET
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-myid/">
CLUSTER MYID
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-myshardid/">
CLUSTER MYSHARDID
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-nodes/">
CLUSTER NODES
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Only supported with the
<a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/">
OSS cluster API
</a>
.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-replicas/">
CLUSTER REPLICAS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-replicate/">
CLUSTER REPLICATE
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-reset/">
CLUSTER RESET
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-saveconfig/">
CLUSTER SAVECONFIG
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-set-config-epoch/">
CLUSTER SET-CONFIG-EPOCH
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-setslot/">
CLUSTER SETSLOT
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-shards/">
CLUSTER SHARDS
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-slaves/">
CLUSTER SLAVES
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Deprecated as of Redis v5.0.0.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/cluster-slots/">
CLUSTER SLOTS
</a>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Supported">
✅ Standard
</span>
<br/>
<span title="Supported">
<nobr>
✅ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
Only supported with the
<a href="/docs/latest/operate/rs/databases/configure/oss-cluster-api/">
OSS cluster API
</a>
. Deprecated as of Redis v7.0.0.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/readonly/">
READONLY
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/commands/readwrite/">
READWRITE
</a>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
<span title="Not supported">
❌ Standard
</span>
<br/>
<span title="Not supported">
<nobr>
❌ Active-Active
</nobr>
</span>
</td>
<td style="text-align:left">
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/compatibility/commands/cluster/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/memory-purge/.html | <section class="prose w-full py-12">
<h1 class="command-name">
MEMORY PURGE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">MEMORY PURGE</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
4.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
Depends on how much memory is allocated, could be slow
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The
<code>
MEMORY PURGE
</code>
command attempts to purge dirty pages so these can be
reclaimed by the allocator.
</p>
<p>
This command is currently implemented only when using
<strong>
jemalloc
</strong>
as an
allocator, and evaluates to a benign NOOP for all others.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/memory-purge/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/get-started.html | <section class="prose w-full py-12 max-w-none">
<h1>
Community Edition
</h1>
<p class="text-lg -mt-5 mb-10">
Get started with Redis Community Edition
</p>
<p>
Redis is an
<a href="/docs/latest/develop/get-started/data-store/">
in-memory data store
</a>
used by millions of developers as a cache,
<a href="/docs/latest/develop/get-started/vector-database/">
vector database
</a>
,
<a href="/docs/latest/develop/get-started/document-database/">
document database
</a>
,
<a href="/docs/latest/develop/data-types/streams/">
streaming engine
</a>
, and message broker. Redis has built-in replication and different levels of
<a href="/docs/latest/operate/oss_and_stack/management/persistence/">
on-disk persistence
</a>
. It supports complex
<a href="/docs/latest/develop/data-types/">
data types
</a>
(for example, strings, hashes, lists, sets, sorted sets, and JSON), with atomic operations defined on those data types.
</p>
<p>
You can install Redis from source, from an executable for your OS, or bundled with Redis Stack and Redis Insight which include popular features and monitoring.
</p>
<ul>
<li>
<a href="/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/">
Install Redis on Linux
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-mac-os/">
Install Redis on macOS
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/">
Install Redis on Windows
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/">
Install Redis with Redis Stack and Redis Insight
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/docker/">
Run Redis Stack on Docker
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-from-source/">
Install Redis from Source
</a>
</li>
</ul>
<h2 id="use-cases">
Use cases
</h2>
<p>
The following quick start guides will show you how to use Redis for the following specific purposes:
</p>
<ul>
<li>
<a href="/docs/latest/develop/get-started/data-store/">
Data structure store
</a>
</li>
<li>
<a href="/docs/latest/develop/get-started/document-database/">
Document database
</a>
</li>
<li>
<a href="/docs/latest/develop/get-started/vector-database/">
Vector database
</a>
</li>
<li>
<a href="/docs/latest/develop/get-started/redis-in-ai/">
AI agents and chatbots
</a>
</li>
<li>
<a href="/docs/latest/develop/get-started/rag/">
Retrieval Augmented Generation (RAG) with Redis
</a>
</li>
</ul>
<h2 id="data-integration-tools-libraries-and-frameworks">
Data integration tools, libraries, and frameworks
</h2>
<ul>
<li>
<a href="/docs/latest/develop/clients/">
Client API libraries
</a>
</li>
<li>
<a href="/docs/latest/integrate/redis-data-integration/">
Redis Data Integration
</a>
</li>
<li>
<a href="/docs/latest/integrate/redisvl/">
Redis vector library for Python
</a>
</li>
<li>
<a href="/docs/latest/integrate/amazon-bedrock/">
Redis Cloud with Amazon Bedrock
</a>
</li>
<li>
<a href="/docs/latest/integrate/redisom-for-net/">
Object-mapping for .NET
</a>
</li>
<li>
<a href="/docs/latest/integrate/spring-framework-cache/">
Spring Data Redis for Java
</a>
</li>
</ul>
<p>
You can find a complete list of integrations on the
<a href="/docs/latest/integrate/">
integrations and frameworks hub
</a>
.
</p>
<p>
To learn more, refer to the
<a href="/docs/latest/develop/">
develop with Redis
</a>
documentation.
</p>
<h2 id="deployment-options">
Deployment options
</h2>
<p>
You can deploy Redis with the following methods:
</p>
<ul>
<li>
As a service by using
<a href="/docs/latest/operate/rc/">
Redis Cloud
</a>
, the fastest way to deploy Redis on your preferred cloud platform.
</li>
<li>
By installing
<a href="/docs/latest/operate/rs/">
Redis Enterprise Software
</a>
in an on-premises data center or on Cloud infrastructure.
</li>
<li>
On a variety Kubernetes distributions by using the
<a href="/docs/latest/operate/kubernetes/">
Redis Enterprise operator for Kubernetes
</a>
.
</li>
</ul>
<p>
The following guides will help you to get started with your preferred deployment method.
</p>
<p>
Get started with
<strong>
<a href="/docs/latest/operate/rc/">
Redis Cloud
</a>
</strong>
by creating a database:
</p>
<ul>
<li>
The
<a href="/docs/latest/operate/rc/rc-quickstart/">
Redis Cloud quick start
</a>
helps you create a free database. (Start here if you're new.)
</li>
<li>
<a href="/docs/latest/operate/rc/databases/create-database/create-essentials-database/">
Create an Essentials database
</a>
with a memory limit up to 12 GB.
</li>
<li>
<a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-new/">
Create a Pro database
</a>
that suits your workload and offers seamless scaling.
</li>
</ul>
<p>
Install a
<strong>
<a href="/docs/latest/operate/rs/">
Redis Enterprise Software
</a>
</strong>
cluster:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart/">
Redis Enterprise on Linux quick start
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/installing-upgrading/quickstarts/docker-quickstart/">
Redis Enterprise on Docker quick start
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/databases/active-active/get-started/">
Get started with Redis Enterprise's Active-Active feature
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/installing-upgrading/">
Install and upgrade Redis Enterprise
</a>
</li>
</ul>
<p>
Leverage
<strong>
<a href="/docs/latest/operate/kubernetes/">
Redis Enterprise for Kubernetes
</a>
</strong>
to simply deploy a Redis Enterprise cluster on Kubernetes:
</p>
<ul>
<li>
<a href="/docs/latest/operate/kubernetes/deployment/quick-start/">
Deploy Redis Enterprise for Kubernetes
</a>
</li>
<li>
<a href="/docs/latest/operate/kubernetes/deployment/openshift/">
Deploy Redis Enterprise for Kubernetes with OpenShift
</a>
</li>
</ul>
<p>
To learn more, refer to the
<a href="/docs/latest/operate/">
Redis products
</a>
documentation.
</p>
<h2 id="provisioning-and-observability-tools">
Provisioning and observability tools
</h2>
<ul>
<li>
<a href="/docs/latest/integrate/pulumi-provider-for-redis-cloud/">
Pulumi provider for Redis Cloud
</a>
</li>
<li>
<a href="/docs/latest/integrate/terraform-provider-for-redis-cloud/">
Terraform provider for Redis Cloud
</a>
</li>
<li>
<a href="/docs/latest/integrate/prometheus-with-redis-cloud/">
Prometheus and Grafana with Redis Cloud
</a>
</li>
<li>
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
Prometheus and Grafana with Redis Enterprise
</a>
</li>
</ul>
<p>
You can find a complete list of integrations on the
<a href="/docs/latest/integrate/">
libraries and tools hub
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/get-started/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/cloud-integrations/gcp-marketplace/team-management/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Google Cloud Marketplace team management
</h1>
<p class="text-lg -mt-5 mb-10">
Shows how to add users in a legacy version of the Google Cloud Marketplace subscription.
</p>
<div class="banner-article rounded-md" style="background-color: #fff8dc">
<p>
This article applies to an earlier Google Cloud marketplace listing. For the current
<a href="https://console.cloud.google.com/marketplace/product/redis-marketplace-isaas/redis-enterprise-cloud-flexible-plan">
Redis Cloud - Pay as You Go
</a>
listing, manage your team through the
<a href="/docs/latest/operate/rc/security/access-control/access-management/">
Access Management
</a>
screen. See
<a href="/docs/latest/operate/rc/cloud-integrations/gcp-marketplace/">
Sign up for Redis Cloud with Google Cloud Marketplace
</a>
for more information.
</p>
</div>
<p>
If you subscribed to Redis Cloud through Google Cloud Marketplace using the
<strong>
Redis Cloud
</strong>
listing, use the IAM section of the Google Cloud console to manage your team.
</p>
<p>
To grant Redis Cloud access to a Google Cloud user, select
<strong>
Add
</strong>
to add a member, insert the email address, and then assign the following roles to the user:
</p>
<ul>
<li>
To designate a viewer, assign
<code>
editor
</code>
,
<code>
serviceusage.serviceUsageViewer
</code>
, and
<code>
redisenterprisecloud.viewer
</code>
</li>
<li>
To designate an owner, assign
<code>
editor
</code>
,
<code>
serviceusage.serviceUsageViewer
</code>
, and
<code>
redisenterprisecloud.admin
</code>
</li>
</ul>
<p>
If these roles are not available, you can add them to your project.
</p>
<ol>
<li>
Select
<strong>
Manage Roles
</strong>
.
</li>
<li>
Use the filter table field to locate the role. (Search for “service usage viewer” or “Redis Cloud admin”.)
</li>
<li>
Select the role.
</li>
<li>
Select
<strong>
Create role from selection
</strong>
and then select
<strong>
Create
</strong>
.
</li>
<li>
Use IAM to add a member and assign the desired role.
</li>
</ol>
<p>
Users must sign in to Redis Cloud using their single sign-on credentials before they appear in the team member list.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/cloud-integrations/gcp-marketplace/team-management/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Nodes requests
</h1>
<p class="text-lg -mt-5 mb-10">
Node requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-nodes">
GET
</a>
</td>
<td>
<code>
/v1/nodes
</code>
</td>
<td>
Get all cluster nodes
</td>
</tr>
<tr>
<td>
<a href="#get-node">
GET
</a>
</td>
<td>
<code>
/v1/nodes/{uid}
</code>
</td>
<td>
Get a single cluster node
</td>
</tr>
<tr>
<td>
<a href="#put-node">
PUT
</a>
</td>
<td>
<code>
/v1/nodes/{uid}
</code>
</td>
<td>
Update a node
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-nodes">
Get all nodes
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/nodes
</span></span></code></pre>
</div>
<p>
Get all cluster nodes.
</p>
<h3 id="permissions">
Permissions
</h3>
<table>
<thead>
<tr>
<th>
Permission name
</th>
<th>
Roles
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_all_nodes_info">
view_all_nodes_info
</a>
</td>
<td>
admin
<br/>
cluster_member
<br/>
cluster_viewer
<br/>
db_member
<br/>
db_viewer
<br/>
user_manager
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /nodes
</span></span></code></pre>
</div>
<h4 id="headers">
Headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a JSON array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/node/">
node objects
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"active"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uptime"</span><span class="p">:</span> <span class="mi">262735</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_memory"</span><span class="p">:</span> <span class="mi">6260334592</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"software_version"</span><span class="p">:</span> <span class="s2">"0.90.0-1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_size"</span><span class="p">:</span> <span class="mi">20639797248</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_path"</span><span class="p">:</span> <span class="s2">"/var/opt/redislabs/persist"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_storage_size"</span><span class="p">:</span> <span class="mi">20639797248</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"os_version"</span><span class="p">:</span> <span class="s2">"Ubuntu 14.04.2 LTS"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_storage_path"</span><span class="p">:</span> <span class="s2">"/var/opt/redislabs/tmp"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"architecture"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"shard_count"</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"public_addr"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cores"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"rack_id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"supported_database_versions"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"db_type"</span><span class="p">:</span> <span class="s2">"memcached"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"version"</span><span class="p">:</span> <span class="s2">"1.4.17"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"db_type"</span><span class="p">:</span> <span class="s2">"redis"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"version"</span><span class="p">:</span> <span class="s2">"2.6.16"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"db_type"</span><span class="p">:</span> <span class="s2">"redis"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"version"</span><span class="p">:</span> <span class="s2">"2.8.19"</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"shard_list"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"addr"</span><span class="p">:</span> <span class="s2">"10.0.3.61"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"active"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional fields..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span></code></pre>
</div>
<h4 id="get-all-status-codes">
Status codes
</h4>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<h2 id="get-node">
Get node
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/nodes/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Get a single cluster node.
</p>
<h3 id="permissions-1">
Permissions
</h3>
<table>
<thead>
<tr>
<th>
Permission name
</th>
<th>
Roles
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#view_node_info">
view_node_info
</a>
</td>
<td>
admin
<br/>
cluster_member
<br/>
cluster_viewer
<br/>
db_member
<br/>
db_viewer
<br/>
user_manager
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /nodes/1
</span></span></code></pre>
</div>
<h4 id="headers-1">
Headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The unique ID of the node requested.
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a
<a href="/docs/latest/operate/rs/references/rest-api/objects/node/">
node object
</a>
.
</p>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"node:1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"// additional fields..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Node UID does not exist
</td>
</tr>
</tbody>
</table>
<h2 id="put-node">
Update node
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/nodes/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Update a
<a href="/docs/latest/operate/rs/references/rest-api/objects/node/">
node object
</a>
.
</p>
<p>
Currently, you can edit the following attributes:
</p>
<ul>
<li>
<p>
<code>
addr
</code>
</p>
</li>
<li>
<p>
<code>
external_addr
</code>
</p>
</li>
<li>
<p>
<code>
recovery_path
</code>
</p>
</li>
<li>
<p>
<code>
accept_servers
</code>
</p>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
You can only update the
<code>
addr
</code>
attribute for offline nodes. Otherwise, the request returns an error.
</div>
</div>
<h3 id="permissions-2">
Permissions
</h3>
<table>
<thead>
<tr>
<th>
Permission name
</th>
<th>
Roles
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/permissions/#update_node">
update_node
</a>
</td>
<td>
admin
</td>
</tr>
</tbody>
</table>
<h3 id="put-request">
Request
</h3>
<h4 id="example-http-request-2">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /nodes/1
</span></span></code></pre>
</div>
<h4 id="example-json-body-2">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"addr"</span><span class="p">:</span> <span class="s2">"10.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"external_addr"</span> <span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"192.0.2.24"</span>
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
<tr>
<td>
Content-Type
</td>
<td>
application/json
</td>
<td>
Media type of request/response body
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters-1">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The unique ID of the updated node.
</td>
</tr>
</tbody>
</table>
<h4 id="body">
Body
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
addr
</td>
<td>
string
</td>
<td>
Internal IP address of node
</td>
</tr>
<tr>
<td>
external_addr
</td>
<td>
JSON array
</td>
<td>
External IP addresses of the node
</td>
</tr>
<tr>
<td>
recovery_path
</td>
<td>
string
</td>
<td>
Path for recovery files
</td>
</tr>
<tr>
<td>
accept_servers
</td>
<td>
boolean
</td>
<td>
If true, no shards will be created on the node
</td>
</tr>
</tbody>
</table>
<h3 id="put-response">
Response
</h3>
<p>
If the request is successful, the body will be empty. Otherwise, it may contain a JSON object with an error code and error message.
</p>
<h4 id="put-status-codes">
Status codes
</h4>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error, the request has been processed.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
Update request cannot be processed.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Bad content provided.
</td>
</tr>
</tbody>
</table>
<h4 id="put-error-codes">
Error codes
</h4>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
node_not_found
</td>
<td>
Node does not exist
</td>
</tr>
<tr>
<td>
node_not_offline
</td>
<td>
Attempted to change node address while it is online
</td>
</tr>
<tr>
<td>
node_already_populated
</td>
<td>
The node contains shards or endpoints, cannot disable accept_servers
</td>
</tr>
<tr>
<td>
invalid_oss_cluster_port_mapping
</td>
<td>
Cannot enable "accept_servers" since there are databases with "oss_cluster_port_mapping" that do not have a port configuration for the current node
</td>
</tr>
<tr>
<td>
node_already_has_rack_id
</td>
<td>
Attempted to change node's rack_id when it already has one
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/nodes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/bind/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin bind
</h1>
<p class="text-lg -mt-5 mb-10">
Manages the proxy policy for a specified database endpoint.
</p>
<p>
Manages the proxy policy for a specific database endpoint.
</p>
<h2 id="bind-endpoint-exclude">
<code>
bind endpoint exclude
</code>
</h2>
<p>
Defines a list of nodes to exclude from the proxy policy for a specific database endpoint. When you exclude a node, the endpoint cannot bind to the node's proxy.
</p>
<p>
Each time you run an exclude command, it overwrites the previous list of excluded nodes.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint <id> exclude
</span></span><span class="line"><span class="cl"> <proxy_id1 .. proxy_idN>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Only allows endpoints for the specified database
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
endpoint ID
</td>
<td>
Changes proxy settings for the specified endpoint
</td>
</tr>
<tr>
<td>
proxy
</td>
<td>
list of proxy IDs
</td>
<td>
Proxies to exclude
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns
<code>
Finished successfully
</code>
if the list of excluded proxies was successfully changed. Otherwise, it returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the policy changed.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:2 all-nodes No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-nodes No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-nodes No
</span></span><span class="line"><span class="cl">$ rladmin <span class="nb">bind</span> endpoint 6:1 exclude <span class="m">2</span>
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-nodes -2 No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-nodes -2 No
</span></span></code></pre>
</div>
<h2 id="bind-endpoint-include">
<code>
bind endpoint include
</code>
</h2>
<p>
Defines a list of nodes to include in the proxy policy for the specific database endpoint.
</p>
<p>
Each time you run an include command, it overwrites the previous list of included nodes.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint <id> include
</span></span><span class="line"><span class="cl"> <proxy_id1 .. proxy_idN>
</span></span></code></pre>
</div>
<h3 id="parameters-1">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Only allows endpoints for the specified database
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
endpoint ID
</td>
<td>
Changes proxy settings for the specified endpoint
</td>
</tr>
<tr>
<td>
proxy
</td>
<td>
list of proxy IDs
</td>
<td>
Proxies to include
</td>
</tr>
</tbody>
</table>
<h3 id="returns-1">
Returns
</h3>
<p>
Returns
<code>
Finished successfully
</code>
if the list of included proxies was successfully changed. Otherwise, it returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the policy changed.
</p>
<h3 id="example-1">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards No
</span></span><span class="line"><span class="cl">$ rladmin <span class="nb">bind</span> endpoint 6:1 include <span class="m">3</span>
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-master-shards +3 No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards +3 No
</span></span></code></pre>
</div>
<h2 id="bind-endpoint-policy">
<code>
bind endpoint policy
</code>
</h2>
<p>
Changes the overall proxy policy for a specific database endpoint.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin <span class="nb">bind</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint <id>
</span></span><span class="line"><span class="cl"> policy <span class="o">{</span> single <span class="p">|</span> all-master-shards <span class="p">|</span> all-nodes <span class="o">}</span>
</span></span></code></pre>
</div>
<h3 id="parameters-2">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Only allows endpoints for the specified database
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
endpoint ID
</td>
<td>
Changes proxy settings for the specified endpoint
</td>
</tr>
<tr>
<td>
policy
</td>
<td>
<nobr>
'all-master-shards'
</nobr>
<br/>
<nobr>
'all-nodes'
</nobr>
<br/>
'single'
</td>
<td>
Changes the
<a href="#proxy-policies">
proxy policy
</a>
to the specified policy
</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>
Proxy policy
<a name="proxy-policies">
</a>
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
all-master-shards
</td>
<td>
Multiple proxies, one on each master node (best for high traffic and multiple master shards)
</td>
</tr>
<tr>
<td>
all-nodes
</td>
<td>
Multiple proxies, one on each node of the cluster (increases traffic in the cluster, only used in special cases)
</td>
</tr>
<tr>
<td>
single
</td>
<td>
All traffic flows through a single proxy bound to the database endpoint (preferable in most cases)
</td>
</tr>
</tbody>
</table>
<h3 id="returns-2">
Returns
</h3>
<p>
Returns
<code>
Finished successfully
</code>
if the proxy policy was successfully changed. Otherwise, it returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the policy changed.
</p>
<h3 id="example-2">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-nodes -2 No
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-nodes -2 No
</span></span><span class="line"><span class="cl">$ rladmin <span class="nb">bind</span> endpoint 6:1 policy all-master-shards
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards No
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/bind/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/grouptimeseries.html | <section class="prose w-full py-12">
<h1>
Commands
</h1>
</section>
|
https://redis.io/docs/latest/commands/xlen/.html | <section class="prose w-full py-12">
<h1 class="command-name">
XLEN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">XLEN key</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
5.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@stream
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Returns the number of entries inside a stream. If the specified key does not
exist the command returns zero, as if the stream was empty.
However note that unlike other Redis types, zero-length streams are
possible, so you should call
<a href="/docs/latest/commands/type/">
<code>
TYPE
</code>
</a>
or
<a href="/docs/latest/commands/exists/">
<code>
EXISTS
</code>
</a>
in order to check if
a key exists or not.
</p>
<p>
Streams are not auto-deleted once they have no entries inside (for instance
after an
<a href="/docs/latest/commands/xdel/">
<code>
XDEL
</code>
</a>
call), because the stream may have consumer groups
associated with it.
</p>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> XADD mystream * item 1
"1731577893423-0"
redis> XADD mystream * item 2
"1731577893423-1"
redis> XADD mystream * item 3
"1731577893423-2"
redis> XLEN mystream
(integer) 3
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the number of entries of the stream at
<em>
key
</em>
.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/xlen/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-start/.html | <section class="prose w-full py-12">
<h1>
redis-di start
</h1>
<p class="text-lg -mt-5 mb-10">
Starts the pipeline
</p>
<h2 id="usage">
Usage
</h2>
<pre tabindex="0"><code>Usage: redis-di start [OPTIONS]
</code></pre>
<h2 id="options">
Options
</h2>
<ul>
<li>
<p>
<code>
log_level
</code>
:
</p>
<ul>
<li>
Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
</li>
<li>
Default:
<code>
info
</code>
</li>
<li>
Usage:
<code>
--log-level -l
</code>
</li>
</ul>
</li>
<li>
<p>
<code>
rdi_host
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-host
</code>
</li>
</ul>
<p>
Host/IP of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_port
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: <IntRange 1<=x<=65535>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-port
</code>
</li>
</ul>
<p>
Port of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_user
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-user
</code>
</li>
</ul>
<p>
RDI Database Username
</p>
</li>
<li>
<p>
<code>
rdi_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-password
</code>
</li>
</ul>
<p>
RDI Database Password
</p>
</li>
<li>
<p>
<code>
rdi_key
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key
</code>
</li>
</ul>
<p>
Private key file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cert
</code>
</li>
</ul>
<p>
Client certificate file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cacert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cacert
</code>
</li>
</ul>
<p>
CA certificate file to verify with
</p>
</li>
<li>
<p>
<code>
rdi_key_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key-password
</code>
</li>
</ul>
<p>
Password for unlocking an encrypted private key
</p>
</li>
<li>
<p>
<code>
help
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--help
</code>
</li>
</ul>
<p>
Show this message and exit.
</p>
</li>
</ul>
<h2 id="cli-help">
CLI help
</h2>
<pre tabindex="0"><code>Usage: redis-di start [OPTIONS]
Starts the pipeline
Options:
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--rdi-host TEXT Host/IP of RDI Database [required]
--rdi-port INTEGER RANGE Port of RDI Database [1<=x<=65535;
required]
--rdi-user TEXT RDI Database Username
--rdi-password TEXT RDI Database Password
--rdi-key TEXT Private key file to authenticate with
--rdi-cert TEXT Client certificate file to authenticate with
--rdi-cacert TEXT CA certificate file to verify with
--rdi-key-password TEXT Password for unlocking an encrypted private
key
--help Show this message and exit.
</code></pre>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-start/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/databases/configuration/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure databases
</h1>
<p class="text-lg -mt-5 mb-10">
Provides background information to help you configure Redis Cloud databases to best fit your needs.
</p>
<p>
Here, you'll find background info and conceptual details to help you customize your Redis Cloud databases to meet your needs.
</p>
<nav>
<a href="/docs/latest/operate/rc/databases/configuration/active-active-redis/">
Active-Active Redis
</a>
<p>
Overview of the Active-Active feature for Redis Cloud.
</p>
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/">
Advanced capabilities
</a>
<p>
Describes Redis Cloud Advanced capability options.
</p>
<a href="/docs/latest/operate/rc/databases/configuration/clustering/">
Clustering Redis Databases
</a>
<p>
Redis Cloud uses clustering to manage very large databases (25 GB and larger). Here, you'll learn how to manage clustering and how to use hashing policies to control how data is managed.
</p>
<a href="/docs/latest/operate/rc/databases/configuration/data-eviction-policies/">
Data eviction
</a>
<p>
Data eviction policies control what happens when new data exceeds the memory limits of a database. Here, you'll learn the available policies and how to change which one is used for a database.
</p>
<a href="/docs/latest/operate/rc/databases/configuration/data-persistence/">
Data persistence
</a>
<p>
Data persistence enables recovery in the event of memory loss or other catastrophic failure. Here, you learn data persistence options, when they're available, and how to apply specific settings to individual databases.
</p>
<a href="/docs/latest/operate/rc/databases/configuration/high-availability/">
High availability and replication
</a>
<p>
Describes database replication and high availability as it affects Redis Cloud.
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/databases/configuration/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin migrate
</h1>
<p class="text-lg -mt-5 mb-10">
Moves Redis Enterprise Software shards or endpoints to a new node in the same cluster.
</p>
<p>
Moves Redis Enterprise shards or endpoints to a new node in the same cluster.
</p>
<p>
For more information about shard migration use cases and considerations, see
<a href="/docs/latest/operate/rs/7.4/databases/migrate-shards/">
Migrate database shards
</a>
.
</p>
<h2 id="migrate-all_master_shards">
<code>
migrate all_master_shards
</code>
</h2>
<p>
Moves all primary shards of a specified database or node to a new node in the same cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin migrate <span class="o">{</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="p">|</span> node <origin node ID> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> all_master_shards
</span></span><span class="line"><span class="cl"> target_node <id>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> override_policy <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Limits migration to a specific database
</td>
</tr>
<tr>
<td>
node
</td>
<td>
integer
</td>
<td>
Limits migration to a specific origin node
</td>
</tr>
<tr>
<td>
target_node
</td>
<td>
integer
</td>
<td>
Migration target node
</td>
</tr>
<tr>
<td>
override_policy
</td>
<td>
</td>
<td>
Overrides the rack aware policy and allows primary and replica shards on the same node
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns
<code>
Done
</code>
if the migration completed successfully. Otherwise, returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-shards">
<code>
rladmin status shards
</code>
</a>
to verify the migration completed.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status shards db db:6 sort ROLE
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:6 tr02 redis:14 node:3 master 0-4095 3.01MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:16 node:3 master 4096-8191 3.2MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:18 node:3 master 8192-12287 3.2MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:20 node:3 master 12288-16383 3.01MB OK
</span></span><span class="line"><span class="cl">$ rladmin migrate db db:6 all_master_shards target_node <span class="m">1</span>
</span></span><span class="line"><span class="cl">Monitoring 8b0f28e2-4342-427a-a8e3-a68cba653ffe
</span></span><span class="line"><span class="cl">queued - migrate_shards
</span></span><span class="line"><span class="cl">running - migrate_shards
</span></span><span class="line"><span class="cl">Executing migrate_redis with shards_uids <span class="o">[</span><span class="s1">'18'</span>, <span class="s1">'14'</span>, <span class="s1">'20'</span>, <span class="s1">'16'</span><span class="o">]</span>
</span></span><span class="line"><span class="cl">Ocompleted - migrate_shards
</span></span><span class="line"><span class="cl">Done
</span></span><span class="line"><span class="cl">$ rladmin status shards node <span class="m">1</span>
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:6 tr02 redis:14 node:1 master 0-4095 3.22MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:16 node:1 master 4096-8191 3.22MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:18 node:1 master 8192-12287 3.22MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:20 node:1 master 12288-16383 2.99MB OK
</span></span></code></pre>
</div>
<h2 id="migrate-all_shards">
<code>
migrate all_shards
</code>
</h2>
<p>
Moves all shards on a specified node to a new node in the same cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin migrate node <origin node ID>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> max_concurrent_bdb_migrations <value> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> all_shards
</span></span><span class="line"><span class="cl"> target_node <id>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> override_policy <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters-1">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
node
</td>
<td>
integer
</td>
<td>
Limits migration to a specific origin node
</td>
</tr>
<tr>
<td>
max_concurrent_bdb_migrations
</td>
<td>
integer
</td>
<td>
Sets the maximum number of concurrent endpoint migrations
</td>
</tr>
<tr>
<td>
override_policy
</td>
<td>
</td>
<td>
Overrides the rack aware policy and allows primary and replica shards on the same node
</td>
</tr>
</tbody>
</table>
<h3 id="returns-1">
Returns
</h3>
<p>
Returns
<code>
Done
</code>
if the migration completed successfully. Otherwise, returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-shards">
<code>
rladmin status shards
</code>
</a>
to verify the migration completed.
</p>
<h3 id="example-1">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status shards node <span class="m">1</span>
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:5 tr01 redis:12 node:1 master 0-16383 3.04MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:15 node:1 slave 0-4095 2.93MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:17 node:1 slave 4096-8191 2.93MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:19 node:1 slave 8192-12287 3.08MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:21 node:1 slave 12288-16383 3.08MB OK
</span></span><span class="line"><span class="cl">$ rladmin migrate node <span class="m">1</span> all_shards target_node <span class="m">2</span>
</span></span><span class="line"><span class="cl">Monitoring 71a4f371-9264-4398-a454-ce3ff4858c09
</span></span><span class="line"><span class="cl">queued - migrate_shards
</span></span><span class="line"><span class="cl">.running - migrate_shards
</span></span><span class="line"><span class="cl">Executing migrate_redis with shards_uids <span class="o">[</span><span class="s1">'21'</span>, <span class="s1">'15'</span>, <span class="s1">'17'</span>, <span class="s1">'19'</span><span class="o">]</span>
</span></span><span class="line"><span class="cl">OExecuting migrate_redis with shards_uids <span class="o">[</span><span class="s1">'12'</span><span class="o">]</span>
</span></span><span class="line"><span class="cl">Ocompleted - migrate_shards
</span></span><span class="line"><span class="cl">Done
</span></span><span class="line"><span class="cl">$ rladmin status shards node <span class="m">2</span>
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:5 tr01 redis:12 node:2 master 0-16383 3.14MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:15 node:2 slave 0-4095 2.96MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:17 node:2 slave 4096-8191 2.96MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:19 node:2 slave 8192-12287 2.96MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:21 node:2 slave 12288-16383 2.96MB OK
</span></span></code></pre>
</div>
<h2 id="migrate-all_slave_shards">
<code>
migrate all_slave_shards
</code>
</h2>
<p>
Moves all replica shards of a specified database or node to a new node in the same cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin migrate <span class="o">{</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="p">|</span> node <origin node ID> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> all_slave_shards
</span></span><span class="line"><span class="cl"> target_node <id>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> override_policy <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters-2">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Limits migration to a specific database
</td>
</tr>
<tr>
<td>
node
</td>
<td>
integer
</td>
<td>
Limits migration to a specific origin node
</td>
</tr>
<tr>
<td>
target_node
</td>
<td>
integer
</td>
<td>
Migration target node
</td>
</tr>
<tr>
<td>
override_policy
</td>
<td>
</td>
<td>
Overrides the rack aware policy and allows primary and replica shards on the same node
</td>
</tr>
</tbody>
</table>
<h3 id="returns-2">
Returns
</h3>
<p>
Returns
<code>
Done
</code>
if the migration completed successfully. Otherwise, returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-shards">
<code>
rladmin status shards
</code>
</a>
to verify the migration completed.
</p>
<h3 id="example-2">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status shards db db:6 node <span class="m">2</span>
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:6 tr02 redis:15 node:2 slave 0-4095 3.06MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:17 node:2 slave 4096-8191 3.06MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:19 node:2 slave 8192-12287 3.06MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:21 node:2 slave 12288-16383 3.06MB OK
</span></span><span class="line"><span class="cl">$ rladmin migrate db db:6 all_slave_shards target_node <span class="m">3</span>
</span></span><span class="line"><span class="cl">Monitoring 5d36a98c-3dc8-435f-8ed9-35809ba017a4
</span></span><span class="line"><span class="cl">queued - migrate_shards
</span></span><span class="line"><span class="cl">.running - migrate_shards
</span></span><span class="line"><span class="cl">Executing migrate_redis with shards_uids <span class="o">[</span><span class="s1">'15'</span>, <span class="s1">'17'</span>, <span class="s1">'21'</span>, <span class="s1">'19'</span><span class="o">]</span>
</span></span><span class="line"><span class="cl">Ocompleted - migrate_shards
</span></span><span class="line"><span class="cl">Done
</span></span><span class="line"><span class="cl">$ rladmin status shards db db:6 node <span class="m">3</span>
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:6 tr02 redis:15 node:3 slave 0-4095 3.04MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:17 node:3 slave 4096-8191 3.04MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:19 node:3 slave 8192-12287 3.04MB OK
</span></span><span class="line"><span class="cl">db:6 tr02 redis:21 node:3 slave 12288-16383 3.04MB OK
</span></span></code></pre>
</div>
<h2 id="migrate-endpoint_to_shards">
<code>
migrate endpoint_to_shards
</code>
</h2>
<p>
Moves database endpoints to the node where the majority of primary shards are located.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin migrate <span class="o">[</span> db <span class="o">{</span> db:<id> <span class="p">|</span> <name> <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> endpoint_to_shards
</span></span><span class="line"><span class="cl"> <span class="o">[</span> restrict_target_node <id> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> commit <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> max_concurrent_bdb_migrations <value> <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters-3">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db
</td>
<td>
db:<id>
<br/>
name
</td>
<td>
Limits migration to a specific database
</td>
</tr>
<tr>
<td>
restrict_target_node
</td>
<td>
integer
</td>
<td>
Moves the endpoint only if the target node matches the specified node
</td>
</tr>
<tr>
<td>
commit
</td>
<td>
</td>
<td>
Performs endpoint movement
</td>
</tr>
<tr>
<td>
max_concurrent_bdb_migrations
</td>
<td>
integer
</td>
<td>
Sets the maximum number of concurrent endpoint migrations
</td>
</tr>
</tbody>
</table>
<h3 id="returns-3">
Returns
</h3>
<p>
Returns a list of steps to perform the migration. If the
<code>
commit
</code>
flag is set, the steps will run and return
<code>
Finished successfully
</code>
if they were completed. Otherwise, returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-endpoints">
<code>
rladmin status endpoints
</code>
</a>
to verify that the endpoints were moved.
</p>
<h3 id="example-3">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:3 all-master-shards No
</span></span><span class="line"><span class="cl">$ rladmin migrate db db:6 endpoint_to_shards
</span></span><span class="line"><span class="cl">* Going to <span class="nb">bind</span> endpoint:6:1 to node <span class="m">1</span>
</span></span><span class="line"><span class="cl">Dry-run completed, add <span class="s1">'commit'</span> argument to execute
</span></span><span class="line"><span class="cl">$ rladmin migrate db db:6 endpoint_to_shards commit
</span></span><span class="line"><span class="cl">* Going to <span class="nb">bind</span> endpoint:6:1 to node <span class="m">1</span>
</span></span><span class="line"><span class="cl">Executing <span class="nb">bind</span> endpoint:6:1: OOO.
</span></span><span class="line"><span class="cl">Finished successfully
</span></span><span class="line"><span class="cl">$ rladmin status endpoints db db:6
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">db:6 tr02 endpoint:6:1 node:1 all-master-shards No
</span></span></code></pre>
</div>
<h2 id="migrate-shard">
<code>
migrate shard
</code>
</h2>
<p>
Moves one or more shards to a new node in the same cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin migrate shard <id1.. idN>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> preserve_roles <span class="o">]</span>
</span></span><span class="line"><span class="cl"> target_node <id>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> override_policy <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters-4">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
shard
</td>
<td>
list of shard IDs
</td>
<td>
Shards to migrate
</td>
</tr>
<tr>
<td>
preserve_roles
</td>
<td>
</td>
<td>
Performs an additional failover to guarantee the primary shards' roles are preserved
</td>
</tr>
<tr>
<td>
target_node
</td>
<td>
integer
</td>
<td>
Migration target node
</td>
</tr>
<tr>
<td>
override_policy
</td>
<td>
</td>
<td>
Overrides the rack aware policy and allows primary and replica shards on the same node
</td>
</tr>
</tbody>
</table>
<h3 id="returns-4">
Returns
</h3>
<p>
Returns
<code>
Done
</code>
if the migration completed successfully. Otherwise, returns an error.
</p>
<p>
Use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-shards">
<code>
rladmin status shards
</code>
</a>
to verify the migration completed.
</p>
<h3 id="example-4">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status shards db db:5
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:5 tr01 redis:12 node:2 master 0-16383 3.01MB OK
</span></span><span class="line"><span class="cl">db:5 tr01 redis:13 node:3 slave 0-16383 3.1MB OK
</span></span><span class="line"><span class="cl">$ rladmin migrate shard <span class="m">13</span> target_node <span class="m">1</span>
</span></span><span class="line"><span class="cl">Monitoring d2637eea-9504-4e94-a70c-76df087efcb2
</span></span><span class="line"><span class="cl">queued - migrate_shards
</span></span><span class="line"><span class="cl">.running - migrate_shards
</span></span><span class="line"><span class="cl">Executing migrate_redis with shards_uids <span class="o">[</span><span class="s1">'13'</span><span class="o">]</span>
</span></span><span class="line"><span class="cl">Ocompleted - migrate_shards
</span></span><span class="line"><span class="cl">Done
</span></span><span class="line"><span class="cl">$ rladmin status shards db db:5
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:5 tr01 redis:12 node:2 master 0-16383 3.01MB OK
</span></span><span class="line"><span class="cl">db:5 tr01 redis:13 node:1 slave 0-16383 3.04MB OK
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/migrate/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.2-release-notes.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisTimeSeries 1.2 release rotes
</h1>
<p class="text-lg -mt-5 mb-10">
Added compression. Stable ingestion time independent of the number of the data points on a time series. API performance improvements. Extended client support.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RedisTimeSeries v1.2.7 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 5.0.0
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 6.0.12
</li>
</ul>
<h2 id="v127-june-2020">
v1.2.7 (June 2020)
</h2>
<p>
This is a maintenance release for version 1.2.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Bugfixes:
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/414">
414
</a>
Crash when a query had an empty label
<code>
(foo,)
</code>
</li>
</ul>
</li>
</ul>
<h2 id="v126-may-2020">
v1.2.6 (May 2020)
</h2>
<p>
This is a maintenance release for version 1.2.
</p>
<p>
Details:
</p>
<ul>
<li>
<p>
Minor enhancements:
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/403">
403
</a>
Support for multi-value filtering in
<code>
TS.MGET
</code>
and
<code>
TS.MRANGE
</code>
.
</li>
</ul>
</li>
<li>
<p>
Bugfixes:
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/378">
378
</a>
Using
<code>
snprintf
</code>
to ensure the same precision of floating-point value replies.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/374">
374
</a>
<code>
TS.RANGE
</code>
crashed when COUNT argument was missing.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/pull/395">
395
</a>
Check minimum compatible Redis version at module load time.
</li>
</ul>
</li>
</ul>
<h2 id="v125-march-2020">
v1.2.5 (March 2020)
</h2>
<p>
Headlines:
</p>
<ul>
<li>
This release improves overall stability and provides fixes for issues found after the previous release.
</li>
</ul>
<p>
Details:
</p>
<ul>
<li>
Bugfixes:
<ul>
<li>
#
<a href="https://github.com/redistimeseries/redistimeseries/issues/358">
358
</a>
<a href="https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!topic/redistimeseries/wH0R69e8lOs">
Wrong behaviour
</a>
in
<code>
TS.RANGE
</code>
due to shifting left.
</li>
<li>
#
<a href="https://github.com/redistimeseries/redistimeseries/issues/353">
353
</a>
Crash where the name of a time-series was already taken due to auto-compaction.
</li>
</ul>
</li>
</ul>
<h2 id="v123-february-2020">
v1.2.3 (February 2020)
</h2>
<p>
Headlines:
</p>
<ul>
<li>
This release improves overall stability and provides fixes for issues found after the previous release.
</li>
</ul>
<p>
Details:
</p>
<ul>
<li>
Bugfixes:
<ul>
<li>
#
<a href="https://github.com/redistimeseries/redistimeseries/issues/338">
338
</a>
reverting #
<a href="https://github.com/redistimeseries/redistimeseries/issues/319">
319
</a>
. Aggregation should happen on deterministic time buckets.
</li>
</ul>
</li>
</ul>
<h2 id="v12-ga-122---january-2020">
v1.2 GA (1.2.2 - January 2020)
</h2>
<p>
This is the general availability (GA) release of RedisTimeSeries 1.2 (1.2.2).
</p>
<p>
Headlines:
</p>
<ul>
<li>
Compression added which can reduce memory up to 98% and improve read performance up to 50%.
</li>
<li>
Stable ingestion time independent of the number of the data points on a time-series.
</li>
<li>
Reviewed API with performance improvements and removed ambiguity.
</li>
<li>
Extended
<a href="/docs/latest/develop/data-types/timeseries/clients/">
client support
</a>
</li>
</ul>
<p>
(we will blog about this release soon including performance improvements results and the link here)
</p>
<p>
Full details:
</p>
<ul>
<li>
<p>
Added functionality
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/261">
261
</a>
Samples are compressed using
<code>
Double Delta compression
</code>
which results in cost savings and faster query times.
</li>
<li>
Based on the
<a href="https://www.vldb.org/pvldb/vol8/p1816-teller.pdf">
Gorilla paper
</a>
.
<ul>
<li>
In theory, this can save space up to 98%. (2 bits per sample in stead of 128).
</li>
<li>
In practice, a memory reduction of 5-8x is common but depends on the use case.
</li>
</ul>
</li>
<li>
Initial benchmarks show 94% memory savings and performance improvements in reads up to XX%.
</li>
<li>
<code>
UNCOMPRESSED
</code>
option in
<code>
TS.CREATE
</code>
.
</li>
</ul>
</li>
<li>
<p>
API changes / Enhancements
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/241">
241
</a>
Overwriting the last sample with the same timestamp is not allowed.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/242">
242
</a>
revised
<code>
TS.INCRBY/DECRBY
</code>
</li>
<li>
Returns a timestamp. The behaviour is now aligned with
<code>
TS.ADD
</code>
.
</li>
<li>
The
<code>
RESET
</code>
functionality was removed.
<code>
RESET
</code>
contradicted the rewriting of the last sample (#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/241">
241
</a>
).
Alternatively, you can reconstruct similar behaviour by
<ul>
<li>
<code>
TS.ADD ts * 1
</code>
+
<code>
sum
</code>
aggregation
</li>
<li>
<code>
TS.INCRBY ts 1
</code>
+
<code>
range
</code>
aggregation
</li>
</ul>
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/317">
317
</a>
Aligning response on empty series of
<code>
TS.GET
</code>
with
<code>
TS.RANGE
</code>
.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/285">
285
</a>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/318">
318
</a>
Changed default behaviour of
<code>
TS.MRANGE
</code>
and
<code>
TS.MGET
</code>
to no longer returns the labels of each time-series in order reduce network traffic. Optional
<code>
WITHLABELS
</code>
argument added.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/319">
319
</a>
<code>
TS.RANGE
</code>
and
<code>
TS.MRANGE
</code>
aggregation starting from requested timestamp.
</li>
</ul>
</li>
<li>
<p>
Performance improvements
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/237">
237
</a>
Downsampling after time window is closed vs. downsampling with each sample.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/285">
285
</a>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/318">
318
</a>
Optional
<code>
WITHLABELS
</code>
argument added. This feature improves read performance drastically.
</li>
</ul>
</li>
<li>
<p>
Minor Enhancements
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/230">
230
</a>
<code>
TS.INFO
</code>
now includes
<code>
total samples
</code>
,
<code>
memory usage
</code>
,
<code>
first time stamp
</code>
, ...
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/230">
230
</a>
<code>
MEMORY
</code>
calculates series memory footprint.
</li>
</ul>
</li>
<li>
<p>
Bugfixes since 1.0.3
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/204">
204
</a>
Module initialization params changed to 64 bits.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/266">
266
</a>
Memory leak in the aggregator context.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/260">
260
</a>
Better error messages.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/259">
259
</a>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/257">
257
</a>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/219">
219
</a>
Miscellaneous.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/320">
320
</a>
Delete the existing key prior to restoring it.
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/323">
323
</a>
Empty first sample on aggregation.
</li>
</ul>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The version inside Redis will be 10202 or 1.2.2 in semantic versioning.
</div>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.2-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/hello/.html | <section class="prose w-full py-12">
<h1 class="command-name">
HELLO
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">HELLO [protover [AUTH username password] [SETNAME clientname]]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
6.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@connection
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Switch to a different protocol, optionally authenticating and setting the
connection's name, or provide a contextual client report.
</p>
<p>
Redis version 6 and above supports two protocols: the old protocol, RESP2, and
a new one introduced with Redis 6, RESP3. RESP3 has certain advantages since
when the connection is in this mode, Redis is able to reply with more semantical
replies: for instance,
<a href="/docs/latest/commands/hgetall/">
<code>
HGETALL
</code>
</a>
will return a
<em>
map type
</em>
, so a client library
implementation no longer requires to know in advance to translate the array into
a hash before returning it to the caller. For a full coverage of RESP3, please
check the
<a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md">
RESP3 specification
</a>
.
</p>
<p>
In Redis 6 connections start in RESP2 mode, so clients implementing RESP2 do
not need to updated or changed. There are no short term plans to drop support for
RESP2, although future version may default to RESP3.
</p>
<p>
<code>
HELLO
</code>
always replies with a list of current server and connection properties,
such as: versions, modules loaded, client ID, replication role and so forth.
When called without any arguments in Redis 6.2 and its default use of RESP2
protocol, the reply looks like this:
</p>
<pre><code>> HELLO
1) "server"
2) "redis"
3) "version"
4) "255.255.255"
5) "proto"
6) (integer) 2
7) "id"
8) (integer) 5
9) "mode"
10) "standalone"
11) "role"
12) "master"
13) "modules"
14) (empty array)
</code></pre>
<p>
Clients that want to handshake using the RESP3 mode need to call the
<code>
HELLO
</code>
command and specify the value "3" as the
<code>
protover
</code>
argument, like so:
</p>
<pre><code>> HELLO 3
1# "server" => "redis"
2# "version" => "6.0.0"
3# "proto" => (integer) 3
4# "id" => (integer) 10
5# "mode" => "standalone"
6# "role" => "master"
7# "modules" => (empty array)
</code></pre>
<p>
Because
<code>
HELLO
</code>
replies with useful information, and given that
<code>
protover
</code>
is
optional or can be set to "2", client library authors may consider using this
command instead of the canonical
<a href="/docs/latest/commands/ping/">
<code>
PING
</code>
</a>
when setting up the connection.
</p>
<p>
When called with the optional
<code>
protover
</code>
argument, this command switches the
protocol to the specified version and also accepts the following options:
</p>
<ul>
<li>
<code>
AUTH <username> <password>
</code>
: directly authenticate the connection in addition to switching to the specified protocol version. This makes calling
<a href="/docs/latest/commands/auth/">
<code>
AUTH
</code>
</a>
before
<code>
HELLO
</code>
unnecessary when setting up a new connection. Note that the
<code>
username
</code>
can be set to "default" to authenticate against a server that does not use ACLs, but rather the simpler
<code>
requirepass
</code>
mechanism of Redis prior to version 6.
</li>
<li>
<code>
SETNAME <clientname>
</code>
: this is the equivalent of calling
<a href="/docs/latest/commands/client-setname/">
<code>
CLIENT SETNAME
</code>
</a>
.
</li>
</ul>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#maps">
Map reply
</a>
: a list of server properties.
<a href="../../develop/reference/protocol-spec#simple-errors">
Simple error reply
</a>
: if the
<code>
protover
</code>
requested does not exist.
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 6.2.0:
<code>
protover
</code>
made optional; when called without arguments the command reports the current connection's context.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/hello/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/objects/crdb/instance_info/.html | <section class="prose w-full py-12 max-w-none">
<h1>
CRDB instance info object
</h1>
<p class="text-lg -mt-5 mb-10">
An object that represents Active-Active instance info
</p>
<p>
An object that represents Active-Active instance info.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
id
</td>
<td>
integer
</td>
<td>
Unique instance ID
</td>
</tr>
<tr>
<td>
cluster
</td>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/cluster_info/">
CRDB cluster_info
</a>
object
</td>
<td>
</td>
</tr>
<tr>
<td>
compression
</td>
<td>
integer
</td>
<td>
Compression level when syncing from this source
</td>
</tr>
<tr>
<td>
db_config
</td>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/objects/crdb/database_config/">
CRDB database_config
</a>
object
</td>
<td>
Database configuration
</td>
</tr>
<tr>
<td>
db_uid
</td>
<td>
string
</td>
<td>
ID of local database instance. This field is likely to be empty for instances other than the local one.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/objects/crdb/instance_info/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/sorting/.html | <section class="prose w-full py-12">
<h1>
Sorting by indexed fields
</h1>
<p class="text-lg -mt-5 mb-10">
Support for sorting query results
</p>
<p>
As of RediSearch 0.15, you can bypass the scoring function mechanism and order search results by the value of different document attributes (fields) directly, even if the sorting field is not used by the query. For example, you can search for first name and sort by last name.
</p>
<h2 id="declaring-sortable-fields">
Declaring sortable fields
</h2>
<p>
When creating an index with
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
, you can declare
<code>
TEXT
</code>
,
<code>
TAG
</code>
,
<code>
NUMERIC
</code>
, and
<code>
GEO
</code>
attributes as
<code>
SORTABLE
</code>
. When an attribute is sortable, you can order the results by its values with relatively low latency. When an attribute is not sortable, it can still be sorted by its values, but with increased latency. For example, in the following schema:
</p>
<pre tabindex="0"><code>FT.CREATE users SCHEMA first_name TEXT last_name TEXT SORTABLE age NUMERIC SORTABLE
</code></pre>
<p>
The fields
<code>
last_name
</code>
and
<code>
age
</code>
are sortable, but
<code>
first_name
</code>
isn't. This means you can search by either first and/or last name, and sort by last name or age.
</p>
<h3 id="note-on-sortable-fields">
Note on sortable fields
</h3>
<p>
In the current implementation, when declaring a sortable field, its content gets copied into a special location in the index that provides for fast access during sorting. This means that making long fields sortable is very expensive and you should be careful with it.
</p>
<h3 id="normalization-unf-option">
Normalization (UNF option)
</h3>
<p>
By default, text fields get normalized and lowercased in a Unicode-safe way when stored for sorting. For example,
<code>
America
</code>
and
<code>
america
</code>
are considered equal in terms of sorting.
</p>
<p>
Using the
<code>
UNF
</code>
(un-normalized form) argument, it is possible to disable the normalization and keep the original form of the value. Therefore,
<code>
America
</code>
will come before
<code>
america
</code>
.
</p>
<h2 id="specifying-sortby">
Specifying SORTBY
</h2>
<p>
If an index includes sortable fields, you can add the
<code>
SORTBY
</code>
parameter to the search request (outside the query body) to order the results. This overrides the scoring function mechanism, and the two cannot be combined. If
<code>
WITHSCORES
</code>
is specified together with
<code>
SORTBY
</code>
, the scores returned are simply the relative position of each result in the result set.
</p>
<p>
The syntax for
<code>
SORTBY
</code>
is:
</p>
<pre tabindex="0"><code>SORTBY {field_name} [ASC|DESC]
</code></pre>
<ul>
<li>
<p>
<code>
field_name
</code>
must be a sortable field defined in the schema.
</p>
</li>
<li>
<p>
<code>
ASC
</code>
means ascending order,
<code>
DESC
</code>
means descending order.
</p>
</li>
<li>
<p>
The default ordering is
<code>
ASC
</code>
.
</p>
</li>
</ul>
<h2 id="example">
Example
</h2>
<pre tabindex="0"><code>> FT.CREATE users ON HASH PREFIX 1 "user" SCHEMA first_name TEXT SORTABLE last_name TEXT age NUMERIC SORTABLE
# Add some users
> HSET user1 first_name "alice" last_name "jones" age 35
> HSET user2 first_name "bob" last_name "jones" age 36
# Searching while sorting
# Searching by last name and sorting by first name
> FT.SEARCH users "@last_name:jones" SORTBY first_name DESC
# Searching by both first and last name, and sorting by age
> FT.SEARCH users "jones" SORTBY age ASC
</code></pre>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/interact/search-and-query/advanced-concepts/sorting/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/cluster/join/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin cluster join
</h1>
<p class="text-lg -mt-5 mb-10">
Adds a node to an existing cluster.
</p>
<p>
Adds a node to an existing cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster join
</span></span><span class="line"><span class="cl"> nodes <node IP address>
</span></span><span class="line"><span class="cl"> username <admin user email>
</span></span><span class="line"><span class="cl"> password <admin password>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> ephemeral_path <path> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> persistent_path <path> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> ccs_persistent_path <path> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> rack_id <node rack ID> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> override_rack_id <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> replace_node <node UID> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> flash_enabled <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> flash_path <path> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> addr <IP.address> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> external_addr <IP.address.1> <span class="o">[</span><IP.address.2> ... <IP.address.N><span class="o">]</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> override_repair <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> accept_servers <span class="o">{</span> enabled <span class="p">|</span> disabled <span class="o">}</span> <span class="o">]</span>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> cnm_http_port <port> <span class="o">]</span>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
accept_servers
</td>
<td>
'enabled'
<br/>
'disabled'
</td>
<td>
Allows allocation of resources on the new node when enabled (optional)
</td>
</tr>
<tr>
<td>
addr
</td>
<td>
IP address
</td>
<td>
Sets a node's internal IP address. If not provided, the node sets the address automatically. (optional)
</td>
</tr>
<tr>
<td>
ccs_persistent_path
</td>
<td>
filepath (default: /var/opt/redislabs/persist)
</td>
<td>
Path to the CCS snapshot location (the default is the same as persistent_path) (optional)
</td>
</tr>
<tr>
<td>
cnm_http_port
</td>
<td>
integer
</td>
<td>
Joins a cluster that has a non-default cnm_http_port (optional)
</td>
</tr>
<tr>
<td>
ephemeral_path
</td>
<td>
filepath
</td>
<td>
Path to the ephemeral storage location (optional)
</td>
</tr>
<tr>
<td>
external_addr
</td>
<td>
list of IP addresses
</td>
<td>
Sets a node's external IP addresses (space-delimited list). If not provided, the node sets the address automatically. (optional)
</td>
</tr>
<tr>
<td>
flash_enabled
</td>
<td>
</td>
<td>
Enables flash capabilities for a database (optional)
</td>
</tr>
<tr>
<td>
flash_path
</td>
<td>
filepath (default: /var/opt/redislabs/flash)
</td>
<td>
Path to the flash storage location in case the node does not support CAPI (required if flash_enabled)
</td>
</tr>
<tr>
<td>
nodes
</td>
<td>
IP address
</td>
<td>
Internal IP address of an existing node in the cluster
</td>
</tr>
<tr>
<td>
override_rack_id
</td>
<td>
</td>
<td>
Changes to a new rack, specified by
<code>
rack_id
</code>
(optional)
</td>
</tr>
<tr>
<td>
override_repair
</td>
<td>
</td>
<td>
Enables joining a cluster with a dead node (optional)
</td>
</tr>
<tr>
<td>
password
</td>
<td>
string
</td>
<td>
Admin user's password
</td>
</tr>
<tr>
<td>
persistent_path
</td>
<td>
filepath (default: /var/opt/redislabs/persist)
</td>
<td>
Path to the persistent storage location (optional)
</td>
</tr>
<tr>
<td>
rack_id
</td>
<td>
string
</td>
<td>
Moves the node to the specified rack (optional)
</td>
</tr>
<tr>
<td>
replace_node
</td>
<td>
integer
</td>
<td>
Replaces the specified node with the new node (optional)
</td>
</tr>
<tr>
<td>
username
</td>
<td>
email address
</td>
<td>
Admin user's email address
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns
<code>
ok
</code>
if the node joined the cluster successfully. Otherwise, it returns an error message.
</p>
<h3 id="example">
Example
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin cluster join nodes 192.0.2.2 <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> username [email protected] <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> password admin-password
</span></span><span class="line"><span class="cl">Joining cluster... ok
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/cluster/join/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/deployment/openshift/openshift-cli/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Deployment with OpenShift CLI for Redis Enterprise for Kubernetes
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Enterprise for Kubernetes and cluster can be installed via CLI tools OpenShift
</p>
<p>
Use these steps to set up a Redis Enterprise Software cluster with OpenShift.
</p>
<h2 id="prerequisites">
Prerequisites
</h2>
<ul>
<li>
<a href="https://docs.openshift.com/container-platform/4.8/installing/index.html">
OpenShift cluster
</a>
with at least 3 nodes (each meeting the
<a href="/docs/latest/operate/rs/installing-upgrading/install/plan-deployment/hardware-requirements/">
minimum requirements for a development installation
</a>
)
</li>
<li>
<a href="https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html">
OpenShift CLI
</a>
</li>
</ul>
<p>
To see which version of Redis Enterprise for Kubernetes supports your OpenShift version, see
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Supported Kubernetes distributions
</a>
.
</p>
<h2 id="deploy-the-operator">
Deploy the operator
</h2>
<ol>
<li>
<p>
Create a new project.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc new-project <your-project-name>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Verify the newly created project.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc project <your-project-name>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Get the deployment files.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">git clone https://github.com/RedisLabs/redis-enterprise-k8s-docs
</span></span></code></pre>
</div>
</li>
<li>
<p>
Deploy the OpenShift operator bundle.
</p>
<p>
If you are using version 6.2.18-41 or earlier, you must
<a href="#install-security-context-constraint">
apply the security context constraint
</a>
before the operator bundle.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc apply -f openshift.bundle.yaml
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Changes to the
<code>
openshift.bundle.yaml
</code>
file can cause unexpected results.
</div>
</div>
</li>
<li>
<p>
Verify that your
<code>
redis-enterprise-operator
</code>
deployment is running.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc get deployment
</span></span></code></pre>
</div>
<p>
A typical response looks like this:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">NAME READY UP-TO-DATE AVAILABLE AGE
</span></span><span class="line"><span class="cl">redis-enterprise-operator 1/1 <span class="m">1</span> <span class="m">1</span> 0m36s
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
DO NOT modify or delete the StatefulSet created during the deployment process. Doing so could destroy your Redis Enterprise cluster (REC).
</div>
</div>
</li>
</ol>
<h2 id="install-security-context-constraint">
Install security context constraint
</h2>
<p>
The Redis Enterprise pods must run in OpenShift with privileges set in a
<a href="https://docs.openshift.com/container-platform/4.4/authentication/managing-security-context-constraints.html#security-context-constraints-about_configuring-internal-oauth">
Security Context Constraint
</a>
. This grants the pod various rights, such as the ability to change system limits or run as a particular user.
</p>
<ol>
<li>
<p>
Apply the file
<code>
scc.yaml
</code>
file.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Do not edit this file.
</div>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc apply -f openshift/scc.yaml
</span></span></code></pre>
</div>
<p>
You should receive the following response:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">securitycontextconstraints.security.openshift.io <span class="s2">"redis-enterprise-scc-v2"</span> configured
</span></span></code></pre>
</div>
<p>
Releases before 6.4.2-6 use the earlier version of the SCC, named
<code>
redis-enterprise-scc
</code>
.
</p>
</li>
<li>
<p>
Provide the operator permissions for the pods.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc adm policy add-scc-to-user redis-enterprise-scc-v2 <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> system:serviceaccount:<my-project>:<rec>
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<p>
If you are using version 6.2.18-41 or earlier, add additional permissions for your cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc adm policy add-scc-to-user redis-enterprise-scc <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span>system:serviceaccount:<my-project>:redis-enterprise-operator
</span></span></code></pre>
</div>
</div>
</div>
</li>
</ol>
<p>
You can check the name of your project using the
<code>
oc project
</code>
command. To replace the project name, use
<code>
oc edit project myproject
</code>
. Replace
<code>
rec
</code>
with the name of your Redis Enterprise cluster, if different.
</p>
<h2 id="create-a-redis-enterprise-cluster-custom-resource">
Create a Redis Enterprise cluster custom resource
</h2>
<ol>
<li>
<p>
Apply the
<code>
RedisEnterpriseCluster
</code>
resource file (
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/openshift/rec_rhel.yaml">
rec_rhel.yaml
</a>
).
</p>
<p>
You can rename the file to
<code>
<your_cluster_name>.yaml
</code>
, but it is not required. Examples below use
<code>
<rec_rhel>.yaml
</code>
.
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_cluster_api/">
Options for Redis Enterprise clusters
</a>
has more info about the Redis Enterprise cluster (REC) custom resource, or see the
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_cluster_api/">
Redis Enterprise cluster API
</a>
for a full list of options.
</p>
<p>
The REC name cannot be changed after cluster creation.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Each Redis Enterprise cluster requires at least 3 nodes. Single-node RECs are not supported.
</div>
</div>
</li>
<li>
<p>
Apply the custom resource file to create your Redis Enterprise cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc apply -f <rec_rhel>.yaml
</span></span></code></pre>
</div>
<p>
The operator typically creates the REC within a few minutes.
</p>
</li>
<li>
<p>
Check the cluster status.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc get pod
</span></span></code></pre>
</div>
<p>
You should receive a response similar to the following:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"> NAME <span class="p">|</span> READY <span class="p">|</span> STATUS <span class="p">|</span> RESTARTS <span class="p">|</span> AGE <span class="p">|</span>
</span></span><span class="line"><span class="cl"><span class="p">|</span> -------------------------------- <span class="p">|</span> ----- <span class="p">|</span> ------- <span class="p">|</span> -------- <span class="p">|</span> --- <span class="p">|</span>
</span></span><span class="line"><span class="cl"><span class="p">|</span> rec-name-0 <span class="p">|</span> 2/2 <span class="p">|</span> Running <span class="p">|</span> <span class="m">0</span> <span class="p">|</span> 1m <span class="p">|</span>
</span></span><span class="line"><span class="cl"><span class="p">|</span> rec-name-1 <span class="p">|</span> 2/2 <span class="p">|</span> Running <span class="p">|</span> <span class="m">0</span> <span class="p">|</span> 1m <span class="p">|</span>
</span></span><span class="line"><span class="cl"><span class="p">|</span> rec-name-2 <span class="p">|</span> 2/2 <span class="p">|</span> Running <span class="p">|</span> <span class="m">0</span> <span class="p">|</span> 1m <span class="p">|</span>
</span></span><span class="line"><span class="cl"><span class="p">|</span> rec-name-controller-x-x <span class="p">|</span> 1/1 <span class="p">|</span> Running <span class="p">|</span> <span class="m">0</span> <span class="p">|</span> 1m <span class="p">|</span>
</span></span><span class="line"><span class="cl"><span class="p">|</span> Redis-enterprise-operator-x-x <span class="p">|</span> 1/1 <span class="p">|</span> Running <span class="p">|</span> <span class="m">0</span> <span class="p">|</span> 5m <span class="p">|</span>
</span></span></code></pre>
</div>
</li>
</ol>
<h2 id="configure-the-admission-controller">
Configure the admission controller
</h2>
<ol>
<li>
<p>
Verify the
<code>
admission-tls
</code>
secret exists.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl get secret admission-tls
</span></span></code></pre>
</div>
<p>
The output should look similar to
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">NAME TYPE DATA AGE
</span></span><span class="line"><span class="cl">admission-tls Opaque <span class="m">2</span> 2m43s
</span></span></code></pre>
</div>
</li>
<li>
<p>
Save the certificate to a local environment variable.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"><span class="nv">CERT</span><span class="o">=</span><span class="sb">`</span>kubectl get secret admission-tls -o <span class="nv">jsonpath</span><span class="o">=</span><span class="s1">'{.data.cert}'</span><span class="sb">`</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Create a Kubernetes validating webhook, replacing
<code>
<namespace>
</code>
with the namespace where the REC was installed.
</p>
<p>
The
<code>
webhook.yaml
</code>
template can be found in
<a href="https://github.com/RedisLabs/redis-enterprise-k8s-docs/tree/master/admission">
redis-enterprise-k8s-docs/admission
</a>
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sed <span class="s1">'s/OPERATOR_NAMESPACE/<namespace>/g'</span> webhook.yaml <span class="p">|</span> kubectl create -f -
</span></span></code></pre>
</div>
</li>
<li>
<p>
Create a patch file for the Kubernetes validating webhook.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">cat > modified-webhook.yaml <span class="s"><<EOF
</span></span></span><span class="line"><span class="cl"><span class="s">webhooks:
</span></span></span><span class="line"><span class="cl"><span class="s">- name: redisenterprise.admission.redislabs
</span></span></span><span class="line"><span class="cl"><span class="s"> clientConfig:
</span></span></span><span class="line"><span class="cl"><span class="s"> caBundle: $CERT
</span></span></span><span class="line"><span class="cl"><span class="s">EOF</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Patch the webhook with the certificate.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">kubectl patch ValidatingWebhookConfiguration <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> redis-enterprise-admission --patch <span class="s2">"</span><span class="k">$(</span>cat modified-webhook.yaml<span class="k">)</span><span class="s2">"</span>
</span></span></code></pre>
</div>
</li>
</ol>
<h3 id="limit-the-webhook-to-relevant-namespaces">
Limit the webhook to relevant namespaces
</h3>
<p>
If not limited, the webhook intercepts requests from all namespaces. If you have several REC objects in your Kubernetes cluster, limit the webhook to the relevant namespaces. If you aren't using multiple namespaces, skip this step.
</p>
<ol>
<li>
<p>
Verify your namespace is labeled and the label is unique to this namespace, as shown in the next example.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">apiVersion: v1
</span></span><span class="line"><span class="cl">kind: Namespace
</span></span><span class="line"><span class="cl">metadata:
</span></span><span class="line"><span class="cl"> labels:
</span></span><span class="line"><span class="cl"> namespace-name: staging
</span></span><span class="line"><span class="cl">name: staging
</span></span></code></pre>
</div>
</li>
<li>
<p>
Patch the webhook spec with the
<code>
namespaceSelector
</code>
field.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">cat > modified-webhook.yaml <span class="s"><<EOF
</span></span></span><span class="line"><span class="cl"><span class="s">webhooks:
</span></span></span><span class="line"><span class="cl"><span class="s">- name: redisenterprise.admission.redislabs
</span></span></span><span class="line"><span class="cl"><span class="s"> namespaceSelector:
</span></span></span><span class="line"><span class="cl"><span class="s"> matchLabels:
</span></span></span><span class="line"><span class="cl"><span class="s"> namespace-name: staging
</span></span></span><span class="line"><span class="cl"><span class="s">EOF</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Apply the patch.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc patch ValidatingWebhookConfiguration <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> redis-enterprise-admission --patch <span class="s2">"</span><span class="k">$(</span>cat modified-webhook.yaml<span class="k">)</span><span class="s2">"</span>
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<p>
For releases before 6.4.2-4, use this command instead:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc patch ValidatingWebhookConfiguration <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> redb-admission --patch <span class="s2">"</span><span class="k">$(</span>cat modified-webhook.yaml<span class="k">)</span><span class="s2">"</span>
</span></span></code></pre>
</div>
<p>
The 6.4.2-4 release introduces a new
<code>
ValidatingWebhookConfiguration
</code>
to replace
<code>
redb-admission
</code>
. See the
<a href="/docs/latest/operate/kubernetes/release-notes/6-4-2-releases/">
6.4.2-4 release notes
</a>
.
</p>
</div>
</div>
</li>
</ol>
<h3 id="verify-admission-controller-installation">
Verify admission controller installation
</h3>
<p>
Apply an invalid resource as shown below to force the admission controller to reject it. If it applies successfully, the admission controller is not installed correctly.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc apply -f - <span class="s"><< EOF
</span></span></span><span class="line"><span class="cl"><span class="s">apiVersion: app.redislabs.com/v1alpha1
</span></span></span><span class="line"><span class="cl"><span class="s">kind: RedisEnterpriseDatabase
</span></span></span><span class="line"><span class="cl"><span class="s">metadata:
</span></span></span><span class="line"><span class="cl"><span class="s"> name: redis-enterprise-database
</span></span></span><span class="line"><span class="cl"><span class="s">spec:
</span></span></span><span class="line"><span class="cl"><span class="s"> evictionPolicy: illegal
</span></span></span><span class="line"><span class="cl"><span class="s">EOF</span>
</span></span></code></pre>
</div>
<p>
You should see this error from the admission controller webhook
<code>
redisenterprise.admission.redislabs
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">Error from server: error when creating <span class="s2">"STDIN"</span>: admission webhook <span class="s2">"redisenterprise.admission.redislabs"</span> denied the request: eviction_policy: u<span class="s1">'illegal'</span> is not one of <span class="o">[</span>u<span class="s1">'volatile-lru'</span>, u<span class="s1">'volatile-ttl'</span>, u<span class="s1">'volatile-random'</span>, u<span class="s1">'allkeys-lru'</span>, u<span class="s1">'allkeys-random'</span>, u<span class="s1">'noeviction'</span>, u<span class="s1">'volatile-lfu'</span>, u<span class="s1">'allkeys-lfu'</span><span class="o">]</span>
</span></span></code></pre>
</div>
<h2 id="create-a-redis-enterprise-database-custom-resource">
Create a Redis Enterprise database custom resource
</h2>
<p>
The operator uses the instructions in the Redis Enterprise database (REDB) custom resources to manage databases on the Redis Enterprise cluster.
</p>
<ol>
<li>
<p>
Create a
<code>
RedisEnterpriseDatabase
</code>
custom resource.
</p>
<p>
This example creates a test database. For production databases, see
<a href="/docs/latest/operate/kubernetes/re-databases/db-controller/#create-a-database">
create a database
</a>
and
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_database_api/">
RedisEnterpriseDatabase API reference
</a>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">cat <span class="s"><< EOF > /tmp/redis-enterprise-database.yml
</span></span></span><span class="line"><span class="cl"><span class="s">apiVersion: app.redislabs.com/v1alpha1
</span></span></span><span class="line"><span class="cl"><span class="s">kind: RedisEnterpriseDatabase
</span></span></span><span class="line"><span class="cl"><span class="s">metadata:
</span></span></span><span class="line"><span class="cl"><span class="s">name: redis-enterprise-database
</span></span></span><span class="line"><span class="cl"><span class="s">spec:
</span></span></span><span class="line"><span class="cl"><span class="s"> memorySize: 100MB
</span></span></span><span class="line"><span class="cl"><span class="s">EOF</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Apply the newly created REDB resource.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">oc apply -f /tmp/redis-enterprise-database.yml
</span></span></code></pre>
</div>
</li>
</ol>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_cluster_api/">
Redis Enterprise cluster API
</a>
</li>
<li>
<a href="/docs/latest/operate/kubernetes/reference/redis_enterprise_database_api/">
Redis Enterprise database API
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/deployment/openshift/openshift-cli/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/metrics/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Real-time metrics
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the metrics that are tracked with Redis Enterprise Software.
</p>
<p>
In the Redis Enterprise Cluster Manager UI, you can see real-time performance metrics for clusters, nodes, databases, and shards, and configure alerts that send notifications based on alert parameters. Select the
<strong>
Metrics
</strong>
tab to view the metrics for each component. For more information, see
<a href="/docs/latest/operate/rs/7.4/clusters/monitoring/">
Monitoring with metrics and alerts
</a>
.
</p>
<p>
See the following topics for metrics definitions:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/database-operations/">
Database operations
</a>
for database metrics
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/resource-usage/">
Resource usage
</a>
for resource and database usage metrics
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/auto-tiering/">
Auto Tiering
</a>
for additional metrics for
<a href="/docs/latest/operate/rs/7.4/databases/auto-tiering/">
Auto Tiering
</a>
databases
</li>
</ul>
<h2 id="prometheus-metrics">
Prometheus metrics
</h2>
<p>
To collect and display metrics data from your databases and other cluster components,
you can connect your
<a href="https://prometheus.io/">
Prometheus
</a>
and
<a href="https://grafana.com/">
Grafana
</a>
server to your Redis Enterprise Software cluster. See
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/">
Metrics in Prometheus
</a>
for a list of available metrics.
</p>
<p>
We recommend you use Prometheus and Grafana to view metrics history and trends.
</p>
<p>
See
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
Prometheus integration
</a>
to learn how to connect Prometheus and Grafana to your Redis Enterprise database.
</p>
<h2 id="limitations">
Limitations
</h2>
<h3 id="shard-limit">
Shard limit
</h3>
<p>
Metrics information is not shown for clusters with more than 128 shards. For large clusters, we recommend you use
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/">
Prometheus and Grafana
</a>
to view metrics.
</p>
<h3 id="metrics-not-shown-during-shard-migration">
Metrics not shown during shard migration
</h3>
<p>
The following metrics are not measured during
<a href="/docs/latest/operate/rs/7.4/databases/configure/replica-ha/">
shard migration
</a>
. If you view these metrics while resharding, the graph will be blank.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/database-operations/#evicted-objectssec">
Evicted objects/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/database-operations/#expired-objectssec">
Expired objects/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/database-operations/#read-missessec">
Read misses/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/database-operations/#write-missessec">
Write misses/sec
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/database-operations/#total-keys">
Total keys
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/resource-usage/#incoming-traffic">
Incoming traffic
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/resource-usage/#outgoing-traffic">
Outgoing traffic
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/metrics/resource-usage/#used-memory">
Used memory
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/metrics/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.alter/.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.ALTER
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.ALTER {index} [SKIPINITIALSCAN] SCHEMA ADD {attribute} {options} ...
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the number of keys in the keyspace
</dd>
</dl>
<p>
Add a new attribute to the index. Adding an attribute to the index causes any future document updates to use the new attribute when indexing and reindexing existing documents.
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
index
</code>
</summary>
<p>
is index name to create.
</p>
</details>
<details open="">
<summary>
<code>
SKIPINITIALSCAN
</code>
</summary>
<p>
if set, does not scan and index.
</p>
</details>
<details open="">
<summary>
<code>
SCHEMA ADD {attribute} {options} ...
</code>
</summary>
<p>
after the SCHEMA keyword, declares which fields to add:
</p>
<ul>
<li>
<code>
attribute
</code>
is attribute to add.
</li>
<li>
<code>
options
</code>
are attribute options. Refer to
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
for more information.
</li>
</ul>
<p>
<note>
<b>
Note:
</b>
</note>
</p>
<p>
Depending on how the index was created, you may be limited by the number of additional text
attributes which can be added to an existing index. If the current index contains fewer than 32
text attributes, then
<code>
SCHEMA ADD
</code>
will only be able to add attributes up to 32 total attributes (meaning that the
index will only ever be able to contain 32 total text attributes). If you wish for the index to
contain more than 32 attributes, create it with the
<code>
MAXTEXTFIELDS
</code>
option.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.ALTER returns a simple string reply
<code>
OK
</code>
if executed correctly, or an error reply otherwise.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Alter an index
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.ALTER idx SCHEMA ADD id2 NUMERIC SORTABLE
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.alter/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-status/.html | <section class="prose w-full py-12">
<h1>
redis-di status
</h1>
<p class="text-lg -mt-5 mb-10">
Displays the status of the pipeline end to end
</p>
<h2 id="usage">
Usage
</h2>
<pre tabindex="0"><code>Usage: redis-di status [OPTIONS]
</code></pre>
<h2 id="options">
Options
</h2>
<ul>
<li>
<p>
<code>
log_level
</code>
:
</p>
<ul>
<li>
Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
</li>
<li>
Default:
<code>
info
</code>
</li>
<li>
Usage:
<code>
--log-level -l
</code>
</li>
</ul>
</li>
<li>
<p>
<code>
rdi_host
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-host
</code>
</li>
</ul>
<p>
Host/IP of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_port
</code>
(REQUIRED):
</p>
<ul>
<li>
Type: <IntRange 1<=x<=65535>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-port
</code>
</li>
</ul>
<p>
Port of RDI Database
</p>
</li>
<li>
<p>
<code>
rdi_user
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-user
</code>
</li>
</ul>
<p>
RDI Database Username
</p>
</li>
<li>
<p>
<code>
rdi_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-password
</code>
</li>
</ul>
<p>
RDI Database Password
</p>
</li>
<li>
<p>
<code>
rdi_key
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key
</code>
</li>
</ul>
<p>
Private key file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cert
</code>
</li>
</ul>
<p>
Client certificate file to authenticate with
</p>
</li>
<li>
<p>
<code>
rdi_cacert
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-cacert
</code>
</li>
</ul>
<p>
CA certificate file to verify with
</p>
</li>
<li>
<p>
<code>
rdi_key_password
</code>
:
</p>
<ul>
<li>
Type: STRING
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--rdi-key-password
</code>
</li>
</ul>
<p>
Password for unlocking an encrypted private key
</p>
</li>
<li>
<p>
<code>
live
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--live -l
</code>
</li>
</ul>
<p>
Live data flow monitoring
</p>
</li>
<li>
<p>
<code>
page_number
</code>
:
</p>
<ul>
<li>
Type:
<intrange x="">
=1>
</intrange>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--page-number -p
</code>
</li>
</ul>
<p>
Set the page number (live mode only)
</p>
</li>
<li>
<p>
<code>
page_size
</code>
:
</p>
<ul>
<li>
Type:
<intrange x="">
=1>
</intrange>
</li>
<li>
Default:
<code>
none
</code>
</li>
<li>
Usage:
<code>
--page-size -s
</code>
</li>
</ul>
<p>
Set the page size (live mode only)
</p>
</li>
<li>
<p>
<code>
ingested_only
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--ingested-only -i
</code>
</li>
</ul>
<p>
Display ingested data streams (live mode only)
</p>
</li>
<li>
<p>
<code>
help
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--help
</code>
</li>
</ul>
<p>
Show this message and exit.
</p>
</li>
</ul>
<h2 id="cli-help">
CLI help
</h2>
<pre tabindex="0"><code>Usage: redis-di status [OPTIONS]
Displays the status of the pipeline end to end
Options:
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--rdi-host TEXT Host/IP of RDI Database [required]
--rdi-port INTEGER RANGE Port of RDI Database [1<=x<=65535;
required]
--rdi-user TEXT RDI Database Username
--rdi-password TEXT RDI Database Password
--rdi-key TEXT Private key file to authenticate with
--rdi-cert TEXT Client certificate file to authenticate with
--rdi-cacert TEXT CA certificate file to verify with
--rdi-key-password TEXT Password for unlocking an encrypted private
key
-l, --live Live data flow monitoring
-p, --page-number INTEGER RANGE
Set the page number (live mode only) [x>=1]
-s, --page-size INTEGER RANGE Set the page size (live mode only) [x>=1]
-i, --ingested-only Display ingested data streams (live mode
only)
--help Show this message and exit.
</code></pre>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-status/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/xgroup-createconsumer/.html | <section class="prose w-full py-12">
<h1 class="command-name">
XGROUP CREATECONSUMER
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">XGROUP CREATECONSUMER key group consumer</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
6.2.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@stream
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Create a consumer named
<code>
<consumername>
</code>
in the consumer group
<code>
<groupname>
</code>
of the stream that's stored at
<code>
<key>
</code>
.
</p>
<p>
Consumers are also created automatically whenever an operation, such as
<a href="/docs/latest/commands/xreadgroup/">
<code>
XREADGROUP
</code>
</a>
, references a consumer that doesn't exist.
This is valid for
<a href="/docs/latest/commands/xreadgroup/">
<code>
XREADGROUP
</code>
</a>
only when there is data in the stream.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the number of created consumers, either 0 or 1.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/xgroup-createconsumer/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/k8s-6-2-10-45-2022-07/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes release notes 6.2.10-45 (July 2022)
</h1>
<p class="text-lg -mt-5 mb-10">
Support added for additional distributions as well as some feature improvements.
</p>
<h2 id="overview">
Overview
</h2>
<p>
The Redis Enterprise K8s 6.2.10-45 supports the Redis Enterprise Software release 6.2.10 and includes feature improvements and bug fixes.
</p>
<p>
The key bug fixes and known limitations are described below.
</p>
<h2 id="images">
Images
</h2>
<p>
This release includes the following container images:
</p>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
redislabs/redis:6.2.10-129
</code>
or
<code>
redislabs/redis:6.2.10-129.rhel8-openshift
</code>
(or
<code>
redislabs/redis:6.2.10-129.rhel7-openshift
</code>
if upgrading from a RHEL7 cluster)
</li>
<li>
<strong>
Operator
</strong>
:
<code>
redislabs/operator:6.2.10-45
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
redislabs/k8s-controller:6.2.10-45
</code>
or
<code>
redislabs/services-manager:6.2.10-45
</code>
(on the Red Hat registry)
</li>
</ul>
<h2 id="feature-improvements">
Feature improvements
</h2>
<ul>
<li>
OpenShift OperatorLifecycleManager support on restricted networks (RED-72968)
</li>
<li>
<code>
log_collector
</code>
script uses
<code>
oc
</code>
command with automatic detection of OpenShift (RED-73215)
</li>
<li>
Operator uses
<code>
policy/v1
</code>
for
<code>
PodDisruptionBudget
</code>
(RED-78564)
</li>
<li>
Added support for Kubernetes distributions (see Compatibility notes below)
</li>
</ul>
<h2 id="fixed-bugs">
Fixed bugs
</h2>
<ul>
<li>
Upgrade failures when RHEL7 was used (RED-77890)
</li>
<li>
Log collector failures when Python2 was used (RED-73403)
</li>
</ul>
<h2 id="api-changes">
API changes
</h2>
<p>
The
<code>
digestHash
</code>
optional field added to
<code>
imageSpec
</code>
fields in the REC. This field should be used in disconnected environments using the OperatorLifecycleManager.
</p>
<h2 id="compatibility-notes">
Compatibility notes
</h2>
<p>
Below is a table showing supported distributions at the time of this release. See
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Supported Kubernetes distributions
</a>
for the current list of supported distributions.
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
<strong>
Kubernetes version
</strong>
</th>
<th style="text-align:center">
1.19
</th>
<th style="text-align:center">
1.20
</th>
<th style="text-align:center">
1.21
</th>
<th style="text-align:center">
1.22
</th>
<th style="text-align:center">
1.23
</th>
<th style="text-align:center">
1.24
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
Community Kubernetes
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
</tr>
<tr>
<td style="text-align:left">
Amazon EKS
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
<td style="text-align:center">
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
Azure AKS
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
Google GKE
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
Rancher 2.6
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
OpenShift version
</strong>
</td>
<td style="text-align:center">
<strong>
4.6
</strong>
</td>
<td style="text-align:center">
<strong>
4.7
</strong>
</td>
<td style="text-align:center">
<strong>
4.8
</strong>
</td>
<td style="text-align:center">
<strong>
4.9
</strong>
</td>
<td style="text-align:center">
<strong>
4.10
</strong>
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
VMware TKGI version
</strong>
</td>
<td style="text-align:center">
<strong>
1.10
</strong>
</td>
<td style="text-align:center">
<strong>
1.11
</strong>
</td>
<td style="text-align:center">
<strong>
1.12
</strong>
</td>
<td style="text-align:center">
<strong>
1.13
</strong>
</td>
<td style="text-align:center">
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported*
</td>
<td style="text-align:center">
supported*
</td>
<td style="text-align:center">
</td>
<td>
</td>
</tr>
</tbody>
</table>
<p>
* Support added in this release
</p>
<h3 id="support-added">
Support added
</h3>
<ul>
<li>
K8s community version 1.24
</li>
</ul>
<h3 id="deprecated">
Deprecated
</h3>
<ul>
<li>
OpenShift 4.7-4.8
</li>
<li>
Kubernetes 1.20
</li>
<li>
Rancher 2.6 for K8s 1.19-1.20
</li>
<li>
TKGI 1.10-11
</li>
</ul>
<h3 id="no-longer-supported">
No longer supported
</h3>
<ul>
<li>
OpenShift 4.6 (previously deprecated)
</li>
<li>
Kubernetes 1.18-1.19 (previously deprecated)
</li>
<li>
Rancher 2.6 for K8s 1.18 (previously deprecated)
</li>
<li>
AKS 1.20-1.21 (previously deprecated)
</li>
<li>
EKS 1.18-1.19 (previously deprecated)
</li>
<li>
GKE 1.19 (previously deprecated)
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<h3 id="large-clusters">
Large clusters
</h3>
<p>
On clusters with more than 9 REC nodes, a Kubernetes upgrade can render the Redis cluster unresponsive in some cases. A fix is available in the 6.4.2-5 release. Upgrade your operator version to 6.4.2-5 or later before upgrading your Kubernetes cluster. (RED-93025)
</p>
<ul>
<li>
<p>
Long cluster names cause routes to be rejected (RED-25871)
</p>
<p>
A cluster name longer than 20 characters will result in a rejected route configuration because the host part of the domain name will exceed 63 characters. The workaround is to limit cluster name to 20 characters or less.
</p>
</li>
<li>
<p>
Cluster CR (REC) errors are not reported after invalid updates (RED-25542)
</p>
<p>
A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence.
</p>
</li>
<li>
<p>
An unreachable cluster has status running (RED-32805)
</p>
<p>
When a cluster is in an unreachable state, the state is still
<code>
running
</code>
instead of being reported as an error.
</p>
</li>
<li>
<p>
Readiness probe incorrect on failures (RED-39300)
</p>
<p>
STS Readiness probe does not mark a node as "not ready" when running
<code>
rladmin status
</code>
on node failure.
</p>
</li>
<li>
<p>
Role missing on replica sets (RED-39002)
</p>
<p>
The
<code>
redis-enterprise-operator
</code>
role is missing permission on replica sets.
</p>
</li>
<li>
<p>
Private registries are not supported on OpenShift 3.11 (RED-38579)
</p>
<p>
OpenShift 3.11 does not support DockerHub private registries. This is a known OpenShift issue.
</p>
</li>
<li>
<p>
Internal DNS and Kubernetes DNS may have conflicts (RED-37462)
</p>
<p>
DNS conflicts are possible between the cluster
<code>
mdns_server
</code>
and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names.
</p>
</li>
<li>
<p>
5.4.10 negatively impacts 5.4.6 (RED-37233)
</p>
<p>
Kubernetes-based 5.4.10 deployments seem to negatively impact existing 5.4.6 deployments that share a Kubernetes cluster.
</p>
</li>
<li>
<p>
Node CPU usage is reported instead of pod CPU usage (RED-36884)
</p>
<p>
In Kubernetes, the node CPU usage we report on is the usage of the Kubernetes worker node hosting the REC pod.
</p>
</li>
<li>
<p>
Clusters must be named "rec" in OLM-based deployments (RED-39825)
</p>
<p>
In OLM-deployed operators, the deployment of the cluster will fail if the name is not "rec". When the operator is deployed via the OLM, the security context constraints (scc) are bound to a specific service account name (i.e., "rec"). The workaround is to name the cluster "rec".
</p>
</li>
<li>
<p>
REC clusters fail to start on Kubernetes clusters with unsynchronized clocks (RED-47254)
</p>
<p>
When REC clusters are deployed on Kubernetes clusters with unsynchronized clocks, the REC cluster does not start correctly. The fix is to use NTP to synchronize the underlying K8s nodes.
</p>
</li>
<li>
<p>
Deleting an OpenShift project with an REC deployed may hang (RED-47192)
</p>
<p>
When a REC cluster is deployed in a project (namespace) and has REDB resources, the REDB resources must be deleted first before the REC can be deleted. As such, until the REDB resources are deleted, the project deletion will hang. The fix is to delete the REDB resources first and the REC second. Afterwards, you may delete the project.
</p>
</li>
<li>
<p>
REC extraLabels are not applied to PVCs on K8s versions 1.15 or older (RED-51921)
</p>
<p>
In K8s 1.15 or older, the PVC labels come from the match selectors and not the PVC templates. As such, these versions cannot support PVC labels. If this feature is required, the only fix is to upgrade the K8s cluster to a newer version.
</p>
</li>
<li>
<p>
Hashicorp Vault integration - no support for Gesher (RED-55080)
</p>
<p>
There is no workaround at this time.
</p>
</li>
<li>
<p>
REC might report error states on initial startup (RED-61707)
</p>
<p>
There is no workaround at this time except to ignore the errors.
</p>
</li>
<li>
<p>
PVC size issues when using decimal value in spec (RED-62132)
</p>
<p>
The workaround for this issue is to make sure you use integer values for the PVC size.
</p>
</li>
<li>
<p>
Following old revision of quick start guide causes issues creating an REDB due to unrecognized memory field name (RED-69515)
</p>
</li>
</ul>
<p>
The workaround is to use the newer (current) revision of the quick start document available online.
</p>
<ul>
<li>
<p>
<code>
autoUpgrade
</code>
set to true by operator might cause unexpected bdb upgrades when
<code>
redisUpgradePolicy
</code>
is set to true (RED-72351)
</p>
<p>
Contact support if your deployment is impacted.
</p>
</li>
<li>
<p>
Procedure to update credentials might be problematic on OpenShift when accessing the cluster externally using routes (RS issue)(RED-73251)(RED-75329)
To workaround this, access the API from within the K8s cluster.
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/k8s-6-2-10-45-2022-07/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bdbs/shards/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Database shards requests
</h1>
<p class="text-lg -mt-5 mb-10">
REST API requests for database shards
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-bdb-shards">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/{bdb_uid}/shards
</code>
</td>
<td>
Get the status of a database's shards
</td>
</tr>
</tbody>
</table>
<h2 id="get-bdb-shards">
Get database shards
</h2>
<pre><code>GET /v1/bdbs/{int: bdb_uid}/shards
</code></pre>
<p>
Gets the status for all shards that belong to the specified database.
</p>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /bdbs/1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
bdb_uid
</td>
<td>
integer
</td>
<td>
The unique ID of the database.
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
The response body contains a JSON array with all shards, represented as
<a href="/docs/latest/operate/rs/references/rest-api/objects/shard/">
shard objects
</a>
.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role"</span><span class="p">:</span> <span class="s2">"master"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"assigned_slots"</span><span class="p">:</span> <span class="s2">"0-8191"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdb_uid"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"detailed_status"</span><span class="p">:</span> <span class="s2">"ok"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"loading"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"idle"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"node_uid"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"redis_info"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"connected_clients"</span><span class="p">:</span> <span class="mi">14</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"used_memory_rss"</span><span class="p">:</span> <span class="mi">12460032</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"report_timestamp"</span><span class="p">:</span> <span class="s2">"2024-09-13T15:28:10Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"status"</span><span class="p">:</span> <span class="s2">"active"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"role"</span><span class="p">:</span> <span class="s2">"slave"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// additional fields...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
No error.
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found">
404 Not Found
</a>
</td>
<td>
bdb uid does not exist.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/rest-api/requests/bdbs/shards/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ts.range/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.RANGE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.RANGE key fromTimestamp toTimestamp
[LATEST]
[FILTER_BY_TS ts...]
[FILTER_BY_VALUE min max]
[COUNT count]
[[ALIGN align] AGGREGATION aggregator bucketDuration [BUCKETTIMESTAMP bt] [EMPTY]]
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/timeseries">
TimeSeries 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(n/m+k) where n = Number of data points, m = Chunk size (data points per chunk), k = Number of data points that are in the requested range
</dd>
</dl>
<p>
Query a range in forward direction
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is the key name for the time series.
</p>
</details>
<details open="">
<summary>
<code>
fromTimestamp
</code>
</summary>
<p>
is start timestamp for the range query (integer Unix timestamp in milliseconds) or
<code>
-
</code>
to denote the timestamp of the earliest sample in the time series.
</p>
</details>
<details open="">
<summary>
<code>
toTimestamp
</code>
</summary>
<p>
is end timestamp for the range query (integer Unix timestamp in milliseconds) or
<code>
+
</code>
to denote the timestamp of the latest sample in the time series.
</p>
<p>
<note>
<b>
Note:
</b>
When the time series is a compaction, the last compacted value may aggregate raw values with timestamp beyond
<code>
toTimestamp
</code>
. That is because
<code>
toTimestamp
</code>
only limits the timestamp of the compacted value, which is the start time of the raw bucket that was compacted.
</note>
</p>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
LATEST
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
is used when a time series is a compaction. With
<code>
LATEST
</code>
, TS.RANGE also reports the compacted value of the latest, possibly partial, bucket, given that this bucket's start time falls within
<code>
[fromTimestamp, toTimestamp]
</code>
. Without
<code>
LATEST
</code>
, TS.RANGE does not report the latest, possibly partial, bucket. When a time series is not a compaction,
<code>
LATEST
</code>
is ignored.
</p>
<p>
The data in the latest bucket of a compaction is possibly partial. A bucket is
<em>
closed
</em>
and compacted only upon arrival of a new sample that
<em>
opens
</em>
a new
<em>
latest
</em>
bucket. There are cases, however, when the compacted value of the latest, possibly partial, bucket is also required. In such a case, use
<code>
LATEST
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
FILTER_BY_TS ts...
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
filters samples by a list of specific timestamps. A sample passes the filter if its exact timestamp is specified and falls within
<code>
[fromTimestamp, toTimestamp]
</code>
.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: samples are filtered before being aggregated.
</p>
</details>
<details open="">
<summary>
<code>
FILTER_BY_VALUE min max
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
filters samples by minimum and maximum values.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: samples are filtered before being aggregated.
</p>
</details>
<details open="">
<summary>
<code>
COUNT count
</code>
</summary>
<p>
When used without
<code>
AGGREGATION
</code>
: limits the number of reported samples.
</p>
<p>
When used together with
<code>
AGGREGATION
</code>
: limits the number of reported buckets.
</p>
</details>
<details open="">
<summary>
<code>
ALIGN align
</code>
(since RedisTimeSeries v1.6)
</summary>
<p>
is a time bucket alignment control for
<code>
AGGREGATION
</code>
. It controls the time bucket timestamps by changing the reference timestamp on which a bucket is defined.
</p>
<p>
<code>
align
</code>
values include:
</p>
<ul>
<li>
<code>
start
</code>
or
<code>
-
</code>
: The reference timestamp will be the query start interval time (
<code>
fromTimestamp
</code>
) which can't be
<code>
-
</code>
</li>
<li>
<code>
end
</code>
or
<code>
+
</code>
: The reference timestamp will be the query end interval time (
<code>
toTimestamp
</code>
) which can't be
<code>
+
</code>
</li>
<li>
A specific timestamp: align the reference timestamp to a specific time
</li>
</ul>
<p>
<note>
<b>
Note:
</b>
When not provided, alignment is set to
<code>
0
</code>
.
</note>
</p>
</details>
<details open="">
<summary>
<code>
AGGREGATION aggregator bucketDuration
</code>
</summary>
<p>
aggregates samples into time buckets, where:
</p>
<ul>
<li>
<p>
<code>
aggregator
</code>
takes one of the following aggregation types:
</p>
<table>
<thead>
<tr>
<th>
<code>
aggregator
</code>
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
avg
</code>
</td>
<td>
Arithmetic mean of all values
</td>
</tr>
<tr>
<td>
<code>
sum
</code>
</td>
<td>
Sum of all values
</td>
</tr>
<tr>
<td>
<code>
min
</code>
</td>
<td>
Minimum value
</td>
</tr>
<tr>
<td>
<code>
max
</code>
</td>
<td>
Maximum value
</td>
</tr>
<tr>
<td>
<code>
range
</code>
</td>
<td>
Difference between the maximum and the minimum value
</td>
</tr>
<tr>
<td>
<code>
count
</code>
</td>
<td>
Number of values
</td>
</tr>
<tr>
<td>
<code>
first
</code>
</td>
<td>
Value with lowest timestamp in the bucket
</td>
</tr>
<tr>
<td>
<code>
last
</code>
</td>
<td>
Value with highest timestamp in the bucket
</td>
</tr>
<tr>
<td>
<code>
std.p
</code>
</td>
<td>
Population standard deviation of the values
</td>
</tr>
<tr>
<td>
<code>
std.s
</code>
</td>
<td>
Sample standard deviation of the values
</td>
</tr>
<tr>
<td>
<code>
var.p
</code>
</td>
<td>
Population variance of the values
</td>
</tr>
<tr>
<td>
<code>
var.s
</code>
</td>
<td>
Sample variance of the values
</td>
</tr>
<tr>
<td>
<code>
twa
</code>
</td>
<td>
Time-weighted average over the bucket's timeframe (since RedisTimeSeries v1.8)
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
<code>
bucketDuration
</code>
is duration of each bucket, in milliseconds.
</p>
</li>
</ul>
<p>
Without
<code>
ALIGN
</code>
, bucket start times are multiples of
<code>
bucketDuration
</code>
.
</p>
<p>
With
<code>
ALIGN align
</code>
, bucket start times are multiples of
<code>
bucketDuration
</code>
with remainder
<code>
align % bucketDuration
</code>
.
</p>
<p>
The first bucket start time is less than or equal to
<code>
fromTimestamp
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
[BUCKETTIMESTAMP bt]
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
controls how bucket timestamps are reported.
</p>
<table>
<thead>
<tr>
<th>
<code>
bt
</code>
</th>
<th>
Timestamp reported for each bucket
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
-
</code>
or
<code>
start
</code>
</td>
<td>
the bucket's start time (default)
</td>
</tr>
<tr>
<td>
<code>
+
</code>
or
<code>
end
</code>
</td>
<td>
the bucket's end time
</td>
</tr>
<tr>
<td>
<code>
~
</code>
or
<code>
mid
</code>
</td>
<td>
the bucket's mid time (rounded down if not an integer)
</td>
</tr>
</tbody>
</table>
</details>
<details open="">
<summary>
<code>
[EMPTY]
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
is a flag, which, when specified, reports aggregations also for empty buckets.
</p>
<table>
<thead>
<tr>
<th>
<code>
aggregator
</code>
</th>
<th>
Value reported for each empty bucket
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
sum
</code>
,
<code>
count
</code>
</td>
<td>
<code>
0
</code>
</td>
</tr>
<tr>
<td>
<code>
last
</code>
</td>
<td>
The value of the last sample before the bucket's start.
<code>
NaN
</code>
when no such sample.
</td>
</tr>
<tr>
<td>
<code>
twa
</code>
</td>
<td>
Average value over the bucket's timeframe based on linear interpolation of the last sample before the bucket's start and the first sample after the bucket's end.
<code>
NaN
</code>
when no such samples.
</td>
</tr>
<tr>
<td>
<code>
min
</code>
,
<code>
max
</code>
,
<code>
range
</code>
,
<code>
avg
</code>
,
<code>
first
</code>
,
<code>
std.p
</code>
,
<code>
std.s
</code>
</td>
<td>
<code>
NaN
</code>
</td>
</tr>
</tbody>
</table>
<p>
Regardless of the values of
<code>
fromTimestamp
</code>
and
<code>
toTimestamp
</code>
, no data is reported for buckets that end before the earliest sample or begin after the latest sample in the time series.
</p>
</details>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
of (
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
,
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
) pairs representing (timestamp, value(double))
</li>
<li>
[] (e.g., on invalid filter value)
</li>
</ul>
<h2 id="complexity">
Complexity
</h2>
<p>
TS.RANGE complexity can be improved in the future by using binary search to find the start of the range, which makes this
<code>
O(Log(n/m)+k*m)
</code>
.
But, because
<code>
m
</code>
is small, you can disregard it and look at the operation as
<code>
O(Log(n)+k)
</code>
.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Filter results by timestamp or sample value
</b>
</summary>
<p>
Consider a metric where acceptable values are between -100 and 100, and the value 9999 is used as an indication of bad measurement.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE temp:TLV LABELS <span class="nb">type</span> temp location TLV
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD temp:TLV <span class="m">1000</span> <span class="m">30</span> temp:TLV <span class="m">1010</span> <span class="m">35</span> temp:TLV <span class="m">1020</span> <span class="m">9999</span> temp:TLV <span class="m">1030</span> <span class="m">40</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1030</span></span></span></code></pre>
</div>
<p>
Now, retrieve all values except out-of-range values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">TS.RANGE temp:TLV - + FILTER_BY_VALUE -100 <span class="m">100</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">30</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">35</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1030</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">40</span></span></span></code></pre>
</div>
<p>
Now, retrieve the average value, while ignoring out-of-range values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">TS.RANGE temp:TLV - + FILTER_BY_VALUE -100 <span class="m">100</span> AGGREGATION avg <span class="m">1000</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">35</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Align aggregation buckets
</b>
</summary>
<p>
To demonstrate alignment, let’s create a stock and add prices at nine different timestamps.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATE stock:A LABELS <span class="nb">type</span> stock name A
</span></span><span class="line"><span class="cl">OK
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">1000</span> <span class="m">100</span> stock:A <span class="m">1010</span> <span class="m">110</span> stock:A <span class="m">1020</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">2000</span> <span class="m">200</span> stock:A <span class="m">2010</span> <span class="m">210</span> stock:A <span class="m">2020</span> <span class="m">220</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2020</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD stock:A <span class="m">3000</span> <span class="m">300</span> stock:A <span class="m">3010</span> <span class="m">310</span> stock:A <span class="m">3020</span> <span class="m">320</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3000</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3010</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3020</span></span></span></code></pre>
</div>
<p>
Next, aggregate without using
<code>
ALIGN
</code>
, defaulting to alignment 0.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.RANGE stock:A - + AGGREGATION min <span class="m">20</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1020</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">120</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1040</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">210</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1060</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1080</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">320</span></span></span></code></pre>
</div>
<p>
And now set
<code>
ALIGN
</code>
to 10 to have a bucket start at time 10, and align all the buckets with a 20 milliseconds duration.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.RANGE stock:A - + ALIGN <span class="m">10</span> AGGREGATION min <span class="m">20</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">990</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">110</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1990</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">210</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2990</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3010</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">310</span></span></span></code></pre>
</div>
<p>
When the start timestamp for the range query is explicitly stated (not
<code>
-
</code>
), you can set
<code>
ALIGN
</code>
to that time by setting align to
<code>
-
</code>
or to
<code>
start
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> TS.RANGE stock:A <span class="m">5</span> + ALIGN - AGGREGATION min <span class="m">20</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">985</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">100</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1005</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">110</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1985</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">200</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2005</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">210</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2985</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">300</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3005</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="m">310</span></span></span></code></pre>
</div>
<p>
Similarly, when the end timestamp for the range query is explicitly stated, you can set
<code>
ALIGN
</code>
to that time by setting align to
<code>
+
</code>
or to
<code>
end
</code>
.
</p>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.mrange/">
<code>
TS.MRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.revrange/">
<code>
TS.REVRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrevrange/">
<code>
TS.MREVRANGE
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ts.range/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/security/access-control/ldap/migrate-to-role-based-ldap/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Migrate to role-based LDAP
</h1>
<p class="text-lg -mt-5 mb-10">
Describes how to migrate existing cluster-based LDAP deployments to role-based LDAP.
</p>
<p>
Redis Enterprise Software supports LDAP through a
<a href="/docs/latest/operate/rs/security/access-control/ldap/">
role-based mechanism
</a>
, first introduced
<a href="/docs/latest/operate/rs/release-notes/rs-6-0-20-april-2021/">
in v6.0.20
</a>
.
</p>
<p>
Earlier versions of Redis Enterprise Software supported a cluster-based mechanism; however, that mechanism was removed in v6.2.12.
</p>
<p>
If you're using the cluster-based mechanism to enable LDAP authentication, you need to migrate to the role-based mechanism before upgrading to Redis Enterprise Software v6.2.12 or later.
</p>
<h2 id="migration-checklist">
Migration checklist
</h2>
<p>
This checklist covers the basic process:
</p>
<ol>
<li>
<p>
Identify accounts per app on the customer end.
</p>
</li>
<li>
<p>
Create or identify an LDAP user account on the server that is responsible for LDAP authentication and authorization.
</p>
</li>
<li>
<p>
Create or identify an LDAP group that contains the app team members.
</p>
</li>
<li>
<p>
Verify or configure the Redis Enterprise ACLs.
</p>
</li>
<li>
<p>
Configure each database ACL.
</p>
</li>
<li>
<p>
Remove the earlier "external" (LDAP) users from Redis Enterprise.
</p>
</li>
<li>
<p>
<em>
(Recommended)
</em>
Update cluster configuration to replace the cluster-based configuration file.
</p>
<p>
You can use
<code>
rladmin
</code>
to update the cluster configuration:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">$ touch /tmp/saslauthd_empty.conf
</span></span><span class="line"><span class="cl">$ rladmin cluster config saslauthd_ldap_conf <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> /tmp/saslauthd_empty.conf
</span></span></code></pre>
</div>
<p>
Here, a blank file replaces the earlier configuration.
</p>
</li>
<li>
<p>
Use
<strong>
Access Control > LDAP > Configuration
</strong>
to enable role-based LDAP.
</p>
</li>
<li>
<p>
Map your LDAP groups to access control roles.
</p>
</li>
<li>
<p>
Test application connectivity using the LDAP credentials of an app team member.
</p>
</li>
<li>
<p>
<em>
(Recommended)
</em>
Turn off default access for the database to avoid anonymous client connections.
</p>
</li>
</ol>
<p>
Because deployments and requirements vary, you’ll likely need to adjust these guidelines.
</p>
<h2 id="test-ldap-access">
Test LDAP access
</h2>
<p>
To test your LDAP integration, you can:
</p>
<ul>
<li>
<p>
Connect with
<code>
redis-cli
</code>
and use the
<a href="/docs/latest/commands/auth/">
<code>
AUTH
</code>
command
</a>
to test LDAP username/password credentials.
</p>
</li>
<li>
<p>
Sign in to the Cluster Manager UI using LDAP credentials authorized for admin access.
</p>
</li>
<li>
<p>
Use
<a href="/docs/latest/develop/tools/insight/">
Redis Insight
</a>
to access a database using authorized LDAP credentials.
</p>
</li>
<li>
<p>
Use the
<a href="/docs/latest/operate/rs/references/rest-api/">
REST API
</a>
to connect using authorized LDAP credentials.
</p>
</li>
</ul>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
Enable and configure
<a href="/docs/latest/operate/rs/security/access-control/ldap/enable-role-based-ldap/">
role-based LDAP
</a>
</li>
<li>
Map LDAP groups to
<a href="/docs/latest/operate/rs/security/access-control/ldap/map-ldap-groups-to-roles/">
access control roles
</a>
</li>
<li>
Update database ACLs to
<a href="/docs/latest/operate/rs/security/access-control/ldap/update-database-acls/">
authorize LDAP access
</a>
</li>
<li>
Learn more about Redis Enterprise Software
<a href="/docs/latest/operate/rs/security/">
security and practices
</a>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/security/access-control/ldap/migrate-to-role-based-ldap/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/clusters/optimize/turn-off-services/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Turn off services to free system memory
</h1>
<p class="text-lg -mt-5 mb-10">
Turn off services to free memory and improve performance.
</p>
<p>
The Redis Enterprise Software cluster nodes host a range of services that support the cluster processes.
In most deployments, either all of these services are required,
or there are enough memory resources on the nodes for the database requirements.
</p>
<p>
In a deployment with limited memory resources, certain services can be disabled from API endpoint to free system memory or using the
<code>
rladmin
</code>
command.
Before you turn off a service, make sure that your deployment does not depend on that service.
After you turn off a service, you can re-enable in the same way.
</p>
<p>
The services that you can turn off are:
</p>
<ul>
<li>
RS Admin Console -
<code>
cm_server
</code>
</li>
<li>
Logs in CSV format -
<code>
stats_archiver
</code>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/">
LDAP authentication
</a>
-
<code>
saslauthd
</code>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/networking/cluster-dns/">
Discovery service
</a>
-
<code>
mdns_server
</code>
,
<code>
pdns_server
</code>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/active-active/">
Active-Active databases
</a>
-
<code>
crdb_coordinator
</code>
,
<code>
crdb_worker
</code>
</li>
<li>
Alert Manager -
<code>
alert_mgr
</code>
(For best results, disable only if you have an alternate alert system.)
</li>
</ul>
<p>
To turn off a service with the
<code>
rladmin cluster config
</code>
command, use the
<code>
services
</code>
parameter and the name of the service, followed by
<code>
disabled
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl"> rladmin cluster config
</span></span><span class="line"><span class="cl"> [ services <service_name> <enabled | disabled> ]
</span></span></code></pre>
</div>
<p>
To turn off a service with the API, use the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration/#put-cluster-services_config">
<code>
PUT /v1/services_configuration
</code>
</a>
endpoint
with the name of the service and the operating mode (enabled/disabled) in JSON format.
</p>
<p>
For example:
</p>
<ul>
<li>
<p>
To turn off the Redis Enterprise Cluster Manager UI, use this PUT request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT https://<span class="o">[</span>host<span class="o">][</span>:9443<span class="o">]</span>/v1/cluster/services_configuration
</span></span><span class="line"><span class="cl"><span class="s1">'{
</span></span></span><span class="line"><span class="cl"><span class="s1"> "cm_server":{
</span></span></span><span class="line"><span class="cl"><span class="s1"> "operating_mode":"disabled"
</span></span></span><span class="line"><span class="cl"><span class="s1"> }
</span></span></span><span class="line"><span class="cl"><span class="s1">}'</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
To turn off the CRDB services and enable the
<code>
stats_archiver
</code>
for cluster component statistics, use this PUT request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT https://<span class="o">[</span>host<span class="o">][</span>:9443<span class="o">]</span>/v1/cluster/services_configuration
</span></span><span class="line"><span class="cl"><span class="s1">'{
</span></span></span><span class="line"><span class="cl"><span class="s1"> "crdb_coordinator":{
</span></span></span><span class="line"><span class="cl"><span class="s1"> "operating_mode":"disabled"
</span></span></span><span class="line"><span class="cl"><span class="s1"> },
</span></span></span><span class="line"><span class="cl"><span class="s1"> "crdb_worker":{
</span></span></span><span class="line"><span class="cl"><span class="s1"> "operating_mode":"disabled"
</span></span></span><span class="line"><span class="cl"><span class="s1"> },
</span></span></span><span class="line"><span class="cl"><span class="s1"> "stats_archiver":{
</span></span></span><span class="line"><span class="cl"><span class="s1"> "operating_mode":"enabled"
</span></span></span><span class="line"><span class="cl"><span class="s1"> }
</span></span></span><span class="line"><span class="cl"><span class="s1">}'</span>
</span></span></code></pre>
</div>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/clusters/optimize/turn-off-services/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/pubsub-numsub/.html | <section class="prose w-full py-12">
<h1 class="command-name">
PUBSUB NUMSUB
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">PUBSUB NUMSUB [channel [channel ...]]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.8.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) for the NUMSUB subcommand, where N is the number of requested channels
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@pubsub
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified channels.
</p>
<p>
Note that it is valid to call this command without channels. In this case it will just return an empty list.
</p>
<p>
Cluster note: in a Redis Cluster clients can subscribe to every node, and can also publish to every other node. The cluster will make sure that published messages are forwarded as needed. That said,
<a href="/docs/latest/commands/pubsub/">
<code>
PUBSUB
</code>
</a>
's replies in a cluster only report information from the node's Pub/Sub context, rather than the entire cluster.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: the number of subscribers per channel, each even element (including the 0th) is channel name, each odd element is the number of subscribers
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/pubsub-numsub/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/durability-ha/replication/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Database replication
</h1>
<p>
Database replication helps ensure high availability.
When replication is enabled, your dataset is replicated to a replica shard,
which is constantly synchronized with the primary shard. If the primary
shard fails, an automatic failover happens and the replica shard is promoted. That is, it becomes the new primary shard.
</p>
<p>
When the old primary shard recovers, it becomes
the replica shard of the new primary shard. This auto-failover mechanism
guarantees that data is served with minimal interruption.
</p>
<p>
You can tune your high availability configuration with:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/7.4/clusters/configure/rack-zone-awareness/">
Rack/Zone
Awareness
</a>
- When rack-zone awareness is used additional logic ensures that master and replica shards never share the same rack, thus ensuring availability even under loss of an entire rack.
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/configure/replica-ha/">
High Availability for Replica Shards
</a>
- When high availability
for replica shards is used, the replica shard is automatically migrated on node failover to maintain high availability.
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Enabling replication has implications for the total database size,
as explained in
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/memory-limit/">
Database memory limits
</a>
.
</div>
</div>
<h2 id="auto-tiering-replication-considerations">
Auto Tiering replication considerations
</h2>
<p>
We recommend that you set the sequential replication feature using
<code>
rladmin
</code>
. This is due to the potential for relatively slow replication
times that can occur with Auto Tiering enabled databases. In some
cases, if sequential replication is not set up, you may run out of memory.
</p>
<p>
While it does not cause data loss on the
primary shards, the replication to replica shards may not succeed as long
as there is high write-rate traffic on the primary and multiple
replications at the same time.
</p>
<p>
The following
<code>
rladmin
</code>
command sets the number of primary shards eligible to
be replicated from the same cluster node, as well as the number of replica
shards on the same cluster node that can run the replication process at
any given time.
</p>
<p>
The recommended sequential replication configuration is two, i.e.:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster max_redis_forks <span class="m">1</span> max_slave_full_syncs <span class="m">1</span>
</span></span></code></pre>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
This means that at any given time,
only one primary and one replica can be part of a full sync replication process.
</div>
</div>
<h2 id="database-replication-backlog">
Database replication backlog
</h2>
<p>
Redis databases that use
<a href="/docs/latest/operate/rs/7.4/databases/durability-ha/replication/">
replication for high availability
</a>
maintain a replication backlog (per shard) to synchronize the primary and replica shards of a database.
By default, the replication backlog is set to one percent (1%) of the database size divided by the database number of shards and ranges between 1MB to 250MB per shard.
Use the
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
and the
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/">
<code>
crdb-cli
</code>
</a>
utilities to control the size of the replication backlog. You can set it to
<code>
auto
</code>
or set a specific size.
</p>
<p>
The syntax varies between regular and Active-Active databases.
</p>
<p>
For a regular Redis database:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">rladmin tune db <db:id | name> repl_backlog <Backlog size in MB | 'auto'>
</span></span></code></pre>
</div>
<p>
For an Active-Active database:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">crdb-cli crdb update --crdb-guid <crdb_guid> --default-db-config "{\"repl_backlog_size\": <size in MB | 'auto'>}"
</span></span></code></pre>
</div>
<h3 id="active-active-replication-backlog">
Active-Active replication backlog
</h3>
<p>
In addition to the database replication backlog, Active-Active databases maintain a backlog (per shard) to synchronize the database instances between clusters.
By default, the Active-Active replication backlog is set to one percent (1%) of the database size divided by the database number of shards, and ranges between 1MB to 250MB per shard.
Use the
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/">
<code>
crdb-cli
</code>
</a>
utility to control the size of the CRDT replication backlog. You can set it to
<code>
auto
</code>
or set a specific size:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">crdb-cli crdb update --crdb-guid <crdb_guid> --default-db-config "{\"crdt_repl_backlog_size\": <size in MB | 'auto'>}"
</span></span></code></pre>
</div>
<p>
<strong>
For Redis Software versions earlier than 6.0.20:
</strong>
The replication backlog and the CRDT replication backlog defaults are set to 1MB and cannot be set dynamically with 'auto' mode.
To control the size of the replication log, use
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/">
<code>
rladmin
</code>
</a>
to tune the local database instance in each cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">rladmin tune db <db:id | name> repl_backlog <Backlog size in MB (or if ending with bytes, KB or GB, in the respective unit)>
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/durability-ha/replication/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.0-release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisTimeSeries 1.0 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
Downsampling/compaction. Secondary indexing. Aggregation at read time. Integration with Prometheus, Grafana, and Telegraph.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RedisTimeSeries v1.0.3 requires:
</p>
<ul>
<li>
Minimum Redis compatibility version (database): 5.0.0
</li>
<li>
Minimum Redis Enterprise Software version (cluster): 5.4.0
</li>
</ul>
<h2 id="v103-september-2019">
v1.0.3 (September 2019)
</h2>
<p>
Update urgency: Medium
</p>
<p>
This is a maintenance release for version 1.0.
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
<p>
Main features:
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/143">
143
</a>
Standard Deviation for Aggregations
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/163">
163
</a>
<code>
TS.RANGE
</code>
and
<code>
TS.MRANGE
</code>
can limit results via optional
<code>
COUNT
</code>
flag
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/161">
161
</a>
Support for ARM architectures
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/160">
160
</a>
Optional
<code>
TIMESTAMP
</code>
in
<code>
TS.INCRBY
</code>
and
<code>
TS.DECRBY
</code>
</li>
</ul>
<p>
Main Fixes:
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/199">
199
</a>
<code>
RETENTION
</code>
is now 64bit
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/issues/211">
211
</a>
write commands to return OOM error when redis reaches max memory
</li>
</ul>
<p>
Main Performance improvements:
</p>
<ul>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/commit/3651ef8eb65b390e333053b91a64617fc2382f6e">
3651
</a>
Do not use
<code>
_union
</code>
if there's only 1 leaf in the index
</li>
<li>
#
<a href="https://github.com/RedisTimeSeries/RedisTimeSeries/commit/0a68d4eca95108595ac7dfbae68d3f0371e41470">
0a68
</a>
Make _difference faster by iterating over the left dict (which is always smaller)
</li>
</ul>
<h2 id="v101-july-2019">
v1.0.1 (July 2019)
</h2>
<p>
Update urgency: Minor
</p>
<p>
This is a maintenance release for version 1.0.
</p>
<p>
Secondary index should work faster when a filter consists of a list of k=v predicates.
</p>
<h2 id="v100-june-2019">
v1.0.0 (June 2019)
</h2>
<p>
This is the General Availability release of RedisTimeSeries! Read the
<a href="https://redislabs.com/blog/redistimeseries-ga-making-4th-dimension-truly-immersive">
full story here
</a>
</p>
<h3 id="features">
Features
</h3>
<p>
In RedisTimeSeries, we are introducing a new data type that uses chunks of memory of fixed size for time series samples, indexed by the same
<a href="https://github.com/antirez/rax">
Radix Tree implementation
</a>
as Redis Streams. With Streams, you can create a [capped stream](/docs/latest/commands/xadd/, effectively limiting the number of messages by count. In RedisTimeSeries, you can apply a retention policy in milliseconds. This is better for time series use cases, because they are typically interested in the data during a given time window, rather than a fixed number of samples.
</p>
<h4 id="downsamplingcompaction">
Downsampling/compaction
</h4>
<p>
If you want to keep all of your raw data points indefinitely, your data set will grow linearly over time. However, if your use case allows you to have less fine-grained data further back in time, downsampling can be applied. This allows you to keep fewer historical data points by aggregating raw data for a given time window using a given aggregation function. RedisTimeSeries supports downsampling with the following aggregations: avg, sum, min, max, range, count, first and last.
</p>
<h4 id="secondary-indexing">
Secondary indexing
</h4>
<p>
When using Redis’ core data structures, you can only retrieve a time series by knowing the exact key holding the time series. Unfortunately, for many time series use cases (such as root cause analysis or monitoring), your application won’t know the exact key it’s looking for. These use cases typically want to query a set of time series that relate to each other in a couple of dimensions to extract the insight you need. You could create your own secondary index with core Redis data structures to help with this, but it would come with a high development cost and require you to manage edge cases to make sure the index is correct.
</p>
<p>
RedisTimeSeries does this indexing for you based on
<code>
field value
</code>
pairs (a.k.a labels) you can add to each time series, and use to filter at query time (a full list of these filters is available in our documentation). Here’s an example of creating a time series with two labels (sensor_id and area_id are the fields with values 2 and 32 respectively) and a retention window of 60,000 milliseconds:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">TS.CREATE temperature RETENTION <span class="m">60000</span> LABELS sensor_id <span class="m">2</span> area_id <span class="m">32</span>
</span></span></code></pre>
</div>
<h4 id="aggregation-at-read-time">
Aggregation at read time
</h4>
<p>
When you need to query a time series, it’s cumbersome to stream all raw data points if you’re only interested in, say, an average over a given time interval. RedisTimeSeries follows the Redis philosophy to only transfer the minimum required data to ensure lowest latency. Below is an example of aggregation query over time buckets of 5,000 milliseconds with an aggregation function:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">127.0.0.1:6379> TS.RANGE temperature:3:32 <span class="m">1548149180000</span> <span class="m">1548149210000</span> AGGREGATION avg <span class="m">5000</span>
</span></span><span class="line"><span class="cl">1<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149180000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"26.199999999999999"</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149185000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"27.399999999999999"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149190000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"24.800000000000001"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149195000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"23.199999999999999"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149200000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"25.199999999999999"</span>
</span></span><span class="line"><span class="cl">6<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149205000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"28"</span>
</span></span><span class="line"><span class="cl">7<span class="o">)</span> 1<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1548149210000</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"20"</span>
</span></span></code></pre>
</div>
<h4 id="integrations">
Integrations
</h4>
<p>
RedisTimeSeries comes with several integrations into existing time series tools. One such integration is our
<a href="https://github.com/RedisTimeSeries/prometheus-redistimeseries-adapter">
RedisTimeSeries adapter for Prometheus
</a>
, which keeps all your monitoring metrics inside RedisTimeSeries while leveraging the entire Prometheus ecosystem.
Furthermore, we also created direct integration for
<a href="https://github.com/RedisTimeSeries/grafana-redistimeseries">
Grafana
</a>
.
<a href="https://github.com/RedisTimeSeries/prometheus-demos">
This repository
</a>
contains a docker-compose setup of RedisTimeSeries, its remote write adaptor, Prometheus and Grafana. It also comes with a set of data generators and pre-built Grafana dashboards.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/release-notes/redistimeseries/redistimeseries-1.0-release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redisvl/user-guide/json-v-hashes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
JSON vs. hash storage
</h1>
<p class="text-lg -mt-5 mb-10">
Storing JSON and hashes with RedisVL
</p>
<p>
Out of the box, Redis provides a
<a href="https://redis.com/redis-enterprise/data-structures/">
variety of data structures
</a>
that can be used for your domain specific applications and use cases.
In this document, you will learn how to use RedisVL with both
<a href="/docs/latest/develop/data-types/hashes/">
hash
</a>
and
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
data.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
This document is a converted form of
<a href="https://github.com/RedisVentures/redisvl/blob/main/docs/user_guide/hash_vs_json_05.ipynb">
this Jupyter notebook
</a>
.
</div>
</div>
<p>
Before beginning, be sure of the following:
</p>
<ol>
<li>
You have installed RedisVL and have that environment activated.
</li>
<li>
You have a running Redis instance with the Redis Query Engine capability.
</li>
</ol>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># import necessary modules</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">pickle</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redisvl.redis.utils</span> <span class="kn">import</span> <span class="n">buffer_to_array</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">jupyterutils</span> <span class="kn">import</span> <span class="n">result_print</span><span class="p">,</span> <span class="n">table_print</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redisvl.index</span> <span class="kn">import</span> <span class="n">SearchIndex</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># load in the example data and printing utils</span>
</span></span><span class="line"><span class="cl"><span class="n">data</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="s2">"hybrid_example_data.pkl"</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">))</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">table_print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</span></span></code></pre>
</div>
<table>
<tbody>
<tr>
<th>
user
</th>
<th>
age
</th>
<th>
job
</th>
<th>
credit_score
</th>
<th>
office_location
</th>
<th>
user_embedding
</th>
</tr>
<tr>
<td>
john
</td>
<td>
18
</td>
<td>
engineer
</td>
<td>
high
</td>
<td>
-122.4194,37.7749
</td>
<td>
b'\xcd\xcc\xcc=\xcd\xcc\xcc=\x00\x00\x00?'
</td>
</tr>
<tr>
<td>
derrick
</td>
<td>
14
</td>
<td>
doctor
</td>
<td>
low
</td>
<td>
-122.4194,37.7749
</td>
<td>
b'\xcd\xcc\xcc=\xcd\xcc\xcc=\x00\x00\x00?'
</td>
</tr>
<tr>
<td>
nancy
</td>
<td>
94
</td>
<td>
doctor
</td>
<td>
high
</td>
<td>
-122.4194,37.7749
</td>
<td>
b'333?\xcd\xcc\xcc=\x00\x00\x00?'
</td>
</tr>
<tr>
<td>
tyler
</td>
<td>
100
</td>
<td>
engineer
</td>
<td>
high
</td>
<td>
-122.0839,37.3861
</td>
<td>
b'\xcd\xcc\xcc=\xcd\xcc\xcc>\x00\x00\x00?'
</td>
</tr>
<tr>
<td>
tim
</td>
<td>
12
</td>
<td>
dermatologist
</td>
<td>
high
</td>
<td>
-122.0839,37.3861
</td>
<td>
b'\xcd\xcc\xcc>\xcd\xcc\xcc>\x00\x00\x00?'
</td>
</tr>
<tr>
<td>
taimur
</td>
<td>
15
</td>
<td>
CEO
</td>
<td>
low
</td>
<td>
-122.0839,37.3861
</td>
<td>
b'\x9a\x99\x19?\xcd\xcc\xcc=\x00\x00\x00?'
</td>
</tr>
<tr>
<td>
joe
</td>
<td>
35
</td>
<td>
dentist
</td>
<td>
medium
</td>
<td>
-122.0839,37.3861
</td>
<td>
b'fff?fff?\xcd\xcc\xcc='
</td>
</tr>
</tbody>
</table>
<h2 id="hash-or-json---how-to-choose">
Hash or JSON - how to choose?
</h2>
<p>
Both storage options offer a variety of features and tradeoffs. Below, you will work through a dummy dataset to learn when and how to use both data types.
</p>
<h3 id="working-with-hashes">
Working with hashes
</h3>
<p>
Hashes in Redis are simple collections of field-value pairs. Think of it like a mutable, single-level dictionary that contains multiple "rows":
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Deimos"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Ergonom"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"Enduro bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">4972</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<p>
Hashes are best suited for use cases with the following characteristics:
</p>
<ul>
<li>
Performance (speed) and storage space (memory consumption) are top concerns.
</li>
<li>
Data can be easily normalized and modeled as a single-level dictionary.
</li>
</ul>
<blockquote>
<p>
Hashes are typically the default recommendation.
</p>
</blockquote>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># define the hash index schema</span>
</span></span><span class="line"><span class="cl"><span class="n">hash_schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"index"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"user-hash"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"prefix"</span><span class="p">:</span> <span class="s2">"user-hash-docs"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"storage_type"</span><span class="p">:</span> <span class="s2">"hash"</span><span class="p">,</span> <span class="c1"># default setting -- HASH</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"tag"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"credit_score"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"tag"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"job"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"text"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"age"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"numeric"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"office_location"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"geo"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"user_embedding"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"attrs"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"dims"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"distance_metric"</span><span class="p">:</span> <span class="s2">"cosine"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"algorithm"</span><span class="p">:</span> <span class="s2">"flat"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"datatype"</span><span class="p">:</span> <span class="s2">"float32"</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># construct a search index from the hash schema</span>
</span></span><span class="line"><span class="cl"><span class="n">hindex</span> <span class="o">=</span> <span class="n">SearchIndex</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">hash_schema</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># connect to local redis instance</span>
</span></span><span class="line"><span class="cl"><span class="n">hindex</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">"redis://localhost:6379"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># create the index (no data yet)</span>
</span></span><span class="line"><span class="cl"><span class="n">hindex</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">overwrite</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># show the underlying storage type</span>
</span></span><span class="line"><span class="cl"><span class="n">hindex</span><span class="o">.</span><span class="n">storage_type</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="o"><</span><span class="n">StorageType</span><span class="o">.</span><span class="n">HASH</span><span class="p">:</span> <span class="s1">'hash'</span><span class="o">></span>
</span></span></code></pre>
</div>
<h4 id="vectors-as-byte-strings">
Vectors as byte strings
</h4>
<p>
One nuance when working with hashes in Redis is that all vectorized data must be passed as a byte string (for efficient storage, indexing, and processing). An example of this can be seen below:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># show a single entry from the data that will be loaded</span>
</span></span><span class="line"><span class="cl"><span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s1">'user'</span><span class="p">:</span> <span class="s1">'john'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'age'</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'job'</span><span class="p">:</span> <span class="s1">'engineer'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'credit_score'</span><span class="p">:</span> <span class="s1">'high'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'office_location'</span><span class="p">:</span> <span class="s1">'-122.4194,37.7749'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'user_embedding'</span><span class="p">:</span> <span class="sa">b</span><span class="s1">'</span><span class="se">\xcd\xcc\xcc</span><span class="s1">=</span><span class="se">\xcd\xcc\xcc</span><span class="s1">=</span><span class="se">\x00\x00\x00</span><span class="s1">?'</span><span class="p">}</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># load hash data</span>
</span></span><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="n">hindex</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="err">$</span> <span class="n">rvl</span> <span class="n">stats</span> <span class="o">-</span><span class="n">i</span> <span class="n">user</span><span class="o">-</span><span class="nb">hash</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Statistics</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="err">╭─────────────────────────────┬─────────────╮</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">Stat</span> <span class="n">Key</span> <span class="err">│</span> <span class="n">Value</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">├─────────────────────────────┼─────────────┤</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">num_docs</span> <span class="err">│</span> <span class="mi">7</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">num_terms</span> <span class="err">│</span> <span class="mi">6</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">max_doc_id</span> <span class="err">│</span> <span class="mi">7</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">num_records</span> <span class="err">│</span> <span class="mi">44</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">percent_indexed</span> <span class="err">│</span> <span class="mi">1</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">hash_indexing_failures</span> <span class="err">│</span> <span class="mi">0</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">number_of_uses</span> <span class="err">│</span> <span class="mi">1</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">bytes_per_record_avg</span> <span class="err">│</span> <span class="mf">3.40909</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">doc_table_size_mb</span> <span class="err">│</span> <span class="mf">0.000767708</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">inverted_sz_mb</span> <span class="err">│</span> <span class="mf">0.000143051</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">key_table_size_mb</span> <span class="err">│</span> <span class="mf">0.000248909</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">offset_bits_per_record_avg</span> <span class="err">│</span> <span class="mi">8</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">offset_vectors_sz_mb</span> <span class="err">│</span> <span class="mf">8.58307e-06</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">offsets_per_term_avg</span> <span class="err">│</span> <span class="mf">0.204545</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">records_per_doc_avg</span> <span class="err">│</span> <span class="mf">6.28571</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">sortable_values_size_mb</span> <span class="err">│</span> <span class="mi">0</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">total_indexing_time</span> <span class="err">│</span> <span class="mf">0.587</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">total_inverted_index_blocks</span> <span class="err">│</span> <span class="mi">18</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">│</span> <span class="n">vector_index_sz_mb</span> <span class="err">│</span> <span class="mf">0.0202332</span> <span class="err">│</span>
</span></span><span class="line"><span class="cl"> <span class="err">╰─────────────────────────────┴─────────────╯</span>
</span></span></code></pre>
</div>
<h4 id="performing-queries">
Performing queries
</h4>
<p>
Once the index is created and data is loaded into the right format, you can run queries against the index:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redisvl.query</span> <span class="kn">import</span> <span class="n">VectorQuery</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redisvl.query.filter</span> <span class="kn">import</span> <span class="n">Tag</span><span class="p">,</span> <span class="n">Text</span><span class="p">,</span> <span class="n">Num</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">t</span> <span class="o">=</span> <span class="p">(</span><span class="n">Tag</span><span class="p">(</span><span class="s2">"credit_score"</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"high"</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="n">Text</span><span class="p">(</span><span class="s2">"job"</span><span class="p">)</span> <span class="o">%</span> <span class="s2">"enginee*"</span><span class="p">)</span> <span class="o">&</span> <span class="p">(</span><span class="n">Num</span><span class="p">(</span><span class="s2">"age"</span><span class="p">)</span> <span class="o">></span> <span class="mi">17</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">v</span> <span class="o">=</span> <span class="n">VectorQuery</span><span class="p">([</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"user_embedding"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">return_fields</span><span class="o">=</span><span class="p">[</span><span class="s2">"user"</span><span class="p">,</span> <span class="s2">"credit_score"</span><span class="p">,</span> <span class="s2">"age"</span><span class="p">,</span> <span class="s2">"job"</span><span class="p">,</span> <span class="s2">"office_location"</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="n">filter_expression</span><span class="o">=</span><span class="n">t</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">results</span> <span class="o">=</span> <span class="n">hindex</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">result_print</span><span class="p">(</span><span class="n">results</span><span class="p">)</span>
</span></span></code></pre>
</div>
<table>
<tbody>
<tr>
<th>
vector_distance
</th>
<th>
user
</th>
<th>
credit_score
</th>
<th>
age
</th>
<th>
job
</th>
<th>
office_location
</th>
</tr>
<tr>
<td>
0
</td>
<td>
john
</td>
<td>
high
</td>
<td>
18
</td>
<td>
engineer
</td>
<td>
-122.4194,37.7749
</td>
</tr>
<tr>
<td>
0.109129190445
</td>
<td>
tyler
</td>
<td>
high
</td>
<td>
100
</td>
<td>
engineer
</td>
<td>
-122.0839,37.3861
</td>
</tr>
</tbody>
</table>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># clean up</span>
</span></span><span class="line"><span class="cl"><span class="n">hindex</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
</span></span></code></pre>
</div>
<h3 id="working-with-json">
Working with JSON
</h3>
<p>
Redis also supports native
<strong>
JSON
</strong>
objects. These can be multi-level (nested) objects, with full
<a href="/docs/latest/develop/data-types/json/path/">
JSONPath
</a>
support for retrieving and updating sub-elements:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bike"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"metadata"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"Deimos"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"brand"</span><span class="p">:</span> <span class="s2">"Ergonom"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"Enduro bikes"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">4972</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<p>
JSON is best suited for use cases with the following characteristics:
</p>
<ul>
<li>
Ease of use and data model flexibility are top concerns.
</li>
<li>
Application data is already native JSON.
</li>
<li>
Replacing another document storage/database solution.
</li>
</ul>
<h4 id="full-json-path-support">
Full JSON Path support
</h4>
<p>
Because Redis enables full JSONPath support, when creating an index schema, elements need to be indexed and selected by their path with the desired
<code>
name
</code>
and
<code>
path
</code>
that points to where the data is located within the objects.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
By default, RedisVL will assume the path as
<code>
$.{name}
</code>
if not provided in JSON fields schema.
</div>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># define the json index schema</span>
</span></span><span class="line"><span class="cl"><span class="n">json_schema</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"index"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"user-json"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"prefix"</span><span class="p">:</span> <span class="s2">"user-json-docs"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"storage_type"</span><span class="p">:</span> <span class="s2">"json"</span><span class="p">,</span> <span class="c1"># JSON storage type</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"tag"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"credit_score"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"tag"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"job"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"text"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"age"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"numeric"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"office_location"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"geo"</span><span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"user_embedding"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"vector"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"attrs"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"dims"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"distance_metric"</span><span class="p">:</span> <span class="s2">"cosine"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"algorithm"</span><span class="p">:</span> <span class="s2">"flat"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"datatype"</span><span class="p">:</span> <span class="s2">"float32"</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">],</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># construct a search index from the JSON schema</span>
</span></span><span class="line"><span class="cl"><span class="n">jindex</span> <span class="o">=</span> <span class="n">SearchIndex</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">json_schema</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># connect to a local redis instance</span>
</span></span><span class="line"><span class="cl"><span class="n">jindex</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">"redis://localhost:6379"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># create the index (no data yet)</span>
</span></span><span class="line"><span class="cl"><span class="n">jindex</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">overwrite</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># note the multiple indices in the same database</span>
</span></span><span class="line"><span class="cl"><span class="err">$</span> <span class="n">rvl</span> <span class="n">index</span> <span class="n">listall</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="mi">20</span><span class="p">:</span><span class="mi">23</span><span class="p">:</span><span class="mi">08</span> <span class="p">[</span><span class="n">RedisVL</span><span class="p">]</span> <span class="n">INFO</span> <span class="n">Indices</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="mi">20</span><span class="p">:</span><span class="mi">23</span><span class="p">:</span><span class="mi">08</span> <span class="p">[</span><span class="n">RedisVL</span><span class="p">]</span> <span class="n">INFO</span> <span class="mf">1.</span> <span class="n">user</span><span class="o">-</span><span class="n">json</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">#### Vectors as float arrays</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">Vectorized</span> <span class="n">data</span> <span class="n">stored</span> <span class="ow">in</span> <span class="n">JSON</span> <span class="n">must</span> <span class="n">be</span> <span class="n">stored</span> <span class="k">as</span> <span class="n">a</span> <span class="n">pure</span> <span class="n">array</span> <span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">g</span><span class="o">.</span><span class="p">,</span> <span class="n">a</span> <span class="n">Python</span> <span class="nb">list</span><span class="p">)</span> <span class="n">of</span> <span class="n">floats</span><span class="o">.</span> <span class="n">Modify</span> <span class="n">your</span> <span class="n">sample</span> <span class="n">data</span> <span class="n">to</span> <span class="n">account</span> <span class="k">for</span> <span class="n">this</span> <span class="n">below</span><span class="p">:</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="err">```</span><span class="n">python</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">json_data</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">json_data</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">d</span><span class="p">[</span><span class="s1">'user_embedding'</span><span class="p">]</span> <span class="o">=</span> <span class="n">buffer_to_array</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s1">'user_embedding'</span><span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># inspect a single JSON record</span>
</span></span><span class="line"><span class="cl"><span class="n">json_data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
</span></span></code></pre>
</div>
<pre><code>{'user': 'john',
'age': 18,
'job': 'engineer',
'credit_score': 'high',
'office_location': '-122.4194,37.7749',
'user_embedding': [0.10000000149011612, 0.10000000149011612, 0.5]}
</code></pre>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">keys</span> <span class="o">=</span> <span class="n">jindex</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">json_data</span><span class="p">)</span>
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># we can now run the exact same query as above</span>
</span></span><span class="line"><span class="cl"><span class="n">result_print</span><span class="p">(</span><span class="n">jindex</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">v</span><span class="p">))</span>
</span></span></code></pre>
</div>
<table>
<tbody>
<tr>
<th>
vector_distance
</th>
<th>
user
</th>
<th>
credit_score
</th>
<th>
age
</th>
<th>
job
</th>
<th>
office_location
</th>
</tr>
<tr>
<td>
0
</td>
<td>
john
</td>
<td>
high
</td>
<td>
18
</td>
<td>
engineer
</td>
<td>
-122.4194,37.7749
</td>
</tr>
<tr>
<td>
0.109129190445
</td>
<td>
tyler
</td>
<td>
high
</td>
<td>
100
</td>
<td>
engineer
</td>
<td>
-122.0839,37.3861
</td>
</tr>
</tbody>
</table>
<h2 id="cleanup">
Cleanup
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">jindex</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redisvl/user-guide/json-v-hashes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/failover/.html | <section class="prose w-full py-12">
<h1 class="command-name">
FAILOVER
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FAILOVER [TO host port [FORCE]] [ABORT] [TIMEOUT milliseconds]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
6.2.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@admin
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@dangerous
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This command will start a coordinated failover between the currently-connected-to master and one of its replicas.
The failover is not synchronous, instead a background task will handle coordinating the failover.
It is designed to limit data loss and unavailability of the cluster during the failover.
This command is analogous to the
<a href="/docs/latest/commands/cluster-failover/">
<code>
CLUSTER FAILOVER
</code>
</a>
command for non-clustered Redis and is similar to the failover support provided by sentinel.
</p>
<p>
The specific details of the default failover flow are as follows:
</p>
<ol>
<li>
The master will internally start a
<code>
CLIENT PAUSE WRITE
</code>
, which will pause incoming writes and prevent the accumulation of new data in the replication stream.
</li>
<li>
The master will monitor its replicas, waiting for a replica to indicate that it has fully consumed the replication stream. If the master has multiple replicas, it will only wait for the first replica to catch up.
</li>
<li>
The master will then demote itself to a replica. This is done to prevent any dual master scenarios. NOTE: The master will not discard its data, so it will be able to rollback if the replica rejects the failover request in the next step.
</li>
<li>
The previous master will send a special PSYNC request to the target replica,
<code>
PSYNC FAILOVER
</code>
, instructing the target replica to become a master.
</li>
<li>
Once the previous master receives acknowledgement the
<code>
PSYNC FAILOVER
</code>
was accepted it will unpause its clients. If the PSYNC request is rejected, the master will abort the failover and return to normal.
</li>
</ol>
<p>
The field
<code>
master_failover_state
</code>
in
<code>
INFO replication
</code>
can be used to track the current state of the failover, which has the following values:
</p>
<ul>
<li>
<code>
no-failover
</code>
: There is no ongoing coordinated failover.
</li>
<li>
<code>
waiting-for-sync
</code>
: The master is waiting for the replica to catch up to its replication offset.
</li>
<li>
<code>
failover-in-progress
</code>
: The master has demoted itself, and is attempting to hand off ownership to a target replica.
</li>
</ul>
<p>
If the previous master had additional replicas attached to it, they will continue replicating from it as chained replicas. You will need to manually execute a
<a href="/docs/latest/commands/replicaof/">
<code>
REPLICAOF
</code>
</a>
on these replicas to start replicating directly from the new master.
</p>
<h2 id="optional-arguments">
Optional arguments
</h2>
<p>
The following optional arguments exist to modify the behavior of the failover flow:
</p>
<ul>
<li>
<p>
<code>
TIMEOUT
</code>
<em>
milliseconds
</em>
-- This option allows specifying a maximum time a master will wait in the
<code>
waiting-for-sync
</code>
state before aborting the failover attempt and rolling back.
This is intended to set an upper bound on the write outage the Redis cluster can experience.
Failovers typically happen in less than a second, but could take longer if there is a large amount of write traffic or the replica is already behind in consuming the replication stream.
If this value is not specified, the timeout can be considered to be "infinite".
</p>
</li>
<li>
<p>
<code>
TO
</code>
<em>
HOST
</em>
<em>
PORT
</em>
-- This option allows designating a specific replica, by its host and port, to failover to. The master will wait specifically for this replica to catch up to its replication offset, and then failover to it.
</p>
</li>
<li>
<p>
<code>
FORCE
</code>
-- If both the
<code>
TIMEOUT
</code>
and
<code>
TO
</code>
options are set, the force flag can also be used to designate that that once the timeout has elapsed, the master should failover to the target replica instead of rolling back.
This can be used for a best-effort attempt at a failover without data loss, but limiting write outage.
</p>
</li>
</ul>
<p>
NOTE: The master will always rollback if the
<code>
PSYNC FAILOVER
</code>
request is rejected by the target replica.
</p>
<h2 id="failover-abort">
Failover abort
</h2>
<p>
The failover command is intended to be safe from data loss and corruption, but can encounter some scenarios it can not automatically remediate from and may get stuck.
For this purpose, the
<code>
FAILOVER ABORT
</code>
command exists, which will abort an ongoing failover and return the master to its normal state.
The command has no side effects if issued in the
<code>
waiting-for-sync
</code>
state but can introduce multi-master scenarios in the
<code>
failover-in-progress
</code>
state.
If a multi-master scenario is encountered, you will need to manually identify which master has the latest data and designate it as the master and have the other replicas.
</p>
<p>
NOTE:
<a href="/docs/latest/commands/replicaof/">
<code>
REPLICAOF
</code>
</a>
is disabled while a failover is in progress, this is to prevent unintended interactions with the failover that might cause data loss.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
if the command was accepted and a coordinated failover is in progress. An error if the operation cannot be executed.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/failover/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/interact/programmability/functions-intro/.html | <section class="prose w-full py-12">
<h1>
Redis functions
</h1>
<p class="text-lg -mt-5 mb-10">
Scripting with Redis 7 and beyond
</p>
<p>
Redis Functions is an API for managing code to be executed on the server. This feature, which became available in Redis 7, supersedes the use of
<a href="/docs/latest/develop/interact/programmability/eval-intro/">
EVAL
</a>
in prior versions of Redis.
</p>
<h2 id="prologue-or-whats-wrong-with-eval-scripts">
Prologue (or, what's wrong with Eval Scripts?)
</h2>
<p>
Prior versions of Redis made scripting available only via the
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
command, which allows a Lua script to be sent for execution by the server.
The core use cases for
<a href="/docs/latest/develop/interact/programmability/eval-intro/">
Eval Scripts
</a>
is executing part of your application logic inside Redis, efficiently and atomically.
Such script can perform conditional updates across multiple keys, possibly combining several different data types.
</p>
<p>
Using
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
requires that the application sends the entire script for execution every time.
Because this results in network and script compilation overheads, Redis provides an optimization in the form of the
<a href="/docs/latest/commands/evalsha/">
<code>
EVALSHA
</code>
</a>
command. By first calling
<a href="/docs/latest/commands/script-load/">
<code>
SCRIPT LOAD
</code>
</a>
to obtain the script's SHA1, the application can invoke it repeatedly afterward with its digest alone.
</p>
<p>
By design, Redis only caches the loaded scripts.
That means that the script cache can become lost at any time, such as after calling
<a href="/docs/latest/commands/script-flush/">
<code>
SCRIPT FLUSH
</code>
</a>
, after restarting the server, or when failing over to a replica.
The application is responsible for reloading scripts during runtime if any are missing.
The underlying assumption is that scripts are a part of the application and not maintained by the Redis server.
</p>
<p>
This approach suits many light-weight scripting use cases, but introduces several difficulties once an application becomes complex and relies more heavily on scripting, namely:
</p>
<ol>
<li>
All client application instances must maintain a copy of all scripts. That means having some mechanism that applies script updates to all of the application's instances.
</li>
<li>
Calling cached scripts within the context of a
<a href="/docs/latest/develop/interact/transactions/">
transaction
</a>
increases the probability of the transaction failing because of a missing script. Being more likely to fail makes using cached scripts as building blocks of workflows less attractive.
</li>
<li>
SHA1 digests are meaningless, making debugging the system extremely hard (e.g., in a
<a href="/docs/latest/commands/monitor/">
<code>
MONITOR
</code>
</a>
session).
</li>
<li>
When used naively,
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
promotes an anti-pattern in which scripts the client application renders verbatim scripts instead of responsibly using the
<a href="/docs/latest/develop/interact/programmability/lua-api#runtime-globals">
<code>
KEYS
</code>
and
<code>
ARGV
</code>
Lua APIs
</a>
.
</li>
<li>
Because they are ephemeral, a script can't call another script. This makes sharing and reusing code between scripts nearly impossible, short of client-side preprocessing (see the first point).
</li>
</ol>
<p>
To address these needs while avoiding breaking changes to already-established and well-liked ephemeral scripts, Redis v7.0 introduces Redis Functions.
</p>
<h2 id="what-are-redis-functions">
What are Redis Functions?
</h2>
<p>
Redis functions are an evolutionary step from ephemeral scripting.
</p>
<p>
Functions provide the same core functionality as scripts but are first-class software artifacts of the database.
Redis manages functions as an integral part of the database and ensures their availability via data persistence and replication.
Because functions are part of the database and therefore declared before use, applications aren't required to load them during runtime nor risk aborted transactions.
An application that uses functions depends only on their APIs rather than on the embedded script logic in the database.
</p>
<p>
Whereas ephemeral scripts are considered a part of the application's domain, functions extend the database server itself with user-provided logic.
They can be used to expose a richer API composed of core Redis commands, similar to modules, developed once, loaded at startup, and used repeatedly by various applications / clients.
Every function has a unique user-defined name, making it much easier to call and trace its execution.
</p>
<p>
The design of Redis Functions also attempts to demarcate between the programming language used for writing functions and their management by the server.
Lua, the only language interpreter that Redis presently support as an embedded execution engine, is meant to be simple and easy to learn.
However, the choice of Lua as a language still presents many Redis users with a challenge.
</p>
<p>
The Redis Functions feature makes no assumptions about the implementation's language.
An execution engine that is part of the definition of the function handles running it.
An engine can theoretically execute functions in any language as long as it respects several rules (such as the ability to terminate an executing function).
</p>
<p>
Presently, as noted above, Redis ships with a single embedded
<a href="/docs/latest/develop/interact/programmability/lua-api">
Lua 5.1
</a>
engine.
There are plans to support additional engines in the future.
Redis functions can use all of Lua's available capabilities to ephemeral scripts,
with the only exception being the
<a href="/docs/latest/develop/interact/programmability/lua-debugging/">
Redis Lua scripts debugger
</a>
.
</p>
<p>
Functions also simplify development by enabling code sharing.
Every function belongs to a single library, and any given library can consist of multiple functions.
The library's contents are immutable, and selective updates of its functions aren't allowed.
Instead, libraries are updated as a whole with all of their functions together in one operation.
This allows calling functions from other functions within the same library, or sharing code between functions by using a common code in library-internal methods, that can also take language native arguments.
</p>
<p>
Functions are intended to better support the use case of maintaining a consistent view for data entities through a logical schema, as mentioned above.
As such, functions are stored alongside the data itself.
Functions are also persisted to the AOF file and replicated from master to replicas, so they are as durable as the data itself.
When Redis is used as an ephemeral cache, additional mechanisms (described below) are required to make functions more durable.
</p>
<p>
Like all other operations in Redis, the execution of a function is atomic.
A function's execution blocks all server activities during its entire time, similarly to the semantics of
<a href="/docs/latest/develop/interact/transactions/">
transactions
</a>
.
These semantics mean that all of the script's effects either have yet to happen or had already happened.
The blocking semantics of an executed function apply to all connected clients at all times.
Because running a function blocks the Redis server, functions are meant to finish executing quickly, so you should avoid using long-running functions.
</p>
<h2 id="loading-libraries-and-functions">
Loading libraries and functions
</h2>
<p>
Let's explore Redis Functions via some tangible examples and Lua snippets.
</p>
<p>
At this point, if you're unfamiliar with Lua in general and specifically in Redis, you may benefit from reviewing some of the examples in
<a href="/docs/latest/develop/interact/programmability/eval-intro/">
Introduction to Eval Scripts
</a>
and
<a href="/docs/latest/develop/interact/programmability/lua-api">
Lua API
</a>
pages for a better grasp of the language.
</p>
<p>
Every Redis function belongs to a single library that's loaded to Redis.
Loading a library to the database is done with the
<a href="/docs/latest/commands/function-load/">
<code>
FUNCTION LOAD
</code>
</a>
command.
The command gets the library payload as input,
the library payload must start with Shebang statement that provides a metadata about the library (like the engine to use and the library name).
The Shebang format is:
</p>
<pre tabindex="0"><code>#!<engine name> name=<library name>
</code></pre>
<p>
Let's try loading an empty library:
</p>
<pre tabindex="0"><code>redis> FUNCTION LOAD "#!lua name=mylib\n"
(error) ERR No functions registered
</code></pre>
<p>
The error is expected, as there are no functions in the loaded library. Every library needs to include at least one registered function to load successfully.
A registered function is named and acts as an entry point to the library.
When the target execution engine handles the
<a href="/docs/latest/commands/function-load/">
<code>
FUNCTION LOAD
</code>
</a>
command, it registers the library's functions.
</p>
<p>
The Lua engine compiles and evaluates the library source code when loaded, and expects functions to be registered by calling the
<code>
redis.register_function()
</code>
API.
</p>
<p>
The following snippet demonstrates a simple library registering a single function named
<em>
knockknock
</em>
, returning a string reply:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-lua" data-lang="lua"><span class="line"><span class="cl"><span class="cp">#!lua name=mylib</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'knockknock'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="kr">function</span><span class="p">()</span> <span class="kr">return</span> <span class="s1">'Who</span><span class="se">\'</span><span class="s1">s there?'</span> <span class="kr">end</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<p>
In the example above, we provide two arguments about the function to Lua's
<code>
redis.register_function()
</code>
API: its registered name and a callback.
</p>
<p>
We can load our library and use
<a href="/docs/latest/commands/fcall/">
<code>
FCALL
</code>
</a>
to call the registered function:
</p>
<pre tabindex="0"><code>redis> FUNCTION LOAD "#!lua name=mylib\nredis.register_function('knockknock', function() return 'Who\\'s there?' end)"
mylib
redis> FCALL knockknock 0
"Who's there?"
</code></pre>
<p>
Notice that the
<a href="/docs/latest/commands/function-load/">
<code>
FUNCTION LOAD
</code>
</a>
command returns the name of the loaded library, this name can later be used
<a href="/docs/latest/commands/function-list/">
<code>
FUNCTION LIST
</code>
</a>
and
<a href="/docs/latest/commands/function-delete/">
<code>
FUNCTION DELETE
</code>
</a>
.
</p>
<p>
We've provided
<a href="/docs/latest/commands/fcall/">
<code>
FCALL
</code>
</a>
with two arguments: the function's registered name and the numeric value
<code>
0
</code>
. This numeric value indicates the number of key names that follow it (the same way
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
and
<a href="/docs/latest/commands/evalsha/">
<code>
EVALSHA
</code>
</a>
work).
</p>
<p>
We'll explain immediately how key names and additional arguments are available to the function. As this simple example doesn't involve keys, we simply use 0 for now.
</p>
<h2 id="input-keys-and-regular-arguments">
Input keys and regular arguments
</h2>
<p>
Before we move to the following example, it is vital to understand the distinction Redis makes between arguments that are names of keys and those that aren't.
</p>
<p>
While key names in Redis are just strings, unlike any other string values, these represent keys in the database.
The name of a key is a fundamental concept in Redis and is the basis for operating the Redis Cluster.
</p>
<p>
<strong>
Important:
</strong>
To ensure the correct execution of Redis Functions, both in standalone and clustered deployments, all names of keys that a function accesses must be explicitly provided as input key arguments.
</p>
<p>
Any input to the function that isn't the name of a key is a regular input argument.
</p>
<p>
Now, let's pretend that our application stores some of its data in Redis Hashes.
We want an
<a href="/docs/latest/commands/hset/">
<code>
HSET
</code>
</a>
-like way to set and update fields in said Hashes and store the last modification time in a new field named
<code>
_last_modified_
</code>
.
We can implement a function to do all that.
</p>
<p>
Our function will call
<a href="/docs/latest/commands/time/">
<code>
TIME
</code>
</a>
to get the server's clock reading and update the target Hash with the new fields' values and the modification's timestamp.
The function we'll implement accepts the following input arguments: the Hash's key name and the field-value pairs to update.
</p>
<p>
The Lua API for Redis Functions makes these inputs accessible as the first and second arguments to the function's callback.
The callback's first argument is a Lua table populated with all key names inputs to the function.
Similarly, the callback's second argument consists of all regular arguments.
</p>
<p>
The following is a possible implementation for our function and its library registration:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-lua" data-lang="lua"><span class="line"><span class="cl"><span class="cp">#!lua name=mylib</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hset</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">time</span> <span class="o">=</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HSET'</span><span class="p">,</span> <span class="n">hash</span><span class="p">,</span> <span class="s1">'_last_modified_'</span><span class="p">,</span> <span class="n">time</span><span class="p">,</span> <span class="n">unpack</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hset'</span><span class="p">,</span> <span class="n">my_hset</span><span class="p">)</span>
</span></span></code></pre>
</div>
<p>
If we create a new file named
<em>
mylib.lua
</em>
that consists of the library's definition, we can load it like so (without stripping the source code of helpful whitespaces):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">$ cat mylib.lua <span class="p">|</span> redis-cli -x FUNCTION LOAD REPLACE
</span></span></code></pre>
</div>
<p>
We've added the
<code>
REPLACE
</code>
modifier to the call to
<a href="/docs/latest/commands/function-load/">
<code>
FUNCTION LOAD
</code>
</a>
to tell Redis that we want to overwrite the existing library definition.
Otherwise, we would have gotten an error from Redis complaining that the library already exists.
</p>
<p>
Now that the library's updated code is loaded to Redis, we can proceed and call our function:
</p>
<pre tabindex="0"><code>redis> FCALL my_hset 1 myhash myfield "some value" another_field "another value"
(integer) 3
redis> HGETALL myhash
1) "_last_modified_"
2) "1640772721"
3) "myfield"
4) "some value"
5) "another_field"
6) "another value"
</code></pre>
<p>
In this case, we had invoked
<a href="/docs/latest/commands/fcall/">
<code>
FCALL
</code>
</a>
with
<em>
1
</em>
as the number of key name arguments.
That means that the function's first input argument is a name of a key (and is therefore included in the callback's
<code>
keys
</code>
table).
After that first argument, all following input arguments are considered regular arguments and constitute the
<code>
args
</code>
table passed to the callback as its second argument.
</p>
<h2 id="expanding-the-library">
Expanding the library
</h2>
<p>
We can add more functions to our library to benefit our application.
The additional metadata field we've added to the Hash shouldn't be included in responses when accessing the Hash's data.
On the other hand, we do want to provide the means to obtain the modification timestamp for a given Hash key.
</p>
<p>
We'll add two new functions to our library to accomplish these objectives:
</p>
<ol>
<li>
The
<code>
my_hgetall
</code>
Redis Function will return all fields and their respective values from a given Hash key name, excluding the metadata (i.e., the
<code>
_last_modified_
</code>
field).
</li>
<li>
The
<code>
my_hlastmodified
</code>
Redis Function will return the modification timestamp for a given Hash key name.
</li>
</ol>
<p>
The library's source code could look something like the following:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-lua" data-lang="lua"><span class="line"><span class="cl"><span class="cp">#!lua name=mylib</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hset</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">time</span> <span class="o">=</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HSET'</span><span class="p">,</span> <span class="n">hash</span><span class="p">,</span> <span class="s1">'_last_modified_'</span><span class="p">,</span> <span class="n">time</span><span class="p">,</span> <span class="n">unpack</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hgetall</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis.setresp</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">res</span> <span class="o">=</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HGETALL'</span><span class="p">,</span> <span class="n">hash</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">res</span><span class="p">[</span><span class="s1">'map'</span><span class="p">][</span><span class="s1">'_last_modified_'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">nil</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">res</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hlastmodified</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HGET'</span><span class="p">,</span> <span class="n">hash</span><span class="p">,</span> <span class="s1">'_last_modified_'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hset'</span><span class="p">,</span> <span class="n">my_hset</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hgetall'</span><span class="p">,</span> <span class="n">my_hgetall</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hlastmodified'</span><span class="p">,</span> <span class="n">my_hlastmodified</span><span class="p">)</span>
</span></span></code></pre>
</div>
<p>
While all of the above should be straightforward, note that the
<code>
my_hgetall
</code>
also calls
<a href="/docs/latest/develop/interact/programmability/lua-api#redis.setresp">
<code>
redis.setresp(3)
</code>
</a>
.
That means that the function expects
<a href="https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md">
RESP3
</a>
replies after calling
<code>
redis.call()
</code>
, which, unlike the default RESP2 protocol, provides dictionary (associative arrays) replies.
Doing so allows the function to delete (or set to
<code>
nil
</code>
as is the case with Lua tables) specific fields from the reply, and in our case, the
<code>
_last_modified_
</code>
field.
</p>
<p>
Assuming you've saved the library's implementation in the
<em>
mylib.lua
</em>
file, you can replace it with:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">$ cat mylib.lua <span class="p">|</span> redis-cli -x FUNCTION LOAD REPLACE
</span></span></code></pre>
</div>
<p>
Once loaded, you can call the library's functions with
<a href="/docs/latest/commands/fcall/">
<code>
FCALL
</code>
</a>
:
</p>
<pre tabindex="0"><code>redis> FCALL my_hgetall 1 myhash
1) "myfield"
2) "some value"
3) "another_field"
4) "another value"
redis> FCALL my_hlastmodified 1 myhash
"1640772721"
</code></pre>
<p>
You can also get the library's details with the
<a href="/docs/latest/commands/function-list/">
<code>
FUNCTION LIST
</code>
</a>
command:
</p>
<pre tabindex="0"><code>redis> FUNCTION LIST
1) 1) "library_name"
2) "mylib"
3) "engine"
4) "LUA"
5) "functions"
6) 1) 1) "name"
2) "my_hset"
3) "description"
4) (nil)
5) "flags"
6) (empty array)
2) 1) "name"
2) "my_hgetall"
3) "description"
4) (nil)
5) "flags"
6) (empty array)
3) 1) "name"
2) "my_hlastmodified"
3) "description"
4) (nil)
5) "flags"
6) (empty array)
</code></pre>
<p>
You can see that it is easy to update our library with new capabilities.
</p>
<h2 id="reusing-code-in-the-library">
Reusing code in the library
</h2>
<p>
On top of bundling functions together into database-managed software artifacts, libraries also facilitate code sharing.
We can add to our library an error handling helper function called from other functions.
The helper function
<code>
check_keys()
</code>
verifies that the input
<em>
keys
</em>
table has a single key.
Upon success it returns
<code>
nil
</code>
, otherwise it returns an
<a href="/docs/latest/develop/interact/programmability/lua-api#redis.error_reply">
error reply
</a>
.
</p>
<p>
The updated library's source code would be:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-lua" data-lang="lua"><span class="line"><span class="cl"><span class="cp">#!lua name=mylib</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">check_keys</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">error</span> <span class="o">=</span> <span class="kc">nil</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">nkeys</span> <span class="o">=</span> <span class="n">table.getn</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kr">if</span> <span class="n">nkeys</span> <span class="o">==</span> <span class="mi">0</span> <span class="kr">then</span>
</span></span><span class="line"><span class="cl"> <span class="n">error</span> <span class="o">=</span> <span class="s1">'Hash key name not provided'</span>
</span></span><span class="line"><span class="cl"> <span class="kr">elseif</span> <span class="n">nkeys</span> <span class="o">></span> <span class="mi">1</span> <span class="kr">then</span>
</span></span><span class="line"><span class="cl"> <span class="n">error</span> <span class="o">=</span> <span class="s1">'Only one key name is allowed'</span>
</span></span><span class="line"><span class="cl"> <span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kr">if</span> <span class="n">error</span> <span class="o">~=</span> <span class="kc">nil</span> <span class="kr">then</span>
</span></span><span class="line"><span class="cl"> <span class="n">redis.log</span><span class="p">(</span><span class="n">redis.LOG_WARNING</span><span class="p">,</span> <span class="n">error</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">redis.error_reply</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kr">end</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="kc">nil</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hset</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">error</span> <span class="o">=</span> <span class="n">check_keys</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kr">if</span> <span class="n">error</span> <span class="o">~=</span> <span class="kc">nil</span> <span class="kr">then</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">error</span>
</span></span><span class="line"><span class="cl"> <span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">time</span> <span class="o">=</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'TIME'</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HSET'</span><span class="p">,</span> <span class="n">hash</span><span class="p">,</span> <span class="s1">'_last_modified_'</span><span class="p">,</span> <span class="n">time</span><span class="p">,</span> <span class="n">unpack</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hgetall</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">error</span> <span class="o">=</span> <span class="n">check_keys</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kr">if</span> <span class="n">error</span> <span class="o">~=</span> <span class="kc">nil</span> <span class="kr">then</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">error</span>
</span></span><span class="line"><span class="cl"> <span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">redis.setresp</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">res</span> <span class="o">=</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HGETALL'</span><span class="p">,</span> <span class="n">hash</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">res</span><span class="p">[</span><span class="s1">'map'</span><span class="p">][</span><span class="s1">'_last_modified_'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">nil</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">res</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">local</span> <span class="kr">function</span> <span class="nf">my_hlastmodified</span><span class="p">(</span><span class="n">keys</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">error</span> <span class="o">=</span> <span class="n">check_keys</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="kr">if</span> <span class="n">error</span> <span class="o">~=</span> <span class="kc">nil</span> <span class="kr">then</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">error</span>
</span></span><span class="line"><span class="cl"> <span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">local</span> <span class="n">hash</span> <span class="o">=</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="kr">return</span> <span class="n">redis.call</span><span class="p">(</span><span class="s1">'HGET'</span><span class="p">,</span> <span class="n">keys</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="s1">'_last_modified_'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="kr">end</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hset'</span><span class="p">,</span> <span class="n">my_hset</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hgetall'</span><span class="p">,</span> <span class="n">my_hgetall</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hlastmodified'</span><span class="p">,</span> <span class="n">my_hlastmodified</span><span class="p">)</span>
</span></span></code></pre>
</div>
<p>
After you've replaced the library in Redis with the above, you can immediately try out the new error handling mechanism:
</p>
<pre tabindex="0"><code>127.0.0.1:6379> FCALL my_hset 0 myhash nope nope
(error) Hash key name not provided
127.0.0.1:6379> FCALL my_hgetall 2 myhash anotherone
(error) Only one key name is allowed
</code></pre>
<p>
And your Redis log file should have lines in it that are similar to:
</p>
<pre tabindex="0"><code>...
20075:M 1 Jan 2022 16:53:57.688 # Hash key name not provided
20075:M 1 Jan 2022 16:54:01.309 # Only one key name is allowed
</code></pre>
<h2 id="functions-in-cluster">
Functions in cluster
</h2>
<p>
As noted above, Redis automatically handles propagation of loaded functions to replicas.
In a Redis Cluster, it is also necessary to load functions to all cluster nodes. This is not handled automatically by Redis Cluster, and needs to be handled by the cluster administrator (like module loading, configuration setting, etc.).
</p>
<p>
As one of the goals of functions is to live separately from the client application, this should not be part of the Redis client library responsibilities. Instead,
<code>
redis-cli --cluster-only-masters --cluster call host:port FUNCTION LOAD ...
</code>
can be used to execute the load command on all master nodes.
</p>
<p>
Also, note that
<code>
redis-cli --cluster add-node
</code>
automatically takes care to propagate the loaded functions from one of the existing nodes to the new node.
</p>
<h2 id="functions-and-ephemeral-redis-instances">
Functions and ephemeral Redis instances
</h2>
<p>
In some cases there may be a need to start a fresh Redis server with a set of functions pre-loaded. Common reasons for that could be:
</p>
<ul>
<li>
Starting Redis in a new environment
</li>
<li>
Re-starting an ephemeral (cache-only) Redis, that uses functions
</li>
</ul>
<p>
In such cases, we need to make sure that the pre-loaded functions are available before Redis accepts inbound user connections and commands.
</p>
<p>
To do that, it is possible to use
<code>
redis-cli --functions-rdb
</code>
to extract the functions from an existing server. This generates an RDB file that can be loaded by Redis at startup.
</p>
<h2 id="function-flags">
Function flags
</h2>
<p>
Redis needs to have some information about how a function is going to behave when executed, in order to properly enforce resource usage policies and maintain data consistency.
</p>
<p>
For example, Redis needs to know that a certain function is read-only before permitting it to execute using
<a href="/docs/latest/commands/fcall_ro/">
<code>
FCALL_RO
</code>
</a>
on a read-only replica.
</p>
<p>
By default, Redis assumes that all functions may perform arbitrary read or write operations. Function Flags make it possible to declare more specific function behavior at the time of registration. Let's see how this works.
</p>
<p>
In our previous example, we defined two functions that only read data. We can try executing them using
<a href="/docs/latest/commands/fcall_ro/">
<code>
FCALL_RO
</code>
</a>
against a read-only replica.
</p>
<pre tabindex="0"><code>redis > FCALL_RO my_hgetall 1 myhash
(error) ERR Can not execute a function with write flag using fcall_ro.
</code></pre>
<p>
Redis returns this error because a function can, in theory, perform both read and write operations on the database.
As a safeguard and by default, Redis assumes that the function does both, so it blocks its execution.
The server will reply with this error in the following cases:
</p>
<ol>
<li>
Executing a function with
<a href="/docs/latest/commands/fcall/">
<code>
FCALL
</code>
</a>
against a read-only replica.
</li>
<li>
Using
<a href="/docs/latest/commands/fcall_ro/">
<code>
FCALL_RO
</code>
</a>
to execute a function.
</li>
<li>
A disk error was detected (Redis is unable to persist so it rejects writes).
</li>
</ol>
<p>
In these cases, you can add the
<code>
no-writes
</code>
flag to the function's registration, disable the safeguard and allow them to run.
To register a function with flags use the
<a href="/docs/latest/develop/interact/programmability/lua-api#redis.register_function_named_args">
named arguments
</a>
variant of
<code>
redis.register_function
</code>
.
</p>
<p>
The updated registration code snippet from the library looks like this:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-lua" data-lang="lua"><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">(</span><span class="s1">'my_hset'</span><span class="p">,</span> <span class="n">my_hset</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">function_name</span><span class="o">=</span><span class="s1">'my_hgetall'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">callback</span><span class="o">=</span><span class="n">my_hgetall</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">flags</span><span class="o">=</span><span class="p">{</span> <span class="s1">'no-writes'</span> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="n">redis.register_function</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">function_name</span><span class="o">=</span><span class="s1">'my_hlastmodified'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">callback</span><span class="o">=</span><span class="n">my_hlastmodified</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">flags</span><span class="o">=</span><span class="p">{</span> <span class="s1">'no-writes'</span> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<p>
Once we've replaced the library, Redis allows running both
<code>
my_hgetall
</code>
and
<code>
my_hlastmodified
</code>
with
<a href="/docs/latest/commands/fcall_ro/">
<code>
FCALL_RO
</code>
</a>
against a read-only replica:
</p>
<pre tabindex="0"><code>redis> FCALL_RO my_hgetall 1 myhash
1) "myfield"
2) "some value"
3) "another_field"
4) "another value"
redis> FCALL_RO my_hlastmodified 1 myhash
"1640772721"
</code></pre>
<p>
For the complete documentation flags, please refer to
<a href="/docs/latest/develop/interact/programmability/lua-api#script_flags">
Script flags
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/interact/programmability/functions-intro/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/integrate/redis-data-integration/release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Release notes
</h1>
<p>
Here's what changed recently in Redis Data Integration (RDI):
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Version (Release date)
</th>
<th style="text-align:left">
Major changes
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<a href="/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-4-2/">
1.4.2 (November 2024)
</a>
</td>
<td style="text-align:left">
Installation on Kubernetes with a Helm chart. Improvements for installation on VMs.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-4-1/">
1.4.1 (November 2024)
</a>
</td>
<td style="text-align:left">
Installation on Kubernetes with a Helm chart. Improvements for installation on VMs.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-4-0/">
1.4.0 (October 2024)
</a>
</td>
<td style="text-align:left">
Installation on Kubernetes with a Helm chart. Improvements for installation on VMs.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-2-8/">
1.2.8 (August 2024)
</a>
</td>
<td style="text-align:left">
API server with a set of APIs to support Redis Insight with creating, testing, deploying & monitoring RDI pipelines. RDI Installer verifies all components are running at the end of installation.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-2/">
1.2 (June 2024)
</a>
</td>
<td style="text-align:left">
API server with a set of APIs to support Redis Insight with creating, testing, deploying & monitoring RDI pipelines. RDI Installer verifies all components are running at the end of installation.
</td>
</tr>
<tr>
<td style="text-align:left">
<a href="/docs/latest/integrate/redis-data-integration/release-notes/rdi-1-0/">
1.0 (June 2024)
</a>
</td>
<td style="text-align:left">
Changes to the processing mode. Simple installation. Silent installation. Pipeline orchestration. Logging. Monitoring. High availability mechanism.
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/integrate/redis-data-integration/release-notes/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/security/access-control/manage-users/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Manage user security
</h1>
<p class="text-lg -mt-5 mb-10">
Manage user account security settings.
</p>
<p>
Redis Enterprise supports the following user account security settings:
</p>
<ul>
<li>
Password complexity
</li>
<li>
Password expiration
</li>
<li>
User lockouts
</li>
<li>
Account inactivity timeout
</li>
</ul>
<h2 id="manage-users-and-user-security">
Manage users and user security
</h2>
<nav>
<a href="/docs/latest/operate/rs/7.4/security/access-control/manage-users/login-lockout/">
Manage user login
</a>
<p>
Manage user login lockout and session timeout.
</p>
<a href="/docs/latest/operate/rs/7.4/security/access-control/manage-users/default-user/">
Manage default user
</a>
<p>
Manage a database's default user.
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/security/access-control/manage-users/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/.html | <section class="prose w-full py-12 max-w-none">
<h1>
<svg class="stack-logo-inline" fill="none" viewbox="0 0 39 31">
<title>
This capability is a part of Redis Stack
</title>
<path d="M21.7371 15.2903C21.5759 15.2895 21.4198 15.2337 21.2947 15.1321 21.1695 15.0305 21.0828 14.8892 21.049 14.7316S21.0362 14.4096 21.1086 14.2655C21.1811 14.1215 21.3005 14.0066 21.4472 13.9397L35.7199 7.47338 21.4578 1.34289C21.2943 1.26329 21.1678 1.12377 21.1045.953307 21.0412.78285 21.046.594558 21.1179.427547 21.1898.260535 21.3233.127641 21.4906.0564719 21.6579-.0146977 21.8462-.0186728 22.0164.045373L37.7492 6.80518C37.8747 6.8605 37.9814 6.95112 38.0563 7.06599S38.171 7.31503 38.171 7.45216 38.1312 7.72347 38.0563 7.83834C37.9814 7.95321 37.8747 8.04383 37.7492 8.09915L22.0306 15.2266C21.9388 15.2698 21.8385 15.2916 21.7371 15.2903z" fill="#db2e2e">
</path>
<path d="M16.4339 15.2903C16.3379 15.2906 16.2429 15.2714 16.1546 15.2337L.421813 8.47393C.296339 8.41861.18966 8.32799.114767 8.21312.0398745 8.09825.0 7.96407.0 7.82694.0 7.68981.0398745 7.55564.114767 7.44077.18966 7.3259.296339 7.23528.421813 7.17995L16.1546.052465C16.3235-.0111265 16.5104-.00772359 16.6768.0619772 16.8433.131678 16.9768.2624 17.0501.427363 17.1233.592325 17.1306.779042 17.0706.949259 17.0106 1.11948 16.8878 1.26031 16.7274 1.34291L2.44763 7.80573 16.7132 13.9362C16.8612 14.0015 16.9823 14.1154 17.0565 14.2592 17.1306 14.4029 17.1532 14.5677 17.1205 14.7261 17.0878 14.8845 17.0019 15.0269 16.8769 15.1295 16.752 15.2322 16.5956 15.2889 16.4339 15.2903z" fill="#db2e2e">
</path>
<path clip-rule="evenodd" d="M29.1651 17.4328c3.1288-1.2763 6.2047-2.5279 7.1875-3.0617L37.1163 13.9539C37.3908 13.8108 37.6564 13.6514 37.9118 13.4766 37.972 13.8833 37.972 14.2967 37.9118 14.7034 37.8022 15.1312 37.4875 15.4847 36.289 16.061 35.4617 16.4605 33.1531 17.408 30.5792 18.4687c-3.6167 1.4884-7.778 3.1819-9.0826 3.889C19.2587 23.4183 18.0284 23.4183 16.3137 22.644 15.4864 22.2021 12.4918 20.9117 9.39476 19.5611c-3.3198-1.446-6.75627-2.945-7.77802-3.4753C.22377 15.3575.153061 15.1948.160132 14.8271V13.8655L.513678 14.0564c1.311652.6647 7.219412 3.1819 11.486722 5.0204 2.1142.898 3.8112 1.6298 4.3769 1.8844C18.092 21.7319 19.3082 21.8733 21.5603 20.6748 22.7022 20.0808 25.9619 18.7409 29.1651 17.4328z" fill="#494c4d" fill-rule="evenodd">
</path>
<path clip-rule="evenodd" d="M29.1651 24.5037c3.1288-1.2763 6.2047-2.5279 7.1875-3.0617L37.1163 21.0248C37.3908 20.8817 37.6564 20.7223 37.9118 20.5475 37.972 20.9542 37.972 21.3676 37.9118 21.7743 37.8022 22.2021 37.4875 22.5557 36.289 23.1319 35.4617 23.5314 33.1531 24.4789 30.5792 25.5396c-3.6167 1.4884-7.778 3.1819-9.0826 3.889-2.2379 1.0606-3.4682 1.0606-5.1829.2864C15.4864 29.2801 12.4918 27.9755 9.39476 26.625c-3.3198-1.446-6.75627-2.9451-7.77802-3.4754C.22377 22.4213.153061 22.2587.160132 21.891V20.9364L.513678 21.1273C1.82533 21.792 7.73309 24.3092 12.0004 26.1477c2.1001.898 3.8006 1.6298 4.3663 1.8844C18.0814 28.8028 19.2976 28.9442 21.5497 27.7457 22.7022 27.1518 25.9619 25.8118 29.1651 24.5037z" fill="#494c4d" fill-rule="evenodd">
</path>
</svg>
Triggers and functions
</h1>
<p class="text-lg -mt-5 mb-10">
Trigger and execute JavaScript functions in the Redis process
</p>
<div class="banner-article rounded-md">
<p>
The Redis Stack triggers and functions feature preview has ended and it will not be promoted to GA.
</p>
</div>
<p>
<a href="https://discord.gg/xTbqgTB">
<img alt="discord" src="https://img.shields.io/discord/697882427875393627?style=flat-square"/>
</a>
<a href="https://github.com/RedisGears/RedisGears/">
<img alt="Github" src="https://img.shields.io/static/v1?label=&message=repository&color=5961FF&logo=github"/>
</a>
</p>
<p>
The triggers and functions feature of Redis Stack allows running JavaScript functions inside Redis. These functions can be executed on-demand, by an event-driven trigger, or by a stream processing trigger.
</p>
<h2 id="quick-links">
Quick links
</h2>
<ul>
<li>
<a href="https://github.com/RedisGears/RedisGears/tree/master/docs/commands">
Command documentation
</a>
</li>
<li>
<a href="https://github.com/RedisGears/RedisGears">
Source code
</a>
</li>
<li>
<a href="https://github.com/RedisGears/RedisGears/releases">
Latest release
</a>
</li>
<li>
<a href="https://hub.docker.com/r/redis/redis-stack-server/">
Docker image
</a>
</li>
</ul>
<h2 id="primary-features">
Primary features
</h2>
<ul>
<li>
JavaScript engine for functions
</li>
<li>
On-demand functions
</li>
<li>
Keyspace triggers
</li>
<li>
Stream triggers
</li>
<li>
Async handling of functions
</li>
<li>
Read data from across the cluster
</li>
</ul>
<h2 id="cluster-support">
Cluster support
</h2>
<p>
Triggers and functions support deployment and execution of functions across a cluster. Functions are executed on the correct shard based on the key that is changed or read functions can be executed on all to return a correct view of the data.
</p>
<h2 id="references">
References
</h2>
<h3 id="blog-posts">
Blog posts
</h3>
<ul>
<li>
<a href="https://redis.com/blog/database-trigger-features/">
Expanding the Database Trigger Features in Redis
</a>
</li>
</ul>
<h2 id="overview">
Overview
</h2>
<nav>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/quick_start_ri/">
Quick start using Redis Insight
</a>
<p>
Get started with triggers and functions using Redis Insight
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/quick_start_cli/">
Quick start using redis-cli
</a>
<p>
Get started with triggers and functions using redis-cli
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/configuration/">
Configuration
</a>
<p>
Configure the operation parameters
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/development/">
Development
</a>
<p>
How to develop for triggers and functions
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/debugging/">
Debugging
</a>
<p>
Methods for debugging your Redis Stack functions
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/concepts/">
Concepts
</a>
<p>
Details about triggers, the JavaScript API, and advanced concepts
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/examples/">
Triggers and functions examples
</a>
<p>
How triggers and functions can be used
</p>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/known_limitations/">
Known limitations
</a>
<p>
Overview of the known limitations
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/auto-tiering/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Auto Tiering
</h1>
<p class="text-lg -mt-5 mb-10">
Auto Tiering enables your data to span both RAM and dedicated flash memory.
</p>
<p>
Redis Enterprise's auto tiering offers users the unique ability to use solid state drives (SSDs) to extend databases beyond DRAM capacity.
Developers can build applications that require large datasets using the same Redis API.
Using SSDs can significantly reduce the infrastructure costs compared to only DRAM deployments.
</p>
<p>
Frequently used data, called hot data, belongs in the fastest memory level to deliver a real-time user experience.
Data that is accessed less frequently, called warm data, can be kept in a slightly slower memory tier.
Redis Enterprise’s Auto tiering maintains hot data in DRAM, keeps warm data in SSDs, and transfers data between tiers automatically.
</p>
<p>
Redis Enterprise’s auto tiering is based on a high-performance storage engine (Speedb) that manages the complexity of using SSDs and DRAM as the total available memory for databases in a Redis Enterprise cluster. This implementation offers a performance boost of up to 10k operations per second per core of the database, doubling the performance of Redis on Flash.
</p>
<p>
Just like all-RAM databases, databases with Auto Tiering enabled are compatible with existing Redis applications.
</p>
<p>
Auto Tiering is also supported on
<a href="/docs/latest/operate/rc/">
Redis Cloud
</a>
and
<a href="/docs/latest/operate/rs/7.4/">
Redis Enterprise Software for Kubernetes
</a>
.
</p>
<h2 id="use-cases">
Use cases
</h2>
<p>
The benefits associated with Auto Tiering are dependent on the use case.
</p>
<p>
Auto Tiering is ideal when your:
</p>
<ul>
<li>
working set is significantly smaller than your dataset (high RAM hit rate)
</li>
<li>
average key size is smaller than average value size (all key names are stored in RAM)
</li>
<li>
most recent data is the most frequently used (high RAM hit rate)
</li>
</ul>
<p>
Auto Tiering is not recommended for:
</p>
<ul>
<li>
Long key names (all key names are stored in RAM)
</li>
<li>
Broad access patterns (any value could be pulled into RAM)
</li>
<li>
Large working sets (working set is stored in RAM)
</li>
<li>
Frequently moved data (moving to and from RAM too often can impact performance)
</li>
</ul>
<p>
Auto Tiering is not intended to be used for persistent storage. Redis Enterprise Software database persistent and ephemeral storage should be on different disks, either local or attached.
</p>
<h2 id="where-is-my-data">
Where is my data?
</h2>
<p>
When using Auto Tiering, RAM storage holds:
</p>
<ul>
<li>
All keys (names)
</li>
<li>
Key indexes
</li>
<li>
Dictionaries
</li>
<li>
Hot data (working set)
</li>
</ul>
<p>
All data is accessed through RAM. If a value in flash memory is accessed, it becomes part of the working set and is moved to RAM. These values are referred to as “hot data”.
</p>
<p>
Inactive or infrequently accessed data is referred to as “warm data” and stored in flash memory. When more space is needed in RAM, warm data is moved from RAM to flash storage.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
When using Auto Tiering with RediSearch, it’s important to note that RediSearch indexes are also stored in RAM.
</div>
</div>
<h2 id="ram-to-flash-ratio">
RAM to Flash ratio
</h2>
<p>
Redis Enterprise Software allows you to configure and tune the ratio of RAM-to-Flash for each database independently, optimizing performance for your specific use case.
While this is an online operation requiring no downtime for your database, it is recommended to perform it during maintenance windows as data might move between tiers (RAM <-> Flash).
</p>
<p>
The RAM limit cannot be smaller than 10% of the total memory. We recommend you keep at least 20% of all values in RAM. Do not set the RAM limit to 100%.
</p>
<h2 id="flash-memory">
Flash memory
</h2>
<p>
Implementing Auto Tiering requires pre planning around memory and sizing. Considerations and requirements for Auto Tiering include:
</p>
<ul>
<li>
Flash memory must be locally attached (as opposed to network attached storage (NAS) and storage area networks (SAN)).
</li>
<li>
Flash memory must be dedicated to Auto Tiering and not shared with other parts of the database, such as durability, binaries, or persistence.
</li>
<li>
For the best performance, the SSDs should be NVMe based, but SATA can also be used.
</li>
<li>
The available flash space must be greater than or equal to the total database size (RAM+Flash). The extra space accounts for write buffers and
<a href="https://en.wikipedia.org/wiki/Write_amplification">
write amplification
</a>
.
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
The Redis Enterprise Software database persistent and ephemeral storage should be on different disks, either local or attached.
</div>
</div>
<p>
Once these requirements are met, you can create and manage both databases with Auto Tiering enabled and
all-RAM databases in the same cluster.
</p>
<p>
When you begin planning the deployment of an Auto Tiering enabled database in production,
we recommend working closely with the Redis technical team for sizing and performance tuning.
</p>
<h3 id="cloud-environments">
Cloud environments
</h3>
<p>
When running in a cloud environment:
</p>
<ul>
<li>
Flash memory is on the ephemeral SSDs of the cloud instance (for example the local NVMe of AWS i4i instnaces and Azure Lsv2 and Lsv3 series).
</li>
<li>
Persistent database storage needs to be network attached (for example, AWS EBS for AWS).
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
We specifically recommend "
<a href="https://aws.amazon.com/ec2/instance-types/#storage-optimized">
Storage Optimized I4i - High I/O Instances
</a>
" because of the performance of NVMe for flash memory.
</div>
</div>
<h3 id="on-premises-environments">
On-premises environments
</h3>
<p>
When you begin planning the deployment of Auto Tiering in production, we recommend working closely with the Redis technical team for sizing and performance tuning.
</p>
<p>
On-premises environments support more deployment options than other environments such as:
</p>
<ul>
<li>
Using Redis Stack features:
<ul>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/search/">
Search and query
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/json/">
JSON
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/">
Time series
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/bloom/">
Probabilistic data structures
</a>
</li>
</ul>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Enabling Auto Tiering for Active-Active distributed databases requires validating and getting the Redis technical team's approval first .
</div>
</div>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
Auto Tiering is not supported running on network attached storage (NAS), storage area network (SAN), or with local HDD drives.
</div>
</div>
<h2 id="next-steps">
Next steps
</h2>
<ul>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/metrics/auto-tiering/">
Auto Tiering metrics
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/databases/auto-tiering/quickstart/">
Auto Tiering quick start
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
Ephemeral and persistent storage
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements/">
Hardware requirements
</a>
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/auto-tiering/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/create/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Create a Redis Enterprise Software database
</h1>
<p class="text-lg -mt-5 mb-10">
Create a database with Redis Enterprise Software.
</p>
<p>
Redis Enterprise Software lets you create databases and distribute them across a cluster of nodes.
</p>
<p>
To create a new database:
</p>
<ol>
<li>
<p>
Sign in to the Cluster Manager UI at
<code>
https://<hostname>:8443
</code>
</p>
</li>
<li>
<p>
Use one of the following methods to create a new database:
</p>
<ul>
<li>
<p>
<a href="#quick-database">
Quick database
</a>
</p>
</li>
<li>
<p>
<a href="#create-database">
Create database
</a>
with additional configuration
</p>
</li>
</ul>
</li>
<li>
<p>
If you did not specify a port number for the database, you can find the port number in the
<strong>
Endpoint
</strong>
field in the
<strong>
Databases > Configuration > General
</strong>
section.
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/databases/connect/test-client-connectivity/">
Test client connectivity
</a>
.
</p>
</li>
</ol>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
For databases with Active-Active replication for geo-distributed locations,
see
<a href="/docs/latest/operate/rs/7.4/databases/active-active/create/">
Create an Active-Active database
</a>
. To create and manage Active-Active databases, use the legacy UI.
</div>
</div>
<h2 id="quick-database">
Quick database
</h2>
<p>
To quickly create a database and skip additional configuration options during initial creation:
</p>
<ol>
<li>
<p>
On the
<strong>
Databases
</strong>
screen, select
<strong>
Quick database
</strong>
.
</p>
</li>
<li>
<p>
Select a Redis version from the
<strong>
Database version
</strong>
list.
</p>
</li>
<li>
<p>
Configure settings that are required for database creation but can be changed later:
</p>
<ul>
<li>
<p>
Database name
</p>
</li>
<li>
<p>
Memory limit (GB)
</p>
</li>
</ul>
</li>
<li>
<p>
Configure optional settings that can't be changed after database creation:
</p>
<ul>
<li>
<p>
Endpoint port (set by the cluster if not set manually)
</p>
</li>
<li>
<p>
Capabilities (previously modules) to enable
</p>
</li>
</ul>
</li>
<li>
<p>
Optionally select
<strong>
Full options
</strong>
to configure
<a href="/docs/latest/operate/rs/7.4/databases/configure/#config-settings">
additional settings
</a>
.
</p>
</li>
<li>
<p>
Select
<strong>
Create
</strong>
.
</p>
</li>
</ol>
<h2 id="create-database">
Create database
</h2>
<p>
To create a new database and configure additional settings:
</p>
<ol>
<li>
<p>
Open the
<strong>
Create database
</strong>
menu with one of the following methods:
</p>
<ul>
<li>
<p>
Click the
<strong>
+
</strong>
button next to
<strong>
Databases
</strong>
in the navigation menu:
</p>
<a href="/docs/latest/images/rs/screenshots/databases/create-db-plus-drop-down.png" sdata-lightbox="/images/rs/screenshots/databases/create-db-plus-drop-down.png">
<img alt="Create database menu has two options: Single Region and Active-Active database." src="/docs/latest/images/rs/screenshots/databases/create-db-plus-drop-down.png" width="350px"/>
</a>
</li>
<li>
<p>
Go to the
<strong>
Databases
</strong>
screen and select
<strong>
Create database
</strong>
:
</p>
<a href="/docs/latest/images/rs/screenshots/databases/create-db-button-drop-down.png" sdata-lightbox="/images/rs/screenshots/databases/create-db-button-drop-down.png">
<img alt="Create database menu has two options: Single Region and Active-Active database." src="/docs/latest/images/rs/screenshots/databases/create-db-button-drop-down.png" width="350px"/>
</a>
</li>
</ul>
</li>
<li>
<p>
Select the database type:
</p>
<ul>
<li>
<p>
<strong>
Single Region
</strong>
</p>
</li>
<li>
<p>
<strong>
Active-Active database
</strong>
- Multiple participating Redis Enterprise clusters can host instances of the same
<a href="/docs/latest/operate/rs/7.4/databases/active-active/">
Active-Active database
</a>
in different geographic locations. Every instance can receive write operations, which are synchronized across all instances without conflict.
</p>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
For Active-Active databases, see
<a href="/docs/latest/operate/rs/7.4/databases/active-active/create/">
Create an Active-Active geo-replicated database
</a>
.
</div>
</div>
</li>
<li>
<p>
Select a Redis version from the
<strong>
Database version
</strong>
list.
</p>
</li>
<li>
<p>
Enter a
<strong>
Database name
</strong>
.
</p>
<ul>
<li>
<p>
Maximum of 63 characters
</p>
</li>
<li>
<p>
Only letters, numbers, or hyphens (-) are valid characters
</p>
</li>
<li>
<p>
Must start and end with a letter or digit
</p>
</li>
<li>
<p>
Case-sensitive
</p>
</li>
</ul>
</li>
<li>
<p>
To configure additional database settings, expand each relevant section to make changes.
</p>
<p>
See
<a href="/docs/latest/operate/rs/7.4/databases/configure/#config-settings">
Configuration settings
</a>
for more information about each setting.
</p>
</li>
<li>
<p>
Select
<strong>
Create
</strong>
.
</p>
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/create/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cluster-delslots/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLUSTER DELSLOTS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLUSTER DELSLOTS slot [slot ...]</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
3.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N) where N is the total number of hash slot arguments
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@admin
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@dangerous
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
In Redis Cluster, each node keeps track of which master is serving
a particular hash slot.
</p>
<p>
The
<code>
CLUSTER DELSLOTS
</code>
command asks a particular Redis Cluster node to
forget which master is serving the hash slots specified as arguments.
</p>
<p>
In the context of a node that has received a
<code>
CLUSTER DELSLOTS
</code>
command and
has consequently removed the associations for the passed hash slots,
we say those hash slots are
<em>
unbound
</em>
. Note that the existence of
unbound hash slots occurs naturally when a node has not been
configured to handle them (something that can be done with the
<a href="/docs/latest/commands/cluster-addslots/">
<code>
CLUSTER ADDSLOTS
</code>
</a>
command) and if it has not received any information about
who owns those hash slots (something that it can learn from heartbeat
or update messages).
</p>
<p>
If a node with unbound hash slots receives a heartbeat packet from
another node that claims to be the owner of some of those hash
slots, the association is established instantly. Moreover, if a
heartbeat or update message is received with a configuration epoch
greater than the node's own, the association is re-established.
</p>
<p>
However, note that:
</p>
<ol>
<li>
The command only works if all the specified slots are already
associated with some node.
</li>
<li>
The command fails if the same slot is specified multiple times.
</li>
<li>
As a side effect of the command execution, the node may go into
<em>
down
</em>
state because not all hash slots are covered.
</li>
</ol>
<h2 id="example">
Example
</h2>
<p>
The following command removes the association for slots 5000 and
5001 from the node receiving the command:
</p>
<pre><code>> CLUSTER DELSLOTS 5000 5001
OK
</code></pre>
<h2 id="usage-in-redis-cluster">
Usage in Redis Cluster
</h2>
<p>
This command only works in cluster mode and may be useful for
debugging and in order to manually orchestrate a cluster configuration
when a new cluster is created. It is currently not used by
<code>
redis-cli
</code>
,
and mainly exists for API completeness.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
if the command was successful. Otherwise an error is returned.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cluster-delslots/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/configure/db-defaults/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure database defaults
</h1>
<p class="text-lg -mt-5 mb-10">
Cluster-wide policies that determine default settings when creating new databases.
</p>
<p>
Database defaults are cluster-wide policies that determine default settings when creating new databases.
</p>
<h2 id="edit-database-defaults">
Edit database defaults
</h2>
<p>
To edit default database configuration using the Cluster Manager UI:
</p>
<ol>
<li>
<p>
On the
<strong>
Databases
</strong>
screen, select
<a href="/docs/latest/images/rs/buttons/button-toggle-actions-vertical.png#no-click" sdata-lightbox="/images/rs/buttons/button-toggle-actions-vertical.png#no-click">
<img alt="Toggle actions button" class="inline" src="/docs/latest/images/rs/buttons/button-toggle-actions-vertical.png#no-click" width="22px"/>
</a>
to open a list of additional actions.
</p>
</li>
<li>
<p>
Select
<strong>
Database defaults
</strong>
.
</p>
</li>
<li>
<p>
Configure
<a href="#db-defaults">
database defaults
</a>
.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/db-defaults.png" sdata-lightbox="/images/rs/screenshots/databases/db-defaults.png">
<img alt="Database defaults configuration panel." src="/docs/latest/images/rs/screenshots/databases/db-defaults.png"/>
</a>
</li>
<li>
<p>
Select
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<h2 id="db-defaults">
Database defaults
</h2>
<h3 id="endpoint-configuration">
Endpoint configuration
</h3>
<p>
You can choose a predefined endpoint configuration to use the recommended database proxy and shards placement policies for your use case. If you want to set these policies manually instead, select
<strong>
Custom
</strong>
endpoint configuration.
</p>
<table>
<thead>
<tr>
<th>
Endpoint configuration
</th>
<th>
Database proxy
</th>
<th>
Shards placement
</th>
<th>
Description
</th>
<th>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Enterprise clustering
</td>
<td>
Single
</td>
<td>
Dense
</td>
<td>
Sets up a single endpoint that uses DNS to automatically reflect IP address updates after failover or topology changes.
</td>
<td>
</td>
</tr>
<tr>
<td>
Using a load balancer
</td>
<td>
All nodes
</td>
<td>
Sparse
</td>
<td>
Configure Redis with a load balancer like HAProxy or Nginx for environments without DNS.
</td>
<td>
</td>
</tr>
<tr>
<td>
Multiple endpoints
</td>
<td>
All primary shards
</td>
<td>
Sparse
</td>
<td>
To set up multiple endpoints, enable
<strong>
OSS Cluster API
</strong>
in the database settings and ensure client support. Clients initially connect to the primary node to retrieve the cluster topology, which allows direct connections to individual Redis proxies on each node.
</td>
<td>
</td>
</tr>
<tr>
<td>
Custom
</td>
<td>
Single, all primary shards, or all nodes
</td>
<td>
Dense or sparse
</td>
<td>
Manually choose default database proxy and shards placement policies.
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h3 id="database-proxy">
Database proxy
</h3>
<p>
Redis Enterprise Software uses
<a href="/docs/latest/operate/rs/7.4/references/terminology/#proxy">
proxies
</a>
to manage and optimize access to database shards. Each node in the cluster runs a single proxy process, which can be active (receives incoming traffic) or passive (waits for failovers).
</p>
<p>
You can configure default
<a href="/docs/latest/operate/rs/7.4/databases/configure/proxy-policy/">
proxy policies
</a>
to determine which nodes' proxies are active and bound to new databases by default.
</p>
<p>
To configure the default database proxy policy using the Cluster Manager UI:
</p>
<ol>
<li>
<p>
<a href="#edit-database-defaults">
<strong>
Edit database defaults
</strong>
</a>
.
</p>
</li>
<li>
<p>
Select a predefined
<a href="#endpoint-configuration">
<strong>
Endpoint Configuration
</strong>
</a>
to use a recommended database proxy policy, or choose
<strong>
Custom
</strong>
to set the policy manually. Changing the database proxy default in the Cluster Manager UI affects both sharded and non-sharded proxy policies.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/db-defaults-endpoint-config-custom.png" sdata-lightbox="/images/rs/screenshots/databases/db-defaults-endpoint-config-custom.png">
<img alt="The Database defaults panel lets you select Database proxy and Shards placement if Endpoint Configuration is set to Custom." src="/docs/latest/images/rs/screenshots/databases/db-defaults-endpoint-config-custom.png"/>
</a>
</li>
</ol>
<h4 id="non-sharded-proxy-policy">
Non-sharded proxy policy
</h4>
<p>
To configure the default proxy policy for non-sharded databases, use one of the following methods:
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/tune/#tune-cluster">
rladmin tune cluster
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster default_non_sharded_proxy_policy <span class="o">{</span> single <span class="p">|</span> all-master-shards <span class="p">|</span> all-nodes <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/policy/#put-cluster-policy">
Update cluster policy
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/cluster/policy
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"default_non_sharded_proxy_policy"</span>: <span class="s2">"single | all-master-shards | all-nodes"</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<h4 id="sharded-proxy-policy">
Sharded proxy policy
</h4>
<p>
To configure the default proxy policy for sharded databases, use one of the following methods:
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/tune/#tune-cluster">
rladmin tune cluster
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster default_sharded_proxy_policy <span class="o">{</span> single <span class="p">|</span> all-master-shards <span class="p">|</span> all-nodes <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/policy/#put-cluster-policy">
Update cluster policy
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/cluster/policy
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"default_sharded_proxy_policy"</span>: <span class="s2">"single | all-master-shards | all-nodes"</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<h3 id="shards-placement">
Shards placement
</h3>
<p>
The default
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/shard-placement-policy/">
shard placement policy
</a>
determines the distribution of database shards across nodes in the cluster.
</p>
<p>
Shard placement policies include:
</p>
<ul>
<li>
<p>
<code>
dense
</code>
: places shards on the smallest number of nodes.
</p>
</li>
<li>
<p>
<code>
sparse
</code>
: spreads shards across many nodes.
</p>
</li>
</ul>
<p>
To configure default shard placement, use one of the following methods:
</p>
<ul>
<li>
<p>
Cluster Manager UI:
</p>
<ol>
<li>
<p>
<a href="#edit-database-defaults">
<strong>
Edit database defaults
</strong>
</a>
.
</p>
</li>
<li>
<p>
Select a predefined
<a href="#endpoint-configuration">
<strong>
Endpoint Configuration
</strong>
</a>
to use a recommended shards placement policy, or choose
<strong>
Custom
</strong>
to set the policy manually.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/db-defaults-endpoint-config-custom.png" sdata-lightbox="/images/rs/screenshots/databases/db-defaults-endpoint-config-custom.png">
<img alt="The Database defaults panel lets you select Database proxy and Shards placement if Endpoint Configuration is set to Custom." src="/docs/latest/images/rs/screenshots/databases/db-defaults-endpoint-config-custom.png"/>
</a>
</li>
</ol>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/tune/#tune-cluster">
rladmin tune cluster
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster default_shards_placement <span class="o">{</span> dense <span class="p">|</span> sparse <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/policy/#put-cluster-policy">
Update cluster policy
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/cluster/policy
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"default_shards_placement"</span>: <span class="s2">"dense | sparse"</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<h3 id="database-version">
Database version
</h3>
<p>
New databases use the default Redis database version unless you select a different
<strong>
Database version
</strong>
when you
<a href="/docs/latest/operate/rs/7.4/databases/create/">
create a database
</a>
in the Cluster Manager UI or specify the
<code>
redis_version
</code>
in a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/">
create database REST API request
</a>
.
</p>
<p>
To configure the Redis database version, use one of the following methods:
</p>
<ul>
<li>
<p>
Cluster Manager UI: Edit
<strong>
Database version
</strong>
in
<a href="#edit-database-defaults">
<strong>
Database defaults
</strong>
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/tune/#tune-cluster">
rladmin tune cluster
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster default_redis_version <x.y>
</span></span></code></pre>
</div>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/policy/#put-cluster-policy">
Update cluster policy
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/cluster/policy
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"default_provisioned_redis_version"</span>: <span class="s2">"x.y"</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<h3 id="internode-encryption">
Internode encryption
</h3>
<p>
Enable
<a href="/docs/latest/operate/rs/7.4/security/encryption/internode-encryption/">
internode encryption
</a>
to encrypt data in transit between nodes for new databases by default.
</p>
<p>
To enable or turn off internode encryption by default, use one of the following methods:
</p>
<ul>
<li>
<p>
Cluster Manager UI: Edit
<strong>
Internode Encryption
</strong>
in
<a href="#edit-database-defaults">
<strong>
Database defaults
</strong>
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/tune/#tune-cluster">
rladmin tune cluster
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster data_internode_encryption <span class="o">{</span> enabled <span class="p">|</span> disabled <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/cluster/policy/#put-cluster-policy">
Update cluster policy
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/cluster/policy
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"data_internode_encryption"</span>: <boolean> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/configure/db-defaults/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/hincrby/.html | <section class="prose w-full py-12">
<h1 class="command-name">
HINCRBY
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">HINCRBY key field increment</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
2.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@hash
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Increments the number stored at
<code>
field
</code>
in the hash stored at
<code>
key
</code>
by
<code>
increment
</code>
.
If
<code>
key
</code>
does not exist, a new key holding a hash is created.
If
<code>
field
</code>
does not exist the value is set to
<code>
0
</code>
before the operation is
performed.
</p>
<p>
The range of values supported by
<code>
HINCRBY
</code>
is limited to 64 bit signed integers.
</p>
<h2 id="examples">
Examples
</h2>
<p>
Since the
<code>
increment
</code>
argument is signed, both increment and decrement
operations can be performed:
</p>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> HSET myhash field 5
(integer) 1
redis> HINCRBY myhash field 1
(integer) 6
redis> HINCRBY myhash field -1
(integer) 5
redis> HINCRBY myhash field -10
(integer) -5
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the value of the field after the increment operation.
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/hincrby/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/ft.sugdel.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.SUGDEL
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.SUGDEL key string
</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/interact/search-and-query">
Search 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Delete a string from a suggestion index
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is suggestion dictionary key.
</p>
</details>
<details open="">
<summary>
<code>
string
</code>
</summary>
<p>
is suggestion string to index.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.SUGDEL returns an integer reply, 1 if the string was found and deleted, 0 otherwise.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Delete a string from a suggestion index
</b>
</summary>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">127.0.0.1:6379> FT.SUGDEL sug <span class="s2">"hello"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">127.0.0.1:6379> FT.SUGDEL sug <span class="s2">"hello"</span>
</span></span><span class="line"><span class="cl"><span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.sugget/">
<code>
FT.SUGGET
</code>
</a>
|
<a href="/docs/latest/commands/ft.sugadd/">
<code>
FT.SUGADD
</code>
</a>
|
<a href="/docs/latest/commands/ft.suglen/">
<code>
FT.SUGLEN
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<p>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</p>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/ft.sugdel/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cf.info/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CF.INFO
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CF.INFO key</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/probabilistic">
Bloom 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Returns information about a cuckoo filter.
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is key name for a cuckoo filter.
</p>
</details>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
with argument name (
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
) and value (
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
) pairs
</li>
<li>
[] on error (invalid arguments, key does not exist, wrong key type, and so on)
</li>
</ul>
<h2 id="examples">
Examples
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> CF.INFO cf
</span></span><span class="line"><span class="cl"> 1<span class="o">)</span> Size
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1080</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> Number of buckets
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">512</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> Number of filter
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> Number of items inserted
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> Number of items deleted
</span></span><span class="line"><span class="cl">10<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">0</span>
</span></span><span class="line"><span class="cl">11<span class="o">)</span> Bucket size
</span></span><span class="line"><span class="cl">12<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">2</span>
</span></span><span class="line"><span class="cl">13<span class="o">)</span> Expansion rate
</span></span><span class="line"><span class="cl">14<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">1</span>
</span></span><span class="line"><span class="cl">15<span class="o">)</span> Max iteration
</span></span><span class="line"><span class="cl">16<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">20</span></span></span></code></pre>
</div>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cf.info/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/connect/troubleshooting-guide/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Troubleshooting pocket guide for Redis Enterprise Software
</h1>
<p class="text-lg -mt-5 mb-10">
Troubleshoot issues with Redis Enterprise Software, including connectivity issues between the database and clients or applications.
</p>
<p>
If your client or application cannot connect to your database, verify the following.
</p>
<h2 id="identify-redis-host-issues">
Identify Redis host issues
</h2>
<h4 id="check-resource-usage">
Check resource usage
</h4>
<ul>
<li>
<p>
Used disk space should be less than
<code>
90%
</code>
. To check the host machine's disk usage, run the
<a href="https://man7.org/linux/man-pages/man1/df.1.html">
<code>
df
</code>
</a>
command:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ df -h
</span></span><span class="line"><span class="cl">Filesystem Size Used Avail Use% Mounted on
</span></span><span class="line"><span class="cl">overlay 59G 23G 33G 41% /
</span></span><span class="line"><span class="cl">/dev/vda1 59G 23G 33G 41% /etc/hosts
</span></span></code></pre>
</div>
</li>
<li>
<p>
RAM and CPU utilization should be less than
<code>
80%
</code>
, and host resources must be available exclusively for Redis Enterprise Software. You should also make sure that swap memory is not being used or is not configured.
</p>
<ol>
<li>
<p>
Run the
<a href="https://man7.org/linux/man-pages/man1/free.1.html">
<code>
free
</code>
</a>
command to check memory usage:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ free
</span></span><span class="line"><span class="cl"> total used free shared buff/cache available
</span></span><span class="line"><span class="cl">Mem: <span class="m">6087028</span> <span class="m">1954664</span> <span class="m">993756</span> <span class="m">409196</span> <span class="m">3138608</span> <span class="m">3440856</span>
</span></span><span class="line"><span class="cl">Swap: <span class="m">1048572</span> <span class="m">0</span> <span class="m">1048572</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Used CPU should be less than
<code>
80%
</code>
. To check CPU usage, use
<code>
top
</code>
or
<code>
vmstat
</code>
.
</p>
<p>
Run
<a href="https://man7.org/linux/man-pages/man1/top.1.html">
<code>
top
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ top
</span></span><span class="line"><span class="cl">Tasks: <span class="m">54</span> total, <span class="m">1</span> running, <span class="m">53</span> sleeping, <span class="m">0</span> stopped, <span class="m">0</span> zombie
</span></span><span class="line"><span class="cl">%Cpu<span class="o">(</span>s<span class="o">)</span>: 1.7 us, 1.4 sy, 0.0 ni, 96.8 id, 0.0 wa, 0.0 hi, 0.1 si, 0.0 st
</span></span><span class="line"><span class="cl">KiB Mem : <span class="m">6087028</span> total, <span class="m">988672</span> free, <span class="m">1958060</span> used, <span class="m">3140296</span> buff/cache
</span></span><span class="line"><span class="cl">KiB Swap: <span class="m">1048572</span> total, <span class="m">1048572</span> free, <span class="m">0</span> used. <span class="m">3437460</span> avail Mem
</span></span></code></pre>
</div>
<p>
Run
<a href="https://man7.org/linux/man-pages/man8/vmstat.8.html">
<code>
vmstat
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ vmstat
</span></span><span class="line"><span class="cl">procs -----------memory---------- ---swap-- -----io---- -system-- ------cpu-----
</span></span><span class="line"><span class="cl">r b swpd free buff cache si so bi bo in cs us sy id wa st
</span></span><span class="line"><span class="cl"><span class="m">2</span> <span class="m">0</span> <span class="m">0</span> <span class="m">988868</span> <span class="m">177588</span> <span class="m">2962876</span> <span class="m">0</span> <span class="m">0</span> <span class="m">0</span> <span class="m">6</span> <span class="m">7</span> <span class="m">12</span> <span class="m">1</span> <span class="m">1</span> <span class="m">99</span> <span class="m">0</span> <span class="m">0</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If CPU or RAM usage is greater than 80%, ask your system administrator which process is the culprit. If the process is not related to Redis, terminate it.
</p>
</li>
</ol>
</li>
</ul>
<h4 id="sync-clock-with-time-server">
Sync clock with time server
</h4>
<p>
It is recommended to sync the host clock with a time server.
</p>
<p>
Verify that time is synchronized with the time server using one of the following commands:
</p>
<ul>
<li>
<p>
<code>
ntpq -p
</code>
</p>
</li>
<li>
<p>
<code>
chronyc sources
</code>
</p>
</li>
<li>
<p>
<a href="https://man7.org/linux/man-pages/man1/timedatectl.1.html">
<code>
timedatectl
</code>
</a>
</p>
</li>
</ul>
<h4 id="remove-https_proxy-and-http_proxy-variables">
Remove https_proxy and http_proxy variables
</h4>
<ol>
<li>
<p>
Run
<a href="https://man7.org/linux/man-pages/man1/printenv.1.html">
<code>
printenv
</code>
</a>
and check if
<code>
https_proxy
</code>
and
<code>
http_proxy
</code>
are configured as environment variables:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">printenv <span class="p">|</span> grep -i proxy
</span></span></code></pre>
</div>
</li>
<li>
<p>
If
<code>
https_proxy
</code>
or
<code>
http_proxy
</code>
exist, remove them:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"><span class="nb">unset</span> https_proxy
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl"><span class="nb">unset</span> http_proxy
</span></span></code></pre>
</div>
</li>
</ol>
<h4 id="review-system-logs">
Review system logs
</h4>
<p>
Review system logs including the syslog or journal for any error messages, warnings, or critical events. See
<a href="/docs/latest/operate/rs/7.4/clusters/logging/">
Logging
</a>
for more information.
</p>
<h2 id="identify-issues-caused-by-security-hardening">
Identify issues caused by security hardening
</h2>
<ul>
<li>
<p>
Temporarily deactivate any security hardening tools (such as selinux, cylance, McAfee, or dynatrace), and check if the problem is resolved.
</p>
</li>
<li>
<p>
The user
<code>
redislabs
</code>
must have read and write access to
<code>
/tmp
</code>
directory. Run the following commands to verify.
</p>
<ol>
<li>
<p>
Create a test file in
<code>
/tmp
</code>
as the
<code>
redislabs
</code>
user:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ su - redislabs -s /bin/bash -c <span class="s1">'touch /tmp/test'</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Verify the file was created successfully:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ ls -l /tmp/test
</span></span><span class="line"><span class="cl">-rw-rw-r-- <span class="m">1</span> redislabs redislabs <span class="m">0</span> Aug <span class="m">12</span> 02:06 /tmp/test
</span></span></code></pre>
</div>
</li>
</ol>
</li>
<li>
<p>
Using a non-permissive file mode creation mask (
<code>
umask
</code>
) can cause issues.
</p>
<ol>
<li>
<p>
Check the output of
<code>
umask
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ <span class="nb">umask</span>
</span></span><span class="line"><span class="cl"><span class="m">0022</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If
<code>
umask
</code>
's output differs from the default value
<code>
0022
</code>
, it might prevent normal operation. Consult your system administrator and revert to the default
<code>
umask
</code>
setting.
</p>
</li>
</ol>
</li>
</ul>
<h2 id="identify-cluster-issues">
Identify cluster issues
</h2>
<ul>
<li>
<p>
Use
<code>
supervisorctl status
</code>
to verify all processes are in a
<code>
RUNNING
</code>
state:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">supervisorctl status
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<code>
rlcheck
</code>
and verify no errors appear:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rlcheck
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/">
<code>
rladmin status issues_only
</code>
</a>
and verify that no issues appear:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status issues_only
</span></span><span class="line"><span class="cl">CLUSTER NODES:
</span></span><span class="line"><span class="cl">NODE:ID ROLE ADDRESS EXTERNAL_ADDRESS HOSTNAME SHARDS CORES FREE_RAM PROVISIONAL_RAM VERSION STATUS
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">DATABASES:
</span></span><span class="line"><span class="cl">DB:ID NAME TYPE STATUS SHARDS PLACEMENT REPLICATION PERSISTENCE ENDPOINT
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">ENDPOINTS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SSL
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/status/#status-shards">
<code>
rladmin status shards
</code>
</a>
. For each shard,
<code>
USED_MEMORY
</code>
should be less than 25 GB.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin status shards
</span></span><span class="line"><span class="cl">SHARDS:
</span></span><span class="line"><span class="cl">DB:ID NAME ID NODE ROLE SLOTS USED_MEMORY STATUS
</span></span><span class="line"><span class="cl">db:1 db1 redis:1 node:1 master 0-16383 2.13MB OK
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/cluster/running_actions/">
<code>
rladmin cluster running_actions
</code>
</a>
and confirm that no tasks are currently running (active):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin cluster running_actions
</span></span><span class="line"><span class="cl">No active tasks
</span></span></code></pre>
</div>
</li>
</ul>
<h2 id="troubleshoot-connectivity">
Troubleshoot connectivity
</h2>
<h4 id="database-endpoint-resolution">
Database endpoint resolution
</h4>
<ol>
<li>
<p>
On the client machine, check if the database endpoint can be resolved:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">dig <endpoint>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If endpoint resolution fails on the client machine, check on one of the cluster nodes:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">dig @localhost <endpoint>
</span></span></code></pre>
</div>
</li>
<li>
<p>
If endpoint resolution succeeds on the cluster node but fails on the client machine, review the DNS configuration and fix any errors.
</p>
</li>
<li>
<p>
If the endpoint can’t be resolved on the cluster node,
<a href="https://redis.com/company/support/">
contact support
</a>
.
</p>
</li>
</ol>
<h4 id="client-application-issues">
Client application issues
</h4>
<ol>
<li>
<p>
To identify possible client application issues, test connectivity from the client machine to the database using
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/redis-cli/">
<code>
redis-cli
</code>
</a>
:
</p>
<p>
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> INFO
</span></span></code></pre>
</div>
<p>
<a href="/docs/latest/commands/ping/">
<code>
PING
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> PING
</span></span></code></pre>
</div>
<p>
or if TLS is enabled:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> --tls --insecure --cert --key PING
</span></span></code></pre>
</div>
</li>
<li>
<p>
If the client machine cannot connect, try to connect to the database from one of the cluster nodes:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <node IP or hostname> -p <port> -a <password> PING
</span></span></code></pre>
</div>
</li>
<li>
<p>
If the cluster node is also unable to connect to the database,
<a href="https://redis.com/company/support/">
contact Redis support
</a>
.
</p>
</li>
<li>
<p>
If the client fails to connect, but the cluster node succeeds, perform health checks on the client and network.
</p>
</li>
</ol>
<h4 id="firewall-access">
Firewall access
</h4>
<ol>
<li>
<p>
Run one of the following commands to verify that database access is not blocked by a firewall on the client machine or cluster:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">iptables -L
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">ufw status
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">firewall-cmd –list-all
</span></span></code></pre>
</div>
</li>
<li>
<p>
To resolve firewall issues:
</p>
<ol>
<li>
<p>
If a firewall is configured for your database, add the client IP address to the firewall rules.
</p>
</li>
<li>
<p>
Configure third-party firewalls and external proxies to allow the cluster FQDN, database endpoint IP address, and database ports.
</p>
</li>
</ol>
</li>
</ol>
<h2 id="troubleshoot-latency">
Troubleshoot latency
</h2>
<h4 id="server-side-latency">
Server-side latency
</h4>
<ul>
<li>
<p>
Make sure the database's used memory does not reach the configured database max memory limit. For more details, see
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/memory-limit/">
Database memory limits
</a>
.
</p>
</li>
<li>
<p>
Try to correlate the time of the latency with any surge in the following metrics:
</p>
<ul>
<li>
<p>
Number of connections
</p>
</li>
<li>
<p>
Used memory
</p>
</li>
<li>
<p>
Evicted keys
</p>
</li>
<li>
<p>
Expired keys
</p>
</li>
</ul>
</li>
<li>
<p>
Run
<a href="/docs/latest/commands/slowlog-get/">
<code>
SLOWLOG GET
</code>
</a>
using
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/redis-cli/">
<code>
redis-cli
</code>
</a>
to identify slow commands such as
<a href="/docs/latest/commands/keys/">
<code>
KEYS
</code>
</a>
or [
<code>
HGETALL
</code>
](/docs/latest/commands/hgetall/:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> SLOWLOG GET <number of entries>
</span></span></code></pre>
</div>
<p>
Consider using alternative commands such as
<a href="/docs/latest/commands/scan/">
<code>
SCAN
</code>
</a>
,
<a href="/docs/latest/commands/sscan/">
<code>
SSCAN
</code>
</a>
,
<a href="/docs/latest/commands/hscan/">
<code>
HSCAN
</code>
</a>
and
<a href="/docs/latest/commands/zscan/">
<code>
ZSCAN
</code>
</a>
</p>
</li>
<li>
<p>
Keys with large memory footprints can cause latency. To identify such keys, compare the keys returned by
<a href="/docs/latest/commands/slowlog-get/">
<code>
SLOWLOG GET
</code>
</a>
with the output of the following commands:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> --memkeys
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis-cli -h <endpoint> -p <port> -a <password> --bigkeys
</span></span></code></pre>
</div>
</li>
<li>
<p>
For additional diagnostics, see:
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/oss_and_stack/management/optimization/latency/">
Diagnosing latency issues
</a>
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/clusters/logging/redis-slow-log/">
View Redis slow log
</a>
</p>
</li>
</ul>
</li>
</ul>
<h4 id="client-side-latency">
Client-side latency
</h4>
<p>
Verify the following:
</p>
<ul>
<li>
<p>
There is no memory or CPU pressure on the client host.
</p>
</li>
<li>
<p>
The client uses a connection pool instead of frequently opening and closing connections.
</p>
</li>
<li>
<p>
The client does not erroneously open multiple connections that can pressure the client or server.
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/connect/troubleshooting-guide/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/databases/import-export/replica-of/create/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Create a database with Replica Of
</h1>
<p class="text-lg -mt-5 mb-10">
Create Replica Of database
</p>
<p>
Replica databases copy data from source databases (previously known as
<em>
master
</em>
), which enable read-only connections from apps and clients located in different geographic locations.
</p>
<p>
To create a replica connection, you define a database as a replica of a source database. Replica Of databases (also known as
<em>
Active-Passive databases
</em>
) synchronize in the background.
</p>
<p>
Sources databases can be:
</p>
<ul>
<li>
Located in the same Redis Enterprise Software cluster
</li>
<li>
Located in a different Redis Enterprise cluster
</li>
<li>
Hosted by a different deployment, e.g. Redis Cloud
</li>
<li>
Redis Community Edition databases
</li>
</ul>
<p>
Your apps can connect to the source database to read and write data; they can also use any replica for read-only access.
</p>
<p>
Replica Of can model a variety of data relationships, including:
</p>
<ul>
<li>
One-to-many relationships, where multiple replicas copy a single source database.
</li>
<li>
Many-to-one relationships, where a single replica collects data from multiple source databases.
</li>
</ul>
<p>
When you change the replica status of a database by adding, removing, or changing sources, the replica database is synchronized to the new sources.
</p>
<h2 id="configure-replica-of">
Configure Replica Of
</h2>
<p>
You can configure a database as a Replica Of, where the source database is in one of the following clusters:
</p>
<ul>
<li>
<p>
<a href="#same-cluster">
Same Redis Enterprise cluster
</a>
</p>
</li>
<li>
<p>
<a href="#different-cluster">
Different Redis Enterprise cluster
</a>
</p>
</li>
<li>
<p>
<a href="#source-available-cluster">
Redis Community Edition cluster
</a>
</p>
</li>
</ul>
<p>
The order of the multiple Replica Of sources has no material impact on replication.
</p>
<p>
For best results when using the
<a href="https://en.wikipedia.org/wiki/Multicast_DNS">
Multicast DNS
</a>
(mDNS) protocol to resolve the fully-qualified domain name (FQDN) of the cluster, verify that your client connections meet the
<a href="/docs/latest/operate/rs/7.4/networking/mdns/">
client mDNS prerequisites
</a>
.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
As long as Replica Of is enabled, data in the target database will not expire and will not be evicted regardless of the set
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/eviction-policy/">
data eviction policy
</a>
.
</div>
</div>
<h3 id="same-cluster">
Same Redis Enterprise cluster
</h3>
<p>
To configure a Replica Of database in the same Redis Enterprise cluster as the source database:
</p>
<ol>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/databases/create/">
Create a new database
</a>
or select an existing database from the
<strong>
Databases
</strong>
screen.
</p>
</li>
<li>
<p>
For an existing database, select
<strong>
Edit
</strong>
from the
<strong>
Configuration
</strong>
tab.
</p>
</li>
<li>
<p>
Expand the
<strong>
Replica Of
</strong>
section.
</p>
</li>
<li>
<p>
Select
<strong>
+ Add source database
</strong>
.
</p>
</li>
<li>
<p>
In the
<strong>
Connect a Replica Of source database
</strong>
dialog, select
<strong>
Current cluster
</strong>
.
</p>
</li>
<li>
<p>
Select the source database from the list.
</p>
</li>
<li>
<p>
Select
<strong>
Add source
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<h3 id="different-cluster">
Different Redis Enterprise cluster
</h3>
<p>
To configure a Replica Of database in a different Redis Enterprise cluster from the source database:
</p>
<ol>
<li>
<p>
Sign in to the Cluster Manager UI of the cluster hosting the source database.
</p>
<ol>
<li>
<p>
In
<strong>
Databases
</strong>
, select the source database and then select the
<strong>
Configuration
</strong>
tab.
</p>
</li>
<li>
<p>
In the
<strong>
Replica Of
</strong>
section, select
<strong>
Use this database as a source for another database
</strong>
.
</p>
</li>
<li>
<p>
Copy the Replica Of source URL.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/config-replica-of-copy-source-url.png" sdata-lightbox="/images/rs/screenshots/databases/config-replica-of-copy-source-url.png">
<img alt="Copy the Replica Of source URL from the Connection link to destination dialog." src="/docs/latest/images/rs/screenshots/databases/config-replica-of-copy-source-url.png"/>
</a>
<p>
To change the internal password, select
<strong>
Regenerate password
</strong>
.
</p>
<p>
If you regenerate the password, replication to existing destinations fails until their credentials are updated with the new password.
</p>
</li>
</ol>
</li>
<li>
<p>
Sign in to the Cluster Manager UI of the destination database's cluster.
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/databases/create/">
Create a new database
</a>
or select an existing database from the
<strong>
Databases
</strong>
screen.
</p>
</li>
<li>
<p>
For an existing database, select
<strong>
Edit
</strong>
from the
<strong>
Configuration
</strong>
tab.
</p>
</li>
<li>
<p>
Expand the
<strong>
Replica Of
</strong>
section.
</p>
</li>
<li>
<p>
Select
<strong>
+ Add source database
</strong>
.
</p>
</li>
<li>
<p>
In the
<strong>
Connect a Replica Of source database
</strong>
dialog, select
<strong>
External
</strong>
.
</p>
</li>
<li>
<p>
Enter the URL of the source database endpoint.
</p>
</li>
<li>
<p>
Select
<strong>
Add source
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<p>
For source databases on different clusters, you can
<a href="/docs/latest/operate/rs/7.4/databases/import-export/replica-of/#data-compression-for-replica-of">
compress replication data
</a>
to save bandwidth.
</p>
<h3 id="source-available-cluster">
Redis Community Edition cluster
</h3>
<p>
To use a database from a Redis Community Edition cluster as a Replica Of source:
</p>
<ol>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/databases/create/">
Create a new database
</a>
or select an existing database from the
<strong>
Databases
</strong>
screen.
</p>
</li>
<li>
<p>
For an existing database, select
<strong>
Edit
</strong>
from the
<strong>
Configuration
</strong>
tab.
</p>
</li>
<li>
<p>
Expand the
<strong>
Replica Of
</strong>
section.
</p>
</li>
<li>
<p>
Select
<strong>
+ Add source database
</strong>
.
</p>
</li>
<li>
<p>
In the
<strong>
Connect a Replica Of source database
</strong>
dialog, select
<strong>
External
</strong>
.
</p>
</li>
<li>
<p>
Enter the URL of the source endpoint in one of the following formats:
</p>
<ul>
<li>
<p>
For databases with passwords:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis://:<password>@<host>:<port>
</span></span></code></pre>
</div>
<p>
Where the password is the Redis password represented with URL encoding escape characters.
</p>
</li>
<li>
<p>
For databases without passwords:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">redis://<host>:<port>
</span></span></code></pre>
</div>
</li>
</ul>
</li>
<li>
<p>
Select
<strong>
Add source
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<h2 id="configure-tls-for-replica-of">
Configure TLS for Replica Of
</h2>
<p>
When you enable TLS for Replica Of, the Replica Of synchronization traffic uses TLS certificates to authenticate the communication between the source and destination clusters.
</p>
<p>
To encrypt Replica Of synchronization traffic, configure encryption for the
<a href="#encrypt-source-database-traffic">
source database
</a>
and the destination
<a href="#encrypt-replica-database-traffic">
replica database
</a>
.
</p>
<h3 id="encrypt-source-database-traffic">
Encrypt source database traffic
</h3>
<p>
To enable TLS for Replica Of cluster connections:
</p>
<ol>
<li>
<p>
For each cluster hosting a replica:
</p>
<ol>
<li>
<p>
Go to
<strong>
Cluster > Security > Certificates
</strong>
.
</p>
</li>
<li>
<p>
Expand the
<strong>
Replica Of and Active-Active authentication (Syncer certificate)
</strong>
section.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/security-syncer-cert.png" sdata-lightbox="/images/rs/screenshots/cluster/security-syncer-cert.png">
<img alt="Syncer certificate for Replica Of and Active-Active authentication." src="/docs/latest/images/rs/screenshots/cluster/security-syncer-cert.png"/>
</a>
</li>
<li>
<p>
Download or copy the syncer certificate.
</p>
</li>
</ol>
</li>
<li>
<p>
From the
<strong>
Security
</strong>
tab of the Replica Of source database, select
<strong>
Edit
</strong>
.
</p>
</li>
<li>
<p>
In the
<strong>
TLS - Transport Layer Security for secure connections
</strong>
section, make sure the checkbox is selected.
</p>
</li>
<li>
<p>
In the
<strong>
Apply TLS for
</strong>
section, select
<strong>
Between databases only
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Mutual TLS (Client authentication)
</strong>
.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/security-tls-replica-of.png" sdata-lightbox="/images/rs/screenshots/databases/security-tls-replica-of.png">
<img alt="Replica Of TLS authentication configuration." src="/docs/latest/images/rs/screenshots/databases/security-tls-replica-of.png"/>
</a>
</li>
<li>
<p>
Select
<strong>
+ Add certificate
</strong>
, paste or upload the syncer certificate, then select
<strong>
Done
</strong>
.
</p>
<p>
Repeat this process, adding the syncer certificate for each cluster hosting a replica of this database.
</p>
</li>
<li>
<p>
<em>
(Optional)
</em>
To require TLS for client connections, change
<strong>
Apply TLS for
</strong>
to
<strong>
Clients and databases + Between databases
</strong>
and add client certificates.
</p>
</li>
<li>
<p>
Select
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<h3 id="encrypt-replica-database-traffic">
Encrypt replica database traffic
</h3>
<p>
To enable TLS for Replica Of in the destination database:
</p>
<ol>
<li>
<p>
From the Cluster Manager UI of the cluster hosting the source database:
</p>
<ol>
<li>
<p>
Go to
<strong>
Cluster > Security > Certificates
</strong>
.
</p>
</li>
<li>
<p>
Expand the
<strong>
Server authentication (Proxy certificate)
</strong>
section.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/security-proxy-cert.png" sdata-lightbox="/images/rs/screenshots/cluster/security-proxy-cert.png">
<img alt="Proxy certificate for server authentication." src="/docs/latest/images/rs/screenshots/cluster/security-proxy-cert.png"/>
</a>
</li>
<li>
<p>
Download or copy the proxy certificate.
</p>
</li>
</ol>
</li>
<li>
<p>
From the
<strong>
Configuration
</strong>
tab of the Replica Of destination database, select
<strong>
Edit
</strong>
.
</p>
</li>
<li>
<p>
Expand the
<strong>
Replica Of
</strong>
section.
</p>
</li>
<li>
<p>
Point to the source database entry and select
<a href="/docs/latest/images/rs/buttons/edit-button.png#no-click" sdata-lightbox="/images/rs/buttons/edit-button.png#no-click">
<img alt="The Edit button" class="inline" src="/docs/latest/images/rs/buttons/edit-button.png#no-click" width="25px"/>
</a>
to edit it.
</p>
</li>
<li>
<p>
Paste or upload the source proxy certificate, then select
<strong>
Done
</strong>
.
</p>
</li>
<li>
<p>
Select
<strong>
Save
</strong>
.
</p>
</li>
</ol>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/databases/import-export/replica-of/create/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/examples/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Triggers and functions examples
</h1>
<p class="text-lg -mt-5 mb-10">
How triggers and functions can be used
</p>
<div class="banner-article rounded-md">
<p>
The Redis Stack triggers and functions feature preview has ended and it will not be promoted to GA.
</p>
</div>
<p>
Redis Stack's triggers and functions feature enables the detection of changes to data as they happen and guarantee seamless execution of business logic at the data source. This ensures that new options to manipulate the data are possible and can be delivered for all the clients at the same time, while deployment and maintenance are simplified. Let's explore some industry-specific use cases where these capabilities shine:
</p>
<ul>
<li>
<strong>
Retail
</strong>
: In the retail sector, a function can be developed to update the inventory immediately upon order receipt. This empowers businesses to accurately predict stock requirements for specific warehouses on any given day.
</li>
<li>
<strong>
Travel
</strong>
: For the travel industry, a trigger can be utilized to detect new flight bookings and efficiently load the relevant information into a queue for different consumers. Services can then leverage this data to provide recommendations for hotels, restaurants, car rental services, and more. Leveraging Redis geometries, powerful recommendation systems can offer localized and personalized suggestions.
</li>
<li>
<strong>
Subscription services
</strong>
: In the realm of subscription services, employing a keyspace trigger can automatically identify users whose subscriptions have been renewed, seamlessly changing their status to active. Further operations can be performed on these users, such as adding them to a queue for the delivery of notifications or executing additional actions.
</li>
</ul>
<p>
These examples highlight the practical application of triggers and functions in different industries, showcasing their value in streamlining processes and delivering efficient solutions.
</p>
<p>
Using keyspace and Stream triggers to capture events and execute the desired JavaScript functions requires few lines of code to enrich applications with new behaviors. The following examples show how typical problems are solved with JavaScript.
</p>
<h2 id="auditing-and-logging">
Auditing and logging
</h2>
<p>
Redis Triggers can be used to detect changes to specific data structures, and log an auditing trail in the Redis log. The timestamp of the latest change can be updated in the same function.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">alertUserChanged</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="nx">data</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// detect the event and log an audit trail
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="k">if</span> <span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">event</span> <span class="o">==</span> <span class="s1">'hset'</span><span class="p">){</span>
</span></span><span class="line"><span class="cl"> <span class="nx">redis</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'User data changed: '</span> <span class="o">+</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">event</span> <span class="o">==</span> <span class="s1">'del'</span><span class="p">){</span>
</span></span><span class="line"><span class="cl"> <span class="nx">redis</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'User deleted: '</span> <span class="o">+</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">curr_time</span> <span class="o">=</span> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s2">"time"</span><span class="p">)[</span><span class="mi">0</span><span class="p">];</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// add the current timestamp to the Hash
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'hset'</span><span class="p">,</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">,</span> <span class="s1">'last'</span><span class="p">,</span> <span class="nx">curr_time</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">redis</span><span class="p">.</span><span class="nx">registerKeySpaceTrigger</span><span class="p">(</span><span class="s1">'alert_user_changed'</span><span class="p">,</span> <span class="s1">'user:'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">alertUserChanged</span><span class="p">,</span> <span class="p">{</span><span class="nx">description</span><span class="o">:</span> <span class="s1">'Report user data change.'</span><span class="p">});</span>
</span></span></code></pre>
</div>
<h2 id="enrich-and-transform-data">
Enrich and transform data
</h2>
<p>
Data can be extracted, enriched or transformed, and loaded again. As an example, upon insertion of a document in a Hash data structure, a Trigger can launch the execution of a Function that computes the number of words in the text (in the example, a simple tokenization is presented but the logic can be as complex as required). The counter is finally stored in the same Hash together with the original document.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">wordsCounter</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="nx">data</span><span class="p">){</span>
</span></span><span class="line"><span class="cl"> <span class="nx">text</span> <span class="o">=</span> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'hget'</span><span class="p">,</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">,</span> <span class="s1">'content'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">words</span> <span class="o">=</span> <span class="nx">text</span><span class="p">.</span><span class="nx">split</span><span class="p">(</span><span class="s1">' '</span><span class="p">).</span><span class="nx">length</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'hset'</span><span class="p">,</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">,</span> <span class="s1">'cnt'</span><span class="p">,</span> <span class="nx">words</span><span class="p">.</span><span class="nx">toString</span><span class="p">());</span>
</span></span><span class="line"><span class="cl"> <span class="nx">redis</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Number of words: '</span> <span class="o">+</span> <span class="nx">words</span><span class="p">.</span><span class="nx">toString</span><span class="p">());</span> <span class="c1">//This log is for demo purposes, be aware of spamming the log file in production
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">redis</span><span class="p">.</span><span class="nx">registerKeySpaceTrigger</span><span class="p">(</span><span class="s1">'words_counter'</span><span class="p">,</span> <span class="s1">'doc:'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">wordsCounter</span><span class="p">,</span> <span class="p">{</span><span class="nx">description</span><span class="o">:</span> <span class="s1">'Count words in a document.'</span><span class="p">});</span>
</span></span></code></pre>
</div>
<h2 id="batch-operations">
Batch operations
</h2>
<p>
JavaScript functions can be executed when required, for example as part of scheduled or periodic maintenance routines. An example could be deleting data identified by the desired pattern.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="err">#</span><span class="o">!</span><span class="nx">js</span> <span class="nx">api_version</span><span class="o">=</span><span class="mf">1.0</span> <span class="nx">name</span><span class="o">=</span><span class="nx">utils</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">redis</span><span class="p">.</span><span class="nx">registerAsyncFunction</span><span class="p">(</span><span class="s1">'del_keys'</span><span class="p">,</span> <span class="kr">async</span> <span class="kd">function</span><span class="p">(</span><span class="nx">async_client</span><span class="p">,</span> <span class="nx">pattern</span><span class="p">){</span>
</span></span><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">count</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">cursor</span> <span class="o">=</span> <span class="s1">'0'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="k">do</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">async_client</span><span class="p">.</span><span class="nx">block</span><span class="p">((</span><span class="nx">client</span><span class="p">)=>{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">res</span> <span class="o">=</span> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'scan'</span><span class="p">,</span> <span class="nx">cursor</span><span class="p">,</span> <span class="s1">'match'</span><span class="p">,</span> <span class="nx">pattern</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">cursor</span> <span class="o">=</span> <span class="nx">res</span><span class="p">[</span><span class="mi">0</span><span class="p">];</span>
</span></span><span class="line"><span class="cl"> <span class="kd">var</span> <span class="nx">keys</span> <span class="o">=</span> <span class="nx">res</span><span class="p">[</span><span class="mi">1</span><span class="p">];</span>
</span></span><span class="line"><span class="cl"> <span class="nx">keys</span><span class="p">.</span><span class="nx">forEach</span><span class="p">((</span><span class="nx">key</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'del'</span><span class="p">,</span> <span class="nx">key</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"> <span class="p">});</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="k">while</span><span class="p">(</span><span class="nx">cursor</span> <span class="o">!=</span> <span class="s1">'0'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">count</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="p">});</span>
</span></span></code></pre>
</div>
<p>
The function
<code>
del_keys
</code>
performs an asynchronous batch scan of all the keys in the database matching the desired pattern, and enters a blocking section where it gets partial results. The asynchronous design of this function permits non-blocking execution, so other clients will not starve while the iteration is performed on a keyspace of arbitrary size. The function can be invoked as follows.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-text" data-lang="text"><span class="line"><span class="cl">TFCALLASYNC utils.del_keys 0 "user:*"
</span></span></code></pre>
</div>
<h2 id="automatic-expiration">
Automatic expiration
</h2>
<p>
Sometimes it is useful to enforce expiration time for data that by nature is short-lived. An example could be session data, or authentication tokens. A trigger fits the use case and can execute a function that sets the desired TTL.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-javascript" data-lang="javascript"><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">automaticSessionExpiry</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="nx">data</span><span class="p">){</span>
</span></span><span class="line"><span class="cl"> <span class="nx">client</span><span class="p">.</span><span class="nx">call</span><span class="p">(</span><span class="s1">'expire'</span><span class="p">,</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span><span class="p">,</span> <span class="s1">'3600'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="nx">redis</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Session '</span> <span class="o">+</span> <span class="nx">data</span><span class="p">.</span><span class="nx">key</span> <span class="o">+</span> <span class="s1">' has been automatically expired'</span><span class="p">);</span> <span class="c1">//This log is for demo purposes, be aware of spamming the log file in production
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nx">redis</span><span class="p">.</span><span class="nx">registerKeySpaceTrigger</span><span class="p">(</span><span class="s1">'automaticSessionExpiry'</span><span class="p">,</span> <span class="s1">'session:'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">automaticSessionExpiry</span><span class="p">,</span> <span class="p">{</span><span class="nx">description</span><span class="o">:</span> <span class="s1">'Set the session TTL to one hour.'</span><span class="p">});</span>
</span></span></code></pre>
</div>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/triggers-and-functions/examples/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/k8s-6-2-12-1/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes release notes 6.2.12-1 (Sept 2022)
</h1>
<p class="text-lg -mt-5 mb-10">
Support added for additional distributions, as well as feature improvements and bug fixes.
</p>
<h2 id="overview">
Overview
</h2>
<p>
The Redis Enterprise K8s 6.2.12-1 supports the Redis Enterprise Software release 6.2.12 and includes feature improvements and bug fixes.
</p>
<p>
The key bug fixes and known limitations are described below.
</p>
<h2 id="images">
Images
</h2>
<p>
This release includes the following container images:
</p>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
redislabs/redis:6.2.12-82
</code>
or
<code>
redislabs/redis:6.2.12-82.rhel8-openshift
</code>
</li>
<li>
<strong>
Operator
</strong>
:
<code>
redislabs/operator:6.2.12-1
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
redislabs/k8s-controller:6.2.12-1
</code>
or
<code>
redislabs/services-manager:6.2.12-1
</code>
(on the Red Hat registry)
</li>
</ul>
<h2 id="feature-improvements">
Feature improvements
</h2>
<ul>
<li>
Redis Enterprise Software 6.2.12 support (RED-83829)
</li>
<li>
Added support for annotations on services created by Redis Enterprise (RED-56245)
</li>
<li>
Support for additional builds of same Redis Software version with same operator version. The list of supported builds will be published. (RED-78757)
</li>
</ul>
<h2 id="bug-fixes">
Bug fixes
</h2>
<ul>
<li>
Fixed Golang related vulnerabilities (RED-79205)
</li>
<li>
Log collector creating larger packages (RED-79650)
</li>
<li>
Log collector crashes when Redis Enterprise cluster is not running (RED-79996)
</li>
<li>
Redis Enterprise Software pods termination process could lead, in some circumstances, to pod shutdown without proper failover of its master shards. This has been fixed so that the failover attempts are retried indefinitely within the grace period, which by default is 1 year. The grace period is controllable via the redisEnterpriseTerminationGracePeriodSeconds parameter in the REC (but note that shutting down a pod without the proper failovers may lead to data loss).(RED-75388)
</li>
</ul>
<h2 id="api-changes">
API changes
</h2>
<p>
The Redis Enterprise cluster
<code>
podSecurityPolicy
</code>
is deprecated. This is still supported but will be removed when all K8s versions supporting the feature are removed.
</p>
<h2 id="compatibility-notes">
Compatibility notes
</h2>
<p>
Below is a table showing supported distributions at the time of this release. See
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Supported Kubernetes distributions
</a>
for the current list of supported distributions.
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
<strong>
Kubernetes version
</strong>
</th>
<th style="text-align:center">
1.20
</th>
<th style="text-align:center">
1.21
</th>
<th style="text-align:center">
1.22
</th>
<th style="text-align:center">
1.23
</th>
<th style="text-align:center">
1.24
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
Community Kubernetes
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
</tr>
<tr>
<td style="text-align:left">
Amazon EKS
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
<td>
</td>
</tr>
<tr>
<td style="text-align:left">
Azure AKS
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
</tr>
<tr>
<td style="text-align:left">
Google GKE
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
</tr>
<tr>
<td style="text-align:left">
Rancher 2.6
</td>
<td style="text-align:center">
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
<td style="text-align:center">
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
OpenShift version
</strong>
</td>
<td style="text-align:center">
<strong>
4.7
</strong>
</td>
<td style="text-align:center">
<strong>
4.8
</strong>
</td>
<td style="text-align:center">
<strong>
4.9
</strong>
</td>
<td style="text-align:center">
<strong>
4.10
</strong>
</td>
<td style="text-align:center">
<strong>
4.11
</strong>
</td>
</tr>
<tr>
<td style="text-align:left">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported
</td>
<td style="text-align:center">
supported*
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
VMware TKGI version
</strong>
</td>
<td style="text-align:center">
<strong>
1.11
</strong>
</td>
<td style="text-align:center">
<strong>
1.12
</strong>
</td>
<td style="text-align:center">
<strong>
1.13
</strong>
</td>
<td style="text-align:center">
<strong>
1.14
</strong>
</td>
<td style="text-align:center">
<strong>
1.15
</strong>
</td>
</tr>
<tr>
<td style="text-align:left">
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
deprecated
</td>
<td style="text-align:center">
supported*
</td>
<td style="text-align:center">
supported*
</td>
<td style="text-align:center">
</td>
</tr>
</tbody>
</table>
<p>
* Support added in this release
</p>
<h3 id="support-added">
Support added
</h3>
<ul>
<li>
Azure AKS 1.24
</li>
<li>
Amazon EKS 1.23
</li>
<li>
Google GKE 1.24
</li>
<li>
OpenShift 4.11
</li>
<li>
Rancher 1.23
</li>
<li>
VMware TKGI 1.14
</li>
</ul>
<h3 id="deprecated">
Deprecated
</h3>
<ul>
<li>
Amazon EKS 1.21
</li>
<li>
Google GKE 1.21
</li>
<li>
OpenShift 4.7
</li>
<li>
OpenShift 4.8
</li>
<li>
VMware TKGI 1.11
</li>
<li>
VMware TKGI 1.12
</li>
</ul>
<h3 id="no-longer-supported">
No longer supported
</h3>
<ul>
<li>
Community Kubernetes 1.21
</li>
<li>
Amazon EKS 1.19, 1.20
</li>
<li>
Azure AKS 1.21
</li>
<li>
Google GKE 1.19, 1.20
</li>
<li>
Rancher 2.6 1.19, 1.20
</li>
<li>
VMware TKGI 1.10
</li>
</ul>
<h2 id="before-upgrading">
Before upgrading
</h2>
<p>
Be aware the following changes included in this release affect the upgrade process. Please read carefully before upgrading.
</p>
<h3 id="supported-upgrade-paths">
Supported upgrade paths
</h3>
<p>
If you are using operator version 6.2.8-15 or earlier, you cannot upgrade directly to operator versions 6.2.12 through 6.4.2-5. You must upgrade to operator version 6.2.10-45 before you can upgrade to operator versions between 6.2.12 and 6.4.2-5. However, upgrades directly to operator version 6.4.2-6 are supported.
</p>
<h2 id="known-limitations">
Known limitations
</h2>
<h3 id="large-clusters">
Large clusters
</h3>
<p>
On clusters with more than 9 REC nodes, a Kubernetes upgrade can render the Redis cluster unresponsive in some cases. A fix is available in the 6.4.2-5 release. Upgrade your operator version to 6.4.2-5 or later before upgrading your Kubernetes cluster. (RED-93025)
</p>
<ul>
<li>
<p>
Long cluster names cause routes to be rejected (RED-25871)
</p>
<p>
A cluster name longer than 20 characters will result in a rejected route configuration because the host part of the domain name will exceed 63 characters. The workaround is to limit cluster name to 20 characters or less.
</p>
</li>
<li>
<p>
Cluster CR (REC) errors are not reported after invalid updates (RED-25542)
</p>
<p>
A cluster CR specification error is not reported if two or more invalid CR resources are updated in sequence.
</p>
</li>
<li>
<p>
An unreachable cluster has status running (RED-32805)
</p>
<p>
When a cluster is in an unreachable state, the state is still
<code>
running
</code>
instead of being reported as an error.
</p>
</li>
<li>
<p>
Readiness probe incorrect on failures (RED-39300)
</p>
<p>
STS Readiness probe does not mark a node as "not ready" when running
<code>
rladmin status
</code>
on node failure.
</p>
</li>
<li>
<p>
Role missing on replica sets (RED-39002)
</p>
<p>
The
<code>
redis-enterprise-operator
</code>
role is missing permission on replica sets.
</p>
</li>
<li>
<p>
Private registries are not supported on OpenShift 3.11 (RED-38579)
</p>
<p>
OpenShift 3.11 does not support DockerHub private registries. This is a known OpenShift issue.
</p>
</li>
<li>
<p>
Internal DNS and Kubernetes DNS may have conflicts (RED-37462)
</p>
<p>
DNS conflicts are possible between the cluster
<code>
mdns_server
</code>
and the K8s DNS. This only impacts DNS resolution from within cluster nodes for Kubernetes DNS names.
</p>
</li>
<li>
<p>
5.4.10 negatively impacts 5.4.6 (RED-37233)
</p>
<p>
Kubernetes-based 5.4.10 deployments seem to negatively impact existing 5.4.6 deployments that share a Kubernetes cluster.
</p>
</li>
<li>
<p>
Node CPU usage is reported instead of pod CPU usage (RED-36884)
</p>
<p>
In Kubernetes, the node CPU usage we report on is the usage of the Kubernetes worker node hosting the REC pod.
</p>
</li>
<li>
<p>
Clusters must be named "rec" in OLM-based deployments (RED-39825)
</p>
<p>
In OLM-deployed operators, the deployment of the cluster will fail if the name is not "rec". When the operator is deployed via the OLM, the security context constraints (scc) are bound to a specific service account name (i.e., "rec"). The workaround is to name the cluster "rec".
</p>
</li>
<li>
<p>
REC clusters fail to start on Kubernetes clusters with unsynchronized clocks (RED-47254)
</p>
<p>
When REC clusters are deployed on Kubernetes clusters with unsynchronized clocks, the REC cluster does not start correctly. The fix is to use NTP to synchronize the underlying K8s nodes.
</p>
</li>
<li>
<p>
Deleting an OpenShift project with an REC deployed may hang (RED-47192)
</p>
<p>
When a REC cluster is deployed in a project (namespace) and has REDB resources, the REDB resources must be deleted first before the REC can be deleted. As such, until the REDB resources are deleted, the project deletion will hang. The fix is to delete the REDB resources first and the REC second. Afterwards, you may delete the project.
</p>
</li>
<li>
<p>
REC extraLabels are not applied to PVCs on K8s versions 1.15 or older (RED-51921)
</p>
<p>
In K8s 1.15 or older, the PVC labels come from the match selectors and not the PVC templates. As such, these versions cannot support PVC labels. If this feature is required, the only fix is to upgrade the K8s cluster to a newer version.
</p>
</li>
<li>
<p>
Hashicorp Vault integration - no support for Gesher (RED-55080)
</p>
<p>
There is no workaround at this time.
</p>
</li>
<li>
<p>
REC might report error states on initial startup (RED-61707)
</p>
<p>
There is no workaround at this time except to ignore the errors.
</p>
</li>
<li>
<p>
PVC size issues when using decimal value in spec (RED-62132)
</p>
<p>
The workaround for this issue is to make sure you use integer values for the PVC size.
</p>
</li>
<li>
<p>
Following old revision of quick start guide causes issues creating an REDB due to unrecognized memory field name (RED-69515)
</p>
<p>
The workaround is to use the newer (current) revision of the quick start document available online.
</p>
</li>
<li>
<p>
<code>
autoUpgrade
</code>
set to true by operator might cause unexpected bdb upgrades when
<code>
redisUpgradePolicy
</code>
is set to true (RED-72351)
</p>
<p>
Contact support if your deployment is impacted.
</p>
</li>
<li>
<p>
Procedure to update credentials might be problematic on OpenShift when accessing the cluster externally using routes (RS issue)(RED-73251)(RED-75329)
To workaround this, access the API from within the K8s cluster.
</p>
</li>
<li>
<p>
On Windows,
<code>
log_collector
</code>
doesn't recognize the namespace given with the
<code>
-n
</code>
flag (RED-83532)
</p>
<p>
To workaround this, use a different operating system.
</p>
</li>
<li>
<p>
Active-Active database creation will fail if the ingress class annotation is not exactly "nginx" when using Nginx ingress controller (RED-83070)
</p>
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/k8s-6-2-12-1/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/references/compatibility/resp/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RESP compatibility with Redis Enterprise
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Enterprise supports RESP2 and RESP3.
</p>
<p>
RESP (Redis Serialization Protocol) is the protocol that clients use to communicate with Redis databases. See the
<a href="/docs/latest/develop/reference/protocol-spec/">
RESP protocol specification
</a>
for more information.
</p>
<h2 id="supported-resp-versions">
Supported RESP versions
</h2>
<ul>
<li>
<p>
RESP2 is supported by all Redis Enterprise versions.
</p>
</li>
<li>
<p>
RESP3 is supported by Redis Enterprise 7.2 and later.
</p>
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Redis Enterprise versions that support RESP3 continue to support RESP2.
</div>
</div>
<h2 id="enable-resp3">
Enable RESP3 for a database
</h2>
<p>
To use RESP3 with a Redis Enterprise Software database:
</p>
<ol>
<li>
<p>
Upgrade Redis servers to version 7.2 or later.
</p>
<p>
For Active-Active and Replica Of databases:
</p>
<ol>
<li>
<p>
Upgrade all participating clusters to Redis Enterprise version 7.2.x or later.
</p>
</li>
<li>
<p>
Upgrade all databases to version 7.x or later.
</p>
</li>
</ol>
</li>
<li>
<p>
Enable RESP3 support for your database (
<code>
enabled
</code>
by default):
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/tune/#tune-db">
<code>
rladmin tune db
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db db:<ID> resp3 enabled
</span></span></code></pre>
</div>
<p>
You can use the database name in place of
<code>
db:<ID>
</code>
in the preceding command.
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/references/rest-api/requests/bdbs/#put-bdbs">
Update database configuration
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/bdbs/<uid>
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"resp3"</span>: <span class="nb">true</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
</li>
</ol>
<h2 id="deactivate-resp3">
Deactivate RESP3 for a database
</h2>
<p>
To deactivate RESP3 support for a database:
</p>
<ul>
<li>
<p>
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/tune/#tune-db">
<code>
rladmin tune db
</code>
</a>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune db db:<ID> resp3 disabled
</span></span></code></pre>
</div>
<p>
You can use the database name in place of
<code>
db:<ID>
</code>
in the preceding command.
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/references/rest-api/requests/bdbs/#put-bdbs">
Update database configuration
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/bdbs/<uid>
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"resp3"</span>: <span class="nb">false</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<p>
When RESP3 is deactivated, connected clients that use RESP3 are disconnected from the database.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
You cannot use sharded pub/sub if you deactivate RESP3 support.
</div>
</div>
<h2 id="change-default-resp3-option">
Change default RESP3 option
</h2>
<p>
The cluster-wide option
<code>
resp3_default
</code>
determines the default value of the
<code>
resp3
</code>
option, which enables or deactivates RESP3 for a database, upon upgrading a database to version 7.2.
<code>
resp3_default
</code>
is set to
<code>
enabled
</code>
by default.
</p>
<p>
To change
<code>
resp3_default
</code>
to
<code>
disabled
</code>
, use one of the following methods:
</p>
<ul>
<li>
<p>
Cluster Manager UI:
</p>
<ol>
<li>
<p>
On the
<strong>
Databases
</strong>
screen, select
<a href="/docs/latest/images/rs/buttons/button-toggle-actions-vertical.png#no-click" sdata-lightbox="/images/rs/buttons/button-toggle-actions-vertical.png#no-click">
<img alt="Toggle actions button" class="inline" src="/docs/latest/images/rs/buttons/button-toggle-actions-vertical.png#no-click" width="22px"/>
</a>
to open a list of additional actions.
</p>
</li>
<li>
<p>
Select
<strong>
Upgrade configuration
</strong>
.
</p>
</li>
<li>
<p>
For
<strong>
RESP3 support
</strong>
, select
<strong>
Disable
</strong>
.
</p>
</li>
<li>
<p>
Click
<strong>
Save
</strong>
.
</p>
</li>
</ol>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/references/cli-utilities/rladmin/tune/#tune-cluster">
<code>
rladmin tune cluster
</code>
</a>
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin tune cluster resp3_default disabled
</span></span></code></pre>
</div>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/references/rest-api/requests/cluster/policy/#put-cluster-policy">
Update cluster policy
</a>
REST API request:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/cluster/policy
</span></span><span class="line"><span class="cl"><span class="o">{</span> <span class="s2">"resp3_default"</span>: <span class="nb">false</span> <span class="o">}</span>
</span></span></code></pre>
</div>
</li>
</ul>
<h2 id="client-prerequisites-for-redis-72-upgrade">
Client prerequisites for Redis 7.2 upgrade
</h2>
<p>
The Redis clients
<a href="https://redis.uptrace.dev/">
Go-Redis
</a>
version 9 and
<a href="https://redis.github.io/lettuce/">
Lettuce
</a>
versions 6 and later use RESP3 by default. If you use either client to run Redis Stack commands, you should set the client's protocol version to RESP2 before upgrading your database to Redis version 7.2 to prevent potential application issues due to RESP3 breaking changes.
</p>
<h3 id="go-redis">
Go-Redis
</h3>
<p>
For applications using Go-Redis v9.0.5 or later, set the protocol version to RESP2:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">client</span> <span class="o">:=</span> <span class="nx">redis</span><span class="p">.</span><span class="nf">NewClient</span><span class="p">(</span><span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">Options</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Addr</span><span class="p">:</span> <span class="s">"<database_endpoint>"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Protocol</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="c1">// Pin the protocol version
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">})</span>
</span></span></code></pre>
</div>
<h3 id="lettuce">
Lettuce
</h3>
<p>
To set the protocol version to RESP2 with Lettuce v6 or later:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">io.lettuce.core.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">io.lettuce.core.api.*</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">io.lettuce.core.protocol.ProtocolVersion</span><span class="o">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">// ...
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="n">RedisClient</span> <span class="n">client</span> <span class="o">=</span> <span class="n">RedisClient</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="s">"<database_endpoint>"</span><span class="o">);</span>
</span></span><span class="line"><span class="cl"><span class="n">client</span><span class="o">.</span><span class="na">setOptions</span><span class="o">(</span><span class="n">ClientOptions</span><span class="o">.</span><span class="na">builder</span><span class="o">()</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">protocolVersion</span><span class="o">(</span><span class="n">ProtocolVersion</span><span class="o">.</span><span class="na">RESP2</span><span class="o">)</span> <span class="c1">// Pin the protocol version
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="o">.</span><span class="na">build</span><span class="o">());</span>
</span></span><span class="line"><span class="cl"><span class="c1">// ...
</span></span></span></code></pre>
</div>
<p>
If you are using
<a href="https://github.com/redis-developer/lettucemod/">
LettuceMod
</a>
, you need to upgrade to
<a href="https://github.com/redis-developer/lettucemod/releases/tag/v3.6.0">
v3.6.0
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/references/compatibility/resp/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/interact/search-and-query/deprecated/development/.html | <section class="prose w-full py-12">
<h1>
Developer notes
</h1>
<p class="text-lg -mt-5 mb-10">
Notes on RediSearch debugging, testing, and documentation
</p>
<p>
Developing RediSearch features involves setting up a development environment (which can be either Linux-based or macOS-based), building the module, running tests and benchmarks, and debugging both the module and its tests.
</p>
<h2 id="cloning-the-git-repository">
Cloning the git repository
</h2>
<p>
Run the following command to clone the RediSearch module and its submodules:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">git clone --recursive https://github.com/RediSearch/RediSearch.git
</span></span></code></pre>
</div>
<h2 id="working-in-an-isolated-environment">
Working in an isolated environment
</h2>
<p>
There are several reasons to develop in an isolated environment, like keeping your workstation clean, and developing for a different Linux distribution.
The most general option for an isolated environment is a virtual machine. It's very easy to set one up using
<a href="https://www.vagrantup.com">
Vagrant
</a>
).
Docker is even more agile, as it offers an almost instant solution:
</p>
<pre tabindex="0"><code>search=$(docker run -d -it -v $PWD:/build debian:bullseye bash)
docker exec -it $search bash
</code></pre>
<p>
Then, from within the container,
<code>
cd /build
</code>
and go on as usual.
</p>
<p>
In this mode, all installations remain in the scope of the Docker container.
Upon exiting the container, you can either re-invoke it with the above
<code>
docker exec
</code>
or commit the state of the container to an image and re-invoke it at a later stage:
</p>
<pre tabindex="0"><code>docker commit $search redisearch1
docker stop $search
search=$(docker run -d -it -v $PWD:/build rediseatch1 bash)
docker exec -it $search bash
</code></pre>
<p>
You can replace
<code>
debian:bullseye
</code>
with your choice of OS, with the host OS being the best choice allowing you to run the RediSearch binary on your host after it is built.
</p>
<h2 id="installing-prerequisites">
Installing prerequisites
</h2>
<p>
To build and test RediSearch you need to install several packages, depending on the underlying OS. The following OSes are supported:
</p>
<ul>
<li>
Ubuntu 18.04
</li>
<li>
Ubuntu 20.04
</li>
<li>
Ubuntu 22.04
</li>
<li>
Debian linux 11
</li>
<li>
Rocky linux 8
</li>
<li>
Rocky linux 9
</li>
<li>
Amazon linux 2
</li>
<li>
Mariner 2.0
</li>
<li>
MacOS
</li>
</ul>
<p>
To install the prerequisites on your system using a setup script, first enter the
<code>
RediSearch
</code>
directory and then run:
</p>
<pre tabindex="0"><code>cd ./install
./install_script.sh sudo
./install_boost.sh 1.83.0
</code></pre>
<p>
Note that this will install various packages on your system using the native package manager (
<code>
sudo
</code>
is not required in a Docker environment).
</p>
<p>
If you prefer to avoid that, you can:
</p>
<ul>
<li>
Review the relevant setup scripts under the
<code>
./install
</code>
directory and install packages manually.
</li>
<li>
Use an isolated environment as explained above.
</li>
</ul>
<h2 id="installing-redis">
Installing Redis
</h2>
<p>
As a rule of thumb, you should run the latest Redis version.
</p>
<p>
If your OS has a Redis 7.x package, you can install it using the OS package manager.
</p>
<p>
Otherwise, you can build it from source and install it as described in
<a href="https://github.com/redis/redis">
redis GitHub page
</a>
.
</p>
<h2 id="getting-help">
Getting help
</h2>
<p>
<code>
make help
</code>
provides a quick summary of the development features. Following is a partial list that contains the most common and relevant ones:
</p>
<pre tabindex="0"><code>make fetch # download and prepare dependant modules
make build # compile and link
COORD=1 # build coordinator
DEBUG=1 # build for debugging
NO_TESTS=1 # disable unit tests
WHY=1 # explain CMake decisions (in /tmp/cmake-why)
FORCE=1 # Force CMake rerun (default)
CMAKE_ARGS=... # extra arguments to CMake
VG=1 # build for Valgrind
SAN=type # build with LLVM sanitizer (type=address|memory|leak|thread)
SLOW=1 # do not parallelize build (for diagnostics)
GCC=1 # build with GCC (default unless Sanitizer)
CLANG=1 # build with CLang
STATIC_LIBSTDCXX=0 # link libstdc++ dynamically (default: 1)
make parsers # build parsers code (required after chaging files under query_parser dir)
make clean # remove build artifacts
ALL=1 # remove entire artifacts directory
make run # run redis with RediSearch
COORD=1 # run three local shards with coordinator (assuming the module was built with coordinator support)
GDB=1 # invoke using gdb
make test # run all tests
COORD=1 # test coordinator
TEST=name # run specified test
make pytest # run python tests (tests/pytests)
COORD=1 # test coordinator
TEST=name # e.g. TEST=test:testSearch
RLTEST_ARGS=... # pass args to RLTest
REJSON=1|0|get # also load JSON module (default: 1)
REJSON_PATH=path # use JSON module at `path`
EXT=1 # External (existing) environment
GDB=1 # RLTest interactive debugging
VG=1 # use Valgrind
VG_LEAKS=0 # do not search leaks with Valgrind
SAN=type # use LLVM sanitizer (type=address|memory|leak|thread)
make unit-tests # run unit tests (C and C++)
TEST=name # e.g. TEST=FGCTest.testRemoveLastBlock
make c_tests # run C tests (from tests/ctests)
make cpp_tests # run C++ tests (from tests/cpptests)
make callgrind # produce a call graph
REDIS_ARGS="args"
make sanbox # create container with CLang Sanitizer
</code></pre>
<h2 id="building-from-source">
Building from source
</h2>
<p>
Run the following from the project root dir:
</p>
<p>
<code>
make build
</code>
will build RediSearch.
</p>
<p>
<code>
make build COORD=1
</code>
will build Redis Community Edition RediSearch Coordinator.
</p>
<p>
<code>
make build STATIC=1
</code>
will build as a static library.
</p>
<p>
Notes:
</p>
<ul>
<li>
Binary files are placed under
<code>
bin
</code>
, according to platform and build variant.
</li>
<li>
RediSearch uses
<a href="https://cmake.org">
CMake
</a>
as its build system.
<code>
make build
</code>
will invoke both CMake and the subsequent make command that's required to complete the build.
</li>
</ul>
<p>
Use
<code>
make clean
</code>
to remove build artifacts.
<code>
make clean ALL=1
</code>
will remove the entire
<code>
bin
</code>
subdirectory.
</p>
<h3 id="diagnosing-the-build-process">
Diagnosing the build process
</h3>
<p>
<code>
make build
</code>
will build in parallel by default.
</p>
<p>
For the purposes of build diagnosis,
<code>
make build SLOW=1 VERBOSE=1
</code>
can be used to examine compilation commands.
</p>
<h2 id="running-redis-with-redisearch">
Running Redis with RediSearch
</h2>
<p>
The following will run
<code>
redis
</code>
and load the RediSearch module.
</p>
<pre tabindex="0"><code>make run
</code></pre>
<p>
You can open
<code>
redis-cli
</code>
in another terminal to interact with it.
</p>
<h2 id="running-tests">
Running tests
</h2>
<p>
There are several sets of unit tests:
</p>
<ul>
<li>
C tests, located in
<code>
tests/ctests
</code>
, run by
<code>
make c_tests
</code>
.
</li>
<li>
C++ tests (enabled by GTest), located in
<code>
tests/cpptests
</code>
, run by
<code>
make cpp_tests
</code>
.
</li>
<li>
Python tests (enabled by RLTest), located in
<code>
tests/pytests
</code>
, run by
<code>
make pytest
</code>
.
</li>
</ul>
<p>
You can run all tests by invoking
<code>
make test
</code>
.
</p>
<p>
A single test can be run using the
<code>
TEST
</code>
parameter, e.g.,
<code>
make test TEST=regex
</code>
.
</p>
<h2 id="debugging">
Debugging
</h2>
<p>
To build for debugging (enabling symbolic information and disabling optimization), run
<code>
make DEBUG=1
</code>
.
You can then use
<code>
make run DEBUG=1
</code>
to invoke
<code>
gdb
</code>
.
In addition to the usual way to set breakpoints in
<code>
gdb
</code>
, it is possible to use the
<code>
BB
</code>
macro to set a breakpoint inside the RediSearch code. It will only have an effect when running under
<code>
gdb
</code>
.
</p>
<p>
Similarly, Python tests in a single-test mode, you can set a breakpoint by using the
<code>
BB()
</code>
function inside a test.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/interact/search-and-query/deprecated/development/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Hardware requirements
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Enterprise Software hardware requirements for development and production environments.
</p>
<p>
The hardware requirements for Redis Enterprise Software are different for development and production environments.
</p>
<ul>
<li>
<p>
In a development environment, you can test your application with a live database.
</p>
<p>
If you want to test your application under production conditions, use the production environment requirements.
</p>
</li>
<li>
<p>
In a production environment, you must have enough resources to handle the load on the database and recover from failures.
</p>
</li>
</ul>
<h2 id="developmentenvironment">
Development environment
</h2>
<p>
You can build your development environment with non-production hardware, such as a laptop, desktop, or small VM or instance,
and with these hardware requirements:
</p>
<table>
<thead>
<tr>
<th>
Item
</th>
<th>
Description
</th>
<th>
Minimum requirements
</th>
<th>
Recommended
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Nodes per cluster
</td>
<td>
You can install on one node but many features require at least two nodes.
</td>
<td>
1 node
</td>
<td>
>= 2 nodes
</td>
</tr>
<tr>
<td>
RAM per node
</td>
<td>
The amount of RAM for each node.
</td>
<td>
4GB
</td>
<td>
>= 10GB
</td>
</tr>
<tr>
<td>
Storage per node
</td>
<td>
The amount of storage space for each node.
</td>
<td>
10GB
</td>
<td>
>= 20GB
</td>
</tr>
</tbody>
</table>
<h2 id="productionenvironment">
Production environment
</h2>
<p>
We recommend these hardware requirements for production systems or for development systems that are designed to demonstrate production use cases:
</p>
<table>
<thead>
<tr>
<th>
Item
</th>
<th>
Description
</th>
<th>
Minimum requirements
</th>
<th>
Recommended
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Nodes
<sup>
*
</sup>
per cluster
</td>
<td>
At least three nodes are required to support a reliable, highly available deployment that handles process failure, node failure, and network split events in a consistent manner.
</td>
<td>
3 nodes
</td>
<td>
>= 3 nodes (Must be an odd number of nodes)
</td>
</tr>
<tr>
<td>
Cores
<sup>
*
</sup>
per node
</td>
<td>
Redis Enterprise Software is based on a multi-tenant architecture and can run multiple Redis processes (or shards) on the same core without significant performance degradation.
</td>
<td>
4 cores
</td>
<td>
>=8 cores
</td>
</tr>
<tr>
<td>
RAM
<sup>
*
</sup>
per node
</td>
<td>
Defining your RAM size must be part of the capacity planning for your Redis usage.
</td>
<td>
15GB
</td>
<td>
>=30GB
</td>
</tr>
<tr>
<td>
Ephemeral Storage
</td>
<td>
Used for storing
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
replication files (RDB format) and cluster log files
</a>
.
</td>
<td>
RAM x 2
</td>
<td>
>= RAM x 4
</td>
</tr>
<tr>
<td>
Persistent Storage
</td>
<td>
Used for storing
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
snapshot (RDB format) and AOF files
</a>
over a persistent storage media, such as AWS Elastic Block Storage (EBS) or Azure Data Disk.
</td>
<td>
RAM x 3
</td>
<td>
In-memory >= RAM x 6 (except for
<a href="/docs/latest/operate/rs/7.4/clusters/optimize/disk-sizing-heavy-write-scenarios/">
extreme 'write' scenarios
</a>
)
<br/>
<br/>
<a href="/docs/latest/operate/rs/7.4/databases/auto-tiering/">
Auto Tiering
</a>
>= (RAM + Flash) x 5.
</td>
</tr>
<tr>
<td>
Network
</td>
<td>
We recommend using multiple NICs per node where each NIC is >100Mbps, but Redis Enterprise Software can also run over a single 1Gbps interface network used for processing application requests, inter-cluster communication, and storage access.
</td>
<td>
1G
</td>
<td>
>=10G
</td>
</tr>
</tbody>
</table>
<p>
<sup>
*
</sup>
Additional considerations:
</p>
<ul>
<li>
<p>
Nodes per Cluster:
</p>
<ul>
<li>
<p>
Clusters with more than 35 nodes are not supported. Please contact the Redis support team for assistance if your sizing calls for deploying a larger number of nodes.
</p>
</li>
<li>
<p>
Quorum nodes also must comply with the above minimal hardware requirements.
</p>
</li>
<li>
<p>
To ensure synchronization and consistency, Active-Active deployments with three-node clusters should not use quorum nodes. Because quorum nodes do not store data shards, they cannot support replication. In case of a node failure, replica shards aren't available for Active-Active synchronization.
</p>
</li>
</ul>
</li>
<li>
<p>
Cores:
</p>
<ul>
<li>
<p>
When the CPU load reaches a certain level, Redis Enterprise Software sends an alert to the operator.
</p>
</li>
<li>
<p>
If your application is designed to put a lot of load on your Redis database, make sure that you have at least one available core for each shard of your database.
</p>
</li>
<li>
<p>
If some of the cluster nodes are utilizing more than 80% of the CPU, consider migrating busy resources to less busy nodes.
</p>
</li>
<li>
<p>
If all the cluster nodes are utilizing over 80% of the CPU, consider scaling out the cluster by
<a href="/docs/latest/operate/rs/7.4/clusters/add-node/">
adding a node
</a>
.
</p>
</li>
</ul>
</li>
<li>
<p>
RAM:
</p>
<ul>
<li>
<p>
Redis uses a relatively large number of buffers, which enable replica communication, client communication, pub/sub commands, and more. As a result, you should ensure that 30% of the RAM is available on each node at any given time.
</p>
</li>
<li>
<p>
If one or more cluster nodes utilizes more than 65% of the RAM, consider migrating resources to less active nodes.
</p>
</li>
<li>
<p>
If all cluster nodes are utilizing more than 70% of available RAM, consider
<a href="/docs/latest/operate/rs/7.4/clusters/add-node/">
adding a node
</a>
.
</p>
</li>
<li>
<p>
Do not run any other memory-intensive processes on the Redis Enterprise Software node.
</p>
</li>
</ul>
</li>
</ul>
<h2 id="sizing-considerations">
Sizing considerations
</h2>
<h3 id="general-sizing">
General database sizing
</h3>
<p>
Factors to consider when sizing your database.
</p>
<ul>
<li>
<strong>
Dataset size
</strong>
– Your limit should be greater than your dataset size to leave room for overhead.
</li>
<li>
<strong>
Database throughput
</strong>
– High throughput needs more shards, leading to a higher memory limit.
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/">
<strong>
Modules
</strong>
</a>
– Using modules with your database consumes more memory.
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/durability-ha/clustering/">
<strong>
Database clustering
</strong>
</a>
– Allows you to spread your data into shards across multiple nodes.
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/durability-ha/replication/">
<strong>
Database replication
</strong>
</a>
– Enabling replication doubles memory consumption.
</li>
</ul>
<h3 id="active-active-sizing">
Active-Active database sizing
</h3>
<p>
Additional factors for sizing Active-Active databases:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/active-active/">
<strong>
Active-Active replication
</strong>
</a>
– Requires double the memory of regular replication, which can be up to two times (2x) the original data size per instance.
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/durability-ha/replication/#database-replication-backlog">
<strong>
Database replication backlog
</strong>
</a>
– For synchronization between shards. By default, this is set to 1% of the database size.
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/active-active/manage/#replication-backlog">
<strong>
Active-Active replication backlog
</strong>
</a>
– For synchronization between clusters. By default, this is set to 1% of the database size.
</li>
</ul>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
Active-Active databases have a lower threshold for activating the eviction policy, because it requires propagation to all participating clusters. The eviction policy starts to evict keys when one of the Active-Active instances reaches 80% of its memory limit.
</div>
</div>
<h3 id="redis-on-flash-sizing">
Sizing databases with Auto Tiering enabled
</h3>
<p>
Additional factors for sizing databases with Auto Tiering enabled:
</p>
<ul>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/configure/database-persistence/#redis-on-flash-data-persistence">
<strong>
Database persistence
</strong>
</a>
– Auto Tiering uses dual database persistence where both the primary and replica shards persist to disk. This may add some processor and network overhead, especially in cloud configurations with network-attached storage.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/hardware-requirements/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/interact/search-and-query/deprecated/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Deprecated
</h1>
<p class="text-lg -mt-5 mb-10">
Deprecated features
</p>
<nav>
<a href="/docs/latest/develop/interact/search-and-query/deprecated/development/">
Developer notes
</a>
<p>
Notes on RediSearch debugging, testing, and documentation
</p>
<a href="/docs/latest/develop/interact/search-and-query/deprecated/payloads/">
Document payloads
</a>
<p>
Payload support(deprecated)
</p>
</nav>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/interact/search-and-query/deprecated/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.52.0/.html | <section class="prose w-full py-12">
<h1>
Redis Insight v2.52.0, June 2024
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Insight v2.52
</p>
<h2 id="252-june-2024">
2.52 (June 2024)
</h2>
<p>
This is the General Availability (GA) release of Redis Insight 2.52.
</p>
<h3 id="highlights">
Highlights
</h3>
<ul>
<li>
Redis Insight now supports
<a href="https://redis.io/docs/latest/develop/data-types/hashes/?utm_source=redisinsight&utm_medium=release_notes&utm_campaign=2.52#field-expiration">
setting expiration for individual hash fields
</a>
, a highly requested feature available in the
<a href="https://github.com/redis-stack/redis-stack/releases/tag/v7.4.0-rc1">
first release candidate of Redis 7.4
</a>
</li>
<li>
Learn how to leverage Redis for Retrieval Augmented Generation (RAG) use cases via a new built-in Redis Insight tutorial
</li>
</ul>
<h3 id="details">
Details
</h3>
<p>
<strong>
Features and improvements
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3470">
#3470
</a>
Redis Insight now supports
<a href="https://redis.io/docs/latest/develop/data-types/hashes/?utm_source=redisinsight&utm_medium=release_notes&utm_campaign=2.52#field-expiration">
setting expiration for individual hash fields
</a>
through intuitive Browser controls. The hash field expiration is a highly requested feature available in the
<a href="https://github.com/redis-stack/redis-stack/releases/tag/v7.4.0-rc1">
first release candidate of Redis 7.4
</a>
.
</li>
<li>
<a href="https://github.com/RedisInsight/Tutorials/pull/60">
#60
</a>
Redis, with its high performance and versatile data structures, is an excellent choice for implementing Retrieval Augmented Generation (RAG). Our new built-in tutorial provides an overview of how Redis can be leveraged in a RAG use case. To get started, open the "Insights" panel in the top right corner and try the new tutorial.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3447">
#3447
</a>
,
<a href="https://github.com/RedisInsight/RedisInsight/pull/3483">
#3483
</a>
UX optimizations for displaying the values of keys in the Browser. The new layout includes controls for editing key values that appear only when you hover over them, optimizing the use of space and providing a cleaner interface.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3231">
#3231
</a>
Support for applying the JSON formatting in Browser for values of keys with float numbers that contain 10 or more decimal places.
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3492">
#3492
</a>
Increased the slot refresh timeout to 5000 milliseconds to enhance connection stability for clustered databases. This adjustment helps avoid scenarios where a connection is terminated before the acknowledgment of a successful connection establishment is received.
</li>
</ul>
<p>
<strong>
Bugs
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/3490">
#3490
</a>
Fix for an issue related to adding a JSON field to a key that already contains many fields.
</li>
</ul>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.52.0/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/kubernetes/release-notes/6-2-18-releases/k8s-6-2-18-41-jan-2023/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise for Kubernetes release notes 6.2.18-41 (Jan 2023)
</h1>
<p class="text-lg -mt-5 mb-10">
This is a maintenance release for 6.2.18 and includes support for Redis Enterprise 6.2.18-72.
</p>
<h2 id="overview">
Overview
</h2>
<p>
This is a maintenance release of Redis Enterprise for Kubernetes 6.2.18-41 that adds supports for Redis Enterprise 6.2.18-72.
</p>
<p>
New images and fixes are listed below. Refer to
<a href="/docs/latest/operate/kubernetes/release-notes/6-2-18-releases/k8s-6-2-18-41/">
6.2.18-41 (Dec 2022
</a>
for compatibility notes and known limitations.
</p>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Warning:
</div>
<p>
Due to a change in the SCC, on OpenShift clusters running version 6.2.12 or earlier upgrading to version 6.2.18 or later, where
<code>
node:1
</code>
is
<b>
not
</b>
the master node, the upgrade might get stuck.
</p>
<p>
For more info and steps to prevent this issue, see
<a href="/docs/latest/operate/kubernetes/upgrade/upgrade-redis-cluster/#before-upgrading">
upgrade a Redis Enterprise cluster (REC)
</a>
.
</p>
</div>
</div>
<h2 id="images">
Images
</h2>
<p>
DockerHub images are available at
<code>
docker.io/
</code>
.
</p>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
redislabs/redis:6.2.18-72
</code>
</li>
<li>
<strong>
Operator
</strong>
:
<code>
redislabs/operator:6.2.18-41
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
redislabs/k8s-controller:6.2.18-41
</code>
</li>
</ul>
<h3 id="openshift-images">
OpenShift images
</h3>
<p>
<strong>
OLM operator version
</strong>
:
<code>
v6.2.18-41c
</code>
</p>
<ul>
<li>
<strong>
Redis Enterprise
</strong>
:
<code>
registry.connect.redhat.com/redislabs/redis-enterprise:6.2.18-72.rhel8-openshift
</code>
(or
<code>
registry.connect.redhat.com/redislabs/redis-enterprise:6.2.18-72.rhel7-openshift
</code>
if upgrading from RHEL 7)
</li>
<li>
<strong>
Operator
</strong>
:
<code>
registry.connect.redhat.com/redislabs/redis-enterprise-operator:6.2.18-41
</code>
</li>
<li>
<strong>
Services Rigger
</strong>
:
<code>
registry.connect.redhat.com/redislabs/services-manager:6.2.18-41
</code>
</li>
</ul>
<h2 id="feature-enhancements">
Feature enhancements
</h2>
<ul>
<li>
Upgraded to support Redis Enterprise 6.2.18-72
</li>
</ul>
<h2 id="compatibility-notes">
Compatibility notes
</h2>
<p>
See
<a href="/docs/latest/operate/kubernetes/release-notes/6-2-18-releases/k8s-6-2-18-41/">
Redis Enterprise for Kubernetes release notes 6.2.18-41 (Dec 2022)
</a>
.
</p>
<h2 id="before-upgrading">
Before upgrading
</h2>
<p>
Be aware the following changes included in this release affect the upgrade process. Please read carefully before upgrading.
</p>
<h3 id="supported-upgrade-paths">
Supported upgrade paths
</h3>
<p>
If you are using a version earlier than 6.2.10-45, you cannot upgrade directly to this release. You must upgrade to 6.2.10-45 before you can upgrade to versions 6.2.18 or later.
</p>
<h2 id="known-limitations">
Known limitations
</h2>
<p>
See
<a href="/docs/latest/operate/kubernetes/release-notes/6-2-18-releases/k8s-6-2-18-41/">
Redis Enterprise for Kubernetes release notes 6.2.18-41 (Dec 2022)
</a>
.
</p>
<h2 id="security">
Security
</h2>
<p>
For a list of fixes related to CVEs, see the
<a href="/docs/latest/operate/rs/release-notes/rs-6-2-18-releases/rs-6-2-18-70/#security">
Redis Enterprise 6.2.18-72 release notes
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/kubernetes/release-notes/6-2-18-releases/k8s-6-2-18-41-jan-2023/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Database CRDT sources alerts requests
</h1>
<p class="text-lg -mt-5 mb-10">
Conflict-free replicated data type (CRDT) source alert requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-bdbs-crdt-sources-alerts">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/crdt_sources/alerts
</code>
</td>
<td>
Get all CRDT sources alert states for all CRDB databases
</td>
</tr>
<tr>
<td>
<a href="#get-bdbs-crdt-sources-alerts">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/crdt_sources/alerts/{uid}
</code>
</td>
<td>
Get all CRDT sources alert states for a database
</td>
</tr>
<tr>
<td>
<a href="#get-bdbs-crdt-source-all-alerts">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/crdt_sources/alerts/{uid}/{crdt_src_id}
</code>
</td>
<td>
Get all alert states for a CRDT source
</td>
</tr>
<tr>
<td>
<a href="#get-bdbs-crdt-source-alert">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/crdt_sources/alerts/{uid}/{crdt_src_id}/{alert}
</code>
</td>
<td>
Get a database alert state
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-bdbs-crdt-sources-alerts">
Get all CRDB CRDT source alert states
</h2>
<pre><code>GET /v1/bdbs/crdt_sources/alerts
</code></pre>
<p>
Get all alert states for all CRDT sources of all CRDBs.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_all_bdbs_alerts">
view_all_bdbs_alerts
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /bdbs/crdt_sources/alerts
</code></pre>
<h4 id="request-headers">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a hash of alert UIDs and the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/alert/">
alerts states
</a>
for each local BDB of CRDB.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"1"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"crdt_src_syncer_connection_error"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_time"</span><span class="p">:</span> <span class="s2">"2014-08-29T11:19:49Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"severity"</span><span class="p">:</span> <span class="s2">"WARNING"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_value"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"memory_util"</span><span class="p">:</span> <span class="mf">81.2</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"..."</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-all-status-codes">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
</tbody>
</table>
<h2 id="get-bdbs-crdt-sources-alerts">
Get all BDB CRDT sources alert states
</h2>
<pre><code>GET /v1/bdbs/crdt_sources/alerts/{int: uid}
</code></pre>
<p>
Get all alert states for all crdt sources for a specific local bdb of a CRDB.
</p>
<h4 id="required-permissions-1">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_bdb_alerts">
view_bdb_alerts
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request-all-crdt-alerts">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>GET /bdbs/crdt_sources/alerts/1
</code></pre>
<h4 id="request-headers-1">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The unique ID of the database
</td>
</tr>
</tbody>
</table>
<h3 id="get-response-all-crdt-alerts">
Response
</h3>
<p>
Returns a hash of
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/alert/">
alert objects
</a>
and their states.
</p>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"crdt_src_syncer_connection_error"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"severity"</span><span class="p">:</span> <span class="s2">"WARNING"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_time"</span><span class="p">:</span> <span class="s2">"2014-08-29T11:19:49Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_value"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"memory_util"</span><span class="p">:</span> <span class="mf">81.2</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes-all-crdt-alerts">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Specified bdb does not exist
</td>
</tr>
</tbody>
</table>
<h2 id="get-bdbs-crdt-source-all-alerts">
Get all CRDT source alert states
</h2>
<pre><code>GET /v1/bdbs/crdt_sources/alerts/{int: uid}/{int: crdt_src_id}
</code></pre>
<p>
Get all alert states for specific crdt source for a specific local BDB
of a CRDB.
</p>
<h4 id="required-permissions-2">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_bdb_alerts">
view_bdb_alerts
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request-crdt-alerts">
Request
</h3>
<h4 id="example-http-request-2">
Example HTTP request
</h4>
<pre><code>GET /bdbs/crdt_sources/alerts/1/2
</code></pre>
<h4 id="request-headers-2">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters-1">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The unique ID of the database
</td>
</tr>
<tr>
<td>
crdt_src_id
</td>
<td>
integer
</td>
<td>
The ID of the crdt source in this BDB
</td>
</tr>
</tbody>
</table>
<h3 id="get-response-crdt-alerts">
Response
</h3>
<p>
Returns a hash of
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/alert/">
alert objects
</a>
and their states.
</p>
<h4 id="example-json-body-2">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"crdt_src_syncer_connection_error"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"severity"</span><span class="p">:</span> <span class="s2">"WARNING"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_time"</span><span class="p">:</span> <span class="s2">"2014-08-29T11:19:49Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_value"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"memory_util"</span><span class="p">:</span> <span class="mf">81.2</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes-crdt-alerts">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Specified bdb does not exist
</td>
</tr>
</tbody>
</table>
<h2 id="get-bdbs-crdt-source-alert">
Get database alert state
</h2>
<pre><code>GET /v1/bdbs/crdt_sources/alerts/{int: uid}/{int: crdt_src_id}/{alert}
</code></pre>
<p>
Get a BDB alert state.
</p>
<h4 id="required-permissions-3">
Required permissions
</h4>
<table>
<thead>
<tr>
<th>
Permission name
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/permissions/#view_bdb_alerts">
view_bdb_alerts
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request-alert">
Request
</h3>
<h4 id="example-http-request-3">
Example HTTP request
</h4>
<pre><code>GET /bdbs/crdt_sources/alerts/1/2/crdt_src_syncer_connection_error
</code></pre>
<h4 id="request-headers-3">
Request headers
</h4>
<table>
<thead>
<tr>
<th>
Key
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Host
</td>
<td>
cnm.cluster.fqdn
</td>
<td>
Domain name
</td>
</tr>
<tr>
<td>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h4 id="url-parameters-2">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer
</td>
<td>
The unique ID of the database
</td>
</tr>
<tr>
<td>
crdt_src_id
</td>
<td>
integer
</td>
<td>
The ID of the crdt source in this BDB
</td>
</tr>
<tr>
<td>
alert
</td>
<td>
string
</td>
<td>
The alert name
</td>
</tr>
</tbody>
</table>
<h3 id="get-response-alert">
Response
</h3>
<p>
Returns an
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/alert/">
alert object
</a>
.
</p>
<h4 id="example-json-body-3">
Example JSON body
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"enabled"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"severity"</span><span class="p">:</span> <span class="s2">"WARNING"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_time"</span><span class="p">:</span> <span class="s2">"2014-08-29T11:19:49Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"change_value"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"state"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"threshold"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"memory_util"</span><span class="p">:</span> <span class="mf">81.2</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h3 id="get-status-codes-alert">
Status codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">
200 OK
</a>
</td>
<td>
No error
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Bad request
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Specified alert or bdb does not exist
</td>
</tr>
</tbody>
</table>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/operate/rc/databases/create-database/create-pro-database-new/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Create a Pro database with a new subscription
</h1>
<p class="text-lg -mt-5 mb-10">
Shows how to create a Pro database with a new subscription
</p>
<p>
Before creating a Redis Cloud database, you need to
<a href="/docs/latest/operate/rc/rc-quickstart/">
create an account
</a>
.
</p>
<p>
To create a database in your Redis Cloud account:
</p>
<ol>
<li>
<p>
Sign in to the
<a href="https://cloud.redis.io">
Redis Cloud console
</a>
.
</p>
</li>
<li>
<p>
Select the
<strong>
New database
</strong>
button.
</p>
<a href="/docs/latest/images/rc/button-database-new.png" sdata-lightbox="/images/rc/button-database-new.png">
<img alt="The New Database button creates a new database." src="/docs/latest/images/rc/button-database-new.png" width="120px"/>
</a>
<p>
This displays the
<strong>
Create database
</strong>
screen.
</p>
</li>
<li>
<p>
Select your Redis use case. There are four pre-defined use cases:
</p>
<a href="/docs/latest/images/rc/create-database-redis-use-cases.png" sdata-lightbox="/images/rc/create-database-redis-use-cases.png">
<img alt="The Redis Use case panel" src="/docs/latest/images/rc/create-database-redis-use-cases.png"/>
</a>
<ul>
<li>
<strong>
Cache
</strong>
: Stores short-term or volatile data. Can be used for session management, semantic cache, session store, and other uses where data is short-lived.
</li>
<li>
<strong>
Database
</strong>
: Stores durable and consistent data. Can be used for document databases, feature storage, gaming leaderboards, durable caches, and other uses where your data needs to be highly available and persistent.
</li>
<li>
<strong>
Vector search
</strong>
: Manages and manipulates vector data. Can be used for Generative AI, recommendation systems, visual search, and other uses where you can search and query your data.
</li>
<li>
<strong>
Custom
</strong>
: If your Redis use case doesn't match any of the other use cases, you can choose this option to customize all of your settings.
</li>
</ul>
<p>
Select the use case that best matches your Redis use case. You can always change the settings later.
</p>
</li>
</ol>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
See
<a href="#use-case-settings">
Use case settings
</a>
to view the default settings for each use case.
</div>
</div>
<ol start="4">
<li>
<p>
Select the type of
<a href="/docs/latest/operate/rc/subscriptions/">
subscription
</a>
you need. For this guide, select
<strong>
Pro
</strong>
.
</p>
<a href="/docs/latest/images/rc/create-database-subscription-pro-new.png" sdata-lightbox="/images/rc/create-database-subscription-pro-new.png">
<img alt="The Subscription selection panel with Pro selected." src="/docs/latest/images/rc/create-database-subscription-pro-new.png"/>
</a>
<div class="alert p-3 relative flex flex-row items-center text-base bg-redis-pencil-200 rounded-md">
<div class="p-2 pr-5">
<svg fill="none" height="21" viewbox="0 0 21 21" width="21" xmlns="http://www.w3.org/2000/svg">
<circle cx="10.5" cy="10.5" r="9.75" stroke="currentColor" stroke-width="1.5">
</circle>
<path d="M10.5 14V16" stroke="currentColor" stroke-width="2">
</path>
<path d="M10.5 5V12" stroke="currentColor" stroke-width="2">
</path>
</svg>
</div>
<div class="p-1 pl-6 border-l border-l-redis-ink-900 border-opacity-50">
<div class="font-medium">
Note:
</div>
<p>
This guide shows how to create a Pro database with a new subscription.
</p>
<ul>
<li>
If you already have a Pro subscription and want to add a database to it, see
<a href="/docs/latest/operate/rc/databases/create-database/create-pro-database-existing/">
Create a Pro database in an existing subscription
</a>
.
</li>
<li>
If you'd rather create an Essentials database, see
<a href="/docs/latest/operate/rc/databases/create-database/create-essentials-database/">
Create an Essentials database
</a>
.
</li>
</ul>
</div>
</div>
</li>
</ol>
<p>
After you select
<strong>
Pro
</strong>
, the
<strong>
Database settings
</strong>
section will appear.
</p>
<a href="/docs/latest/images/rc/create-pro-db-settings.png" sdata-lightbox="/images/rc/create-pro-db-settings.png">
<img alt="The database settings section." src="/docs/latest/images/rc/create-pro-db-settings.png"/>
</a>
<p>
You can choose to create your database in one of two ways:
</p>
<ul>
<li>
<a href="#easy-create">
<strong>
Easy create
</strong>
</a>
selects the optimal settings for your use case for you.
</li>
<li>
<a href="#custom-settings">
<strong>
Custom settings
</strong>
</a>
lets you select all of the configuration options for your new database.
</li>
</ul>
<h2 id="easy-create">
Create database with Easy create
</h2>
<p>
If you choose to create your database with Easy create:
</p>
<a href="/docs/latest/images/rc/pro-easy-create-vendor.png" sdata-lightbox="/images/rc/pro-easy-create-vendor.png">
<img alt="The database name, cloud vendor and region settings." src="/docs/latest/images/rc/pro-easy-create-vendor.png"/>
</a>
<ol>
<li>
<p>
Redis will generate a database name for you. If you want to change it, you can do so in the
<strong>
Database name
</strong>
field.
</p>
</li>
<li>
<p>
Choose a
<strong>
Cloud Provider
</strong>
and a
<strong>
Region
</strong>
.
</p>
</li>
<li>
<p>
Enter the following settings for your database:
</p>
<a href="/docs/latest/images/rc/pro-easy-create-size-throughput.png" sdata-lightbox="/images/rc/pro-easy-create-size-throughput.png">
<img alt="The Dataset size, throughput, and High availability settings." src="/docs/latest/images/rc/pro-easy-create-size-throughput.png"/>
</a>
<table>
<thead>
<tr>
<th style="text-align:left">
Database setting
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<strong>
Dataset size (GB)
</strong>
</td>
<td style="text-align:left">
The amount of data for your dataset. Specify small sizes as decimals of 1.0 GB; example:
<code>
0.1
</code>
GB (minimum). We calculate the total memory limit for you based on the other settings you choose for your database.
<br/>
Databases with Search and query have specific sizing requirements, see
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#search-and-query-sizing">
Search and query sizing
</a>
for more information.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Throughput
</strong>
</td>
<td style="text-align:left">
Identifies maximum throughput for the database, which is specified in terms of operations per second (
<strong>
Ops/sec
</strong>
). See
<a href="/docs/latest/operate/rc/databases/configuration/clustering/#throughput">
Throughput
</a>
for more information.
<br/>
Databases with Search and query have specific throughput requirements, see
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#search-and-query-sizing">
Search and query sizing
</a>
for more information.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
High Availability
</strong>
</td>
<td style="text-align:left">
Indicates whether a replica copy of the database is maintained in case the primary database becomes unavailable. (Warning: doubles memory consumption). See
<a href="/docs/latest/operate/rc/databases/configuration/high-availability/">
High Availability
</a>
.
</td>
</tr>
</tbody>
</table>
</li>
<li>
<p>
Select
<strong>
View all settings
</strong>
to review the database settings that we selected for you based on your use case.
</p>
<a href="/docs/latest/images/rc/pro-easy-create-optimal-settings.png" sdata-lightbox="/images/rc/pro-easy-create-optimal-settings.png">
<img alt="The optimal database settings." src="/docs/latest/images/rc/pro-easy-create-optimal-settings.png"/>
</a>
<p>
If you want to change these settings, select
<a href="#custom-settings">
<strong>
Switch to custom settings
</strong>
</a>
.
</p>
</li>
<li>
<p>
Enter your payment details.
</p>
<p>
If you haven't previously entered a payment method, use the
<strong>
Add Credit Card
</strong>
button to add one.
</p>
<a href="/docs/latest/images/rc/icon-add-credit-card.png" sdata-lightbox="/images/rc/icon-add-credit-card.png">
<img alt="The Add credit card icon." src="/docs/latest/images/rc/icon-add-credit-card.png"/>
</a>
</li>
</ol>
<p>
Select
<strong>
Confirm & pay
</strong>
to create your database.
</p>
<a href="/docs/latest/images/rc/button-create-db-confirm-pay.png" sdata-lightbox="/images/rc/button-create-db-confirm-pay.png">
<img alt="Select Confirm & Pay to create your new database." src="/docs/latest/images/rc/button-create-db-confirm-pay.png" width="140px"/>
</a>
<p>
Note that databases are created in the background. While they are provisioning, you aren't allowed to make changes. This process generally takes 10-15 minutes.
</p>
<p>
Use the
<strong>
Database list
</strong>
to check the status of your databases.
</p>
<h2 id="custom-settings">
Create database with Custom settings
</h2>
<a href="/docs/latest/images/rc/create-pro-db-settings-custom.png" sdata-lightbox="/images/rc/create-pro-db-settings-custom.png">
<img alt="The database settings section, with custom settings selected." src="/docs/latest/images/rc/create-pro-db-settings-custom.png"/>
</a>
<p>
If you choose to create your database with custom settings, you need to:
</p>
<ol>
<li>
<p>
Set up the deployment options, including cloud vendor details, high availability settings, and advanced options.
</p>
</li>
<li>
<p>
Define the database size requirements.
</p>
</li>
<li>
<p>
Review your choices, provide payment details, and then create your databases.
</p>
</li>
</ol>
<p>
The following sections provide more information.
</p>
<h3 id="set-up-deployment-details">
Set up deployment details
</h3>
<p>
The
<strong>
Setup
</strong>
tab specifies general settings for your Redis deployment.
</p>
<a href="/docs/latest/images/rc/subscription-new-flexible-tabs-setup.png" sdata-lightbox="/images/rc/subscription-new-flexible-tabs-setup.png">
<img alt="The Setup tab of the new Pro Database process." src="/docs/latest/images/rc/subscription-new-flexible-tabs-setup.png" width="75%"/>
</a>
<p>
There are three sections on this tab:
</p>
<ul>
<li>
<a href="#general-settings">
General settings
</a>
include the cloud provider details and specific configuration options.
</li>
<li>
<a href="#version">
Version
</a>
lets you choose the Redis version of your databases.
</li>
<li>
<a href="#advanced-options">
Advanced options
</a>
define settings for high availability and security. Configurable settings vary according to cloud provider.
</li>
</ul>
<h4 id="general-settings">
General settings
</h4>
<a href="/docs/latest/images/rc/subscription-new-flexible-setup-general.png" sdata-lightbox="/images/rc/subscription-new-flexible-setup-general.png">
<img alt="The General settings of the Setup tab." src="/docs/latest/images/rc/subscription-new-flexible-setup-general.png" width="75%"/>
</a>
<p>
The following settings are defined in the
<strong>
General settings
</strong>
of the
<strong>
Setup
</strong>
tab:
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
General setting
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<strong>
Cloud vendor
</strong>
</td>
<td style="text-align:left">
The public cloud vendor to deploy your databases. (
<em>
required
</em>
)
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Region
</strong>
</td>
<td style="text-align:left">
The vendor region where you wish to deploy your databases. (
<em>
required
</em>
)
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Active-Active Redis
</strong>
</td>
<td style="text-align:left">
Hosts your datasets in multiple read-write locations to support distributed applications and disaster recovery. See
<a href="/docs/latest/operate/rc/databases/create-database/create-active-active-database/">
Create an Active-Active database
</a>
for specific steps and configuration options exclusive to Active-Active.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Auto Tiering
</strong>
</td>
<td style="text-align:left">
Determines if your databases are stored only in memory (RAM) or are split between memory and Flash storage (RAM+Flash). See
<a href="/docs/latest/operate/rs/databases/auto-tiering/">
Auto Tiering
</a>
</td>
</tr>
</tbody>
</table>
<h4 id="version">
Version
</h4>
<a href="/docs/latest/images/rc/subscription-new-flexible-version-section.png" sdata-lightbox="/images/rc/subscription-new-flexible-version-section.png">
<img alt="Version selection between Redis 6.2, 7.2, and 7.4." src="/docs/latest/images/rc/subscription-new-flexible-version-section.png" width="75%"/>
</a>
<p>
The
<strong>
Version
</strong>
section lets you choose the Redis version of your databases. Choose
<strong>
Redis 7.2
</strong>
if you want to use the latest stable version of Redis, or select
<strong>
Redis 7.4
</strong>
for the Redis 7.4 Preview.
</p>
<p>
Redis 7.4 offers hash field expiration and other feature set improvements. For more information on the changes in Redis 7.4, see the
<a href="https://redis.io/blog/announcing-redis-community-edition-and-redis-stack-74">
Redis 7.4 release notes
</a>
.
</p>
<h4 id="advanced-options">
Advanced options
</h4>
<a href="/docs/latest/images/rc/subscription-new-flexible-setup-advanced.png" sdata-lightbox="/images/rc/subscription-new-flexible-setup-advanced.png">
<img alt="The Advanced settings of the Setup tab." src="/docs/latest/images/rc/subscription-new-flexible-setup-advanced.png" width="75%"/>
</a>
<p>
The following settings are defined in the
<strong>
Advanced options
</strong>
of the
<strong>
Setup
</strong>
tab:
</p>
<table>
<thead>
<tr>
<th>
Advanced option
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Multi-AZ
</strong>
</td>
<td>
Determines if replication spans multiple Availability Zones, which provides automatic failover when problems occur. See
<a href="/docs/latest/operate/rc/databases/configuration/high-availability/">
High Availability
</a>
.
</td>
</tr>
<tr>
<td>
<strong>
Allowed Availability Zones
</strong>
</td>
<td>
The availability zones for your selected region.
<br/>
<br/>
If you choose
<strong>
Manual selection
</strong>
, you must select at least one zone ID from the
<strong>
Zone IDs
</strong>
list. For more information, see
<a href="/docs/latest/operate/rc/databases/configuration/high-availability/#availability-zones">
Availability zones
</a>
.
</td>
</tr>
<tr>
<td>
<strong>
Cloud account
</strong>
</td>
<td>
To deploy these databases to an existing cloud account, select it here. Use the
<strong>
Add
</strong>
button to add a new cloud account.
<br/>
<br/>
(Available only if
<a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/">
self-managed cloud vendor accounts
</a>
are enabled)
</td>
</tr>
<tr>
<td>
<strong>
VPC configuration
</strong>
</td>
<td>
Select
<strong>
In a new VPC
</strong>
to deploy to a new
<a href="https://en.wikipedia.org/wiki/Virtual_private_cloud">
virtual private cloud
</a>
(VPC).
<br/>
<br/>
To deploy these databases to an existing virtual private cloud, select
<strong>
In existing VPC
</strong>
and then set VPC ID to the appropriate ID value.
<br/>
<br/>
(Available only if
<a href="/docs/latest/operate/rc/cloud-integrations/aws-cloud-accounts/">
self-managed cloud vendor accounts
</a>
are enabled)
</td>
</tr>
<tr>
<td>
<strong>
Deployment CIDR
</strong>
</td>
<td>
The
<a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">
CIDR
</a>
range of IP addresses for your deployment. Redis creates a new
<a href="https://en.wikipedia.org/wiki/Subnetwork">
subnet
</a>
for the
<strong>
Deployment CIDR
</strong>
in your
<a href="https://en.wikipedia.org/wiki/Virtual_private_cloud">
virtual private cloud
</a>
(VPC). It cannot overlap with the CIDR ranges of other subnets used by your account.
<br/>
<br/>
For deployments in an existing VPC, the
<strong>
Deployment CIDR
</strong>
must be within your VPC's
<strong>
primary
</strong>
CIDR range (secondary CIDRs are not supported).
</td>
</tr>
<tr>
<td>
<strong>
Maintenance windows
</strong>
</td>
<td>
Determines when Redis can perform
<a href="/docs/latest/operate/rc/subscriptions/maintenance/">
maintenance
</a>
on your databases. Select
<strong>
Manual
</strong>
if you want to set
<a href="/docs/latest/operate/rc/subscriptions/maintenance/set-maintenance-windows/">
manual maintenance windows
</a>
.
</td>
</tr>
</tbody>
</table>
<p>
When finished, choose
<strong>
Continue
</strong>
to determine your size requirements.
</p>
<a href="/docs/latest/images/rc/button-subscription-continue.png" sdata-lightbox="/images/rc/button-subscription-continue.png">
<img alt="Select the Continue button to continue to the next step." src="/docs/latest/images/rc/button-subscription-continue.png" width="100px"/>
</a>
<h3 id="sizing-tab">
Sizing tab
</h3>
<p>
The
<strong>
Sizing
</strong>
tab helps you specify the database, memory, and throughput requirements for your subscription.
</p>
<a href="/docs/latest/images/rc/subscription-new-flexible-sizing-tab.png" sdata-lightbox="/images/rc/subscription-new-flexible-sizing-tab.png">
<img alt="The Sizing tab when creating a new Pro subscription." src="/docs/latest/images/rc/subscription-new-flexible-sizing-tab.png" width="75%"/>
</a>
<p>
When you first visit the
<strong>
Sizing
</strong>
tab, there are no databases defined. Select the
<strong>
Add
</strong>
button to create one.
</p>
<a href="/docs/latest/images/rc/icon-add-database.png" sdata-lightbox="/images/rc/icon-add-database.png">
<img alt="Use the Add button to define a new database for your subscription." src="/docs/latest/images/rc/icon-add-database.png" width="30px"/>
</a>
<p>
This opens the
<strong>
New Database
</strong>
dialog, which lets you define the requirements for your new database.
</p>
<a href="/docs/latest/images/rc/flexible-add-database-basic.png" sdata-lightbox="/images/rc/flexible-add-database-basic.png">
<img alt="The New Database dialog with basic settings." src="/docs/latest/images/rc/flexible-add-database-basic.png" width="75%"/>
</a>
<p>
By default, you're shown basic settings, which include:
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Database setting
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<strong>
Name
</strong>
</td>
<td style="text-align:left">
A custom name for your database (
<em>
required
</em>
)
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Advanced Capabilities
</strong>
</td>
<td style="text-align:left">
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/">
Advanced data types
</a>
used by the database. Choose from
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/search/">
Search and query
</a>
,
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/json/">
JSON
</a>
,
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/timeseries/">
Time series
</a>
, or
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/bloom/">
Probabilistic
</a>
.
<br/>
Databases with Search and query have specific sizing requirements, see
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#search-and-query-sizing">
Search and query sizing
</a>
for more information.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Query performance factor
</strong>
</td>
<td style="text-align:left">
<em>
(Search and query databases only)
</em>
Adds additional compute power to process your query and vector search workloads and boost your queries per second. See
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#search-and-query-sizing">
Search and query sizing
</a>
for more information.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Throughput
</strong>
</td>
<td style="text-align:left">
Identifies maximum throughput for the database, which is specified in terms of operations per second (
<strong>
Ops/sec
</strong>
). See
<a href="/docs/latest/operate/rc/databases/configuration/clustering/#throughput">
Throughput
</a>
for more information.
<br/>
Databases with Search and query have specific throughput requirements, see
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#search-and-query-sizing">
Search and query sizing
</a>
for more information.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Dataset size (GB)
</strong>
</td>
<td style="text-align:left">
The amount of data for your dataset. Specify small sizes as decimals of 1.0 GB; example:
<code>
0.1
</code>
GB (minimum). We calculate the total memory limit for you based on the other settings you choose for your database.
<br/>
Databases with Search and query have specific sizing requirements, see
<a href="/docs/latest/operate/rc/databases/configuration/advanced-capabilities/#search-and-query-sizing">
Search and query sizing
</a>
for more information.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
High Availability
</strong>
</td>
<td style="text-align:left">
Indicates whether a replica copy of the database is maintained in case the primary database becomes unavailable. (Warning: Doubles memory consumption). See
<a href="/docs/latest/operate/rc/databases/configuration/high-availability/">
High Availability
</a>
.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Data Persistence
</strong>
</td>
<td style="text-align:left">
Defines the data persistence policy, if any. See
<a href="/docs/latest/operate/rc/databases/configuration/data-persistence/">
Data persistence
</a>
.
</td>
</tr>
</tbody>
</table>
<p>
Select
<strong>
More options
</strong>
to specify values for the following settings.
</p>
<a href="/docs/latest/images/rc/flexible-add-database-advanced.png" sdata-lightbox="/images/rc/flexible-add-database-advanced.png">
<img alt="The New Database dialog with advanced settings." src="/docs/latest/images/rc/flexible-add-database-advanced.png" width="75%"/>
</a>
<table>
<thead>
<tr>
<th style="text-align:left">
Database option
</th>
<th style="text-align:left">
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<strong>
OSS Cluster API
</strong>
</td>
<td style="text-align:left">
Enable to use the
<a href="/docs/latest/operate/rc/databases/configuration/clustering/#oss-cluster-api">
Redis Cluster API
</a>
.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Type
</strong>
</td>
<td style="text-align:left">
Set to
<strong>
Redis
</strong>
, otherwise
<strong>
Memcached
</strong>
database for legacy database support.
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Supported Protocol(s)
</strong>
</td>
<td style="text-align:left">
Choose between RESP2 and RESP3
<em>
(Redis 7.2 only)
</em>
. See
<a href="/docs/latest/develop/reference/protocol-spec/#resp-versions">
Redis serialization protocol
</a>
for details
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Quantity
</strong>
</td>
<td style="text-align:left">
Number of databases to create with these settings.
</td>
</tr>
</tbody>
</table>
<p>
When finished, select
<strong>
Save configuration
</strong>
to save your database configuration.
</p>
<a href="/docs/latest/images/rc/button-configuration-save.png" sdata-lightbox="/images/rc/button-configuration-save.png">
<img alt="Select the Save configuration button to define your new database." src="/docs/latest/images/rc/button-configuration-save.png" width="140px"/>
</a>
<p>
Use the
<strong>
Add database
</strong>
button to define additional databases or select the
<strong>
Continue button
</strong>
to display the
<strong>
Review and create
</strong>
tab.
</p>
<p>
Hover over a database to see the
<strong>
Edit
</strong>
and
<strong>
Delete
</strong>
icons. You can use the
<strong>
Edit
</strong>
icon to change a database or the
<strong>
Delete
</strong>
icon to remove a database from the list.
</p>
<p>
<a href="/docs/latest/images/rc/icon-database-edit.png#no-click" sdata-lightbox="/images/rc/icon-database-edit.png#no-click">
<img alt="Use the Edit button to change database settings." class="inline" src="/docs/latest/images/rc/icon-database-edit.png#no-click" width="30px"/>
</a>
<a href="/docs/latest/images/rc/icon-database-delete.png#no-click" sdata-lightbox="/images/rc/icon-database-delete.png#no-click">
<img alt="Use the Delete button to remove a database." class="inline" src="/docs/latest/images/rc/icon-database-delete.png#no-click" width="30px"/>
</a>
</p>
<h3 id="review-and-create-tab">
Review and Create tab
</h3>
<p>
The
<strong>
Review & Create
</strong>
tab provides a cost estimate for your Redis Cloud Pro plan:
</p>
<a href="/docs/latest/images/rc/subscription-new-flexible-review.png" sdata-lightbox="/images/rc/subscription-new-flexible-review.png">
<img alt="The Review & Create tab of the New Flexible subscription screen." src="/docs/latest/images/rc/subscription-new-flexible-review.png" width="75%"/>
</a>
<p>
Redis breaks down your databases to Redis Billing Units (RBUs), each with their own size and throughput requirements. For more info, see
<a href="#billing-unit-types">
Billing unit types
</a>
.
</p>
<p>
Select
<strong>
Back to Sizing
</strong>
to make changes or
<strong>
Confirm & Pay
</strong>
to create your databases.
</p>
<a href="/docs/latest/images/rc/button-create-db-confirm-pay.png" sdata-lightbox="/images/rc/button-create-db-confirm-pay.png">
<img alt="Select Confirm & pay to create your database." src="/docs/latest/images/rc/button-create-db-confirm-pay.png" width="140px"/>
</a>
<p>
Note that databases are created in the background. While they are provisioning, you aren't allowed to make changes. This process generally takes 10-15 minutes.
</p>
<p>
Use the
<strong>
Database list
</strong>
to check the status of your databases.
</p>
<h2 id="use-case-settings">
Use case settings
</h2>
<p>
The following table shows the default use case settings for a Pro database.
</p>
<table>
<thead>
<tr>
<th>
<strong>
Type
</strong>
</th>
<th>
High Availability
</th>
<th>
Data Persistence
</th>
<th>
Eviction Policy
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Cache
</strong>
</td>
<td>
Single-zone
</td>
<td>
None
</td>
<td>
<code>
volatile-lru
</code>
</td>
</tr>
<tr>
<td>
<strong>
Database
</strong>
</td>
<td>
Multi-zone
</td>
<td>
Append-only file every 1 sec
</td>
<td>
None
</td>
</tr>
<tr>
<td>
<strong>
Vector Search
</strong>
</td>
<td>
Multi-zone
</td>
<td>
Append-only file every 1 sec
</td>
<td>
None
</td>
</tr>
<tr>
<td>
<strong>
Custom
</strong>
</td>
<td>
Single-zone
</td>
<td>
Append-only file every 1 sec
</td>
<td>
None
</td>
</tr>
</tbody>
</table>
<h2 id="billing-unit-types">
Billing Unit types
</h2>
<p>
The Redis Billing Unit types associated with your Pro subscription depend on your database memory size and throughput requirements.
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
Billing unit type
</th>
<th style="text-align:left">
Capacity (Memory/Throughput)
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
Nano
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</td>
<td style="text-align:left">
500MB / 500 ops/sec
</td>
</tr>
<tr>
<td style="text-align:left">
Micro
</td>
<td style="text-align:left">
1GB / 1K ops/sec
</td>
</tr>
<tr>
<td style="text-align:left">
High-throughput
</td>
<td style="text-align:left">
2.5GB / 25K ops/sec
</td>
</tr>
<tr>
<td style="text-align:left">
Small
</td>
<td style="text-align:left">
12.5GB / 12.5K ops/sec
</td>
</tr>
<tr>
<td style="text-align:left">
Large
</td>
<td style="text-align:left">
25GB / 25K ops/sec
</td>
</tr>
<tr>
<td style="text-align:left">
Very large
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td style="text-align:left">
50GB / 5K ops/sec
</td>
</tr>
<tr>
<td style="text-align:left">
XLarge
<sup>
<a href="#table-note-3">
3
</a>
</sup>
</td>
<td style="text-align:left">
50GB / 10K ops/sec
</td>
</tr>
</tbody>
</table>
<ol>
<li>
<p>
<a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;">
</a>
Not available for databases hosted on external AWS accounts.
</p>
</li>
<li>
<p>
<a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;">
</a>
Used for databases with Auto Tiering before Redis 7.2.
</p>
</li>
<li>
<p>
<a name="table-note-3" style="display: block; height: 80px; margin-top: -80px;">
</a>
Used for hosted databases with Auto Tiering for Redis 7.2 and later.
</p>
</li>
</ol>
<p>
Prices vary according to the cloud provider and region. Minimum prices apply. To learn more, see
<a href="https://redis.com/redis-enterprise-cloud/pricing/">
Cloud pricing
</a>
.
</p>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/operate/rc/databases/create-database/create-pro-database-new/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/cms.initbydim/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CMS.INITBYDIM
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CMS.INITBYDIM key width depth</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available in:
</dt>
<dd class="m-0">
<a href="/docs/stack">
Redis Stack
</a>
/
<a href="/docs/data-types/probabilistic">
Bloom 2.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
</dl>
<p>
Initializes a Count-Min Sketch to dimensions specified by user.
</p>
<h3 id="parameters">
Parameters:
</h3>
<ul>
<li>
<strong>
key
</strong>
: The name of the sketch.
</li>
<li>
<strong>
width
</strong>
: Number of counters in each array. Reduces the error size.
</li>
<li>
<strong>
depth
</strong>
: Number of counter-arrays. Reduces the probability for an
error of a certain size (percentage of total count).
</li>
</ul>
<h2 id="return">
Return
</h2>
<p>
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
-
<code>
OK
</code>
if executed correctly, or [] otherwise.
</p>
<h2 id="examples">
Examples
</h2>
<pre tabindex="0"><code>redis> CMS.INITBYDIM test 2000 5
OK
</code></pre>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/cms.initbydim/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
https://redis.io/docs/latest/commands/getset/.html | <section class="prose w-full py-12">
<h1 class="command-name">
GETSET
<span class="text-base">
(deprecated)
</span>
</h1>
<div class="border-l-8 pl-4">
<p>
As of Redis version 6.2.0, this command is regarded as deprecated.
</p>
<p>
It can be replaced by
<a href="/docs/latest/commands/set/">
<code>
SET
</code>
</a>
with the
<code>
GET
</code>
argument when migrating or writing new code.
</p>
</div>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">GETSET key value</pre>
<dl class="grid grid-cols-[auto,1fr] gap-2 mb-12">
<dt class="font-semibold text-redis-ink-900 m-0">
Available since:
</dt>
<dd class="m-0">
1.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1)
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
ACL categories:
</dt>
<dd class="m-0">
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@string
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Atomically sets
<code>
key
</code>
to
<code>
value
</code>
and returns the old value stored at
<code>
key
</code>
.
Returns an error when
<code>
key
</code>
exists but does not hold a string value. Any
previous time to live associated with the key is discarded on successful
<a href="/docs/latest/commands/set/">
<code>
SET
</code>
</a>
operation.
</p>
<h2 id="design-pattern">
Design pattern
</h2>
<p>
<code>
GETSET
</code>
can be used together with
<a href="/docs/latest/commands/incr/">
<code>
INCR
</code>
</a>
for counting with atomic reset.
For example: a process may call
<a href="/docs/latest/commands/incr/">
<code>
INCR
</code>
</a>
against the key
<code>
mycounter
</code>
every time
some event occurs, but from time to time we need to get the value of the counter
and reset it to zero atomically.
This can be done using
<code>
GETSET mycounter "0"
</code>
:
</p>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> INCR mycounter
(integer) 1
redis> GETSET mycounter "0"
"1"
redis> GET mycounter
"0"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="examples">
Examples
</h2>
<div class="bg-slate-900 border-b border-slate-700 rounded-t-xl px-4 py-3 w-full flex">
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M2.5 10C2.5 5.85786 5.85786 2.5 10 2.5C14.1421 2.5 17.5 5.85786 17.5 10C17.5 14.1421 14.1421 17.5 10 17.5C5.85786 17.5 2.5 14.1421 2.5 10Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L18.6603 17.5L1.33975 17.5L10 2.5Z">
</path>
</svg>
<svg class="shrink-0 h-[1.0625rem] w-[1.0625rem] fill-slate-50" fill="currentColor" viewbox="0 0 20 20">
<path d="M10 2.5L12.0776 7.9322L17.886 8.22949L13.3617 11.8841L14.8738 17.5L10 14.3264L5.1262 17.5L6.63834 11.8841L2.11403 8.22949L7.92238 7.9322L10 2.5Z">
</path>
</svg>
</div>
<form class="redis-cli overflow-y-auto max-h-80">
<pre tabindex="0">redis> SET mykey "Hello"
"OK"
redis> GETSET mykey "World"
"Hello"
redis> GET mykey
"World"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
: the old value stored at the key.
</li>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
: if the key does not exist.
</li>
</ul>
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
: the old value stored at the key.
</li>
<li>
<a href="../../develop/reference/protocol-spec#nulls">
Null reply
</a>
: if the key does not exist.
</li>
</ul>
<br/>
<form class="text-sm w-full mt-24 pt-5 border-t border-t-redis-pen-700 border-opacity-50" id="page-feedback" name="page-feedback">
<input class="hidden" name="origin" value="https://redis.io/docs/latest/commands/getset/"/>
<div class="flex flex-row justify-between">
<div class="grid justify-center">
<span class="font-mono">
RATE THIS PAGE
</span>
<div class="star-rating">
<input id="5-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="5"/>
<label class="star" for="5-stars">
★
</label>
<input id="4-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="4"/>
<label class="star" for="4-stars">
★
</label>
<input id="3-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="3"/>
<label class="star" for="3-stars">
★
</label>
<input id="2-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="2"/>
<label class="star" for="2-stars">
★
</label>
<input id="1-stars" name="rating" onchange="document.querySelector('#feedback-form').classList.remove('hidden')" type="radio" value="1"/>
<label class="star" for="1-stars">
★
</label>
</div>
</div>
<a class="font-mono no-underline" href="#">
Back to top ↑
</a>
</div>
<div class="hidden" id="feedback-form">
<div class="grid gap-2">
<textarea class="p-2 mt-1 block w-full h-24 border border-opacity-50 border-redis-ink-900 rounded-md" name="comment" placeholder="Why did you choose this rating?" rows="3"></textarea>
<button class="font-mono button text-redis-ink-900 border border-solid border-transparent bg-redis-red-500 hover:bg-redis-red-600 focus:bg-red-600 focus:ring-red-600; w-min justify-self-end" type="submit">
Submit
</button>
</div>
</div>
</form>
<script>
document.addEventListener("DOMContentLoaded", function() {
const form = document.querySelector("#page-feedback");
form.addEventListener("submit", function(event) {
event.preventDefault();
var xhr = new XMLHttpRequest();
var url = "\/docusight\/api\/rate";
var params = new URLSearchParams(new FormData(form));
xhr.open("POST", url, true);
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
const responseData = JSON.parse(xhr.responseText);
const responseMessage = responseData.response;
const newText = document.createTextNode(responseMessage);
form.parentNode.replaceChild(newText, form);
}
};
xhr.send(params);
});
});
</script>
</section>
|
Subsets and Splits