url
stringlengths 38
157
| content
stringlengths 72
15.1M
|
|---|---|
https://redis.io/docs/latest/commands/rpush/.html | <section class="prose w-full py-12">
<h1 class="command-name">
RPUSH
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">RPUSH key element [element ...]</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) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
</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>
@list
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Insert all the specified values at the tail of the list stored at
<code>
key
</code>
.
If
<code>
key
</code>
does not exist, it is created as empty list before performing the push
operation.
When
<code>
key
</code>
holds a value that is not a list, an error is returned.
</p>
<p>
It is possible to push multiple elements using a single command call just
specifying multiple arguments at the end of the command.
Elements are inserted one after the other to the tail of the list, from the
leftmost element to the rightmost element.
So for instance the command
<code>
RPUSH mylist a b c
</code>
will result into a list
containing
<code>
a
</code>
as first element,
<code>
b
</code>
as second element and
<code>
c
</code>
as third element.
</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> RPUSH mylist "hello"
(integer) 1
redis> RPUSH mylist "world"
(integer) 2
redis> LRANGE mylist 0 -1
1) "hello"
2) "world"
</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 length of the list after the push operation.
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 2.4.0: Accepts multiple
<code>
element
</code>
arguments.
</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/rpush/"/>
<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/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Insight
</h1>
<p class="text-lg -mt-5 mb-10">
Visualize and optimize Redis data, connect to RDI, and more.
</p>
<p>
<a href="https://discord.gg/QUkjSsk">
<img alt="Discord" src="https://img.shields.io/discord/697882427875393627?style=flat-square"/>
</a>
<a href="https://github.com/redisinsight/redisinsight/">
<img alt="Github" src="https://img.shields.io/static/v1?label=&message=repository&color=5961FF&logo=github"/>
</a>
</p>
<p>
Redis Insight is a powerful tool for visualizing and optimizing data in Redis or Redis Stack, making real-time application development easier and more fun than ever before. Redis Insight lets you do both GUI- and CLI-based interactions in a fully-featured desktop GUI client.
</p>
<h3 id="installation-and-release-notes">
Installation and release notes
</h3>
<ul>
<li>
<p>
See
<a href="/docs/latest/operate/redisinsight/install/">
these pages
</a>
for installation information.
</p>
</li>
<li>
<p>
<a href="https://github.com/Redis-Insight/Redis-Insight/releases">
Redis Insight Release Notes
</a>
</p>
</li>
</ul>
<h2 id="overview">
Overview
</h2>
<h3 id="connection-management">
Connection management
</h3>
<ul>
<li>
Automatically discover and add your local Redis or Redis Stack databases (that use standalone connection type and do not require authentication).
</li>
<li>
Discover your databases in Redis Enterprise Cluster and databases with Flexible plans in Redis Cloud.
</li>
<li>
Use a form to enter your connection details and add any Redis database running anywhere (including Redis Community Edition Cluster or Sentinel).
</li>
<li>
Connect to a Redis Data Integration (RDI) management plane, create, test, and deploy RDI pipelines, and view RDI statistics.
</li>
</ul>
<img src="images/Databases.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">
Note:
</div>
When you add a Redis database for a particular user using the
<code>
username
</code>
and
<code>
password
</code>
fields, that user must be able to run the
<code>
INFO
</code>
command. See the
<a href="/docs/latest/operate/oss_and_stack/management/security/acl/">
access control list (ACL) documentation
</a>
for more information.
</div>
</div>
<h3 id="redis-copilot">
Redis Copilot
</h3>
<p>
Redis Copilot is an AI-powered developer assistant that helps you learn about Redis, explore your Redis data, and build search queries in a conversational manner. It is available in Redis Insight as well as within the Redis public documentation.
</p>
<p>
Currently, Redis Copilot provides two primary features: a general chatbot and a context-aware data chatbot.
</p>
<p>
<strong>
General chatbot
</strong>
: the knowledge-based chatbot serves as an interactive and dynamic documentation interface to simplify the learning process. You can ask specific questions about Redis commands, concepts, and products, and get responses on the fly. The general chatbot is also available in our public docs.
</p>
<p>
<strong>
My data chatbot
</strong>
: the context-aware chatbot available in Redis Insight lets you construct search queries using everyday language rather than requiring specific programming syntax. This feature lets you query and explore data easily and interactively without extensive technical knowledge.
</p>
<p>
Here's an example of using Redis Copilot to search data using a simple, natural language prompt.
</p>
<img src="images/copilot-example.png"/>
<p>
See the
<a href="/docs/latest/develop/tools/insight/copilot-faq/">
Redis Insight Copilot FAQ
</a>
for more information.
</p>
<h3 id="rdi-in-redis-insight">
RDI in Redis Insight
</h3>
<p>
Redis Insight includes Redis Data Integration (RDI) connectivity, which allows you to connect to an RDI management plane, and create, test, and deploy RDI pipelines. Read more about this feature
<a href="/docs/latest/develop/tools/insight/rdi-connector/">
here
</a>
.
</p>
<h3 id="browser">
Browser
</h3>
<p>
Browse, filter and visualize your key-value Redis data structures.
</p>
<ul>
<li>
<p>
<a href="https://en.wikipedia.org/wiki/Create,_read,_update_and_delete">
CRUD
</a>
support for lists, hashes, strings, sets, sorted sets, and streams
</p>
</li>
<li>
<p>
CRUD support for
<a href="/docs/latest/develop/data-types/json/">
JSON
</a>
</p>
</li>
<li>
<p>
Group keys according to their namespaces
</p>
<img src="images/Browser.png"/>
</li>
<li>
<p>
View, validate, and manage your key values in a human-readable format using formatters that prettify and highlight data in different formats (for example, Unicode, JSON, MessagePack, HEX, and ASCII) in the Browser tool.
</p>
<img src="images/data_formatting.png"/>
</li>
</ul>
<h3 id="profiler">
Profiler
</h3>
<p>
Analyze every command sent to Redis in real time.
</p>
<img src="images/Profiler.png"/>
<h3 id="cli">
CLI
</h3>
<p>
The CLI is accessible at any time within the application.
</p>
<ul>
<li>
Employs integrated help to deliver intuitive assistance
</li>
<li>
Use together with a convenient command helper that lets you search and read on Redis commands.
</li>
</ul>
<img src="images/CLI.png"/>
<h3 id="workbench">
Workbench
</h3>
<p>
Workbench is an advanced command line interface with intelligent command auto-complete and complex data visualization support.
</p>
<ul>
<li>
Built-in guides: you can conveniently discover Redis and Redis Stack features using the built-in guides.
</li>
<li>
Command auto-complete support for all features in Redis and Redis Stack.
</li>
<li>
Advanced, schema-aware auto-complete for Redis Query Engine, which provides for faster query building with context-sensitive suggestions that recognize indexes, schemas, and fields based on your current query. Start typing any Redis Query Engine command in to try this feature. See below for an example of an in-progress
<code>
FT.SEARCH
</code>
command.
</li>
</ul>
<img src="images/Workbench_Search.png"/>
<p>
Workbench also includes:
</p>
<ul>
<li>
<p>
Visualizations of your indexes, queries, and aggregations.
</p>
</li>
<li>
<p>
Visualizations of your
<a href="/docs/latest/develop/data-types/timeseries/">
time series
</a>
data.
</p>
<img src="images/Workbench_TimeSeries.png"/>
</li>
</ul>
<h2 id="tools">
Tools
</h2>
<h3 id="database-analysis">
Database analysis
</h3>
<p>
Use the database analysis tool to optimize the performance and memory usage of your Redis database. Check data type distribution and memory allocation and review the summary of key expiration time and memory to be freed over time. Inspect the top keys and namespaces sorted by consumed memory or key length and count of keys, respectively. Capture and track the changes in your database by viewing historical analysis reports. Next figure shows a sample database analysis report.
</p>
<img src="images/database_analysis.png"/>
<h3 id="redis-streams-support">
Redis Streams support
</h3>
<p>
Create and manage streams by adding, removing, and filtering entries per timestamp. To see and work with new entries, enable and customize the automatic refresh rate.
</p>
<p>
View and manage the list of consumer groups. See existing consumers in a given consumer name as well as the last messages delivered to them. Inspect the list of pending messages, explicitly acknowledge the processed items, or claim unprocessed messages via Redis Insight.
</p>
<img src="images/streams.png"/>
<h3 id="search-features">
Search features
</h3>
<p>
If you're using Redis Stack's indexing, querying, or full-text search features, Redis Insight provides UI controls to quickly and conveniently run search queries against a preselected index. You can also create a secondary index of your data in a dedicated pane.
</p>
<img src="images/search.png"/>
<h3 id="bulk-actions">
Bulk actions
</h3>
<p>
Easily and quickly delete multiple keys of the same type and/or with the same key name pattern in bulk. To do so, in the List or Tree view, set filters per key type or key names and open the Bulk Actions section. The section displays a summary of all the keys with the expected number of keys that will be deleted based on the set filters.
</p>
<p>
When the bulk deletion is completed, Redis Insight displays the results of this operation with the number of keys processed and the time taken to delete the keys in bulk.
Use bulk deletion to optimize the usage of your database based on the results from the Redis database analysis.
</p>
<img src="images/bulk_actions.png"/>
<h3 id="slow-log">
Slow Log
</h3>
<p>
The Slow Log tool displays the list of logs captured by the SLOWLOG command to analyze all commands that exceed a specified runtime, which helps with troubleshooting performance issues. Specify both the runtime and the maximum length of Slowlog (which are server configurations) to configure the list of commands logged and set the auto-refresh interval to automatically update the list of commands displayed.
</p>
<img src="images/slowlog.png"/>
<h2 id="plugins">
Plugins
</h2>
<p>
With Redis Insight you can now also extend the core functionality by building your own data visualizations. See our
<a href="https://github.com/Redis-Insight/Redis-Insight/wiki/Plugin-Documentation">
plugin documentation
</a>
for more information.
</p>
<h2 id="telemetry">
Telemetry
</h2>
<p>
Redis Insight includes an opt-in telemetry system. This help us improve the developer experience of the app. We value your privacy; all collected data is anonymized.
</p>
<h2 id="log-files">
Log files
</h2>
<p>
You can review the Redis Insight log files (files with a
<code>
.log
</code>
extension) to get detailed information about system issues.
These are the locations on supported platforms:
</p>
<ul>
<li>
<strong>
Docker
</strong>
: In the
<code>
/data/logs
</code>
directory
<em>
inside the container
</em>
.
</li>
<li>
<strong>
Mac
</strong>
: In the
<code>
/Users/<your-username>/.redis-insight
</code>
directory.
</li>
<li>
<strong>
Windows
</strong>
: In the
<code>
C:\Users\<your-username>\.redis-insight
</code>
directory.
</li>
<li>
<strong>
Linux
</strong>
: In the
<code>
/home/<your-username>/.redis-insight
</code>
directory.
</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 install Redis Insight on operating systems that are not officially supported, but it may not behave as expected.
</div>
</div>
<h2 id="redis-insight-api-only-for-docker">
Redis Insight API (only for Docker)
</h2>
<p>
If you are running Redis Insight from
<a href="/docs/latest/operate/redisinsight/install/install-on-docker/">
Docker
</a>
,
you can access the API from
<code>
http://localhost:5540/api/docs
</code>
.
</p>
<h2 id="feedback">
Feedback
</h2>
<p>
To provide your feedback,
<a href="https://github.com/Redis-Insight/Redis-Insight/issues/new">
open a ticket in our Redis Insight repository
</a>
.
</p>
<h2 id="license">
License
</h2>
<p>
Redis Insight is licensed under
<a href="https://github.com/Redis-Insight/Redis-Insight/blob/main/LICENSE">
SSPL
</a>
license.
</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/"/>
<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/config-yaml-reference/.html | <section class="prose w-full py-12">
<h1>
Redis Data Integration configuration file
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Data Integration configuration file reference
</p>
<p>
<strong>
Properties
</strong>
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#sources">
<strong>
sources
</strong>
</a>
<br/>
(Source collectors)
</td>
<td>
<code>
object
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="#processors">
<strong>
processors
</strong>
</a>
<br/>
(Configuration details of Redis Data Integration Processors)
</td>
<td>
<code>
object
</code>
,
<code>
null
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a href="#targets">
<strong>
targets
</strong>
</a>
<br/>
(Target connections)
</td>
<td>
<code>
object
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<p>
<a name="sources">
</a>
</p>
<h2 id="sources-source-collectors">
sources: Source collectors
</h2>
<p>
<strong>
Additional Properties
</strong>
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
</thead>
</table>
<p>
<a name="processors">
</a>
</p>
<h2 id="processors-configuration-details-of-redis-data-integration-processors">
processors: Configuration details of Redis Data Integration Processors
</h2>
<p>
<strong>
Properties
</strong>
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
on_failed_retry_interval
</strong>
<br/>
(Interval (in seconds) on which to perform retry on failure)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
5
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
read_batch_size
</strong>
<br/>
(The batch size for reading data from source database)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
2000
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
debezium_lob_encoded_placeholder
</strong>
<br/>
(Enable Debezium LOB placeholders)
</td>
<td>
<code>
string
</code>
</td>
<td>
Default:
<code>
"X19kZWJleml1bV91bmF2YWlsYWJsZV92YWx1ZQ=="
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
dedup
</strong>
<br/>
(Enable deduplication mechanism)
</td>
<td>
<code>
boolean
</code>
</td>
<td>
Default:
<code>
false
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
dedup_max_size
</strong>
<br/>
(Max size of the deduplication set)
</td>
<td>
<code>
integer
</code>
</td>
<td>
Default:
<code>
1024
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
dedup_strategy
</strong>
<br/>
(Deduplication strategy: reject - reject messages(dlq), ignore - ignore messages)
</td>
<td>
<code>
string
</code>
</td>
<td>
(DEPRECATED)
<br/>
Property 'dedup_strategy' is now deprecated. The only supported strategy is 'ignore'. Please remove from the configuration.
<br/>
Default:
<code>
"ignore"
</code>
<br/>
Enum:
<code>
"reject"
</code>
,
<code>
"ignore"
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
duration
</strong>
<br/>
(Time (in ms) after which data will be read from stream even if read_batch_size was not reached)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
100
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
write_batch_size
</strong>
<br/>
(The batch size for writing data to target Redis database. Should be less or equal to the read_batch_size)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
200
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
error_handling
</strong>
<br/>
(Error handling strategy: ignore - skip, dlq - store rejected messages in a dead letter queue)
</td>
<td>
<code>
string
</code>
</td>
<td>
Default:
<code>
"dlq"
</code>
<br/>
Pattern: ``^${.*}$
</td>
<td>
ignore
</td>
</tr>
<tr>
<td>
<strong>
dlq_max_messages
</strong>
<br/>
(Dead letter queue max messages per stream)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
1000
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
target_data_type
</strong>
<br/>
(Target data type: hash/json - RedisJSON module must be in use in the target DB)
</td>
<td>
<code>
string
</code>
</td>
<td>
Default:
<code>
"hash"
</code>
<br/>
Pattern: ``^${.*}$
</td>
<td>
hash
</td>
</tr>
<tr>
<td>
<strong>
json_update_strategy
</strong>
<br/>
(Target update strategy: replace/merge - RedisJSON module must be in use in the target DB)
</td>
<td>
<code>
string
</code>
</td>
<td>
(DEPRECATED)
<br/>
Property 'json_update_strategy' will be deprecated in future releases. Use 'on_update' job-level property to define the json update strategy.
<br/>
Default:
<code>
"replace"
</code>
<br/>
Pattern: ``^${.*}$
</td>
<td>
replace
</td>
</tr>
<tr>
<td>
<strong>
initial_sync_processes
</strong>
<br/>
(Number of processes RDI Engine creates to process the initial sync with the source)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
4
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
Maximum:
<code>
32
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
idle_sleep_time_ms
</strong>
<br/>
(Idle sleep time (in milliseconds) between batches)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
200
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
Maximum:
<code>
999999
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
idle_streams_check_interval_ms
</strong>
<br/>
(Interval (in milliseconds) for checking new streams when the stream processor is idling)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
1000
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
Maximum:
<code>
999999
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
busy_streams_check_interval_ms
</strong>
<br/>
(Interval (in milliseconds) for checking new streams when the stream processor is busy)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
5000
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
Maximum:
<code>
999999
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
wait_enabled
</strong>
<br/>
(Checks if the data has been written to the replica shard)
</td>
<td>
<code>
boolean
</code>
</td>
<td>
Default:
<code>
false
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
wait_timeout
</strong>
<br/>
(Timeout in milliseconds when checking write to the replica shard)
</td>
<td>
<code>
integer
</code>
,
<code>
string
</code>
</td>
<td>
Default:
<code>
1000
</code>
<br/>
Pattern:
<code>
^\${.*}$
</code>
<br/>
Minimum:
<code>
1
</code>
<br/>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
retry_on_replica_failure
</strong>
<br/>
(Ensures that the data has been written to the replica shard and keeps retrying if not)
</td>
<td>
<code>
boolean
</code>
</td>
<td>
Default:
<code>
true
</code>
<br/>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<p>
<strong>
Additional Properties:
</strong>
not allowed
<br/>
<a name="targets">
</a>
</p>
<h2 id="targets-target-connections">
targets: Target connections
</h2>
<p>
<strong>
Properties
</strong>
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#targetsconnection">
<strong>
connection
</strong>
</a>
<br/>
(Connection details)
</td>
<td>
<code>
object
</code>
</td>
<td>
</td>
<td>
</td>
</tr>
</tbody>
</table>
<p>
<a name="targetsconnection">
</a>
</p>
<h3 id="targetsconnection-connection-details">
targets.connection: Connection details
</h3>
<p>
<strong>
Properties (Pattern)
</strong>
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
<th>
Required
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
.*
</strong>
</td>
<td>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<td>
<strong>
additionalProperties
</strong>
</td>
<td>
</td>
<td>
</td>
<td>
</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/reference/config-yaml-reference/"/>
<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/redis_acls/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis access control list (ACL) requests
</h1>
<p class="text-lg -mt-5 mb-10">
Redis access control list (ACL) requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-redis_acls">
GET
</a>
</td>
<td>
<code>
/v1/redis_acls
</code>
</td>
<td>
Get all Redis ACLs
</td>
</tr>
<tr>
<td>
<a href="#get-redis_acl">
GET
</a>
</td>
<td>
<code>
/v1/redis_acls/{uid}
</code>
</td>
<td>
Get a single Redis ACL
</td>
</tr>
<tr>
<td>
<a href="#put-redis_acl">
PUT
</a>
</td>
<td>
<code>
/v1/redis_acls/{uid}
</code>
</td>
<td>
Update a Redis ACL
</td>
</tr>
<tr>
<td>
<a href="#post-redis_acl">
POST
</a>
</td>
<td>
<code>
/v1/redis_acls
</code>
</td>
<td>
Create a new Redis ACL
</td>
</tr>
<tr>
<td>
<a href="#delete-redis_acl">
DELETE
</a>
</td>
<td>
<code>
/v1/redis_acls/{uid}
</code>
</td>
<td>
Delete a Redis ACL
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-redis_acls">
Get all Redis ACLs
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/redis_acls
</span></span></code></pre>
</div>
<p>
Get all Redis ACL objects.
</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_redis_acls_info">
view_all_redis_acls_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 /redis_acls
</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/redis_acl/">
Redis ACL 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">"name"</span><span class="p">:</span> <span class="s2">"Full Access"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"+@all ~*"</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">"name"</span><span class="p">:</span> <span class="s2">"Read Only"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"+@read ~*"</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">3</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">"Not Dangerous"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"+@all -@dangerous ~*"</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">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">"Geo"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo"</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>
<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 redis_acl yet.
</td>
</tr>
</tbody>
</table>
<h2 id="get-redis_acl">
Get Redis ACL
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/redis_acls/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Get a single Redis ACL object.
</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_redis_acl_info">
view_redis_acl_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 /redis_acls/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 object's unique ID.
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a
<a href="/docs/latest/operate/rs/references/rest-api/objects/redis_acl/">
Redis ACL 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">"Geo"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo"</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>
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>
redis_acl 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 redis_acl yet.
</td>
</tr>
</tbody>
</table>
<h2 id="put-redis_acl">
Update Redis ACL
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">PUT /v1/redis_acls/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Update an existing Redis ACL object.
</p>
<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_redis_acl">
update_redis_acl
</a>
</td>
<td>
admin
<br/>
user_manager
</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 /redis_acls/17
</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">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo -@dangerous"</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="headers-2">
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 a
<a href="/docs/latest/operate/rs/references/rest-api/objects/redis_acl/">
Redis ACL object
</a>
with updated fields in the request body.
</p>
<h3 id="put-response">
Response
</h3>
<p>
Returns the updated
<a href="/docs/latest/operate/rs/references/rest-api/objects/redis_acl/">
Redis ACL 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">"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">"Geo"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo -@dangerous"</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>
<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>
invalid_param
</td>
<td>
A 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, redis_acl was updated.
</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-existent redis_acl.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">
409 Conflict
</a>
</td>
<td>
Cannot change a read-only object
</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 redis_acl yet.
</td>
</tr>
</tbody>
</table>
<h2 id="post-redis_acl">
Create Redis ACL
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">POST /v1/redis_acls
</span></span></code></pre>
</div>
<p>
Create a new Redis ACL object.
</p>
<h3 id="permissions-3">
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/#create_redis_acl">
create_redis_acl
</a>
</td>
<td>
admin
<br/>
user_manager
</td>
</tr>
</tbody>
</table>
<h3 id="post-request">
Request
</h3>
<h4 id="example-http-request-3">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">POST /redis_acls
</span></span></code></pre>
</div>
<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">"Geo"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo"</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h4 id="headers-3">
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 a
<a href="/docs/latest/operate/rs/references/rest-api/objects/redis_acl/">
Redis ACL object
</a>
in the request body.
</p>
<h3 id="post-response">
Response
</h3>
<p>
Returns the newly created
<a href="/docs/latest/operate/rs/references/rest-api/objects/redis_acl/">
Redis ACL object
</a>
.
</p>
<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">"Geo"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo"</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_param
</td>
<td>
A 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, redis_acl 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 redis_acl yet.
</td>
</tr>
</tbody>
</table>
<h3 id="examples">
Examples
</h3>
<h4 id="curl">
cURL
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">curl -k -u <span class="s2">"[username]:[password]"</span> -X POST <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -H <span class="s1">'Content-Type: application/json'</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -d <span class="s1">'{ "name": "Geo", "acl": "~* +@geo" }'</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> https://<span class="o">[</span>host<span class="o">][</span>:port<span class="o">]</span>/v1/redis_acls
</span></span></code></pre>
</div>
<h4 id="python">
Python
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><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">json</span>
</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="s2">"https://[host][:port]/v1/redis_acls"</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Content-Type'</span><span class="p">:</span> <span class="s1">'application/json'</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">payload</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</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">"Geo"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"acl"</span><span class="p">:</span> <span class="s2">"~* +@geo"</span>
</span></span><span class="line"><span class="cl"><span class="p">})</span>
</span></span><span class="line"><span class="cl"><span class="n">auth</span><span class="o">=</span><span class="p">(</span><span class="s2">"[username]"</span><span class="p">,</span> <span class="s2">"[password]"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</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">request</span><span class="p">(</span><span class="s2">"POST"</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">auth</span><span class="o">=</span><span class="n">auth</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span> <span class="n">payload</span><span class="o">=</span><span class="n">payload</span><span class="p">,</span> <span class="n">verify</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 class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
</span></span></code></pre>
</div>
<h2 id="delete-redis_acl">
Delete Redis ACL
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">DELETE /v1/redis_acls/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Delete a Redis ACL object.
</p>
<h3 id="permissions-4">
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/#delete_redis_acl">
delete_redis_acl
</a>
</td>
<td>
admin
<br/>
user_manager
</td>
</tr>
</tbody>
</table>
<h3 id="delete-request">
Request
</h3>
<h4 id="example-http-request-4">
Example HTTP request
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">DELETE /redis_acls/1
</span></span></code></pre>
</div>
<h4 id="headers-4">
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 redis_acl unique ID.
</td>
</tr>
</tbody>
</table>
<h3 id="delete-response">
Response
</h3>
<p>
Returns a status code that indicates the Redis ACL deletion success or failure.
</p>
<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 redis_acl 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.4.10">
409 Conflict
</a>
</td>
<td>
Cannot delete a read-only object
</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 redis_acl 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/redis_acls/"/>
<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/query_syntax/.html | <section class="prose w-full py-12">
<h1>
Query syntax
</h1>
<p class="text-lg -mt-5 mb-10">
Learn how to use query syntax
</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 query syntax that RediSearch uses has improved over time,
adding new features and making queries simpler to write. However,
changing the syntax like this could potentially break existing queries that rely on
an older version of the syntax. To avoid this problem, RediSearch supports
different query syntax
<em>
dialects
</em>
to ensure backward compatibility.
Any breaking changes to the syntax are introduced in a new dialect, while
RediSearch continues to support older dialects. This means you can always choose
the correct dialect to support the query you are using.
See
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/">
Query dialects
</a>
for full details of the dialects and the RediSearch versions that introduced them.
</div>
</div>
<h2 id="basic-syntax">
Basic syntax
</h2>
<p>
You can use simple syntax for complex queries using these rules:
</p>
<ul>
<li>
<p>
Exact phrases are wrapped in quotes, for example,
<code>
"hello world"
</code>
.
</p>
</li>
<li>
<p>
Multiword phrases are lists of tokens, for example,
<code>
foo bar baz
</code>
, and imply intersection (AND) of the terms.
</p>
</li>
<li>
<p>
<code>
OR
</code>
unions are expressed with a pipe (
<code>
|
</code>
) character, for example,
<code>
hello|hallo|shalom|hola
</code>
.
</p>
<p>
<strong>
Notes
</strong>
:
</p>
<p>
Consider the differences in parser behavior in example
<code>
hello world | "goodbye" moon
</code>
:
</p>
<ul>
<li>
In DIALECT 1, this query is interpreted as searching for
<code>
(hello world | "goodbye") moon
</code>
.
</li>
<li>
In DIALECT 2 or greater, this query is interpreted as searching for either
<code>
hello world
</code>
<strong>
OR
</strong>
<code>
"goodbye" moon
</code>
.
</li>
</ul>
</li>
<li>
<p>
<code>
NOT
</code>
negation of expressions or subqueries is expressed with a subtraction symbol (
<code>
-
</code>
), for example,
<code>
hello -world
</code>
. Purely negative queries such as
<code>
-foo
</code>
and
<code>
-@title:(foo|bar)
</code>
are also supported.
</p>
<p>
<strong>
Notes
</strong>
:
</p>
<p>
Consider a simple query with negation
<code>
-hello world
</code>
:
</p>
<ul>
<li>
In DIALECT 1, this query is interpreted as "find values in any field that does not contain
<code>
hello
</code>
<strong>
AND
</strong>
does not contain
<code>
world
</code>
". The equivalent is
<code>
-(hello world)
</code>
or
<code>
-hello -world
</code>
.
</li>
<li>
In DIALECT 2 or greater, this query is interpreted
<code>
as -hello
</code>
<strong>
AND
</strong>
<code>
world
</code>
(only
<code>
hello
</code>
is negated).
</li>
<li>
In DIALECT 2 or greater, to achieve the default behavior of DIALECT 1, update your query to
<code>
-(hello world)
</code>
.
</li>
</ul>
</li>
<li>
<p>
Prefix/infix/suffix matches (all terms starting/containing/ending with a term) are expressed with an asterisk
<code>
*
</code>
. For performance reasons, a minimum term length is enforced. The default is 2, but it's configurable.
</p>
</li>
<li>
<p>
In DIALECT 2 or greater, wildcard pattern matches are expressed as
<code>
"w'foo*bar?'"
</code>
. Note the use of double quotes to contain the
<em>
w
</em>
pattern.
</p>
</li>
<li>
<p>
A special wildcard query that returns all results in the index is just the asterisk
<code>
*
</code>
. This cannot be combined with other options.
</p>
</li>
<li>
<p>
As of v2.6.1,
<code>
DIALECT 3
</code>
returns JSON rather than scalars from multivalue attributes.
</p>
</li>
<li>
<p>
Selection of specific fields using the syntax
<code>
hello @field:world
</code>
.
</p>
</li>
<li>
<p>
Numeric range matches on numeric fields with the syntax
<code>
@field:[{min} {max}]
</code>
.
</p>
</li>
<li>
<p>
Georadius matches on geo fields with the syntax
<code>
@field:[{lon} {lat} {radius} {m|km|mi|ft}]
</code>
.
</p>
</li>
<li>
<p>
As of 2.6, range queries on vector fields with the syntax
<code>
@field:[VECTOR_RANGE {radius} $query_vec]
</code>
, where
<code>
query_vec
</code>
is given as a query parameter.
</p>
</li>
<li>
<p>
As of v2.4, k-nearest neighbors (KNN) queries on vector fields with or without pre-filtering with the syntax
<code>
{filter_query}=>[KNN {num} @field $query_vec]
</code>
.
</p>
</li>
<li>
<p>
Tag field filters with the syntax
<code>
@field:{tag | tag | ...}
</code>
. See the full documentation on
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/tags/">
tags
</a>
.
</p>
</li>
<li>
<p>
Optional terms or clauses:
<code>
foo ~bar
</code>
means bar is optional but documents containing
<code>
bar
</code>
will rank higher.
</p>
</li>
<li>
<p>
Fuzzy matching on terms:
<code>
%hello%
</code>
means all terms with Levenshtein distance of 1 from it. Use multiple pairs of '%' brackets, up to three deep, to increase the Levenshtein distance.
</p>
</li>
<li>
<p>
An expression in a query can be wrapped in parentheses to disambiguate, for example,
<code>
(hello|hella) (world|werld)
</code>
.
</p>
</li>
<li>
<p>
Query attributes can be applied to individual clauses, for example,
<code>
(foo bar) => { $weight: 2.0; $slop: 1; $inorder: false; }
</code>
.
</p>
</li>
<li>
<p>
Combinations of the above can be used together, for example,
<code>
hello (world|foo) "bar baz" bbbb
</code>
.
</p>
</li>
</ul>
<h2 id="pure-negative-queries">
Pure negative queries
</h2>
<p>
As of v0.19.3, it is possible to have a query consisting of just a negative expression. For example
<code>
-hello
</code>
or
<code>
-(@title:(foo|bar))
</code>
. The results are all the documents not containing the query terms.
</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>
Any complex expression can be negated this way, however, caution should be taken here: if a negative expression has little or no results, this is equivalent to traversing and ranking all the documents in the index, which can be slow and cause high CPU consumption.
</div>
</div>
<h2 id="field-modifiers">
Field modifiers
</h2>
<p>
You can specify field modifiers in a query, and not just by using the
<code>
INFIELDS
</code>
global keyword.
</p>
<p>
To specify which fields the query matches, prepend the expression with the
<code>
@
</code>
symbol, the field name, and a
<code>
:
</code>
(colon) symbol, for each expression or subexpression.
</p>
<p>
If a field modifier precedes multiple words or expressions, it applies only to the adjacent expression with DIALECT 1. With DIALECT 2 or greater, you extend the query to other fields.
</p>
<p>
Consider this simple query:
<code>
@name:James Brown
</code>
. Here, the field modifier
<code>
@name
</code>
is followed by two words:
<code>
James
</code>
and
<code>
Brown
</code>
.
</p>
<ul>
<li>
In DIALECT 1, this query would be interpreted as "find
<code>
James Brown
</code>
in the
<code>
@name
</code>
field".
</li>
<li>
In DIALECT 2 or greater, this query will be interpreted as "find
<code>
James
</code>
in the
<code>
@name
</code>
field
<strong>
AND
</strong>
<code>
Brown
</code>
in
<strong>
ANY
</strong>
text field. In other words, it would be interpreted as
<code>
(@name:James) Brown
</code>
.
</li>
<li>
In DIALECT 2 or greater, to achieve the default behavior of DIALECT 1, update your query to
<code>
@name:(James Brown)
</code>
.
</li>
</ul>
<p>
If a field modifier precedes an expression in parentheses, it applies only to the expression inside the parentheses. The expression should be valid for the specified field, otherwise it is skipped.
</p>
<p>
To create complex filtering on several fields, you can combine multiple modifiers. For example, if you have an index of car models, with a vehicle class, country of origin, and engine type, you can search for SUVs made in Korea with hybrid or diesel engines using the following query:
</p>
<pre tabindex="0"><code>FT.SEARCH cars "@country:korea @engine:(diesel|hybrid) @class:suv"
</code></pre>
<p>
You can apply multiple modifiers to the same term or grouped terms:
</p>
<pre tabindex="0"><code>FT.SEARCH idx "@title|body:(hello world) @url|image:mydomain"
</code></pre>
<p>
Now, you search for documents that have
<code>
"hello"
</code>
and
<code>
"world"
</code>
either in the body or the title and the term
<code>
mydomain
</code>
in their
<code>
url
</code>
or
<code>
image
</code>
fields.
</p>
<h2 id="numeric-filters-in-query">
Numeric filters in query
</h2>
<p>
If a field in the schema is defined as NUMERIC, it is possible to use the FILTER argument in the Redis request or filter with it by specifying filtering rules in the query. The syntax is
<code>
@field:[{min} {max}]
</code>
, for example,
<code>
@price:[100 200]
</code>
.
</p>
<h3 id="a-few-notes-on-numeric-predicates">
A few notes on numeric predicates
</h3>
<ol>
<li>
<p>
It is possible to specify a numeric predicate as the entire query, whereas it is impossible to do it with the
<code>
FILTER
</code>
argument.
</p>
</li>
<li>
<p>
It is possible to intersect or union multiple numeric filters in the same query, be it for the same field or different ones.
</p>
</li>
<li>
<p>
<code>
-inf
</code>
,
<code>
inf
</code>
and
<code>
+inf
</code>
are acceptable numbers in a range. Therefore,
<em>
greater than 100
</em>
is expressed as
<code>
[(100 inf]
</code>
.
</p>
</li>
<li>
<p>
Numeric filters are inclusive. Exclusive min or max are expressed with
<code>
(
</code>
prepended to the number, for example,
<code>
[(100 (200]
</code>
.
</p>
</li>
<li>
<p>
It is possible to negate a numeric filter by prepending a
<code>
-
</code>
sign to the filter. For example, returning a result where price differs from 100 is expressed as:
<code>
@title:foo -@price:[100 100]
</code>
.
</p>
</li>
</ol>
<h2 id="tag-filters">
Tag filters
</h2>
<p>
As of v0.91, you can use a special field type called a
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/tags/">
<em>
tag field
</em>
</a>
, with simpler
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/escaping/#tokenization-rules-for-tag-fields">
tokenization
</a>
and encoding in the index. You can't access the values in these fields using a general fieldless search. Instead, you use special syntax:
</p>
<pre tabindex="0"><code>@field:{ tag | tag | ...}
</code></pre>
<p>
Example:
</p>
<pre tabindex="0"><code>@cities:{ New York | Los Angeles | Barcelona }
</code></pre>
<p>
Tags can have multiple words or include other punctuation marks other than the field's separator (
<code>
,
</code>
by default). The following characters in tags should be escaped with a backslash (
<code>
\
</code>
):
<code>
$
</code>
,
<code>
{
</code>
,
<code>
}
</code>
,
<code>
\
</code>
, and
<code>
|
</code>
.
</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>
Before RediSearch 2.4, it was also recommended to escape spaces. The reason was that, if a multiword tag included stopwords, a syntax error was returned. So tags, like "to be or not to be" needed be escaped as "to\ be\ or\ not\ to\ be". For good measure, you also could escape all spaces within tags. Starting with RediSearch 2.4, using
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/#dialect-2">
<code>
DIALECT 2
</code>
</a>
or greater you can use spaces in a
<code>
tag
</code>
query, even with stopwords.
</div>
</div>
<p>
Notice that multiple tags in the same clause create a union of documents containing either tags. To create an intersection of documents containing all tags, you should repeat the tag filter several times. For example:
</p>
<pre tabindex="0"><code># Return all documents containing all three cities as tags
@cities:{ New York } @cities:{Los Angeles} @cities:{ Barcelona }
# Now, return all documents containing either city
@cities:{ New York | Los Angeles | Barcelona }
</code></pre>
<p>
Tag clauses can be combined into any subclause, used as negative expressions, optional expressions, and so on.
</p>
<h2 id="geo-filters">
Geo filters
</h2>
<p>
As of v0.21, it is possible to add geo radius queries directly into the query language with the syntax
<code>
@field:[{lon} {lat} {radius} {m|km|mi|ft}]
</code>
. This filters the result to a given radius from a lon,lat point, defined in meters, kilometers, miles or feet. See Redis's own
<a href="/docs/latest/commands/georadius/">
<code>
GEORADIUS
</code>
</a>
command for more details.
</p>
<p>
Radius filters can be added into the query just like numeric filters. For example, in a database of businesses, looking for Chinese restaurants near San Francisco (within a 5km radius) would be expressed as:
<code>
chinese restaurant @location:[-122.41 37.77 5 km]
</code>
.
</p>
<h2 id="polygon-search">
Polygon search
</h2>
<p>
Geospatial databases are essential for managing and analyzing location-based data in a variety of industries. They help organizations make data-driven decisions, optimize operations, and achieve their strategic goals more efficiently. Polygon search extends Redis's geospatial search capabilities to be able to query against a value in a
<code>
GEOSHAPE
</code>
attribute. This value must follow a
<a href="https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry">
"well-known text"
</a>
(WKT) representation of geometry. Two such geometries are supported:
</p>
<ul>
<li>
<code>
POINT
</code>
, for example
<code>
POINT(2 4)
</code>
.
</li>
<li>
<code>
POLYGON
</code>
, for example
<code>
POLYGON((2 2, 2 8, 6 11, 10 8, 10 2, 2 2))
</code>
.
</li>
</ul>
<p>
There is a new schema field type called
<code>
GEOSHAPE
</code>
, which can be specified as either:
</p>
<ul>
<li>
<code>
FLAT
</code>
for Cartesian X Y coordinates
</li>
<li>
<code>
SPHERICAL
</code>
for geographic longitude and latitude coordinates. This is the default coordinate system.
</li>
</ul>
<p>
Finally, there's new
<a href="/docs/latest/commands/ft.search/">
<code>
FT.SEARCH
</code>
</a>
syntax that allows you to query for polygons that either contain or are within a given geoshape.
</p>
<p>
<code>
@field:[{WITHIN|CONTAINS} $geometry] PARAMS 2 geometry {geometry}
</code>
</p>
<p>
Here's an example using two stacked polygons that represent a box contained within a house.
</p>
<p>
<img alt="two stacked polygons" src="/docs/latest/develop/interact/search-and-query/img/polygons.png"/>
</p>
<p>
First, create an index using a
<code>
FLAT
</code>
<code>
GEOSHAPE
</code>
, representing a 2D X Y coordinate system.
</p>
<p>
<code>
FT.CREATE polygon_idx PREFIX 1 shape: SCHEMA g GEOSHAPE FLAT t TEXT
</code>
</p>
<p>
Next, create the data structures that represent the geometries in the picture.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">HSET shape:1 t <span class="s2">"this is my house"</span> g <span class="s2">"POLYGON((2 2, 2 8, 6 11, 10 8, 10 2, 2 2))"</span>
</span></span><span class="line"><span class="cl">HSET shape:2 t <span class="s2">"this is a square in my house"</span> g <span class="s2">"POLYGON((4 4, 4 6, 6 6, 6 4, 4 4))"</span>
</span></span></code></pre>
</div>
<p>
Finally, use
<a href="/docs/latest/commands/ft.search/">
<code>
FT.SEARCH
</code>
</a>
to query the geometries. Note the use of
<code>
DIALECT 3
</code>
, which is required. Here are a few examples.
</p>
<p>
Search for a polygon that contains a specified point:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">FT.SEARCH polygon_idx <span class="s2">"@g:[CONTAINS </span><span class="nv">$point</span><span class="s2">]"</span> PARAMS <span class="m">2</span> point <span class="s1">'POINT(8 8)'</span> DIALECT <span class="m">3</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">1</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"shape:1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"t"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"this is my house"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"g"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"POLYGON((2 2, 2 8, 6 11, 10 8, 10 2, 2 2))"</span>
</span></span></code></pre>
</div>
<p>
Search for geometries contained in a specified polygon:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">FT.SEARCH polygon_idx <span class="s2">"@g:[WITHIN </span><span class="nv">$poly</span><span class="s2">]"</span> PARAMS <span class="m">2</span> poly <span class="s1">'POLYGON((0 0, 0 100, 100 100, 100 0, 0 0))'</span> DIALECT <span class="m">3</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">2</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"shape:2"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"t"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"this is a square in my house"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"g"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"POLYGON((4 4, 4 6, 6 6, 6 4, 4 4))"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"shape:1"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"t"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"this is my house"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"g"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"POLYGON((2 2, 2 8, 6 11, 10 8, 10 2, 2 2))"</span>
</span></span></code></pre>
</div>
<p>
Search for a polygon that is not contained in the indexed geometries:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">FT.SEARCH polygon_idx <span class="s2">"@g:[CONTAINS </span><span class="nv">$poly</span><span class="s2">]"</span> PARAMS <span class="m">2</span> poly <span class="s1">'POLYGON((14 4, 14 6, 16 6, 16 4, 14 4))'</span> DIALECT <span class="m">3</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">0</span>
</span></span></code></pre>
</div>
<p>
Search for a polygon that is known to be contained within the geometries (the box):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">FT.SEARCH polygon_idx <span class="s2">"@g:[CONTAINS </span><span class="nv">$poly</span><span class="s2">]"</span> PARAMS <span class="m">2</span> poly <span class="s1">'POLYGON((4 4, 4 6, 6 6, 6 4, 4 4))'</span> DIALECT <span class="m">3</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">2</span>
</span></span><span class="line"><span class="cl">2<span class="o">)</span> <span class="s2">"shape:1"</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"t"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"this is my house"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"g"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"POLYGON((2 2, 2 8, 6 11, 10 8, 10 2, 2 2))"</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="s2">"shape:2"</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> 1<span class="o">)</span> <span class="s2">"t"</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> <span class="s2">"this is a square in my house"</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> <span class="s2">"g"</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> <span class="s2">"POLYGON((4 4, 4 6, 6 6, 6 4, 4 4))"</span>
</span></span></code></pre>
</div>
<p>
Note that both the house and box shapes were returned.
</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>
GEOSHAPE does not support JSON multi-value or SORTABLE options.
</div>
</div>
<p>
For more examples, see the
<a href="/docs/latest/commands/ft.create/">
<code>
FT.CREATE
</code>
</a>
and
<a href="/docs/latest/commands/ft.search/">
<code>
FT.SEARCH
</code>
</a>
command pages.
</p>
<h2 id="vector-search">
Vector search
</h2>
<p>
You can add vector similarity queries directly into the query language by:
</p>
<ol>
<li>
<p>
Using a
<strong>
range
</strong>
query with the syntax of
<code>
@vector:[VECTOR_RANGE {radius} $query_vec]
</code>
, which filters the results to a given radius from a given query vector. The distance metric derives from the definition of a @vector field in the index schema, for example, Cosine or L2 (as of v2.6.1).
</p>
</li>
<li>
<p>
Running a k nearest neighbors (KNN) query on a @vector field. The basic syntax is
<code>
"*=>[ KNN {num|$num} @vector $query_vec ]"
</code>
.
It is also possible to run a hybrid query on filtered results. A hybrid query allows the user to specify a filter criteria that all results in a KNN query must satisfy. The filter criteria can include any type of field (i.e., indexes created on both vectors and other values, such as TEXT, PHONETIC, NUMERIC, GEO, etc.).
The general syntax for hybrid query is
<code>
{some filter query}=>[ KNN {num|$num} @vector $query_vec]
</code>
, where
<code>
=>
</code>
separates the filter query from the vector KNN query.
</p>
</li>
</ol>
<p>
<strong>
Examples:
</strong>
</p>
<ul>
<li>
<p>
Return 10 nearest neighbors entities in which
<code>
query_vec
</code>
is closest to the vector stored in
<code>
@vector_field
</code>
:
</p>
<p>
<code>
*=>[KNN 10 @vector_field $query_vec]
</code>
</p>
</li>
<li>
<p>
Among entities published between 2020 and 2022, return 10 nearest neighbors entities in which
<code>
query_vec
</code>
is closest to the vector stored in
<code>
@vector_field
</code>
:
</p>
<p>
<code>
@published_year:[2020 2022]=>[KNN 10 @vector_field $query_vec]
</code>
</p>
</li>
<li>
<p>
Return every entity for which the distance between the vector stored under its @vector_field and
<code>
query_vec
</code>
is at most 0.5, in terms of the @vector_field distance metric:
</p>
<p>
<code>
@vector_field:[VECTOR_RANGE 0.5 $query_vec]
</code>
</p>
</li>
</ul>
<p>
As of v2.4, the KNN vector search can be used at most once in a query, while, as of v2.6, the vector range filter can be used multiple times in a query. For more information on vector similarity syntax, see
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/">
Querying vector fields
</a>
, and
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors#vector-search-examples">
Vector search examples
</a>
sections.
</p>
<h2 id="prefix-matching">
Prefix matching
</h2>
<p>
When indexes are updated, Redis maintains a dictionary of all terms in the index. This can be used to match all terms starting with a given prefix. Selecting prefix matches is done by appending
<code>
*
</code>
to a prefix token. For example:
</p>
<pre tabindex="0"><code>hel* world
</code></pre>
<p>
Will be expanded to cover
<code>
(hello|help|helm|...) world
</code>
.
</p>
<h3 id="a-few-notes-on-prefix-searches">
A few notes on prefix searches
</h3>
<ol>
<li>
<p>
As prefixes can be expanded into many terms, use them with caution. The expansion will create a Union operation of all suffixes.
</p>
</li>
<li>
<p>
As a protective measure to avoid selecting too many terms, blocking Redis, which is single threaded, there are two limitations on prefix matching:
</p>
</li>
</ol>
<ul>
<li>
<p>
Prefixes are limited to 2 letters or more. You can change this number by using the
<code>
MINPREFIX
</code>
setting on the module command line.
</p>
</li>
<li>
<p>
The minimum word length to stem is 4 letters or more. You can change this number by using the
<code>
MINSTEMLEN
</code>
setting on the module command line.
</p>
</li>
<li>
<p>
Expansion is limited to 200 terms or less. You can change this number by using the
<code>
MAXEXPANSIONS
</code>
setting on the module command line.
</p>
</li>
</ul>
<ol start="3">
<li>
<p>
Prefix matching fully supports Unicode and is case insensitive.
</p>
</li>
<li>
<p>
Currently, there is no sorting or bias based on suffix popularity.
</p>
</li>
</ol>
<h2 id="infixsuffix-matching">
Infix/suffix matching
</h2>
<p>
As of v2.6.0, the dictionary can be used for infix (contains) or suffix queries by appending
<code>
*
</code>
to the token. For example:
</p>
<pre tabindex="0"><code>*sun* *ing
</code></pre>
<p>
These queries are CPU intensive because they require iteration over the whole dictionary.
</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>
All notes about prefix searches also apply to infix/suffix queries.
</div>
</div>
<h3 id="using-a-suffix-trie">
Using a suffix trie
</h3>
<p>
A suffix trie maintains a list of terms that match the suffix. If you add a suffix trie to a field using the
<code>
WITHSUFFIXTRIE
</code>
keyword, you can create more efficient infix and suffix queries because it eliminates the need to iterate over the whole dictionary. However, the iteration on the union does not change.
</p>
<p>
Suffix queries create a union of the list of terms from the suffix term node. Infix queries use the suffix terms as prefixes to the trie and create a union of all terms from all matching nodes.
</p>
<h2 id="wildcard-matching">
Wildcard matching
</h2>
<p>
As of v2.6.0, you can use the dictionary for wildcard matching queries with these parameters.
</p>
<ul>
<li>
<code>
?
</code>
- for any single character
</li>
<li>
<code>
*
</code>
- for any character repeating zero or more times
</li>
<li>
' and \ - for escaping; other special characters are ignored
</li>
</ul>
<p>
An example of the syntax is
<code>
"w'foo*bar?'"
</code>
.
</p>
<h3 id="using-a-suffix-trie-1">
Using a suffix trie
</h3>
<p>
A suffix trie maintains a list of terms which match the suffix. If you add a suffix trie to a field using the
<code>
WITHSUFFIXTRIE
</code>
keyword, you can create more efficient wildcard matching queries because it eliminates the need to iterate over the whole dictionary. However, the iteration on the union does not change.
</p>
<p>
With a suffix trie, the wildcard pattern is broken into tokens at every
<code>
*
</code>
character. A heuristic is used to choose the token with the least terms, and each term is matched with the wildcard pattern.
</p>
<h2 id="fuzzy-matching">
Fuzzy matching
</h2>
<p>
As of v1.2.0, the dictionary of all terms in the index can also be used to perform
<a href="https://en.wikipedia.org/wiki/Approximate_string_matching">
fuzzy matching
</a>
.
Fuzzy matches are performed based on
<a href="https://en.wikipedia.org/wiki/Levenshtein_distance">
Levenshtein distance
</a>
(LD).
Fuzzy matching on a term is performed by surrounding the term with '%', for example:
</p>
<pre tabindex="0"><code>%hello% world
</code></pre>
<p>
This performs fuzzy matching on
<code>
hello
</code>
for all terms where LD is 1.
</p>
<p>
As of v1.4.0, the LD of the fuzzy match can be set by the number of '%' characters surrounding it, so that
<code>
%%hello%%
</code>
will perform fuzzy matching on 'hello' for all terms where LD is 2.
</p>
<p>
The maximum LD for fuzzy matching is 3.
</p>
<h2 id="wildcard-queries">
Wildcard queries
</h2>
<p>
As of v1.1.0, you can use a special query to retrieve all the documents in an index. This is meant mostly for the aggregation engine. You can call it by specifying only a single star sign as the query string, in other words,
<code>
FT.SEARCH myIndex *
</code>
.
</p>
<p>
You can't combine this with any other filters, field modifiers, or anything inside the query. It is technically possible to use the deprecated
<code>
FILTER
</code>
and
<code>
GEOFILTER
</code>
request parameters outside the query string in conjunction with a wildcard, but this makes the wildcard meaningless and only hurts performance.
</p>
<h2 id="query-attributes">
Query attributes
</h2>
<p>
As of v1.2.0, you can apply specific query modifying attributes to specific clauses of the query.
</p>
<p>
The syntax is
<code>
(foo bar) => { $attribute: value; $attribute:value; ...}
</code>
:
</p>
<pre tabindex="0"><code>(foo bar) => { $weight: 2.0; $slop: 1; $inorder: true; }
~(bar baz) => { $weight: 0.5; }
</code></pre>
<p>
The supported attributes are:
</p>
<ol>
<li>
<strong>
$weight
</strong>
: determines the weight of the sub-query or token in the overall ranking on the result (default: 1.0).
</li>
<li>
<strong>
$slop
</strong>
: determines the maximum allowed slop (space between terms) in the query clause (default: 0).
</li>
<li>
<strong>
$inorder
</strong>
: whether or not the terms in a query clause must appear in the same order as in the query. This is usually set alongside with
<code>
$slop
</code>
(default: false).
</li>
<li>
<strong>
$phonetic
</strong>
: whether or not to perform phonetic matching (default: true). Note: setting this attribute to true for fields which were not created as
<code>
PHONETIC
</code>
will produce an error.
</li>
</ol>
<p>
As of v2.6.1, the query attributes syntax supports these additional attributes:
</p>
<ul>
<li>
<strong>
$yield_distance_as
</strong>
: specifies the distance field name, used for later sorting and/or returning, for clauses that yield some distance metric. It is currently supported for vector queries only (both KNN and range).
</li>
<li>
<strong>
vector query params
</strong>
: pass optional parameters for
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors#querying-vector-fields">
vector queries
</a>
in key-value format.
</li>
</ul>
<h2 id="a-few-query-examples">
A few query examples
</h2>
<ul>
<li>
<p>
Simple phrase query -
<code>
hello
</code>
<em>
AND
</em>
<code>
world
</code>
:
</p>
<pre><code> hello world
</code></pre>
</li>
<li>
<p>
Exact phrase query -
<code>
hello
</code>
<em>
FOLLOWED BY
</em>
<code>
world
</code>
:
</p>
<pre><code> "hello world"
</code></pre>
</li>
<li>
<p>
Union - documents containing either
<code>
hello
</code>
<em>
OR
</em>
<code>
world
</code>
:
</p>
<pre><code> hello|world
</code></pre>
</li>
<li>
<p>
Not - documents containing
<code>
hello
</code>
<em>
BUT NOT
</em>
<code>
world
</code>
:
</p>
<pre><code> hello -world
</code></pre>
</li>
<li>
<p>
Intersection of unions:
</p>
<pre><code> (hello|halo) (world|werld)
</code></pre>
</li>
<li>
<p>
Negation of union:
</p>
<pre><code> hello -(world|werld)
</code></pre>
</li>
<li>
<p>
Union inside phrase:
</p>
<pre><code> (barack|barrack) obama
</code></pre>
</li>
<li>
<p>
Optional terms with higher priority to ones containing more matches:
</p>
<pre><code> obama ~barack ~michelle
</code></pre>
</li>
<li>
<p>
Exact phrase in one field, one word in another field:
</p>
<pre><code> @title:"barack obama" @job:president
</code></pre>
</li>
<li>
<p>
Combined
<em>
AND
</em>
,
<em>
OR
</em>
with field specifiers:
</p>
<pre><code> @title:"hello world" @body:(foo bar) @category:(articles|biographies)
</code></pre>
</li>
<li>
<p>
Prefix/infix/suffix queries:
</p>
<pre><code> hello worl*
hel* *worl
hello -*worl*
</code></pre>
</li>
<li>
<p>
Wildcard matching queries:
</p>
<pre><code> "w'foo??bar??baz'"
"w'???????'"
"w'hello*world'"
</code></pre>
</li>
<li>
<p>
Numeric filtering - products named
<code>
tv
</code>
with a price range of 200 to 500:
</p>
<pre><code> @name:tv @price:[200 500]
</code></pre>
</li>
<li>
<p>
Numeric filtering - users with age greater than 18:
</p>
<pre><code> @age:[(18 +inf]
</code></pre>
</li>
</ul>
<h2 id="mapping-common-sql-predicates-to-redis-query-engine">
Mapping common SQL predicates to Redis Query Engine
</h2>
<table>
<thead>
<tr>
<th>
SQL Condition
</th>
<th>
Redis Query Engine Equivalent
</th>
<th>
Comments
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
WHERE x='foo' AND y='bar'
</td>
<td>
@x:foo @y:bar
</td>
<td>
for less ambiguity use (@x:foo) (@y:bar)
</td>
</tr>
<tr>
<td>
WHERE x='foo' AND y!='bar'
</td>
<td>
@x:foo -@y:bar
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE x='foo' OR y='bar'
</td>
<td>
(@x:foo)|(@y:bar)
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE x IN ('foo', 'bar','hello world')
</td>
<td>
@x:(foo|bar|"hello world")
</td>
<td>
quotes mean exact phrase
</td>
</tr>
<tr>
<td>
WHERE y='foo' AND x NOT IN ('foo','bar')
</td>
<td>
@y:foo (-@x:foo) (-@x:bar)
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE x NOT IN ('foo','bar')
</td>
<td>
-@x:(foo|bar)
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE num BETWEEN 10 AND 20
</td>
<td>
@num:[10 20]
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE num >= 10
</td>
<td>
@num:[10 +inf]
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE num > 10
</td>
<td>
@num:[(10 +inf]
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE num < 10
</td>
<td>
@num:[-inf (10]
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE num <= 10
</td>
<td>
@num:[-inf 10]
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE num < 10 OR num > 20
</td>
<td>
@num:[-inf (10] | @num:[(20 +inf]
</td>
<td>
</td>
</tr>
<tr>
<td>
WHERE name LIKE 'john%'
</td>
<td>
@name:john*
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h2 id="technical-notes">
Technical notes
</h2>
<p>
The query parser is built using the Lemon Parser Generator and a Ragel based lexer. You can see the
<code>
DIALECT 2
</code>
grammar definition
<a href="https://github.com/RediSearch/RediSearch/blob/master/src/query_parser/v2/parser.y">
at this git repo
</a>
.
</p>
<p>
You can also see the
<a href="/docs/latest/develop/interact/search-and-query/basic-constructs/configuration-parameters#default_dialect">
DEFAULT_DIALECT
</a>
configuration parameter.
</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/query_syntax/"/>
<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/metrics/resource-usage/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Resource usage metrics
</h1>
<h2 id="connections">
Connections
</h2>
<p>
Number of connections to the database.
</p>
<p>
<strong>
Components measured
</strong>
: Cluster, Node, and Database
</p>
<h2 id="cpu-usage">
CPU usage
</h2>
<p>
Percent of the node CPU used.
</p>
<p>
<strong>
Components measured
</strong>
: Cluster and Node
</p>
<h3 id="main-thread-cpu-usage">
Main thread CPU usage
</h3>
<p>
Percent of the CPU used by the main thread.
</p>
<p>
<strong>
Components measured
</strong>
: Database and Shard
</p>
<h3 id="fork-cpu-usage">
Fork CPU usage
</h3>
<p>
CPU usage of Redis child forks.
</p>
<p>
<strong>
Components measured
</strong>
: Database and Shard
</p>
<h3 id="total-cpu-usage">
Total CPU usage
</h3>
<p>
Percent usage of the CPU for all nodes.
</p>
<p>
<strong>
Components measured
</strong>
: Database
</p>
<h2 id="free-disk-space">
Free disk space
</h2>
<p>
Remaining unused disk space.
</p>
<p>
<strong>
Components measured
</strong>
: Cluster and Node
</p>
<h2 id="memory">
Memory
</h2>
<h3 id="used-memory">
Used memory
</h3>
<p>
Total memory used by the database, including RAM,
<a href="/docs/latest/operate/rs/databases/auto-tiering/">
Flash
</a>
(if enabled), and
<a href="/docs/latest/operate/rs/databases/durability-ha/replication/">
replication
</a>
(if enabled).
</p>
<p>
Used memory does not include:
</p>
<ol>
<li>
Fragmentation overhead - The ratio of memory seen by the operating system to memory allocated by Redis
</li>
<li>
Replication buffers at the primary nodes - Set to 10% of used memory and is between 64 MB and 2048 MB
</li>
<li>
Memory used by Lua scripts - Does not exceed 1 MB
</li>
<li>
Copy on Write (COW) operation that can be triggered by:
<ul>
<li>
A full replication process
</li>
<li>
A database snapshot process
</li>
<li>
AOF rewrite process
</li>
</ul>
</li>
</ol>
<p>
Used memory is not measured during
<a href="/docs/latest/operate/rs/databases/configure/replica-ha/">
shard migration
</a>
.
</p>
<p>
<strong>
Components measured
</strong>
: Database and Shard
</p>
<h3 id="free-ram">
Free RAM
</h3>
<p>
Available RAM for System use.
</p>
<p>
<strong>
Components measured
</strong>
: Cluster and Node
</p>
<h3 id="memory-limit">
Memory limit
</h3>
<p>
Memory size limit of the database, enforced on the
<a href="#used-memory">
used memory
</a>
.
</p>
<p>
<strong>
Components measured
</strong>
: Database
</p>
<h3 id="memory-usage">
Memory usage
</h3>
<p>
Percent of memory used by Redis out of the
<a href="#memory-limit">
memory limit
</a>
.
</p>
<p>
<strong>
Components measured
</strong>
: Database
</p>
<h2 id="traffic">
Traffic
</h2>
<h3 id="incoming-traffic">
Incoming traffic
</h3>
<p>
Total incoming traffic to the database in bytes/sec.
</p>
<p>
All incoming traffic is not measured during
<a href="/docs/latest/operate/rs/databases/configure/replica-ha/">
shard migration
</a>
.
</p>
<p>
<strong>
Components measured
</strong>
: Cluster, Node and Database
</p>
<h4 id="incoming-traffic-compressed">
Incoming traffic compressed
</h4>
<p>
Total incoming compressed traffic (in bytes/sec) per
<a href="/docs/latest/operate/rs/databases/active-active/">
Active-Active
</a>
replica database.
</p>
<h4 id="incoming-traffic-uncompressed">
Incoming traffic uncompressed
</h4>
<p>
Total incoming uncompressed traffic (in bytes/sec) per
<a href="/docs/latest/operate/rs/databases/active-active/">
Active-Active
</a>
replica database.
</p>
<h3 id="outgoing-traffic">
Outgoing traffic
</h3>
<p>
Total outgoing traffic from the database in bytes per second.
</p>
<p>
Outgoing traffic is not measured during
<a href="/docs/latest/operate/rs/databases/configure/replica-ha/">
shard migration
</a>
.
</p>
<p>
<strong>
Components measured
</strong>
: Cluster, Node and Database
</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/metrics/resource-usage/"/>
<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/slowlog-get/.html | <section class="prose w-full py-12">
<h1 class="command-name">
SLOWLOG GET
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">SLOWLOG GET [count]</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.2.12
</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 entries returned
</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>
The
<code>
SLOWLOG GET
</code>
command returns entries from the slow log in chronological order.
</p>
<p>
The Redis Slow Log is a system to log queries that exceeded a specified execution time.
The execution time does not include I/O operations like talking with the client, sending the reply and so forth, but just the time needed to actually execute the command (this is the only stage of command execution where the thread is blocked and can not serve other requests in the meantime).
</p>
<p>
A new entry is added to the slow log whenever a command exceeds the execution time threshold defined by the
<code>
slowlog-log-slower-than
</code>
configuration directive.
The maximum number of entries in the slow log is governed by the
<code>
slowlog-max-len
</code>
configuration directive.
</p>
<p>
By default the command returns latest ten entries in the log. The optional
<code>
count
</code>
argument limits the number of returned entries, so the command returns at most up to
<code>
count
</code>
entries, the special number -1 means return all entries.
</p>
<p>
Each entry from the slow log is comprised of the following six values:
</p>
<ol>
<li>
A unique progressive identifier for every slow log entry.
</li>
<li>
The unix timestamp at which the logged command was processed.
</li>
<li>
The amount of time needed for its execution, in microseconds.
</li>
<li>
The array composing the arguments of the command.
</li>
<li>
Client IP address and port.
</li>
<li>
Client name if set via the
<a href="/docs/latest/commands/client-setname/">
<code>
CLIENT SETNAME
</code>
</a>
command.
</li>
</ol>
<p>
The entry's unique ID can be used in order to avoid processing slow log entries multiple times (for instance you may have a script sending you an email alert for every new slow log entry).
The ID is never reset in the course of the Redis server execution, only a server
restart will reset it.
</p>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of slow log entries per the above format.
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 4.0.0: Added client IP address, port and name to the reply.
</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/slowlog-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/cli-utilities/crdb-cli/crdb/purge-instance/.html | <section class="prose w-full py-12 max-w-none">
<h1>
crdb-cli crdb purge-instance
</h1>
<p class="text-lg -mt-5 mb-10">
Deletes data from a local instance and removes it from the Active-Active database.
</p>
<p>
Deletes data from a local instance and removes the instance from the Active-Active database.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">crdb-cli crdb purge-instance --crdb-guid <guid>
</span></span><span class="line"><span class="cl"> --instance-id <instance-id>
</span></span><span class="line"><span class="cl"> <span class="o">[</span> --no-wait <span class="o">]</span>
</span></span></code></pre>
</div>
<p>
Once this command finishes, the other replicas must remove this instance with
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/crdb-cli/crdb/remove-instance/">
<code>
crdb-cli crdb remove-instance --force
</code>
</a>
.
</p>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
crdb-guid
</td>
<td>
string
</td>
<td>
The GUID of the database (required)
</td>
</tr>
<tr>
<td>
instance-id
</td>
<td>
string
</td>
<td>
The ID of the local instance (required)
</td>
</tr>
<tr>
<td>
no-wait
</td>
<td>
</td>
<td>
Does not wait for the task to complete
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns the task ID of the task that is purging the local instance.
</p>
<p>
If
<code>
--no-wait
</code>
is specified, the command exits. Otherwise, it will wait for the instance to be purged and return
<code>
finished
</code>
.
</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">$ crdb-cli crdb purge-instance --crdb-guid db6365b5-8aca-4055-95d8-7eb0105c0b35 --instance-id <span class="m">2</span>
</span></span><span class="line"><span class="cl">Task add0705c-87f1-4c28-ad6a-ab5d98e00c58 created
</span></span><span class="line"><span class="cl"> ---> Status changed: queued -> started
</span></span><span class="line"><span class="cl"> ---> Status changed: started -> finished
</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/crdb-cli/crdb/purge-instance/"/>
<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-delete-all-contexts/.html | <section class="prose w-full py-12">
<h1>
redis-di delete-all-contexts
</h1>
<p class="text-lg -mt-5 mb-10">
Deletes all contexts
</p>
<h2 id="usage">
Usage
</h2>
<pre tabindex="0"><code>Usage: redis-di delete-all-contexts [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>
force
</code>
:
</p>
<ul>
<li>
Type: BOOL
</li>
<li>
Default:
<code>
false
</code>
</li>
<li>
Usage:
<code>
--force -f
</code>
</li>
</ul>
<p>
Force operation. skips verification prompts
</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 delete-all-contexts [OPTIONS]
Deletes all contexts
Options:
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
-f, --force Force operation. skips verification prompts
--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-delete-all-contexts/"/>
<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/crdb_tasks/.html | <section class="prose w-full py-12 max-w-none">
<h1>
CRDB tasks requests
</h1>
<p class="text-lg -mt-5 mb-10">
Active-Active database task status requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-crdb_task">
GET
</a>
</td>
<td>
<code>
/v1/crdb_tasks/{task_id}
</code>
</td>
<td>
Get the status of an executed task
</td>
</tr>
</tbody>
</table>
<h2 id="get-crdb_task">
Get task status
</h2>
<pre><code>GET /v1/crdb_tasks/{task_id}
</code></pre>
<p>
Get the status of an executed task.
</p>
<p>
The status of a completed task is kept for 500 seconds by default.
</p>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /crdb_tasks/1
</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>
X-Result-TTL
</td>
<td>
integer
</td>
<td>
Task time to live
</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>
task_id
</td>
<td>
string
</td>
<td>
Task ID
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a
<a href="/docs/latest/operate/rs/references/rest-api/objects/crdb_task/">
CRDB task object
</a>
.
</p>
<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>
Task status.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">
401 Unauthorized
</a>
</td>
<td>
Unauthorized request. Invalid credentials
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Task not found.
</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/crdb_tasks/"/>
<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/quickstarts/redis-enterprise-software-quickstart/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software quickstart
</h1>
<p class="text-lg -mt-5 mb-10">
Set up a test deployment of Redis Enterprise Software for Linux.
</p>
<p>
This guide helps you install Redis Enterprise Software on a Linux host to test its capabilities.
</p>
<p>
When finished, you'll have a simple cluster with a single node:
</p>
<ol>
<li>
<p>
<a href="#ensure-port-availability">
Ensure port availability
</a>
</p>
</li>
<li>
<p>
<a href="#install-redis-enterprise-software">
Install Redis Enterprise Software
</a>
</p>
</li>
<li>
<p>
<a href="#set-up-a-cluster">
Set up a Redis Enterprise Software cluster
</a>
</p>
</li>
<li>
<p>
<a href="#create-a-database">
Create a new Redis database
</a>
</p>
</li>
<li>
<p>
<a href="#connect-to-your-database">
Connect to your Redis database
</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>
<strong>
This quickstart is designed for local testing only.
</strong>
For production environments, see the
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/#install-redis-enterprise-software">
install and setup
</a>
guide for deployment options and instructions.
</div>
</div>
<h2 id="ensure-port-availability">
Ensure port availability
</h2>
<p>
If ports that Redis assigns to the database are being used by the operating system or other processes, the installation fails.
</p>
<p>
Follow the relevant sections to configure required ports.
</p>
<p>
For recommended and optional port configuration, see
<a href="/docs/latest/operate/rs/7.4/networking/port-configurations/">
Network port configurations
</a>
.
</p>
<h3 id="update-sysctlconf-to-avoid-port-collisions">
Update
<code>
sysctl.conf
</code>
to avoid port collisions
</h3>
<p>
To avoid port collision, update
<code>
/etc/sysctl.conf
</code>
to include:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">net.ipv4.ip_local_port_range <span class="o">=</span> <span class="m">30000</span> <span class="m">65535</span>
</span></span></code></pre>
</div>
<h3 id="ubuntu-conflicts-with-port-53">
Ubuntu conflicts with port 53
</h3>
<p>
If port 53 is in use, the installation fails. This can occur in
default installations of Ubuntu 18.04 and 20.04 in which
<code>
systemd-resolved
</code>
(DNS server) is running.
</p>
<p>
To prevent this issue, change the system configuration to make this port available
before installation.
</p>
<ol>
<li>
<p>
Edit
<code>
/etc/systemd/resolved.conf
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo vi /etc/systemd/resolved.conf
</span></span></code></pre>
</div>
</li>
<li>
<p>
Add
<code>
DNSStubListener=no
</code>
as the last line in the file and save the file.
</p>
</li>
<li>
<p>
Rename the current
<code>
/etc/resolv.conf
</code>
file:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo mv /etc/resolv.conf /etc/resolv.conf.orig
</span></span></code></pre>
</div>
</li>
<li>
<p>
Create a symbolic link for
<code>
/etc/resolv.conf
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo ln -s /run/systemd/resolve/resolv.conf /etc/resolv.conf
</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>
You might encounter a temporary name resolution error (
<code>
sudo: unable to resolve host {hostname}: Temporary failure in name resolution
</code>
), which should be fixed when you restart
<code>
systemd-resolved
</code>
in the next step.
</div>
</div>
</li>
<li>
<p>
Restart the DNS service:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo service systemd-resolved restart
</span></span></code></pre>
</div>
</li>
</ol>
<h3 id="configuration-for-aws-and-gcp">
Configuration for AWS and GCP
</h3>
<p>
For detailed configuration instructions, see your cloud provider's documentation.
</p>
<ol>
<li>
<p>
Create a VPC that you can use with regional subnets.
</p>
</li>
<li>
<p>
Within this VPC, create firewall rules that allow external and internal access for Redis Enterprise Software.
</p>
</li>
</ol>
<table>
<thead>
<tr>
<th>
Ingress/Egress
</th>
<th>
Source
</th>
<th>
Protocol
</th>
<th>
Ports
</th>
<th>
Other protocols
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Ingress
</td>
<td>
0.0.0.0/0
</td>
<td>
TCP
</td>
<td>
21, 22, 53, 8001, 8443, 9443, 8070,
<nobr>
10000-19999
</nobr>
</td>
<td>
ICMP
</td>
</tr>
<tr>
<td>
Ingress
</td>
<td>
0.0.0.0/0
</td>
<td>
UDP
</td>
<td>
53, 5353
</td>
<td>
</td>
</tr>
<tr>
<td>
Ingress
</td>
<td>
10.0.0.0/8 (if subnets use 10. ranges)
</td>
<td>
all
</td>
<td>
all
</td>
<td>
</td>
</tr>
</tbody>
</table>
<h2 id="install-redis-enterprise-software">
Install Redis Enterprise Software
</h2>
<p>
To install Redis Enterprise Software:
</p>
<ol>
<li>
<p>
Download the installation files from the
<a href="https://redis.com/redis-enterprise-software/download-center/software/">
Redis Enterprise Download Center
</a>
and copy the download package to a machine with a Linux-based OS.
</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 are required to create a free account to access the download center.
</div>
</div>
</li>
<li>
<p>
Extract the installation files:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">tar vxf <downloaded tar file name>
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run the
<code>
install.sh
</code>
script in the current directory:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo ./install.sh -y
</span></span></code></pre>
</div>
</li>
</ol>
<h2 id="set-up-a-cluster">
Set up a cluster
</h2>
<p>
To set up your machine as a Redis Enterprise Software cluster:
</p>
<ol>
<li>
<p>
In the web browser on the host machine, go to
<a href="https://localhost:8443">
https://localhost:8443
</a>
to see
the new Redis Enterprise Software Cluster Manager UI. The cluster generates self-signed TLS certificates to secure the connection. These self-signed certificates are unknown to the browser and must be accepted before you proceed.
</p>
<p>
To use the legacy UI for this quickstart instead, see the
<a href="https://docs.redis.com/6.4/rs/installing-upgrading/quickstarts/">
6.4 version of the quickstarts
</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>
<ul>
<li>
If the server does not show the login screen, try again after a few minutes.
</li>
</ul>
</div>
</div>
</li>
<li>
<p>
Select
<strong>
Create new cluster
</strong>
.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/create-cluster.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/create-cluster.png">
<img alt="When you first install Redis Enterprise Software, you need to set up a cluster." src="/docs/latest/images/rs/screenshots/cluster/setup/create-cluster.png"/>
</a>
</li>
<li>
<p>
Enter an email and password for the administrator account, then select
<strong>
Next
</strong>
to proceed to cluster setup.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/admin-credentials.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/admin-credentials.png">
<img alt="Set the credentials for your admin user." src="/docs/latest/images/rs/screenshots/cluster/setup/admin-credentials.png"/>
</a>
<p>
You can also use these credentials to connect to the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/">
REST API
</a>
.
</p>
</li>
<li>
<p>
Enter your cluster license key if you have one. Otherwise, a trial version is installed.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/cluster-license-key.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/cluster-license-key.png">
<img alt="Enter your cluster license key if you have one." src="/docs/latest/images/rs/screenshots/cluster/setup/cluster-license-key.png"/>
</a>
</li>
<li>
<p>
In the
<strong>
Configuration
</strong>
section, enter a cluster FQDN such as
<code>
cluster.local
</code>
, then select
<strong>
Next
</strong>
.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/config-cluster.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/config-cluster.png">
<img alt="Configure the cluster FQDN." src="/docs/latest/images/rs/screenshots/cluster/setup/config-cluster.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">
Warning:
</div>
If the FQDN is
<code>
cluster.local
</code>
, you cannot configure DNS. You cannot change the FQDN after cluster creation.
</div>
</div>
</li>
<li>
<p>
On the node setup screen, select
<strong>
Create cluster
</strong>
to accept the defaults.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/node-settings.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/node-settings.png">
<img alt="Configure the node specific settings." src="/docs/latest/images/rs/screenshots/cluster/setup/node-settings.png"/>
</a>
</li>
<li>
<p>
Select
<strong>
OK
</strong>
to acknowledge the replacement of the HTTPS TLS certificate on the node. If you receive a browser warning, you can proceed safely.
</p>
<a href="/docs/latest/images/rs/screenshots/cluster/setup/https-page-refresh-modal.png" sdata-lightbox="/images/rs/screenshots/cluster/setup/https-page-refresh-modal.png">
<img alt="Modal shown when a page refresh is needed because the certificates have been updated." src="/docs/latest/images/rs/screenshots/cluster/setup/https-page-refresh-modal.png"/>
</a>
</li>
</ol>
<h2 id="create-a-database">
Create a database
</h2>
<ol>
<li>
<p>
On the
<strong>
Databases
</strong>
screen, select
<strong>
Quick database
</strong>
.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/db-screen.png" sdata-lightbox="/images/rs/screenshots/databases/db-screen.png">
<img alt="Select Quick database on the Databases screen." src="/docs/latest/images/rs/screenshots/databases/db-screen.png"/>
</a>
</li>
<li>
<p>
Enter 12000 for the
<strong>
Port
</strong>
.
</p>
<p>
If port 12000 is not available, enter any available port number between 10000 to 19999 or leave it blank to let the cluster assign a port number for you. You will use this port number to connect to the database.
</p>
<a href="/docs/latest/images/rs/screenshots/databases/quick-db.png" sdata-lightbox="/images/rs/screenshots/databases/quick-db.png">
<img alt="Create a quick database." src="/docs/latest/images/rs/screenshots/databases/quick-db.png"/>
</a>
</li>
<li>
<p>
Select
<strong>
Create
</strong>
to create your database.
</p>
</li>
</ol>
<p>
When you see
<strong>
Database active
</strong>
appear on the database configuration screen, the database is activated and ready for you to use.
</p>
<a href="/docs/latest/images/rs/icons/db-active-icon.png" sdata-lightbox="/images/rs/icons/db-active-icon.png">
<img alt="Database active icon." src="/docs/latest/images/rs/icons/db-active-icon.png" width="150px"/>
</a>
<p>
You now have a Redis database!
</p>
<h2 id="connect-to-your-database">
Connect to your database
</h2>
<p>
After you create the Redis database, you can connect to it and store data.
See
<a href="/docs/latest/operate/rs/7.4/databases/connect/test-client-connectivity/">
Test client connection
</a>
for connection options and examples.
</p>
<h2 id="supported-web-browsers">
Supported web browsers
</h2>
<p>
To use the Redis Enterprise Software Cluster Manager UI, you need a modern browser with JavaScript enabled.
</p>
<p>
The following browsers have been tested with the current version of the Cluster Manager UI:
</p>
<ul>
<li>
<p>
Microsoft Windows, version 10 or later.
</p>
<ul>
<li>
<a href="https://www.google.com/chrome/">
Google Chrome
</a>
, version 48 and later
</li>
<li>
<a href="https://www.microsoft.com/edge">
Microsoft Edge
</a>
, version 20 and later
</li>
<li>
<a href="https://www.mozilla.org/firefox/">
Mozilla Firefox
</a>
, version 44 and and later
</li>
<li>
<a href="https://www.opera.com/">
Opera
</a>
, version 35 and later
</li>
</ul>
</li>
<li>
<p>
Apple macOS:
</p>
<ul>
<li>
<a href="https://www.google.com/chrome/">
Google Chrome
</a>
, version 48 and later
</li>
<li>
<a href="https://www.mozilla.org/firefox/">
Mozilla Firefox
</a>
, version 44 and and later
</li>
<li>
<a href="https://www.opera.com/">
Opera
</a>
, version 35 and later
</li>
</ul>
</li>
<li>
<p>
Linux:
</p>
<ul>
<li>
<a href="https://www.google.com/chrome/">
Google Chrome
</a>
, version 49 and later
</li>
<li>
<a href="https://www.mozilla.org/firefox/">
Mozilla Firefox
</a>
, version 44 and and later
</li>
<li>
<a href="https://www.opera.com/">
Opera
</a>
, version 35 and later
</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/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-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/operate/kubernetes/networking/ingress/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Configure Ingress for external routing
</h1>
<p class="text-lg -mt-5 mb-10">
Configure an ingress controller to access your Redis Enterprise databases from outside the Kubernetes cluster.
</p>
<h2 id="prerequisites">
Prerequisites
</h2>
<p>
Before creating an Ingress, you'll need:
</p>
<ul>
<li>
A RedisEnterpriseDatabase (REDB) with TLS enabled for client connections
</li>
<li>
A supported Ingress controller with
<code>
ssl-passthrough
</code>
enabled
<ul>
<li>
<a href="https://kubernetes.github.io/ingress-nginx/deploy/">
Ingress-NGINX Controller
</a>
<ul>
<li>
Be sure to use the
<code>
kubernetes/ingress-nginx
</code>
controller and NOT the
<code>
nginxinc/kubernetes-ingress
</code>
controller.
</li>
</ul>
</li>
<li>
<a href="https://haproxy-ingress.github.io/docs/getting-started/">
HAProxy Ingress
</a>
</li>
<li>
To use Istio for your Ingress resources, see
<a href="/docs/latest/operate/kubernetes/networking/istio-ingress/">
Configure Istio for external routing
</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>
Make sure your Ingress controller has
<code>
ssl-passthrough
</code>
enabled. This is enabled by default for HAProxy, but disabled by default for NGINX. See the
<a href="https://kubernetes.github.io/ingress-nginx/user-guide/tls/#ssl-passthrough">
NGINX User Guide
</a>
for details.
</div>
</div>
<h2 id="create-an-ingress-resource">
Create an Ingress resource
</h2>
<ol>
<li>
<p>
Retrieve the hostname of your Ingress controller's
<code>
LoadBalancer
</code>
service.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ kubectl get svc <haproxy-ingress <span class="p">|</span> ingress-ngnix-controller> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -n <ingress-ctrl-namespace>
</span></span></code></pre>
</div>
<p>
Below is example output for an HAProxy running on a K8s cluster hosted by AWS.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">NAME TYPE CLUSTER-IP EXTERNAL-IP PORT<span class="o">(</span>S<span class="o">)</span> AGE
</span></span><span class="line"><span class="cl">haproxy-ingress LoadBalancer 10.43.62.53 a56e24df8c6173b79a63d5da54fd9cff-676486416.us-east-1.elb.amazonaws.com 80:30610/TCP,443:31597/TCP 21m
</span></span></code></pre>
</div>
</li>
<li>
<p>
Choose the hostname you will use to access your database (this value will be represented in this article with
<code>
<my-db-hostname>
</code>
).
</p>
</li>
<li>
<p>
Create a DNS entry that resolves your chosen database hostname to the IP address for the Ingress controller's LoadBalancer.
</p>
</li>
<li>
<p>
Create the Ingress resource YAML file.
</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">networking.k8s.io/v1</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">Ingress</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">rec-ingress</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="l"><controller-specific-annotations-below></span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">spec</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">rules</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="l"><my-db-hostname></span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">http</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">paths</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l">/</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">pathType</span><span class="p">:</span><span class="w"> </span><span class="l">ImplementationSpecific</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">backend</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">service</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"><db-name></span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">port</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">redis</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
For HAProxy, insert the following into the
<code>
annotations
</code>
section:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-YAML" data-lang="YAML"><span class="line"><span class="cl"><span class="nt">kubernetes.io/ingress.class</span><span class="p">:</span><span class="w"> </span><span class="l">haproxy</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">ingress.kubernetes.io/ssl-passthrough</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
For NGINX, insert the following into the
<code>
annotations
</code>
section:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-YAML" data-lang="YAML"><span class="line"><span class="cl"><span class="nt">kubernetes.io/ingress.class</span><span class="p">:</span><span class="w"> </span><span class="l">nginx</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">nginx.ingress.kubernetes.io/ssl-passthrough</span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
The
<code>
ssl-passthrough
</code>
annotation is required to allow access to the database. The specific format changes depending on your Ingress controller and any additional customizations. See
<a href="https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/">
NGINX Configuration annotations
</a>
and
<a href="https://www.haproxy.com/documentation/kubernetes/latest/configuration/ingress/">
HAProxy Ingress Options
</a>
for updated annotation formats.
</p>
</li>
</ol>
<h2 id="test-your-external-access">
Test your external access
</h2>
<p>
To test your external access to the database, you need a client that supports
<a href="https://en.wikipedia.org/wiki/Transport_Layer_Security">
TLS
</a>
and
<a href="https://en.wikipedia.org/wiki/Server_Name_Indication">
SNI
</a>
.
</p>
<h4 id="test-your-access-with-openssl">
Test your access with Openssl
</h4>
<ol>
<li>
<p>
Get the default CA certificate from the
<code>
redis-enterprise-node
</code>
container on any of the Redis Enterprise pods.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ kubectl <span class="nb">exec</span> -it <pod-name> -c redis-enterprise-node <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -- cat /etc/opt/redislabs/proxy_cert.pem
</span></span></code></pre>
</div>
</li>
<li>
<p>
Run the following
<code>
openssl
</code>
command, substituting your own values for
<code>
<my-db-hostname>
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ openssl s_client <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -connect <my-db-hostname>:443 <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -crlf -CAfile ./proxy_cert.pem <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -servername <my-db-hostname>
</span></span></code></pre>
</div>
<p>
If you are connected to the database, you will receive
<code>
PONG
</code>
back, as shown below:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">...
</span></span><span class="line"><span class="cl"> Verify <span class="k">return</span> code: <span class="m">0</span> <span class="o">(</span>ok<span class="o">)</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">PING
</span></span><span class="line"><span class="cl">+PONG
</span></span></code></pre>
</div>
</li>
</ol>
<h4 id="test-your-access-with-python">
Test your access with Python
</h4>
<p>
You can use the code below to test your access with Python, substituting your own values for
<code>
<my-db-hostname>
</code>
and
<code>
<file-path>
</code>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><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></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">StrictRedis</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="s1">'<my-db-hostname>'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">port</span><span class="o">=</span><span class="mi">443</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">ssl</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">ssl_ca_certs</span><span class="o">=</span><span class="s1">'/<file-path>/proxy_cert.pem'</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="nb">print</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">info</span><span class="p">())</span>
</span></span></code></pre>
</div>
<p>
Your output should look something like this:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ /Users/example-user/Documents/Projects/test_client/venv3.7/bin/python <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> /Users/example-user/Documents/Projects/test_client/test_ssl.py
</span></span><span class="line"><span class="cl"><span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'redis_version'</span>: <span class="s1">'5.0.5'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'redis_git_sha1'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'redis_git_dirty'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'redis_build_id'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'redis_mode'</span>: <span class="s1">'standalone'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'os'</span>: <span class="s1">'Linux 4.14.154-128.181.amzn2.x86_64 x86_64'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'arch_bits'</span>: 64,
</span></span><span class="line"><span class="cl"> <span class="s1">'multiplexing_api'</span>: <span class="s1">'epoll'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'gcc_version'</span>: <span class="s1">'7.4.0'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'process_id'</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s1">'run_id'</span>: <span class="s1">'3ce7721b096517057d28791aab555ed8ac02e1de'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'tcp_port'</span>: 10811,
</span></span><span class="line"><span class="cl"> <span class="s1">'uptime_in_seconds'</span>: 316467,
</span></span><span class="line"><span class="cl"> <span class="s1">'uptime_in_days'</span>: 3,
</span></span><span class="line"><span class="cl"> <span class="s1">'hz'</span>: 10,
</span></span><span class="line"><span class="cl"> <span class="s1">'lru_clock'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'config_file'</span>: <span class="s1">''</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'connected_clients'</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s1">'client_longest_output_list'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'client_biggest_input_buf'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'blocked_clients'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_memory'</span>: 12680016,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_memory_human'</span>: <span class="s1">'12.9M'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_memory_rss'</span>: 12680016,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_memory_peak'</span>: 13452496,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_memory_peak_human'</span>: <span class="s1">'12.82M'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_memory_lua'</span>: 151552,
</span></span><span class="line"><span class="cl"> <span class="s1">'mem_fragmentation_ratio'</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s1">'mem_allocator'</span>: <span class="s1">'jemalloc-5.1.0'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'loading'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'rdb_changes_since_last_save'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'rdb_bgsave_in_progress'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'rdb_last_save_time'</span>: 1577753916,
</span></span><span class="line"><span class="cl"> <span class="s1">'rdb_last_bgsave_status'</span>: <span class="s1">'ok'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'rdb_last_bgsave_time_sec'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'rdb_current_bgsave_time_sec'</span>: -1,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_enabled'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_rewrite_in_progress'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_rewrite_scheduled'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_last_rewrite_time_sec'</span>: -1,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_current_rewrite_time_sec'</span>: -1,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_last_bgrewrite_status'</span>: <span class="s1">'ok'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'aof_last_write_status'</span>: <span class="s1">'ok'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'total_connections_received'</span>: 4,
</span></span><span class="line"><span class="cl"> <span class="s1">'total_commands_processed'</span>: 6,
</span></span><span class="line"><span class="cl"> <span class="s1">'instantaneous_ops_per_sec'</span>: 14,
</span></span><span class="line"><span class="cl"> <span class="s1">'total_net_input_bytes'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'total_net_output_bytes'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'instantaneous_input_kbps'</span>: 0.0,
</span></span><span class="line"><span class="cl"> <span class="s1">'instantaneous_output_kbps'</span>: 0.0,
</span></span><span class="line"><span class="cl"> <span class="s1">'rejected_connections'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'sync_full'</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s1">'sync_partial_ok'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'sync_partial_err'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'expired_keys'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'evicted_keys'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'keyspace_hits'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'keyspace_misses'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'pubsub_channels'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'pubsub_patterns'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'latest_fork_usec'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'migrate_cached_sockets'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'role'</span>: <span class="s1">'master'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'connected_slaves'</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s1">'slave0'</span>: <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'ip'</span>: <span class="s1">'0.0.0.0'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'port'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'state'</span>: <span class="s1">'online'</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'offset'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'lag'</span>: <span class="m">0</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span>,
</span></span><span class="line"><span class="cl"> <span class="s1">'master_repl_offset'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'repl_backlog_active'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'repl_backlog_size'</span>: 1048576,
</span></span><span class="line"><span class="cl"> <span class="s1">'repl_backlog_first_byte_offset'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'repl_backlog_histlen'</span>: 0,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_cpu_sys'</span>: 0.0,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_cpu_user'</span>: 0.0,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_cpu_sys_children'</span>: 0.0,
</span></span><span class="line"><span class="cl"> <span class="s1">'used_cpu_user_children'</span>: 0.0,
</span></span><span class="line"><span class="cl"> <span class="s1">'cluster_enabled'</span>: <span class="m">0</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">Process finished with <span class="nb">exit</span> code <span class="m">0</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/kubernetes/networking/ingress/"/>
<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/hincrbyfloat/.html | <section class="prose w-full py-12">
<h1 class="command-name">
HINCRBYFLOAT
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">HINCRBYFLOAT 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.6.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>
Increment the specified
<code>
field
</code>
of a hash stored at
<code>
key
</code>
, and representing a
floating point number, by the specified
<code>
increment
</code>
. If the increment value
is negative, the result is to have the hash field value
<strong>
decremented
</strong>
instead of incremented.
If the field does not exist, it is set to
<code>
0
</code>
before performing the operation.
An error is returned if one of the following conditions occur:
</p>
<ul>
<li>
The key contains a value of the wrong type (not a hash).
</li>
<li>
The current field content or the specified increment are not parsable as a
double precision floating point number.
</li>
</ul>
<p>
The exact behavior of this command is identical to the one of the
<a href="/docs/latest/commands/incrbyfloat/">
<code>
INCRBYFLOAT
</code>
</a>
command, please refer to the documentation of
<a href="/docs/latest/commands/incrbyfloat/">
<code>
INCRBYFLOAT
</code>
</a>
for further
information.
</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 mykey field 10.50
(integer) 1
redis> HINCRBYFLOAT mykey field 0.1
"10.6"
redis> HINCRBYFLOAT mykey field -5
"5.6"
redis> HSET mykey field 5.0e3
(integer) 0
redis> HINCRBYFLOAT mykey field 2.0e2
"5200"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="implementation-details">
Implementation details
</h2>
<p>
The command is always propagated in the replication link and the Append Only
File as a
<a href="/docs/latest/commands/hset/">
<code>
HSET
</code>
</a>
operation, so that differences in the underlying floating point
math implementation will not be sources of inconsistency.
</p>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
: the value of the field after the increment operation.
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string 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/hincrbyfloat/"/>
<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/actions/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Actions requests
</h1>
<p class="text-lg -mt-5 mb-10">
Actions requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-actions">
GET
</a>
</td>
<td>
<code>
/v1/actions
</code>
</td>
<td>
Get all actions
</td>
</tr>
<tr>
<td>
<a href="#get-action">
GET
</a>
</td>
<td>
<code>
/v1/actions/{uid}
</code>
</td>
<td>
Get a single action
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-actions">
Get all actions
</h2>
<pre tabindex="0"><code>GET /v1/actions
</code></pre>
<p>
Get the status of all actions (executing, queued, or completed) on all entities (clusters, nodes, and databases). This API tracks long-lived API requests that return either a
<code>
task_id
</code>
or an
<code>
action_uid
</code>
.
</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_status_of_cluster_action">
view_status_of_cluster_action
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre tabindex="0"><code>GET /actions
</code></pre>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a JSON array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/action/">
action objects
</a>
and an array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/state-machine/">
state-machine objects
</a>
.
</p>
<p>
Regardless of an action’s source, each action in the response contains the following attributes:
<code>
name
</code>
,
<code>
action_uid
</code>
,
<code>
status
</code>
, and
<code>
progress
</code>
.
</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">"actions"</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">"action_uid"</span><span class="p">:</span> <span class="s2">"159ca2f8-7bf3-4cda-97e8-4eb560665c28"</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">"retry_bdb"</span><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">"2"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"progress"</span><span class="p">:</span> <span class="s2">"100"</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">"completed"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"task_id"</span><span class="p">:</span> <span class="s2">"159ca2f8-7bf3-4cda-97e8-4eb560665c28"</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">"action_uid"</span><span class="p">:</span> <span class="s2">"661697c5-c747-41bd-ab81-ffc8fd13c494"</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">"retry_bdb"</span><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">"progress"</span><span class="p">:</span> <span class="s2">"100"</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">"completed"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"task_id"</span><span class="p">:</span> <span class="s2">"661697c5-c747-41bd-ab81-ffc8fd13c494"</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">"state-machines"</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">"action_uid"</span><span class="p">:</span> <span class="s2">"a10586b1-60bc-428e-9bc6-392eb5f0d8ae"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"heartbeat"</span><span class="p">:</span> <span class="mi">1650378874</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">"SMCreateBDB"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"object_name"</span><span class="p">:</span> <span class="s2">"bdb:1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"progress"</span><span class="p">:</span> <span class="mi">100</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">"completed"</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>
<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, response provides info about an ongoing action
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Action does not exist (i.e. not currently running and no available status of last run).
</td>
</tr>
</tbody>
</table>
<h2 id="get-action">
Get a specific action
</h2>
<pre tabindex="0"><code>GET /v1/actions/{uid}
</code></pre>
<p>
Get the status of a currently executing, queued, or completed action.
</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_status_of_cluster_action">
view_status_of_cluster_action
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre tabindex="0"><code>GET /actions/{uid}
</code></pre>
<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>
string
</td>
<td>
The action_uid to check
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns an
<a href="/docs/latest/operate/rs/references/rest-api/objects/action/">
action object
</a>
.
</p>
<p>
Regardless of an action’s source, each action contains the following attributes:
<code>
name
</code>
,
<code>
action_uid
</code>
,
<code>
status
</code>
, and
<code>
progress
</code>
.
</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">"action_uid"</span><span class="p">:</span> <span class="s2">"159ca2f8-7bf3-4cda-97e8-4eb560665c28"</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">"retry_bdb"</span><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">"2"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"progress"</span><span class="p">:</span> <span class="s2">"100"</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">"completed"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"task_id"</span><span class="p">:</span> <span class="s2">"159ca2f8-7bf3-4cda-97e8-4eb560665c28"</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, response provides info about an ongoing action
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Action does not exist (i.e. not currently running and no available status of last run)
</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/actions/"/>
<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/lset/.html | <section class="prose w-full py-12">
<h1 class="command-name">
LSET
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">LSET key index element</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(N) where N is the length of the list. Setting either the first or the last element of the list is 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>
@list
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Sets the list element at
<code>
index
</code>
to
<code>
element
</code>
.
For more information on the
<code>
index
</code>
argument, see
<a href="/docs/latest/commands/lindex/">
<code>
LINDEX
</code>
</a>
.
</p>
<p>
An error is returned for out of range indexes.
</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> RPUSH mylist "one"
(integer) 1
redis> RPUSH mylist "two"
(integer) 2
redis> RPUSH mylist "three"
(integer) 3
redis> LSET mylist 0 "four"
"OK"
redis> LSET mylist -2 "five"
"OK"
redis> LRANGE mylist 0 -1
1) "four"
2) "five"
3) "three"
</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#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/lset/"/>
<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/crdb-cli/crdb/list/.html | <section class="prose w-full py-12 max-w-none">
<h1>
crdb-cli crdb list
</h1>
<p class="text-lg -mt-5 mb-10">
Shows a list of all Active-Active databases.
</p>
<p>
Shows a list of all Active-Active databases.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">crdb-cli crdb list
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<p>
None
</p>
<h3 id="returns">
Returns
</h3>
<p>
Returns a list of all Active-Active databases that the cluster participates in. Each database is represented with a unique GUID, the name of the database, an instance ID, and the FQDN of the cluster that hosts the instance.
</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">$ crdb-cli crdb list
</span></span><span class="line"><span class="cl">CRDB-GUID NAME REPL-ID CLUSTER-FQDN
</span></span><span class="line"><span class="cl">d84f6fe4-5bb7-49d2-a188-8900e09c6f66 database1 <span class="m">1</span> cluster1.redis.local
</span></span><span class="line"><span class="cl">d84f6fe4-5bb7-49d2-a188-8900e09c6f66 database1 <span class="m">2</span> cluster2.redis.local
</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/crdb-cli/crdb/list/"/>
<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/acl-log/.html | <section class="prose w-full py-12">
<h1 class="command-name">
ACL LOG
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">ACL LOG [count | RESET]</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(N) with N being the number of entries shown.
</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>
The command shows a list of recent ACL security events:
</p>
<ol>
<li>
Failures to authenticate their connections with
<a href="/docs/latest/commands/auth/">
<code>
AUTH
</code>
</a>
or
<a href="/docs/latest/commands/hello/">
<code>
HELLO
</code>
</a>
.
</li>
<li>
Commands denied because against the current ACL rules.
</li>
<li>
Commands denied because accessing keys not allowed in the current ACL rules.
</li>
</ol>
<p>
The optional argument specifies how many entries to show. By default
up to ten failures are returned. The special
<a href="/docs/latest/commands/reset/">
<code>
RESET
</code>
</a>
argument clears the log.
Entries are displayed starting from the most recent.
</p>
<h2 id="examples">
Examples
</h2>
<pre tabindex="0"><code>> AUTH someuser wrongpassword
(error) WRONGPASS invalid username-password pair
> ACL LOG 1
1) 1) "count"
2) (integer) 1
3) "reason"
4) "auth"
5) "context"
6) "toplevel"
7) "object"
8) "AUTH"
9) "username"
10) "someuser"
11) "age-seconds"
12) "8.038"
13) "client-info"
14) "id=3 addr=127.0.0.1:57275 laddr=127.0.0.1:6379 fd=8 name= age=16 idle=0 flags=N db=0 sub=0 psub=0 ssub=0 multi=-1 qbuf=48 qbuf-free=16842 argv-mem=25 multi-mem=0 rbs=1024 rbp=0 obl=0 oll=0 omem=0 tot-mem=18737 events=r cmd=auth user=default redir=-1 resp=2"
15) "entry-id"
16) (integer) 0
17) "timestamp-created"
18) (integer) 1675361492408
19) "timestamp-last-updated"
20) (integer) 1675361492408
</code></pre>
<p>
Each log entry is composed of the following fields:
</p>
<ol>
<li>
<code>
count
</code>
: The number of security events detected within a 60 second period that are represented by this entry.
</li>
<li>
<code>
reason
</code>
: The reason that the security events were logged. Either
<code>
command
</code>
,
<code>
key
</code>
,
<code>
channel
</code>
, or
<code>
auth
</code>
.
</li>
<li>
<code>
context
</code>
: The context that the security events were detected in. Either
<code>
toplevel
</code>
,
<code>
multi
</code>
,
<code>
lua
</code>
, or
<code>
module
</code>
.
</li>
<li>
<code>
object
</code>
: The resource that the user had insufficient permissions to access.
<code>
auth
</code>
when the reason is
<code>
auth
</code>
.
</li>
<li>
<code>
username
</code>
: The username that executed the command that caused the security events or the username that had a failed authentication attempt.
</li>
<li>
<code>
age-seconds
</code>
: Age of the log entry in seconds.
</li>
<li>
<code>
client-info
</code>
: Displays the client info of a client which caused one of the security events.
</li>
<li>
<code>
entry-id
</code>
: The sequence number of the entry (starting at 0) since the server process started. Can also be used to check if items were “lost”, if they fell between periods.
</li>
<li>
<code>
timestamp-created
</code>
: A UNIX timestamp in
<code>
milliseconds
</code>
at the time the entry was first created.
</li>
<li>
<code>
timestamp-last-updated
</code>
: A UNIX timestamp in
<code>
milliseconds
</code>
at the time the entry was last updated.
</li>
</ol>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<p>
When called to show security events:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: an array of
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
elements representing ACL security events.
When called with
<code>
RESET
</code>
:
</li>
<li>
<a href="../../develop/reference/protocol-spec#simple-strings">
Simple string reply
</a>
:
<code>
OK
</code>
if the security log was cleared.
</li>
</ul>
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 7.2.0: Added entry ID, timestamp created, and timestamp last updated.
</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/acl-log/"/>
<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/modules/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis modules API
</h1>
<p class="text-lg -mt-5 mb-10">
Introduction to writing Redis modules
</p>
<p>
The modules documentation is composed of the following pages:
</p>
<ul>
<li>
Introduction to Redis modules (this file). An overview about Redis Modules system and API. It's a good idea to start your reading here.
</li>
<li>
<a href="/docs/latest/develop/reference/modules/modules-native-types/">
Implementing native data types
</a>
covers the implementation of native data types into modules.
</li>
<li>
<a href="/docs/latest/develop/reference/modules/modules-blocking-ops/">
Blocking operations
</a>
shows how to write blocking commands that will not reply immediately, but will block the client, without blocking the Redis server, and will provide a reply whenever will be possible.
</li>
<li>
<a href="/docs/latest/develop/reference/modules/modules-api-ref/">
Redis modules API reference
</a>
is generated from module.c top comments of RedisModule functions. It is a good reference in order to understand how each function works.
</li>
</ul>
<p>
Redis modules make it possible to extend Redis functionality using external
modules, rapidly implementing new Redis commands with features
similar to what can be done inside the core itself.
</p>
<p>
Redis modules are dynamic libraries that can be loaded into Redis at
startup, or using the
<a href="/docs/latest/commands/module-load/">
<code>
MODULE LOAD
</code>
</a>
command. Redis exports a C API, in the
form of a single C header file called
<code>
redismodule.h
</code>
. Modules are meant
to be written in C, however it will be possible to use C++ or other languages
that have C binding functionalities.
</p>
<p>
Modules are designed in order to be loaded into different versions of Redis,
so a given module does not need to be designed, or recompiled, in order to
run with a specific version of Redis. For this reason, the module will
register to the Redis core using a specific API version. The current API
version is "1".
</p>
<p>
This document is about an alpha version of Redis modules. API, functionalities
and other details may change in the future.
</p>
<h2 id="loading-modules">
Loading modules
</h2>
<p>
In order to test the module you are developing, you can load the module
using the following
<code>
redis.conf
</code>
configuration directive:
</p>
<pre><code>loadmodule /path/to/mymodule.so
</code></pre>
<p>
It is also possible to load a module at runtime using the following command:
</p>
<pre><code>MODULE LOAD /path/to/mymodule.so
</code></pre>
<p>
In order to list all loaded modules, use:
</p>
<pre><code>MODULE LIST
</code></pre>
<p>
Finally, you can unload (and later reload if you wish) a module using the
following command:
</p>
<pre><code>MODULE UNLOAD mymodule
</code></pre>
<p>
Note that
<code>
mymodule
</code>
above is not the filename without the
<code>
.so
</code>
suffix, but
instead, the name the module used to register itself into the Redis core.
The name can be obtained using
<a href="/docs/latest/commands/module-list/">
<code>
MODULE LIST
</code>
</a>
. However it is good practice
that the filename of the dynamic library is the same as the name the module
uses to register itself into the Redis core.
</p>
<h2 id="the-simplest-module-you-can-write">
The simplest module you can write
</h2>
<p>
In order to show the different parts of a module, here we'll show a very
simple module that implements a command that outputs a random number.
</p>
<pre><code>#include "redismodule.h"
#include <stdlib.h>
int HelloworldRand_RedisCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
RedisModule_ReplyWithLongLong(ctx,rand());
return REDISMODULE_OK;
}
int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
if (RedisModule_Init(ctx,"helloworld",1,REDISMODULE_APIVER_1)
== REDISMODULE_ERR) return REDISMODULE_ERR;
if (RedisModule_CreateCommand(ctx,"helloworld.rand",
HelloworldRand_RedisCommand, "fast random",
0, 0, 0) == REDISMODULE_ERR)
return REDISMODULE_ERR;
return REDISMODULE_OK;
}
</code></pre>
<p>
The example module has two functions. One implements a command called
HELLOWORLD.RAND. This function is specific of that module. However the
other function called
<code>
RedisModule_OnLoad()
</code>
must be present in each
Redis module. It is the entry point for the module to be initialized,
register its commands, and potentially other private data structures
it uses.
</p>
<p>
Note that it is a good idea for modules to call commands with the
name of the module followed by a dot, and finally the command name,
like in the case of
<code>
HELLOWORLD.RAND
</code>
. This way it is less likely to
have collisions.
</p>
<p>
Note that if different modules have colliding commands, they'll not be
able to work in Redis at the same time, since the function
<code>
RedisModule_CreateCommand
</code>
will fail in one of the modules, so the module
loading will abort returning an error condition.
</p>
<h2 id="module-initialization">
Module initialization
</h2>
<p>
The above example shows the usage of the function
<code>
RedisModule_Init()
</code>
.
It should be the first function called by the module
<code>
OnLoad
</code>
function.
The following is the function prototype:
</p>
<pre><code>int RedisModule_Init(RedisModuleCtx *ctx, const char *modulename,
int module_version, int api_version);
</code></pre>
<p>
The
<code>
Init
</code>
function announces the Redis core that the module has a given
name, its version (that is reported by
<a href="/docs/latest/commands/module-list/">
<code>
MODULE LIST
</code>
</a>
), and that is willing
to use a specific version of the API.
</p>
<p>
If the API version is wrong, the name is already taken, or there are other
similar errors, the function will return
<code>
REDISMODULE_ERR
</code>
, and the module
<code>
OnLoad
</code>
function should return ASAP with an error.
</p>
<p>
Before the
<code>
Init
</code>
function is called, no other API function can be called,
otherwise the module will segfault and the Redis instance will crash.
</p>
<p>
The second function called,
<code>
RedisModule_CreateCommand
</code>
, is used in order
to register commands into the Redis core. The following is the prototype:
</p>
<pre><code>int RedisModule_CreateCommand(RedisModuleCtx *ctx, const char *name,
RedisModuleCmdFunc cmdfunc, const char *strflags,
int firstkey, int lastkey, int keystep);
</code></pre>
<p>
As you can see, most Redis modules API calls all take as first argument
the
<code>
context
</code>
of the module, so that they have a reference to the module
calling it, to the command and client executing a given command, and so forth.
</p>
<p>
To create a new command, the above function needs the context, the command's
name, a pointer to the function implementing the command, the command's flags
and the positions of key names in the command's arguments.
</p>
<p>
The function that implements the command must have the following prototype:
</p>
<pre><code>int mycommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc);
</code></pre>
<p>
The command function arguments are just the context, that will be passed
to all the other API calls, the command argument vector, and total number
of arguments, as passed by the user.
</p>
<p>
As you can see, the arguments are provided as pointers to a specific data
type, the
<code>
RedisModuleString
</code>
. This is an opaque data type you have API
functions to access and use, direct access to its fields is never needed.
</p>
<p>
Zooming into the example command implementation, we can find another call:
</p>
<pre><code>int RedisModule_ReplyWithLongLong(RedisModuleCtx *ctx, long long integer);
</code></pre>
<p>
This function returns an integer to the client that invoked the command,
exactly like other Redis commands do, like for example
<a href="/docs/latest/commands/incr/">
<code>
INCR
</code>
</a>
or
<a href="/docs/latest/commands/scard/">
<code>
SCARD
</code>
</a>
.
</p>
<h2 id="module-cleanup">
Module cleanup
</h2>
<p>
In most cases, there is no need for special cleanup.
When a module is unloaded, Redis will automatically unregister commands and
unsubscribe from notifications.
However in the case where a module contains some persistent memory or
configuration, a module may include an optional
<code>
RedisModule_OnUnload
</code>
function.
If a module provides this function, it will be invoked during the module unload
process.
The following is the function prototype:
</p>
<pre><code>int RedisModule_OnUnload(RedisModuleCtx *ctx);
</code></pre>
<p>
The
<code>
OnUnload
</code>
function may prevent module unloading by returning
<code>
REDISMODULE_ERR
</code>
.
Otherwise,
<code>
REDISMODULE_OK
</code>
should be returned.
</p>
<h2 id="setup-and-dependencies-of-a-redis-module">
Setup and dependencies of a Redis module
</h2>
<p>
Redis modules don't depend on Redis or some other library, nor they
need to be compiled with a specific
<code>
redismodule.h
</code>
file. In order
to create a new module, just copy a recent version of
<code>
redismodule.h
</code>
in your source tree, link all the libraries you want, and create
a dynamic library having the
<code>
RedisModule_OnLoad()
</code>
function symbol
exported.
</p>
<p>
The module will be able to load into different versions of Redis.
</p>
<p>
A module can be designed to support both newer and older Redis versions where certain API functions are not available in all versions.
If an API function is not implemented in the currently running Redis version, the function pointer is set to NULL.
This allows the module to check if a function exists before using it:
</p>
<pre><code>if (RedisModule_SetCommandInfo != NULL) {
RedisModule_SetCommandInfo(cmd, &info);
}
</code></pre>
<p>
In recent versions of
<code>
redismodule.h
</code>
, a convenience macro
<code>
RMAPI_FUNC_SUPPORTED(funcname)
</code>
is defined.
Using the macro or just comparing with NULL is a matter of personal preference.
</p>
<h2 id="passing-configuration-parameters-to-redis-modules">
Passing configuration parameters to Redis modules
</h2>
<p>
When the module is loaded with the
<a href="/docs/latest/commands/module-load/">
<code>
MODULE LOAD
</code>
</a>
command, or using the
<code>
loadmodule
</code>
directive in the
<code>
redis.conf
</code>
file, the user is able to pass
configuration parameters to the module by adding arguments after the module
file name:
</p>
<pre><code>loadmodule mymodule.so foo bar 1234
</code></pre>
<p>
In the above example the strings
<code>
foo
</code>
,
<code>
bar
</code>
and
<code>
1234
</code>
will be passed
to the module
<code>
OnLoad()
</code>
function in the
<code>
argv
</code>
argument as an array
of RedisModuleString pointers. The number of arguments passed is into
<code>
argc
</code>
.
</p>
<p>
The way you can access those strings will be explained in the rest of this
document. Normally the module will store the module configuration parameters
in some
<code>
static
</code>
global variable that can be accessed module wide, so that
the configuration can change the behavior of different commands.
</p>
<h2 id="working-with-redismodulestring-objects">
Working with RedisModuleString objects
</h2>
<p>
The command argument vector
<code>
argv
</code>
passed to module commands, and the
return value of other module APIs functions, are of type
<code>
RedisModuleString
</code>
.
</p>
<p>
Usually you directly pass module strings to other API calls, however sometimes
you may need to directly access the string object.
</p>
<p>
There are a few functions in order to work with string objects:
</p>
<pre><code>const char *RedisModule_StringPtrLen(RedisModuleString *string, size_t *len);
</code></pre>
<p>
The above function accesses a string by returning its pointer and setting its
length in
<code>
len
</code>
.
You should never write to a string object pointer, as you can see from the
<code>
const
</code>
pointer qualifier.
</p>
<p>
However, if you want, you can create new string objects using the following
API:
</p>
<pre><code>RedisModuleString *RedisModule_CreateString(RedisModuleCtx *ctx, const char *ptr, size_t len);
</code></pre>
<p>
The string returned by the above command must be freed using a corresponding
call to
<code>
RedisModule_FreeString()
</code>
:
</p>
<pre><code>void RedisModule_FreeString(RedisModuleString *str);
</code></pre>
<p>
However if you want to avoid having to free strings, the automatic memory
management, covered later in this document, can be a good alternative, by
doing it for you.
</p>
<p>
Note that the strings provided via the argument vector
<code>
argv
</code>
never need
to be freed. You only need to free new strings you create, or new strings
returned by other APIs, where it is specified that the returned string must
be freed.
</p>
<h2 id="creating-strings-from-numbers-or-parsing-strings-as-numbers">
Creating strings from numbers or parsing strings as numbers
</h2>
<p>
Creating a new string from an integer is a very common operation, so there
is a function to do this:
</p>
<pre><code>RedisModuleString *mystr = RedisModule_CreateStringFromLongLong(ctx,10);
</code></pre>
<p>
Similarly in order to parse a string as a number:
</p>
<pre><code>long long myval;
if (RedisModule_StringToLongLong(ctx,argv[1],&myval) == REDISMODULE_OK) {
/* Do something with 'myval' */
}
</code></pre>
<h2 id="accessing-redis-keys-from-modules">
Accessing Redis keys from modules
</h2>
<p>
Most Redis modules, in order to be useful, have to interact with the Redis
data space (this is not always true, for example an ID generator may
never touch Redis keys). Redis modules have two different APIs in order to
access the Redis data space, one is a low level API that provides very
fast access and a set of functions to manipulate Redis data structures.
The other API is more high level, and allows to call Redis commands and
fetch the result, similarly to how Lua scripts access Redis.
</p>
<p>
The high level API is also useful in order to access Redis functionalities
that are not available as APIs.
</p>
<p>
In general modules developers should prefer the low level API, because commands
implemented using the low level API run at a speed comparable to the speed
of native Redis commands. However there are definitely use cases for the
higher level API. For example often the bottleneck could be processing the
data and not accessing it.
</p>
<p>
Also note that sometimes using the low level API is not harder compared to
the higher level one.
</p>
<h2 id="calling-redis-commands">
Calling Redis commands
</h2>
<p>
The high level API to access Redis is the sum of the
<code>
RedisModule_Call()
</code>
function, together with the functions needed in order to access the
reply object returned by
<code>
Call()
</code>
.
</p>
<p>
<code>
RedisModule_Call
</code>
uses a special calling convention, with a format specifier
that is used to specify what kind of objects you are passing as arguments
to the function.
</p>
<p>
Redis commands are invoked just using a command name and a list of arguments.
However when calling commands, the arguments may originate from different
kind of strings: null-terminated C strings, RedisModuleString objects as
received from the
<code>
argv
</code>
parameter in the command implementation, binary
safe C buffers with a pointer and a length, and so forth.
</p>
<p>
For example if I want to call
<a href="/docs/latest/commands/incrby/">
<code>
INCRBY
</code>
</a>
using a first argument (the key)
a string received in the argument vector
<code>
argv
</code>
, which is an array
of RedisModuleString object pointers, and a C string representing the
number "10" as second argument (the increment), I'll use the following
function call:
</p>
<pre><code>RedisModuleCallReply *reply;
reply = RedisModule_Call(ctx,"INCRBY","sc",argv[1],"10");
</code></pre>
<p>
The first argument is the context, and the second is always a null terminated
C string with the command name. The third argument is the format specifier
where each character corresponds to the type of the arguments that will follow.
In the above case
<code>
"sc"
</code>
means a RedisModuleString object, and a null
terminated C string. The other arguments are just the two arguments as
specified. In fact
<code>
argv[1]
</code>
is a RedisModuleString and
<code>
"10"
</code>
is a null
terminated C string.
</p>
<p>
This is the full list of format specifiers:
</p>
<ul>
<li>
<strong>
c
</strong>
-- Null terminated C string pointer.
</li>
<li>
<strong>
b
</strong>
-- C buffer, two arguments needed: C string pointer and
<code>
size_t
</code>
length.
</li>
<li>
<strong>
s
</strong>
-- RedisModuleString as received in
<code>
argv
</code>
or by other Redis module APIs returning a RedisModuleString object.
</li>
<li>
<strong>
l
</strong>
-- Long long integer.
</li>
<li>
<strong>
v
</strong>
-- Array of RedisModuleString objects.
</li>
<li>
<strong>
!
</strong>
-- This modifier just tells the function to replicate the command to replicas and AOF. It is ignored from the point of view of arguments parsing.
</li>
<li>
<strong>
A
</strong>
-- This modifier, when
<code>
!
</code>
is given, tells to suppress AOF propagation: the command will be propagated only to replicas.
</li>
<li>
<strong>
R
</strong>
-- This modifier, when
<code>
!
</code>
is given, tells to suppress replicas propagation: the command will be propagated only to the AOF if enabled.
</li>
</ul>
<p>
The function returns a
<code>
RedisModuleCallReply
</code>
object on success, on
error NULL is returned.
</p>
<p>
NULL is returned when the command name is invalid, the format specifier uses
characters that are not recognized, or when the command is called with the
wrong number of arguments. In the above cases the
<code>
errno
</code>
var is set to
<code>
EINVAL
</code>
. NULL is also returned when, in an instance with Cluster enabled, the target
keys are about non local hash slots. In this case
<code>
errno
</code>
is set to
<code>
EPERM
</code>
.
</p>
<h2 id="working-with-redismodulecallreply-objects">
Working with RedisModuleCallReply objects.
</h2>
<p>
<code>
RedisModuleCall
</code>
returns reply objects that can be accessed using the
<code>
RedisModule_CallReply*
</code>
family of functions.
</p>
<p>
In order to obtain the type or reply (corresponding to one of the data types
supported by the Redis protocol), the function
<code>
RedisModule_CallReplyType()
</code>
is used:
</p>
<pre><code>reply = RedisModule_Call(ctx,"INCRBY","sc",argv[1],"10");
if (RedisModule_CallReplyType(reply) == REDISMODULE_REPLY_INTEGER) {
long long myval = RedisModule_CallReplyInteger(reply);
/* Do something with myval. */
}
</code></pre>
<p>
Valid reply types are:
</p>
<ul>
<li>
<code>
REDISMODULE_REPLY_STRING
</code>
Bulk string or status replies.
</li>
<li>
<code>
REDISMODULE_REPLY_ERROR
</code>
Errors.
</li>
<li>
<code>
REDISMODULE_REPLY_INTEGER
</code>
Signed 64 bit integers.
</li>
<li>
<code>
REDISMODULE_REPLY_ARRAY
</code>
Array of replies.
</li>
<li>
<code>
REDISMODULE_REPLY_NULL
</code>
NULL reply.
</li>
</ul>
<p>
Strings, errors and arrays have an associated length. For strings and errors
the length corresponds to the length of the string. For arrays the length
is the number of elements. To obtain the reply length the following function
is used:
</p>
<pre><code>size_t reply_len = RedisModule_CallReplyLength(reply);
</code></pre>
<p>
In order to obtain the value of an integer reply, the following function is used, as already shown in the example above:
</p>
<pre><code>long long reply_integer_val = RedisModule_CallReplyInteger(reply);
</code></pre>
<p>
Called with a reply object of the wrong type, the above function always
returns
<code>
LLONG_MIN
</code>
.
</p>
<p>
Sub elements of array replies are accessed this way:
</p>
<pre><code>RedisModuleCallReply *subreply;
subreply = RedisModule_CallReplyArrayElement(reply,idx);
</code></pre>
<p>
The above function returns NULL if you try to access out of range elements.
</p>
<p>
Strings and errors (which are like strings but with a different type) can
be accessed using in the following way, making sure to never write to
the resulting pointer (that is returned as a
<code>
const
</code>
pointer so that
misusing must be pretty explicit):
</p>
<pre><code>size_t len;
char *ptr = RedisModule_CallReplyStringPtr(reply,&len);
</code></pre>
<p>
If the reply type is not a string or an error, NULL is returned.
</p>
<p>
RedisCallReply objects are not the same as module string objects
(RedisModuleString types). However sometimes you may need to pass replies
of type string or integer, to API functions expecting a module string.
</p>
<p>
When this is the case, you may want to evaluate if using the low level
API could be a simpler way to implement your command, or you can use
the following function in order to create a new string object from a
call reply of type string, error or integer:
</p>
<pre><code>RedisModuleString *mystr = RedisModule_CreateStringFromCallReply(myreply);
</code></pre>
<p>
If the reply is not of the right type, NULL is returned.
The returned string object should be released with
<code>
RedisModule_FreeString()
</code>
as usually, or by enabling automatic memory management (see corresponding
section).
</p>
<h2 id="releasing-call-reply-objects">
Releasing call reply objects
</h2>
<p>
Reply objects must be freed using
<code>
RedisModule_FreeCallReply
</code>
. For arrays,
you need to free only the top level reply, not the nested replies.
Currently the module implementation provides a protection in order to avoid
crashing if you free a nested reply object for error, however this feature
is not guaranteed to be here forever, so should not be considered part
of the API.
</p>
<p>
If you use automatic memory management (explained later in this document)
you don't need to free replies (but you still could if you wish to release
memory ASAP).
</p>
<h2 id="returning-values-from-redis-commands">
Returning values from Redis commands
</h2>
<p>
Like normal Redis commands, new commands implemented via modules must be
able to return values to the caller. The API exports a set of functions for
this goal, in order to return the usual types of the Redis protocol, and
arrays of such types as elements. Also errors can be returned with any
error string and code (the error code is the initial uppercase letters in
the error message, like the "BUSY" string in the "BUSY the sever is busy" error
message).
</p>
<p>
All the functions to send a reply to the client are called
<code>
RedisModule_ReplyWith<something>
</code>
.
</p>
<p>
To return an error, use:
</p>
<pre><code>RedisModule_ReplyWithError(RedisModuleCtx *ctx, const char *err);
</code></pre>
<p>
There is a predefined error string for key of wrong type errors:
</p>
<pre><code>REDISMODULE_ERRORMSG_WRONGTYPE
</code></pre>
<p>
Example usage:
</p>
<pre><code>RedisModule_ReplyWithError(ctx,"ERR invalid arguments");
</code></pre>
<p>
We already saw how to reply with a
<code>
long long
</code>
in the examples above:
</p>
<pre><code>RedisModule_ReplyWithLongLong(ctx,12345);
</code></pre>
<p>
To reply with a simple string, that can't contain binary values or newlines,
(so it's suitable to send small words, like "OK") we use:
</p>
<pre><code>RedisModule_ReplyWithSimpleString(ctx,"OK");
</code></pre>
<p>
It's possible to reply with "bulk strings" that are binary safe, using
two different functions:
</p>
<pre><code>int RedisModule_ReplyWithStringBuffer(RedisModuleCtx *ctx, const char *buf, size_t len);
int RedisModule_ReplyWithString(RedisModuleCtx *ctx, RedisModuleString *str);
</code></pre>
<p>
The first function gets a C pointer and length. The second a RedisModuleString
object. Use one or the other depending on the source type you have at hand.
</p>
<p>
In order to reply with an array, you just need to use a function to emit the
array length, followed by as many calls to the above functions as the number
of elements of the array are:
</p>
<pre><code>RedisModule_ReplyWithArray(ctx,2);
RedisModule_ReplyWithStringBuffer(ctx,"age",3);
RedisModule_ReplyWithLongLong(ctx,22);
</code></pre>
<p>
To return nested arrays is easy, your nested array element just uses another
call to
<code>
RedisModule_ReplyWithArray()
</code>
followed by the calls to emit the
sub array elements.
</p>
<h2 id="returning-arrays-with-dynamic-length">
Returning arrays with dynamic length
</h2>
<p>
Sometimes it is not possible to know beforehand the number of items of
an array. As an example, think of a Redis module implementing a FACTOR
command that given a number outputs the prime factors. Instead of
factorializing the number, storing the prime factors into an array, and
later produce the command reply, a better solution is to start an array
reply where the length is not known, and set it later. This is accomplished
with a special argument to
<code>
RedisModule_ReplyWithArray()
</code>
:
</p>
<pre><code>RedisModule_ReplyWithArray(ctx, REDISMODULE_POSTPONED_LEN);
</code></pre>
<p>
The above call starts an array reply so we can use other
<code>
ReplyWith
</code>
calls
in order to produce the array items. Finally in order to set the length,
use the following call:
</p>
<pre><code>RedisModule_ReplySetArrayLength(ctx, number_of_items);
</code></pre>
<p>
In the case of the FACTOR command, this translates to some code similar
to this:
</p>
<pre><code>RedisModule_ReplyWithArray(ctx, REDISMODULE_POSTPONED_LEN);
number_of_factors = 0;
while(still_factors) {
RedisModule_ReplyWithLongLong(ctx, some_factor);
number_of_factors++;
}
RedisModule_ReplySetArrayLength(ctx, number_of_factors);
</code></pre>
<p>
Another common use case for this feature is iterating over the arrays of
some collection and only returning the ones passing some kind of filtering.
</p>
<p>
It is possible to have multiple nested arrays with postponed reply.
Each call to
<code>
SetArray()
</code>
will set the length of the latest corresponding
call to
<code>
ReplyWithArray()
</code>
:
</p>
<pre><code>RedisModule_ReplyWithArray(ctx, REDISMODULE_POSTPONED_LEN);
... generate 100 elements ...
RedisModule_ReplyWithArray(ctx, REDISMODULE_POSTPONED_LEN);
... generate 10 elements ...
RedisModule_ReplySetArrayLength(ctx, 10);
RedisModule_ReplySetArrayLength(ctx, 100);
</code></pre>
<p>
This creates a 100 items array having as last element a 10 items array.
</p>
<h2 id="arity-and-type-checks">
Arity and type checks
</h2>
<p>
Often commands need to check that the number of arguments and type of the key
is correct. In order to report a wrong arity, there is a specific function
called
<code>
RedisModule_WrongArity()
</code>
. The usage is trivial:
</p>
<pre><code>if (argc != 2) return RedisModule_WrongArity(ctx);
</code></pre>
<p>
Checking for the wrong type involves opening the key and checking the type:
</p>
<pre><code>RedisModuleKey *key = RedisModule_OpenKey(ctx,argv[1],
REDISMODULE_READ|REDISMODULE_WRITE);
int keytype = RedisModule_KeyType(key);
if (keytype != REDISMODULE_KEYTYPE_STRING &&
keytype != REDISMODULE_KEYTYPE_EMPTY)
{
RedisModule_CloseKey(key);
return RedisModule_ReplyWithError(ctx,REDISMODULE_ERRORMSG_WRONGTYPE);
}
</code></pre>
<p>
Note that you often want to proceed with a command both if the key
is of the expected type, or if it's empty.
</p>
<h2 id="low-level-access-to-keys">
Low level access to keys
</h2>
<p>
Low level access to keys allow to perform operations on value objects associated
to keys directly, with a speed similar to what Redis uses internally to
implement the built-in commands.
</p>
<p>
Once a key is opened, a key pointer is returned that will be used with all the
other low level API calls in order to perform operations on the key or its
associated value.
</p>
<p>
Because the API is meant to be very fast, it cannot do too many run-time
checks, so the user must be aware of certain rules to follow:
</p>
<ul>
<li>
Opening the same key multiple times where at least one instance is opened for writing, is undefined and may lead to crashes.
</li>
<li>
While a key is open, it should only be accessed via the low level key API. For example opening a key, then calling DEL on the same key using the
<code>
RedisModule_Call()
</code>
API will result into a crash. However it is safe to open a key, perform some operation with the low level API, closing it, then using other APIs to manage the same key, and later opening it again to do some more work.
</li>
</ul>
<p>
In order to open a key the
<code>
RedisModule_OpenKey
</code>
function is used. It returns
a key pointer, that we'll use with all the next calls to access and modify
the value:
</p>
<pre><code>RedisModuleKey *key;
key = RedisModule_OpenKey(ctx,argv[1],REDISMODULE_READ);
</code></pre>
<p>
The second argument is the key name, that must be a
<code>
RedisModuleString
</code>
object.
The third argument is the mode:
<code>
REDISMODULE_READ
</code>
or
<code>
REDISMODULE_WRITE
</code>
.
It is possible to use
<code>
|
</code>
to bitwise OR the two modes to open the key in
both modes. Currently a key opened for writing can also be accessed for reading
but this is to be considered an implementation detail. The right mode should
be used in sane modules.
</p>
<p>
You can open non existing keys for writing, since the keys will be created
when an attempt to write to the key is performed. However when opening keys
just for reading,
<code>
RedisModule_OpenKey
</code>
will return NULL if the key does not
exist.
</p>
<p>
Once you are done using a key, you can close it with:
</p>
<pre><code>RedisModule_CloseKey(key);
</code></pre>
<p>
Note that if automatic memory management is enabled, you are not forced to
close keys. When the module function returns, Redis will take care to close
all the keys which are still open.
</p>
<h2 id="getting-the-key-type">
Getting the key type
</h2>
<p>
In order to obtain the value of a key, use the
<code>
RedisModule_KeyType()
</code>
function:
</p>
<pre><code>int keytype = RedisModule_KeyType(key);
</code></pre>
<p>
It returns one of the following values:
</p>
<pre><code>REDISMODULE_KEYTYPE_EMPTY
REDISMODULE_KEYTYPE_STRING
REDISMODULE_KEYTYPE_LIST
REDISMODULE_KEYTYPE_HASH
REDISMODULE_KEYTYPE_SET
REDISMODULE_KEYTYPE_ZSET
</code></pre>
<p>
The above are just the usual Redis key types, with the addition of an empty
type, that signals the key pointer is associated with an empty key that
does not yet exists.
</p>
<h2 id="creating-new-keys">
Creating new keys
</h2>
<p>
To create a new key, open it for writing and then write to it using one
of the key writing functions. Example:
</p>
<pre><code>RedisModuleKey *key;
key = RedisModule_OpenKey(ctx,argv[1],REDISMODULE_WRITE);
if (RedisModule_KeyType(key) == REDISMODULE_KEYTYPE_EMPTY) {
RedisModule_StringSet(key,argv[2]);
}
</code></pre>
<h2 id="deleting-keys">
Deleting keys
</h2>
<p>
Just use:
</p>
<pre><code>RedisModule_DeleteKey(key);
</code></pre>
<p>
The function returns
<code>
REDISMODULE_ERR
</code>
if the key is not open for writing.
Note that after a key gets deleted, it is setup in order to be targeted
by new key commands. For example
<code>
RedisModule_KeyType()
</code>
will return it is
an empty key, and writing to it will create a new key, possibly of another
type (depending on the API used).
</p>
<h2 id="managing-key-expires-ttls">
Managing key expires (TTLs)
</h2>
<p>
To control key expires two functions are provided, that are able to set,
modify, get, and unset the time to live associated with a key.
</p>
<p>
One function is used in order to query the current expire of an open key:
</p>
<pre><code>mstime_t RedisModule_GetExpire(RedisModuleKey *key);
</code></pre>
<p>
The function returns the time to live of the key in milliseconds, or
<code>
REDISMODULE_NO_EXPIRE
</code>
as a special value to signal the key has no associated
expire or does not exist at all (you can differentiate the two cases checking
if the key type is
<code>
REDISMODULE_KEYTYPE_EMPTY
</code>
).
</p>
<p>
In order to change the expire of a key the following function is used instead:
</p>
<pre><code>int RedisModule_SetExpire(RedisModuleKey *key, mstime_t expire);
</code></pre>
<p>
When called on a non existing key,
<code>
REDISMODULE_ERR
</code>
is returned, because
the function can only associate expires to existing open keys (non existing
open keys are only useful in order to create new values with data type
specific write operations).
</p>
<p>
Again the
<code>
expire
</code>
time is specified in milliseconds. If the key has currently
no expire, a new expire is set. If the key already have an expire, it is
replaced with the new value.
</p>
<p>
If the key has an expire, and the special value
<code>
REDISMODULE_NO_EXPIRE
</code>
is
used as a new expire, the expire is removed, similarly to the Redis
<a href="/docs/latest/commands/persist/">
<code>
PERSIST
</code>
</a>
command. In case the key was already persistent, no operation is
performed.
</p>
<h2 id="obtaining-the-length-of-values">
Obtaining the length of values
</h2>
<p>
There is a single function in order to retrieve the length of the value
associated to an open key. The returned length is value-specific, and is
the string length for strings, and the number of elements for the aggregated
data types (how many elements there is in a list, set, sorted set, hash).
</p>
<pre><code>size_t len = RedisModule_ValueLength(key);
</code></pre>
<p>
If the key does not exist, 0 is returned by the function:
</p>
<h2 id="string-type-api">
String type API
</h2>
<p>
Setting a new string value, like the Redis
<a href="/docs/latest/commands/set/">
<code>
SET
</code>
</a>
command does, is performed
using:
</p>
<pre><code>int RedisModule_StringSet(RedisModuleKey *key, RedisModuleString *str);
</code></pre>
<p>
The function works exactly like the Redis
<a href="/docs/latest/commands/set/">
<code>
SET
</code>
</a>
command itself, that is, if
there is a prior value (of any type) it will be deleted.
</p>
<p>
Accessing existing string values is performed using DMA (direct memory
access) for speed. The API will return a pointer and a length, so that's
possible to access and, if needed, modify the string directly.
</p>
<pre><code>size_t len, j;
char *myptr = RedisModule_StringDMA(key,&len,REDISMODULE_WRITE);
for (j = 0; j < len; j++) myptr[j] = 'A';
</code></pre>
<p>
In the above example we write directly on the string. Note that if you want
to write, you must be sure to ask for
<code>
WRITE
</code>
mode.
</p>
<p>
DMA pointers are only valid if no other operations are performed with the key
before using the pointer, after the DMA call.
</p>
<p>
Sometimes when we want to manipulate strings directly, we need to change
their size as well. For this scope, the
<code>
RedisModule_StringTruncate
</code>
function
is used. Example:
</p>
<pre><code>RedisModule_StringTruncate(mykey,1024);
</code></pre>
<p>
The function truncates, or enlarges the string as needed, padding it with
zero bytes if the previous length is smaller than the new length we request.
If the string does not exist since
<code>
key
</code>
is associated to an open empty key,
a string value is created and associated to the key.
</p>
<p>
Note that every time
<code>
StringTruncate()
</code>
is called, we need to re-obtain
the DMA pointer again, since the old may be invalid.
</p>
<h2 id="list-type-api">
List type API
</h2>
<p>
It's possible to push and pop values from list values:
</p>
<pre><code>int RedisModule_ListPush(RedisModuleKey *key, int where, RedisModuleString *ele);
RedisModuleString *RedisModule_ListPop(RedisModuleKey *key, int where);
</code></pre>
<p>
In both the APIs the
<code>
where
</code>
argument specifies if to push or pop from tail
or head, using the following macros:
</p>
<pre><code>REDISMODULE_LIST_HEAD
REDISMODULE_LIST_TAIL
</code></pre>
<p>
Elements returned by
<code>
RedisModule_ListPop()
</code>
are like strings created with
<code>
RedisModule_CreateString()
</code>
, they must be released with
<code>
RedisModule_FreeString()
</code>
or by enabling automatic memory management.
</p>
<h2 id="set-type-api">
Set type API
</h2>
<p>
Work in progress.
</p>
<h2 id="sorted-set-type-api">
Sorted set type API
</h2>
<p>
Documentation missing, please refer to the top comments inside
<code>
module.c
</code>
for the following functions:
</p>
<ul>
<li>
<code>
RedisModule_ZsetAdd
</code>
</li>
<li>
<code>
RedisModule_ZsetIncrby
</code>
</li>
<li>
<code>
RedisModule_ZsetScore
</code>
</li>
<li>
<code>
RedisModule_ZsetRem
</code>
</li>
</ul>
<p>
And for the sorted set iterator:
</p>
<ul>
<li>
<code>
RedisModule_ZsetRangeStop
</code>
</li>
<li>
<code>
RedisModule_ZsetFirstInScoreRange
</code>
</li>
<li>
<code>
RedisModule_ZsetLastInScoreRange
</code>
</li>
<li>
<code>
RedisModule_ZsetFirstInLexRange
</code>
</li>
<li>
<code>
RedisModule_ZsetLastInLexRange
</code>
</li>
<li>
<code>
RedisModule_ZsetRangeCurrentElement
</code>
</li>
<li>
<code>
RedisModule_ZsetRangeNext
</code>
</li>
<li>
<code>
RedisModule_ZsetRangePrev
</code>
</li>
<li>
<code>
RedisModule_ZsetRangeEndReached
</code>
</li>
</ul>
<h2 id="hash-type-api">
Hash type API
</h2>
<p>
Documentation missing, please refer to the top comments inside
<code>
module.c
</code>
for the following functions:
</p>
<ul>
<li>
<code>
RedisModule_HashSet
</code>
</li>
<li>
<code>
RedisModule_HashGet
</code>
</li>
</ul>
<h2 id="iterating-aggregated-values">
Iterating aggregated values
</h2>
<p>
Work in progress.
</p>
<h2 id="replicating-commands">
Replicating commands
</h2>
<p>
If you want to use module commands exactly like normal Redis commands, in the
context of replicated Redis instances, or using the AOF file for persistence,
it is important for module commands to handle their replication in a consistent
way.
</p>
<p>
When using the higher level APIs to invoke commands, replication happens
automatically if you use the "!" modifier in the format string of
<code>
RedisModule_Call()
</code>
as in the following example:
</p>
<pre><code>reply = RedisModule_Call(ctx,"INCRBY","!sc",argv[1],"10");
</code></pre>
<p>
As you can see the format specifier is
<code>
"!sc"
</code>
. The bang is not parsed as a
format specifier, but it internally flags the command as "must replicate".
</p>
<p>
If you use the above programming style, there are no problems.
However sometimes things are more complex than that, and you use the low level
API. In this case, if there are no side effects in the command execution, and
it consistently always performs the same work, what is possible to do is to
replicate the command verbatim as the user executed it. To do that, you just
need to call the following function:
</p>
<pre><code>RedisModule_ReplicateVerbatim(ctx);
</code></pre>
<p>
When you use the above API, you should not use any other replication function
since they are not guaranteed to mix well.
</p>
<p>
However this is not the only option. It's also possible to exactly tell
Redis what commands to replicate as the effect of the command execution, using
an API similar to
<code>
RedisModule_Call()
</code>
but that instead of calling the command
sends it to the AOF / replicas stream. Example:
</p>
<pre><code>RedisModule_Replicate(ctx,"INCRBY","cl","foo",my_increment);
</code></pre>
<p>
It's possible to call
<code>
RedisModule_Replicate
</code>
multiple times, and each
will emit a command. All the sequence emitted is wrapped between a
<code>
MULTI/EXEC
</code>
transaction, so that the AOF and replication effects are the
same as executing a single command.
</p>
<p>
Note that
<code>
Call()
</code>
replication and
<code>
Replicate()
</code>
replication have a rule,
in case you want to mix both forms of replication (not necessarily a good
idea if there are simpler approaches). Commands replicated with
<code>
Call()
</code>
are always the first emitted in the final
<code>
MULTI/EXEC
</code>
block, while all
the commands emitted with
<code>
Replicate()
</code>
will follow.
</p>
<h2 id="automatic-memory-management">
Automatic memory management
</h2>
<p>
Normally when writing programs in the C language, programmers need to manage
memory manually. This is why the Redis modules API has functions to release
strings, close open keys, free replies, and so forth.
</p>
<p>
However given that commands are executed in a contained environment and
with a set of strict APIs, Redis is able to provide automatic memory management
to modules, at the cost of some performance (most of the time, a very low
cost).
</p>
<p>
When automatic memory management is enabled:
</p>
<ol>
<li>
You don't need to close open keys.
</li>
<li>
You don't need to free replies.
</li>
<li>
You don't need to free RedisModuleString objects.
</li>
</ol>
<p>
However you can still do it, if you want. For example, automatic memory
management may be active, but inside a loop allocating a lot of strings,
you may still want to free strings no longer used.
</p>
<p>
In order to enable automatic memory management, just call the following
function at the start of the command implementation:
</p>
<pre><code>RedisModule_AutoMemory(ctx);
</code></pre>
<p>
Automatic memory management is usually the way to go, however experienced
C programmers may not use it in order to gain some speed and memory usage
benefit.
</p>
<h2 id="allocating-memory-into-modules">
Allocating memory into modules
</h2>
<p>
Normal C programs use
<code>
malloc()
</code>
and
<code>
free()
</code>
in order to allocate and
release memory dynamically. While in Redis modules the use of malloc is
not technically forbidden, it is a lot better to use the Redis Modules
specific functions, that are exact replacements for
<code>
malloc
</code>
,
<code>
free
</code>
,
<code>
realloc
</code>
and
<code>
strdup
</code>
. These functions are:
</p>
<pre><code>void *RedisModule_Alloc(size_t bytes);
void* RedisModule_Realloc(void *ptr, size_t bytes);
void RedisModule_Free(void *ptr);
void RedisModule_Calloc(size_t nmemb, size_t size);
char *RedisModule_Strdup(const char *str);
</code></pre>
<p>
They work exactly like their
<code>
libc
</code>
equivalent calls, however they use
the same allocator Redis uses, and the memory allocated using these
functions is reported by the
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
command in the memory section, is
accounted when enforcing the
<code>
maxmemory
</code>
policy, and in general is
a first citizen of the Redis executable. On the contrary, the method
allocated inside modules with libc
<code>
malloc()
</code>
is transparent to Redis.
</p>
<p>
Another reason to use the modules functions in order to allocate memory
is that, when creating native data types inside modules, the RDB loading
functions can return deserialized strings (from the RDB file) directly
as
<code>
RedisModule_Alloc()
</code>
allocations, so they can be used directly to
populate data structures after loading, instead of having to copy them
to the data structure.
</p>
<h2 id="pool-allocator">
Pool allocator
</h2>
<p>
Sometimes in commands implementations, it is required to perform many
small allocations that will be not retained at the end of the command
execution, but are just functional to execute the command itself.
</p>
<p>
This work can be more easily accomplished using the Redis pool allocator:
</p>
<pre><code>void *RedisModule_PoolAlloc(RedisModuleCtx *ctx, size_t bytes);
</code></pre>
<p>
It works similarly to
<code>
malloc()
</code>
, and returns memory aligned to the
next power of two of greater or equal to
<code>
bytes
</code>
(for a maximum alignment
of 8 bytes). However it allocates memory in blocks, so it the overhead
of the allocations is small, and more important, the memory allocated
is automatically released when the command returns.
</p>
<p>
So in general short living allocations are a good candidates for the pool
allocator.
</p>
<h2 id="writing-commands-compatible-with-redis-cluster">
Writing commands compatible with Redis Cluster
</h2>
<p>
Documentation missing, please check the following functions inside
<code>
module.c
</code>
:
</p>
<pre><code>RedisModule_IsKeysPositionRequest(ctx);
RedisModule_KeyAtPos(ctx,pos);
</code></pre>
<nav>
<a href="/docs/latest/develop/reference/modules/modules-api-ref/">
Modules API reference
</a>
<p>
Reference for the Redis Modules API
</p>
<a href="/docs/latest/develop/reference/modules/modules-blocking-ops/">
Redis modules and blocking commands
</a>
<p>
How to implement blocking commands in a Redis module
</p>
<a href="/docs/latest/develop/reference/modules/modules-native-types/">
Modules API for native types
</a>
<p>
How to use native types in a Redis module
</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/reference/modules/"/>
<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/search/redisearch-2-upgrade/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Upgrade a database to Search 2.x
</h1>
<p class="text-lg -mt-5 mb-10">
Upgrade a database from Search 1.x to Search 2.x.
</p>
<p>
RediSearch 2.x includes some significant architectural changes that improve functionality.
The main change is that RediSearch 2.x stores indexes outside of the Redis database that contains the data.
This makes commands more efficient and improves replication between clusters because the index changes are managed by the participating clusters rather than being synchronized with the data.
</p>
<p>
This change allows databases with RediSearch to support:
</p>
<ul>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/search/search-active-active/">
Active-Active databases
</a>
</li>
<li>
Database cluster re-sharding
</li>
<li>
Replica Of to a sharded destination database
</li>
<li>
<a href="/docs/latest/commands/ttl/">
EXPIRE
</a>
of documents reflected in the index
</li>
</ul>
<p>
In addition, RediSearch 2.x indexes data that already existed in the database at the time that the index was created.
</p>
<p>
To upgrade a Redis Enterprise Software database with RediSearch 1.x to RediSearch 2.x, you have to set up a new database with RediSearch 2.x and use the
<code>
RediSearch_Syncer.py
</code>
script to replicate the data from the old database into the new 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>
After you create the database or after you replicate the data,
<a href="/docs/latest/commands/ft.create">
create an index
</a>
with a prefix or filter that defines the keys that you want to index.
</div>
</div>
<h2 id="prerequisites">
Prerequisites
</h2>
<p>
Install Python 3 on the host where you plan to run the synchronization script:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo apt install python3
</span></span></code></pre>
</div>
<h2 id="limitations">
Limitations
</h2>
<ul>
<li>
Suggestions (
<code>
FT.SUG
</code>
APIs) and spell check dictionaries are not replicated from the source database. You need to add them manually.
</li>
<li>
If there are multiple indexes on the source and the documents do not have prefixes that identify them with an index, RediSearch 2.x can't index the documents in their respective indexes.
</li>
<li>
The
<code>
NOSAVE
</code>
option is no longer supported. Indexes created with the
<code>
NOSAVE
</code>
option can't be upgraded.
</li>
<li>
Databases that contain temporary indexes can't be upgraded.
</li>
<li>
Any attempt to add, delete, or modify an index during the upgrade will cause the replication process to fail. During the upgrade, the source database can only receive
<code>
FT.ADD
</code>
and
<code>
FT.DEL
</code>
commands.
</li>
</ul>
<h2 id="replicate-data-from-redisearch-1x-to-redisearch-2x">
Replicate data from RediSearch 1.x to RediSearch 2.x
</h2>
<p>
To replicate a RediSearch 1.x database to a RediSearch 2.x database:
</p>
<ol>
<li>
<p>
Sign in to the admin console of the Redis Enterprise cluster where you want to host the new RediSearch 2.x database.
</p>
</li>
<li>
<p>
<a href="#add-new-module">
Add the RediSearch 2.x module
</a>
to the cluster.
</p>
</li>
<li>
<p>
<a href="#create-db">
Create a new database
</a>
with RediSearch 2.x.
</p>
</li>
<li>
<p>
<a href="#migrate-data">
Migrate data
</a>
to the RediSearch 2.x database.
</p>
</li>
</ol>
<h3 id="add-new-module">
Add RediSearch 2.x to the cluster
</h3>
<ol>
<li>
<p>
Download the RediSearch 2.x module package from the
<a href="https://redis.io/downloads">
Redis Download Center
</a>
.
</p>
</li>
<li>
<p>
In the Redis Enterprise admin console, select
<strong>
settings
</strong>
.
</p>
</li>
<li>
<p>
In
<strong>
redis modules
</strong>
, select the
<strong>
Add module
</strong>
button.
</p>
<a href="/docs/latest/images/rs/upgrade_module.png" sdata-lightbox="/images/rs/upgrade_module.png">
<img src="/docs/latest/images/rs/upgrade_module.png"/>
</a>
</li>
<li>
<p>
Use the file browser to select the module package and upload it to the cluster.
</p>
</li>
</ol>
<h3 id="create-db">
Create a RediSearch 2.x database
</h3>
<ol>
<li>
<p>
<a href="/docs/latest/operate/rs/databases/create/">
Create a database
</a>
and configure its settings.
</p>
</li>
<li>
<p>
In the
<strong>
Redis Modules
</strong>
section:
</p>
<ol>
<li>
<p>
Select the
<strong>
Add
</strong>
button:
</p>
<a href="/docs/latest/images/rs/icon_add.png" sdata-lightbox="/images/rs/icon_add.png">
<img alt="The Add icon" src="/docs/latest/images/rs/icon_add.png" width="30px"/>
</a>
</li>
<li>
<p>
Select
<strong>
RediSearch 2
</strong>
from the dropdown list.
</p>
</li>
<li>
<p>
Select the
<strong>
OK
</strong>
button to confirm:
</p>
<a href="/docs/latest/images/rs/icon_save.png" sdata-lightbox="/images/rs/icon_save.png">
<img alt="The Save icon" src="/docs/latest/images/rs/icon_save.png" width="30px"/>
</a>
</li>
</ol>
</li>
<li>
<p>
Select the
<strong>
Activate
</strong>
button to create the database.
</p>
</li>
</ol>
<h3 id="migrate-data">
Migrate data
</h3>
<ol>
<li>
<p>
Download the RediSearch_Syncer package for your operating system:
</p>
<ul>
<li>
<a href="http://redismodules.s3.amazonaws.com/redisearch/RediSearchSyncer/RediSearchSyncer-rhel7.zip">
RedHat Enterprise Linux 7
</a>
</li>
<li>
<a href="http://redismodules.s3.amazonaws.com/redisearch/RediSearchSyncer/RediSearchSyncer-bionic.zip">
Ubuntu 18.04
</a>
</li>
<li>
<a href="http://redismodules.s3.amazonaws.com/redisearch/RediSearchSyncer/RediSearchSyncer-xenial.zip">
Ubuntu 16.04
</a>
</li>
<li>
<a href="http://redismodules.s3.amazonaws.com/redisearch/RediSearchSyncer/RediSearchSyncer-trusty.zip">
Ubuntu 14.04
</a>
</li>
</ul>
</li>
<li>
<p>
Extract the package:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">unzip <package_name>
</span></span></code></pre>
</div>
</li>
<li>
<p>
In the extracted directory, run the RediSearch_Syncer.py script:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">python3 RediSearch_Syncer.py -d <destination_url> -s <source_url> <span class="o">[</span>--add-prefix <prefix><span class="o">]</span>
</span></span></code></pre>
</div>
<p>
Replace the following variables with your own values:
</p>
<ul>
<li>
<p>
<code>
destination url
</code>
- The replication URL of the RediSearch 2.x database. To find this value, go to the database configuration screen in the admin console and select
<strong>
Get Replica of source URL
</strong>
.
</p>
</li>
<li>
<p>
<code>
source url
</code>
- The replication URL of the RediSearch 1.x database. To find this value, go to the database configuration screen in the admin console and select
<strong>
Get Replica of source URL
</strong>
.
</p>
</li>
<li>
<p>
<code>
--add-prefix <prefix>
</code>
(optional) - Adds a prefix to all of the hashes that are replicated to the new 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>
Only use the
<code>
add-prefix
</code>
option if you want to index all of the hashes in the same index in the source database.
</div>
</div>
</li>
</ul>
<p>
The script shows a table with the progress of the replication process.
Press
<strong>
F5
</strong>
to see the updated status.
</p>
<p>
For example:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">python RediSearch_Syncer.py -d redis://admin:IBrS0xaL6rShfB1wKTtUkcQG1g3UWAlTd53AotPdTcQvGIVP@redis-19472.cluster1.local:19472 -s redis://admin:1GjFuUbBqTSPDbRfaxEPLSoXpFmRdFxmBKMD0BuxwMJ2DEaO@redis-19636.cluster1.local:19636
</span></span></code></pre>
</div>
</li>
<li>
<p>
Stop the processes that are sending requests to the source database so all of the data gets synchronized to the destination database.
</p>
</li>
<li>
<p>
Run
<code>
FT.INFO
</code>
on both source and destination databases and compare the number of indexed documents. The replication process is complete when the number of indexed documents is the same in both databases.
</p>
</li>
<li>
<p>
When the status field is
<code>
st_in_sync
</code>
, you can press
<strong>
Ctrl-C
</strong>
to cancel the synchronization process.
</p>
</li>
<li>
<p>
Press
<strong>
Q
</strong>
to quit the
<code>
RediSearch_Syncer.py
</code>
.
</p>
</li>
</ol>
<p>
You can now redirect your database connections to the RediSearch 2.x database.
</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/search/redisearch-2-upgrade/"/>
<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.loadchunk/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CF.LOADCHUNK
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CF.LOADCHUNK key iterator data</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(n), where n is the capacity
</dd>
</dl>
<p>
Restores a cuckoo filter previously saved using
<a href="/docs/latest/commands/cf.scandump/">
<code>
CF.SCANDUMP
</code>
</a>
.
</p>
<p>
See the
<a href="/docs/latest/commands/cf.scandump/">
<code>
CF.SCANDUMP
</code>
</a>
command for example usage.
</p>
<p>
<note>
<b>
Notes
</b>
</note>
</p>
<ul>
<li>
This command overwrites the cuckoo filter stored under
<code>
key
</code>
.
</li>
<li>
Make sure that the cuckoo filter is not changed between invocations.
</li>
</ul>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
<p>
is key name for a cuckoo filter to restore.
</p>
</details>
<details open="">
<summary>
<code>
iterator
</code>
</summary>
<p>
Iterator value associated with
<code>
data
</code>
(returned by
<a href="/docs/latest/commands/cf.scandump/">
<code>
CF.SCANDUMP
</code>
</a>
)
</p>
</details>
<details open="">
<summary>
<code>
data
</code>
</summary>
<p>
Current data chunk (returned by
<a href="/docs/latest/commands/cf.scandump/">
<code>
CF.SCANDUMP
</code>
</a>
)
</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/#simple-strings">
Simple string reply
</a>
-
<code>
OK
</code>
if executed correctly
</li>
<li>
[] on error (invalid arguments, wrong key type, wrong data, etc.)
</li>
</ul>
<h2 id="examples">
Examples
</h2>
<p>
See
<a href="/docs/latest/commands/cf.scandump/">
<code>
CF.SCANDUMP
</code>
</a>
for an example.
</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/cf.loadchunk/"/>
<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/write-behind/reference/cli/.html | <section class="prose w-full py-12 max-w-none">
<h1>
CLI
</h1>
<p class="text-lg -mt-5 mb-10">
Write-behind CLI reference
</p>
<nav>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di/">
redis-di
</a>
<p>
A command line tool to manage & configure Write-behind
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-add-context/">
redis-di add-context
</a>
<p>
Adds a new context
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-configure/">
redis-di configure
</a>
<p>
Configures the Write-behind Database so it is ready to process data
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-create/">
redis-di create
</a>
<p>
Creates the Write-behind Database instance
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-delete/">
redis-di delete
</a>
<p>
Deletes Write-behind database permanently
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-delete-all-contexts/">
redis-di delete-all-contexts
</a>
<p>
Deletes all contexts
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-delete-context/">
redis-di delete-context
</a>
<p>
Deletes a context
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-deploy/">
redis-di deploy
</a>
<p>
Deploys the Write-behind configurations including target
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-describe-job/">
redis-di describe-job
</a>
<p>
Describes a transformation engine's job
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-dump-support-package/">
redis-di dump-support-package
</a>
<p>
Dumps Write-behind support package
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-get-rejected/">
redis-di get-rejected
</a>
<p>
Returns all the stored rejected entries
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-list-contexts/">
redis-di list-contexts
</a>
<p>
Lists all saved contexts
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-list-jobs/">
redis-di list-jobs
</a>
<p>
Lists transformation engine's jobs
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-monitor/">
redis-di monitor
</a>
<p>
Monitors Write-behind by collecting metrics and exporting to Prometheus
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-reset/">
redis-di reset
</a>
<p>
Resets the pipeline into initial full sync mode
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-scaffold/">
redis-di scaffold
</a>
<p>
Generates configuration files for Write-behind and Debezium (when ingesting data to Redis)
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-set-context/">
redis-di set-context
</a>
<p>
Sets a context to be the active one
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-set-secret/">
redis-di set-secret
</a>
<p>
Writes a secret to Redis secret store
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-start/">
redis-di start
</a>
<p>
Starts the pipeline
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-status/">
redis-di status
</a>
<p>
Displays the status of the pipeline end to end
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-stop/">
redis-di stop
</a>
<p>
Stops the pipeline
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-trace/">
redis-di trace
</a>
<p>
Starts a trace session for troubleshooting data transformation
</p>
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-upgrade/">
redis-di upgrade
</a>
<p>
Upgrades Write-behind Engine without losing data or downtime
</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/write-behind/reference/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/rest-api/objects/cluster/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster object
</h1>
<p class="text-lg -mt-5 mb-10">
An object that represents a cluster
</p>
<p>
An API object that represents the cluster.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
alert_settings
</td>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/cluster/alert_settings/">
alert_settings
</a>
object
</td>
<td>
Cluster and node alert settings
</td>
</tr>
<tr>
<td>
bigstore_driver
</td>
<td>
'speedb'
<br/>
'rocksdb'
</td>
<td>
Storage engine for Auto Tiering
</td>
</tr>
<tr>
<td>
cluster_ssh_public_key
</td>
<td>
string
</td>
<td>
Cluster's autogenerated SSH public key
</td>
</tr>
<tr>
<td>
cm_port
</td>
<td>
integer, (range: 1024-65535)
</td>
<td>
UI HTTPS listening port
</td>
</tr>
<tr>
<td>
cm_session_timeout_minutes
</td>
<td>
integer (default: 15)
</td>
<td>
The timeout (in minutes) for the session to the CM
</td>
</tr>
<tr>
<td>
cnm_http_max_threads_per_worker
</td>
<td>
integer (default: 10)
</td>
<td>
Maximum number of threads per worker in the
<code>
cnm_http
</code>
service (deprecated)
</td>
</tr>
<tr>
<td>
cnm_http_port
</td>
<td>
integer, (range: 1024-65535)
</td>
<td>
API HTTP listening port
</td>
</tr>
<tr>
<td>
cnm_http_workers
</td>
<td>
integer (default: 1)
</td>
<td>
Number of workers in the
<code>
cnm_http
</code>
service
</td>
</tr>
<tr>
<td>
cnm_https_port
</td>
<td>
integer, (range: 1024-65535)
</td>
<td>
API HTTPS listening port
</td>
</tr>
<tr>
<td>
control_cipher_suites
</td>
<td>
string
</td>
<td>
Specifies the enabled ciphers for the control plane. The ciphers are specified in the format understood by the BoringSSL library.
</td>
</tr>
<tr>
<td>
control_cipher_suites_tls_1_3
</td>
<td>
string
</td>
<td>
Specifies the enabled TLS 1.3 ciphers for the control plane. The ciphers are specified in the format understood by the BoringSSL library. (read-only)
</td>
</tr>
<tr>
<td>
crdb_coordinator_port
</td>
<td>
integer, (range: 1024-65535) (default: 9081)
</td>
<td>
CRDB coordinator port
</td>
</tr>
<tr>
<td>
crdt_rest_client_retries
</td>
<td>
integer
</td>
<td>
Maximum number of retries for the REST client used by the Active-Active management API
</td>
</tr>
<tr>
<td>
crdt_rest_client_timeout
</td>
<td>
integer
</td>
<td>
Timeout for REST client used by the Active-Active management API
</td>
</tr>
<tr>
<td>
created_time
</td>
<td>
string
</td>
<td>
Cluster creation date (read-only)
</td>
</tr>
<tr>
<td>
data_cipher_list
</td>
<td>
string
</td>
<td>
Specifies the enabled ciphers for the data plane. The ciphers are specified in the format understood by the OpenSSL library.
</td>
</tr>
<tr>
<td>
data_cipher_suites_tls_1_3
</td>
<td>
string
</td>
<td>
Specifies the enabled TLS 1.3 ciphers for the data plane.
</td>
</tr>
<tr>
<td>
debuginfo_path
</td>
<td>
string
</td>
<td>
Path to a local directory used when generating support packages
</td>
</tr>
<tr>
<td>
default_non_sharded_proxy_policy
</td>
<td>
string (default: single)
</td>
<td>
Default proxy_policy for newly created non-sharded databases' endpoints (read-only)
</td>
</tr>
<tr>
<td>
default_sharded_proxy_policy
</td>
<td>
string (default: all-master-shards)
</td>
<td>
Default proxy_policy for newly created sharded databases' endpoints (read-only)
</td>
</tr>
<tr>
<td>
email_alerts
</td>
<td>
boolean (default: false)
</td>
<td>
Send node/cluster email alerts (requires valid SMTP and email_from settings)
</td>
</tr>
<tr>
<td>
email_from
</td>
<td>
string
</td>
<td>
Sender email for automated emails
</td>
</tr>
<tr>
<td>
encrypt_pkeys
</td>
<td>
boolean (default: false)
</td>
<td>
Enable or turn off encryption of private keys
</td>
</tr>
<tr>
<td>
envoy_admin_port
</td>
<td>
integer, (range: 1024-65535)
</td>
<td>
Envoy admin port. Changing this port during runtime might result in an empty response because envoy serves as the cluster gateway.
</td>
</tr>
<tr>
<td>
envoy_max_downstream_connections
</td>
<td>
integer, (range: 100-2048)
</td>
<td>
The max downstream connections envoy is allowed to open
</td>
</tr>
<tr>
<td>
envoy_mgmt_server_port
</td>
<td>
integer, (range: 1024-65535)
</td>
<td>
Envoy management server port
</td>
</tr>
<tr>
<td>
gossip_envoy_admin_port
</td>
<td>
integer, (range: 1024-65535)
</td>
<td>
Gossip envoy admin port
</td>
</tr>
<tr>
<td>
handle_redirects
</td>
<td>
boolean (default: false)
</td>
<td>
Handle API HTTPS requests and redirect to the master node internally
</td>
</tr>
<tr>
<td>
http_support
</td>
<td>
boolean (default: false)
</td>
<td>
Enable or turn off HTTP support
</td>
</tr>
<tr>
<td>
min_control_TLS_version
</td>
<td>
'1.2'
<br/>
'1.3'
</td>
<td>
The minimum version of TLS protocol which is supported at the control path
</td>
</tr>
<tr>
<td>
min_data_TLS_version
</td>
<td>
'1.2'
<br/>
'1.3'
</td>
<td>
The minimum version of TLS protocol which is supported at the data path
</td>
</tr>
<tr>
<td>
min_sentinel_TLS_version
</td>
<td>
'1.2'
<br/>
'1.3'
</td>
<td>
The minimum version of TLS protocol which is supported at the data path
</td>
</tr>
<tr>
<td>
name
</td>
<td>
string
</td>
<td>
Cluster's fully qualified domain name (read-only)
</td>
</tr>
<tr>
<td>
password_complexity
</td>
<td>
boolean (default: false)
</td>
<td>
Enforce password complexity policy
</td>
</tr>
<tr>
<td>
password_expiration_duration
</td>
<td>
integer (default: 0)
</td>
<td>
The number of days a password is valid until the user is required to replace it
</td>
</tr>
<tr>
<td>
proxy_certificate
</td>
<td>
string
</td>
<td>
Cluster's proxy certificate
</td>
</tr>
<tr>
<td>
proxy_max_ccs_disconnection_time
</td>
<td>
integer
</td>
<td>
Cluster-wide proxy timeout policy between proxy and CCS
</td>
</tr>
<tr>
<td>
rack_aware
</td>
<td>
boolean
</td>
<td>
Cluster operates in a rack-aware mode (read-only)
</td>
</tr>
<tr>
<td>
reserved_ports
</td>
<td>
array of strings
</td>
<td>
List of reserved ports and/or port ranges to avoid using for database endpoints (for example
<code>
"reserved_ports": ["11000", "13000-13010"]
</code>
)
</td>
</tr>
<tr>
<td>
s3_url
</td>
<td>
string
</td>
<td>
Specifies the URL for S3 export and import
</td>
</tr>
<tr>
<td>
saslauthd_ldap_conf
</td>
<td>
string
</td>
<td>
saslauthd LDAP configuration
</td>
</tr>
<tr>
<td>
sentinel_cipher_suites
</td>
<td>
array
</td>
<td>
Specifies the list of enabled ciphers for the sentinel service. The supported ciphers are those implemented by the
<a href="https://golang.org/src/crypto/tls/cipher_suites.go">
cipher_suites.go
</a>
package.
</td>
</tr>
<tr>
<td>
sentinel_cipher_suites_tls_1_3
</td>
<td>
string
</td>
<td>
Specifies the list of enabled TLS 1.3 ciphers for the discovery (sentinel) service. The supported ciphers are those implemented by the
<a href="https://golang.org/src/crypto/tls/cipher_suites.go">
cipher_suites.go
</a>
package.(read-only)
</td>
</tr>
<tr>
<td>
sentinel_tls_mode
</td>
<td>
'allowed'
<br/>
'disabled'
<br/>
'required'
</td>
<td>
Determines whether the discovery service allows, blocks, or requires TLS connections (previously named
<code>
sentinel_ssl_policy
</code>
)
<br/>
<strong>
allowed
</strong>
: Allows both TLS and non-TLS connections
<br/>
<strong>
disabled
</strong>
: Allows only non-TLS connections
<br/>
<strong>
required
</strong>
: Allows only TLS connections
</td>
</tr>
<tr>
<td>
slave_ha
</td>
<td>
boolean (default: false)
</td>
<td>
Enable the replica high-availability mechanism (read-only)
</td>
</tr>
<tr>
<td>
slave_ha_bdb_cooldown_period
</td>
<td>
integer (default: 86400)
</td>
<td>
Time in seconds between runs of the replica high-availability mechanism on different nodes on the same database (read-only)
</td>
</tr>
<tr>
<td>
slave_ha_cooldown_period
</td>
<td>
integer (default: 3600)
</td>
<td>
Time in seconds between runs of the replica high-availability mechanism on different nodes (read-only)
</td>
</tr>
<tr>
<td>
slave_ha_grace_period
</td>
<td>
integer (default: 900)
</td>
<td>
Time in seconds between a node failure and when the replica high-availability mechanism starts relocating shards (read-only)
</td>
</tr>
<tr>
<td>
slowlog_in_sanitized_support
</td>
<td>
boolean
</td>
<td>
Whether to include slowlogs in the sanitized support package
</td>
</tr>
<tr>
<td>
smtp_host
</td>
<td>
string
</td>
<td>
SMTP server for automated emails
</td>
</tr>
<tr>
<td>
smtp_password
</td>
<td>
string
</td>
<td>
SMTP server password
</td>
</tr>
<tr>
<td>
smtp_port
</td>
<td>
integer
</td>
<td>
SMTP server port for automated emails
</td>
</tr>
<tr>
<td>
smtp_tls_mode
</td>
<td>
'none'
<br/>
'starttls'
<br/>
'tls'
</td>
<td>
Specifies which TLS mode to use for SMTP access
</td>
</tr>
<tr>
<td>
smtp_use_tls
</td>
<td>
boolean (default: false)
</td>
<td>
Use TLS for SMTP access (deprecated as of Redis Enterprise v4.3.3, use smtp_tls_mode field instead)
</td>
</tr>
<tr>
<td>
smtp_username
</td>
<td>
string
</td>
<td>
SMTP server username (pattern does not allow special characters &,<,>,")
</td>
</tr>
<tr>
<td>
syncer_certificate
</td>
<td>
string
</td>
<td>
Cluster's syncer certificate
</td>
</tr>
<tr>
<td>
upgrade_mode
</td>
<td>
boolean (default: false)
</td>
<td>
Is cluster currently in upgrade mode
</td>
</tr>
<tr>
<td>
use_external_ipv6
</td>
<td>
boolean (default: true)
</td>
<td>
Should redislabs services listen on ipv6
</td>
</tr>
<tr>
<td>
use_ipv6
</td>
<td>
boolean (default: true)
</td>
<td>
Should redislabs services listen on ipv6 (deprecated as of Redis Enterprise v6.4.2, replaced with use_external_ipv6)
</td>
</tr>
<tr>
<td>
wait_command
</td>
<td>
boolean (default: true)
</td>
<td>
Supports Redis wait command (read-only)
</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/"/>
<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.forget/.html | <section class="prose w-full py-12">
<h1 class="command-name">
JSON.FORGET
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">JSON.FORGET 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 1.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 deleted value, O(N) when path is evaluated to multiple values, where N is the size of the key
</dd>
</dl>
<p>
See
<a href="/docs/latest/commands/json.del/">
<code>
JSON.DEL
</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/json.forget/"/>
<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/bdb/.html | <section class="prose w-full py-12 max-w-none">
<h1>
BDB object
</h1>
<p class="text-lg -mt-5 mb-10">
An object that represents a database
</p>
<p>
An API object that represents a managed database in the cluster.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value & Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
uid
</td>
<td>
integer; Cluster unique ID of database. Can be set during creation but cannot be updated.
</td>
</tr>
<tr>
<td>
account_id
</td>
<td>
integer; SM account ID
</td>
</tr>
<tr>
<td>
action_uid
</td>
<td>
string; Currently running action's UID (read-only)
</td>
</tr>
<tr>
<td>
aof_policy
</td>
<td>
Policy for Append-Only File data persistence
<br/>
Values:
<br/>
<strong>
'appendfsync-every-sec'
</strong>
<br/>
'appendfsync-always'
</td>
</tr>
<tr>
<td>
authentication_admin_pass
</td>
<td>
string; Password for administrative access to the BDB (used for SYNC from the BDB)
</td>
</tr>
<tr>
<td>
authentication_redis_pass
</td>
<td>
string; Redis AUTH password authentication.
<br/>
Use for Redis databases only. Ignored for memcached databases. (deprecated as of Redis Enterprise v7.2, replaced with multiple passwords feature in version 6.0.X)
</td>
</tr>
<tr>
<td>
authentication_sasl_pass
</td>
<td>
string; Binary memcache SASL password
</td>
</tr>
<tr>
<td>
authentication_sasl_uname
</td>
<td>
string; Binary memcache SASL username (pattern does not allow special characters &,<,>,")
</td>
</tr>
<tr>
<td>
authentication_ssl_client_certs
</td>
<td>
<pre><code>[{<br/> "client_cert": string<br/>}, ...]</code></pre>
List of authorized client certificates
<br/>
<strong>
client_cert
</strong>
: X.509 PEM (base64) encoded certificate
</td>
</tr>
<tr>
<td>
authentication_ssl_crdt_certs
</td>
<td>
<pre><code>[{<br/> "client_cert": string<br/>}, ...]</code></pre>
List of authorized CRDT certificates
<br/>
<strong>
client_cert
</strong>
: X.509 PEM (base64) encoded certificate
</td>
</tr>
<tr>
<td>
authorized_names
</td>
<td>
array of strings; Additional certified names (deprecated as of Redis Enterprise v6.4.2; use authorized_subjects instead)
</td>
</tr>
<tr>
<td>
authorized_subjects
</td>
<td>
<pre><code>[{<br/> "CN": string,<br/> "O": string,<br/> "OU": [array of strings],<br/> "L": string,<br/> "ST": string,<br/> "C": string<br/>}, ...]</code></pre>
A list of valid subjects used for additional certificate validations during TLS client authentication. All subject attributes are case-sensitive.
<br/>
<strong>
Required subject fields
</strong>
:
<br/>
"CN" for Common Name
<br/>
<strong>
Optional subject fields:
</strong>
<br/>
"O" for Organization
<br/>
"OU" for Organizational Unit (array of strings)
<br/>
"L" for Locality (city)
<br/>
"ST" for State/Province
<br/>
"C" for 2-letter country code
</td>
</tr>
<tr>
<td>
auto_upgrade
</td>
<td>
boolean (default: false); Upgrade the database automatically after a cluster upgrade
</td>
</tr>
<tr>
<td>
avoid_nodes
</td>
<td>
array of strings; Cluster node UIDs to avoid when placing the database's shards and binding its endpoints
</td>
</tr>
<tr>
<td>
background_op
</td>
<td>
Deprecated as of Redis Enterprise Software v7.8.2. Use
<a href="/docs/latest/operate/rs/references/rest-api/requests/actions/bdb/">
<code>
GET /v1/actions/bdb/<bdb_uid>
</code>
</a>
instead.
<br/>
<pre><code>[{<br/> "status": string,<br/> "name": string,<br/> "error": object,<br/> "progress": number<br/>}, ...]</code></pre>
(read-only);
<strong>
progress
</strong>
: Percent of completed steps in current operation
</td>
</tr>
<tr>
<td>
backup
</td>
<td>
boolean (default: false); Policy for periodic database backup
</td>
</tr>
<tr>
<td>
backup_failure_reason
</td>
<td>
Reason of last failed backup process (read-only)
<br/>
Values:
<br/>
'no-permission'
<br/>
'wrong-file-path'
<br/>
'general-error'
</td>
</tr>
<tr>
<td>
backup_history
</td>
<td>
integer (default: 0); Backup history retention policy (number of days, 0 is forever)
</td>
</tr>
<tr>
<td>
backup_interval
</td>
<td>
integer; Interval in seconds in which automatic backup will be initiated
</td>
</tr>
<tr>
<td>
backup_interval_offset
</td>
<td>
integer; Offset (in seconds) from round backup interval when automatic backup will be initiated (should be less than backup_interval)
</td>
</tr>
<tr>
<td>
backup_location
</td>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/backup_location/">
complex object
</a>
; Target for automatic database backups.
<br/>
Call
<code>
GET
</code>
<code>
/jsonschema
</code>
to retrieve the object's structure.
</td>
</tr>
<tr>
<td>
backup_progress
</td>
<td>
number,
<nobr>
(range: 0-100)
</nobr>
; Database scheduled periodic backup progress (percentage) (read-only)
</td>
</tr>
<tr>
<td>
backup_status
</td>
<td>
Status of scheduled periodic backup process (read-only)
<br/>
Values:
<br/>
'exporting'
<br/>
'succeeded'
<br/>
'failed'
</td>
</tr>
<tr>
<td>
bigstore
</td>
<td>
boolean (default: false); Database bigstore option
</td>
</tr>
<tr>
<td>
bigstore_ram_size
</td>
<td>
integer (default: 0); Memory size of bigstore RAM part.
</td>
</tr>
<tr>
<td>
bigstore_ram_weights
</td>
<td>
<pre><code>[{<br/> "shard_uid": integer,<br/> "weight": number<br/>}, ...]</code></pre>
List of shard UIDs and their bigstore RAM weights;
<br/>
<strong>
shard_uid
</strong>
: Shard UID;
<br/>
<strong>
weight
</strong>
: Relative weight of RAM distribution
</td>
</tr>
<tr>
<td>
client_cert_subject_validation_type
</td>
<td>
Enables additional certificate validations that further limit connections to clients with valid certificates during TLS client authentication.
<br/>
Values:
<br/>
<strong>
disabled
</strong>
: Authenticates clients with valid certificates. No additional validations are enforced.
<br/>
<strong>
san_cn
</strong>
: A client certificate is valid only if its Common Name (CN) matches an entry in the list of valid subjects. Ignores other Subject attributes.
<br/>
<strong>
full_subject
</strong>
: A client certificate is valid only if its Subject attributes match an entry in the list of valid subjects.
</td>
</tr>
<tr>
<td>
conns
</td>
<td>
integer (default 5); Number of internal proxy connections
</td>
</tr>
<tr>
<td>
conns_type
</td>
<td>
Connections limit type
<br/>
Values:
<br/>
<strong>
‘per-thread’
</strong>
<br/>
‘per-shard’
</td>
</tr>
<tr>
<td>
crdt
</td>
<td>
boolean (default: false); Use CRDT-based data types for multi-master replication
</td>
</tr>
<tr>
<td>
crdt_causal_consistency
</td>
<td>
boolean (default: false); Causal consistent CRDB.
</td>
</tr>
<tr>
<td>
crdt_config_version
</td>
<td>
integer; Replica-set configuration version, for internal use only.
</td>
</tr>
<tr>
<td>
crdt_featureset_version
</td>
<td>
integer; CRDB active FeatureSet version
</td>
</tr>
<tr>
<td>
crdt_ghost_replica_ids
</td>
<td>
string; Removed replicas IDs, for internal use only.
</td>
</tr>
<tr>
<td>
crdt_guid
</td>
<td>
string; GUID of CRDB this database belongs to, for internal use only.
</td>
</tr>
<tr>
<td>
crdt_modules
</td>
<td>
string; CRDB modules information. The string representation of a JSON list, containing hashmaps.
</td>
</tr>
<tr>
<td>
crdt_protocol_version
</td>
<td>
integer; CRDB active Protocol version
</td>
</tr>
<tr>
<td>
crdt_repl_backlog_size
</td>
<td>
string; Active-Active replication backlog size ('auto' or size in bytes)
</td>
</tr>
<tr>
<td>
crdt_replica_id
</td>
<td>
integer; Local replica ID, for internal use only.
</td>
</tr>
<tr>
<td>
crdt_replicas
</td>
<td>
string; Replica set configuration, for internal use only.
</td>
</tr>
<tr>
<td>
crdt_sources
</td>
<td>
array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/syncer_sources/">
syncer_sources
</a>
objects; Remote endpoints/peers of CRDB database to sync from. See the 'bdb -> replica_sources' section
</td>
</tr>
<tr>
<td>
crdt_sync
</td>
<td>
Enable, disable, or pause syncing from specified crdt_sources. Applicable only for Active-Active databases. See
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/replica_sync/">
replica_sync
</a>
for more details.
<br/>
Values:
<br/>
'enabled'
<br/>
<strong>
'disabled'
</strong>
<br/>
'paused'
<br/>
'stopped'
</td>
</tr>
<tr>
<td>
<span class="break-all">
crdt_sync_connection_alarm_timeout_seconds
</span>
</td>
<td>
integer (default: 0); If the syncer takes longer than the specified number of seconds to connect to an Active-Active database, raise a connection alarm
</td>
</tr>
<tr>
<td>
crdt_sync_dist
</td>
<td>
boolean; Enable/disable distributed syncer in master-master
</td>
</tr>
<tr>
<td>
crdt_syncer_auto_oom_unlatch
</td>
<td>
boolean (default: true); Syncer automatically attempts to recover synchronisation from peers after this database throws an Out-Of-Memory error. Otherwise, the syncer exits
</td>
</tr>
<tr>
<td>
crdt_xadd_id_uniqueness_mode
</td>
<td>
XADD strict ID uniqueness mode. CRDT only.
<br/>
Values:
<br/>
‘liberal’
<br/>
<strong>
‘strict’
</strong>
<br/>
‘semi-strict’
</td>
</tr>
<tr>
<td>
created_time
</td>
<td>
string; The date and time the database was created (read-only)
</td>
</tr>
<tr>
<td>
data_internode_encryption
</td>
<td>
boolean; Should the data plane internode communication for this database be encrypted
</td>
</tr>
<tr>
<td>
data_persistence
</td>
<td>
Database on-disk persistence policy. For snapshot persistence, a
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/snapshot_policy/">
snapshot_policy
</a>
must be provided
<br/>
Values:
<br/>
<strong>
'disabled'
</strong>
<br/>
'snapshot'
<br/>
'aof'
</td>
</tr>
<tr>
<td>
dataset_import_sources
</td>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/dataset_import_sources/">
complex object
</a>
; Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
<br/>
Call GET /jsonschema to retrieve the object's structure.
</td>
</tr>
<tr>
<td>
db_conns_auditing
</td>
<td>
boolean; Enables/deactivates
<a href="/docs/latest/operate/rs/security/audit-events/">
database connection auditing
</a>
</td>
</tr>
<tr>
<td>
default_user
</td>
<td>
boolean (default: true); Allow/disallow a default user to connect
</td>
</tr>
<tr>
<td>
disabled_commands
</td>
<td>
string (default: ); Redis commands which are disabled in db
</td>
</tr>
<tr>
<td>
dns_address_master
</td>
<td>
string; Database private address endpoint FQDN (read-only) (deprecated as of Redis Enterprise v4.3.3)
</td>
</tr>
<tr>
<td>
email_alerts
</td>
<td>
boolean (default: false); Send email alerts for this DB
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
string; Latest bound endpoint. Used when reconfiguring an endpoint via update
</td>
</tr>
<tr>
<td>
endpoint_ip
</td>
<td>
complex object; External IP addresses of node hosting the BDB's endpoint.
<code>
GET
</code>
<code>
/jsonschema
</code>
to retrieve the object's structure. (read-only) (deprecated as of Redis Enterprise v4.3.3)
</td>
</tr>
<tr>
<td>
endpoint_node
</td>
<td>
integer; Node UID hosting the BDB's endpoint (read-only) (deprecated as of Redis Enterprise v4.3.3)
</td>
</tr>
<tr>
<td>
endpoints
</td>
<td>
array; List of database access endpoints (read-only)
<br/>
<strong>
uid
</strong>
: Unique identification of this source
<br/>
<strong>
dns_name
</strong>
: Endpoint’s DNS name
<br/>
<strong>
port
</strong>
: Endpoint’s TCP port number
<br/>
<strong>
addr
</strong>
: Endpoint’s accessible addresses
<br/>
<strong>
proxy_policy
</strong>
: The policy used for proxy binding to the endpoint
<br/>
<strong>
exclude_proxies
</strong>
: List of proxies to exclude
<br/>
<strong>
include_proxies
</strong>
: List of proxies to include
<br/>
<strong>
addr_type
</strong>
: Indicates if the endpoint is based on internal or external IPs
<br/>
<span class="break-all">
<strong>
oss_cluster_api_preferred_ip_type
</strong>
</span>
: Indicates preferred IP type in the OSS cluster API: internal/external
<br/>
<span class="break-all">
<strong>
oss_cluster_api_preferred_endpoint_type
</strong>
</span>
: Indicates preferred endpoint type in the OSS cluster API: ip/hostname
</td>
</tr>
<tr>
<td>
enforce_client_authentication
</td>
<td>
Require authentication of client certificates for SSL connections to the database. If set to 'enabled', a certificate should be provided in either authentication_ssl_client_certs or authentication_ssl_crdt_certs
<br/>
Values:
<br/>
<strong>
'enabled'
</strong>
<br/>
'disabled'
</td>
</tr>
<tr>
<td>
eviction_policy
</td>
<td>
Database eviction policy (Redis style).
<br/>
Values:
<br/>
'volatile-lru'
<br/>
'volatile-ttl'
<br/>
'volatile-random'
<br/>
'allkeys-lru'
<br/>
'allkeys-random'
<br/>
'noeviction'
<br/>
'volatile-lfu'
<br/>
'allkeys-lfu'
<br/>
<strong>
Redis DB default
</strong>
: 'volatile-lru'
<br/>
<strong>
memcached DB default
</strong>
: 'allkeys-lru'
</td>
</tr>
<tr>
<td>
export_failure_reason
</td>
<td>
Reason of last failed export process (read-only)
<br/>
Values:
<br/>
'no-permission'
<br/>
'wrong-file-path'
<br/>
'general-error'
</td>
</tr>
<tr>
<td>
export_progress
</td>
<td>
number,
<nobr>
(range: 0-100)
</nobr>
; Database manually triggered export progress (percentage) (read-only)
</td>
</tr>
<tr>
<td>
export_status
</td>
<td>
Status of manually triggered export process (read-only)
<br/>
Values:
<br/>
'exporting'
<br/>
'succeeded'
<br/>
'failed'
</td>
</tr>
<tr>
<td>
generate_text_monitor
</td>
<td>
boolean; Enable/disable generation of syncer monitoring information
</td>
</tr>
<tr>
<td>
gradual_src_max_sources
</td>
<td>
integer (default: 1); Sync a maximum N sources in parallel (gradual_src_mode should be enabled for this to take effect)
</td>
</tr>
<tr>
<td>
gradual_src_mode
</td>
<td>
Indicates if gradual sync (of sync sources) should be activated
<br/>
Values:
<br/>
'enabled'
<br/>
'disabled'
</td>
</tr>
<tr>
<td>
gradual_sync_max_shards_per_source
</td>
<td>
integer (default: 1); Sync a maximum of N shards per source in parallel (gradual_sync_mode should be enabled for this to take effect)
</td>
</tr>
<tr>
<td>
gradual_sync_mode
</td>
<td>
Indicates if gradual sync (of source shards) should be activated ('auto' for automatic decision)
<br/>
Values:
<br/>
'enabled'
<br/>
'disabled'
<br/>
'auto'
</td>
</tr>
<tr>
<td>
hash_slots_policy
</td>
<td>
The policy used for hash slots handling
<br/>
Values:
<br/>
<strong>
'legacy'
</strong>
: slots range is '1-4096'
<br/>
<strong>
'16k'
</strong>
: slots range is '0-16383'
</td>
</tr>
<tr>
<td>
implicit_shard_key
</td>
<td>
boolean (default: false); Controls the behavior of what happens in case a key does not match any of the regex rules.
<br/>
<strong>
true
</strong>
: if a key does not match any of the rules, the entire key will be used for the hashing function
<br/>
<strong>
false
</strong>
: if a key does not match any of the rules, an error will be returned.
</td>
</tr>
<tr>
<td>
import_failure_reason
</td>
<td>
Import failure reason (read-only)
<br/>
Values:
<br/>
'download-error'
<br/>
'file-corrupted'
<br/>
'general-error'
<br/>
'file-larger-than-mem-limit:<n bytes of expected dataset>:<n bytes configured bdb limit>'
<br/>
'key-too-long'
<br/>
'invalid-bulk-length'
<br/>
'out-of-memory'
</td>
</tr>
<tr>
<td>
import_progress
</td>
<td>
number,
<nobr>
(range: 0-100)
</nobr>
; Database import progress (percentage) (read-only)
</td>
</tr>
<tr>
<td>
import_status
</td>
<td>
Database import process status (read-only)
<br/>
Values:
<br/>
'idle'
<br/>
'initializing'
<br/>
'importing'
<br/>
'succeeded'
<br/>
'failed'
</td>
</tr>
<tr>
<td>
internal
</td>
<td>
boolean (default: false); Is this a database used by the cluster internally
</td>
</tr>
<tr>
<td>
last_backup_time
</td>
<td>
string; Time of last successful backup (read-only)
</td>
</tr>
<tr>
<td>
last_changed_time
</td>
<td>
string; Last administrative configuration change (read-only)
</td>
</tr>
<tr>
<td>
last_export_time
</td>
<td>
string; Time of last successful export (read-only)
</td>
</tr>
<tr>
<td>
max_aof_file_size
</td>
<td>
integer; Maximum size for shard's AOF file (bytes). Default 300GB, (on bigstore DB 150GB)
</td>
</tr>
<tr>
<td>
max_aof_load_time
</td>
<td>
integer (default: 3600); Maximum time shard's AOF reload should take (seconds).
</td>
</tr>
<tr>
<td>
max_client_pipeline
</td>
<td>
integer (default: 200); Maximum number of pipelined commands per connection. Maximum value is 2047.
</td>
</tr>
<tr>
<td>
max_connections
</td>
<td>
integer (default: 0); Maximum number of client connections allowed (0 unlimited)
</td>
</tr>
<tr>
<td>
max_pipelined
</td>
<td>
integer (default: 2000); Determines the maximum number of commands in the proxy’s pipeline per shard connection.
</td>
</tr>
<tr>
<td>
master_persistence
</td>
<td>
boolean (default: false); If true, persists the primary shard in addition to replica shards in a replicated and persistent database.
</td>
</tr>
<tr>
<td>
memory_size
</td>
<td>
integer (default: 0); Database memory limit (0 is unlimited), expressed in bytes.
</td>
</tr>
<tr>
<td>
metrics_export_all
</td>
<td>
boolean; Enable/disable exposing all shard metrics through the metrics exporter
</td>
</tr>
<tr>
<td>
mkms
</td>
<td>
boolean (default: true); Are MKMS (Multi Key Multi Slots) commands supported?
</td>
</tr>
<tr>
<td>
module_list
</td>
<td>
<pre><code>[{<br/> "module_id": string,<br/> "module_args": [<br/> u'string',<br/> u'null'],<br/> "module_name": string,<br/> "semantic_version": string<br/>}, ...]</code></pre>
List of modules associated with the database
<br/>
<br/>
<strong>
module_id
</strong>
: Module UID (deprecated; use
<code>
module_name
</code>
instead)
<br/>
<strong>
module_args
</strong>
: Module command-line arguments (pattern does not allow special characters &,<,>,")
<br/>
<strong>
module_name
</strong>
: Module's name
<br/>
<strong>
semantic_version
</strong>
: Module's semantic version (deprecated; use
<code>
module_args
</code>
instead)
<br/>
<br/>
<strong>
module_id
</strong>
and
<strong>
semantic_version
</strong>
are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2.
</td>
</tr>
<tr>
<td>
mtls_allow_outdated_certs
</td>
<td>
boolean; An optional mTLS relaxation flag for certs verification
</td>
</tr>
<tr>
<td>
mtls_allow_weak_hashing
</td>
<td>
boolean; An optional mTLS relaxation flag for certs verification
</td>
</tr>
<tr>
<td>
name
</td>
<td>
string; Database name. Only letters, numbers, or hyphens are valid characters. The name must start and end with a letter or number.
</td>
</tr>
<tr>
<td>
oss_cluster
</td>
<td>
boolean (default: false); OSS Cluster mode option. Cannot be enabled with
<code>
'hash_slots_policy': 'legacy'
</code>
</td>
</tr>
<tr>
<td>
<span class="break-all">
oss_cluster_api_preferred_endpoint_type
</span>
</td>
<td>
Endpoint type in the OSS cluster API
<br/>
Values:
<br/>
<strong>
‘ip’
</strong>
<br/>
‘hostname’
</td>
</tr>
<tr>
<td>
<span class="break-all">
oss_cluster_api_preferred_ip_type
</span>
</td>
<td>
Internal/external IP type in OSS cluster API. Default value for new endpoints
<br/>
Values:
<br/>
<strong>
'internal'
</strong>
<br/>
'external'
</td>
</tr>
<tr>
<td>
oss_sharding
</td>
<td>
boolean (default: false); An alternative to
<code>
shard_key_regex
</code>
for using the common case of the OSS shard hashing policy
</td>
</tr>
<tr>
<td>
port
</td>
<td>
integer; TCP port on which the database is available. Generated automatically if omitted and returned as 0
</td>
</tr>
<tr>
<td>
proxy_policy
</td>
<td>
The default policy used for proxy binding to endpoints
<br/>
Values:
<br/>
'single'
<br/>
'all-master-shards'
<br/>
'all-nodes'
</td>
</tr>
<tr>
<td>
rack_aware
</td>
<td>
boolean (default: false); Require the database to always replicate across multiple racks
</td>
</tr>
<tr>
<td>
recovery_wait_time
</td>
<td>
integer (default: -1); Defines how many seconds to wait for the persistence file to become available during auto recovery. After the wait time expires, auto recovery completes with potential data loss. The default
<code>
-1
</code>
means to wait forever.
</td>
</tr>
<tr>
<td>
redis_version
</td>
<td>
string; Version of the redis-server processes: e.g. 6.0, 5.0-big
</td>
</tr>
<tr>
<td>
repl_backlog_size
</td>
<td>
string; Redis replication backlog size ('auto' or size in bytes)
</td>
</tr>
<tr>
<td>
replica_sources
</td>
<td>
array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/syncer_sources/">
syncer_sources
</a>
objects; Remote endpoints of database to sync from. See the 'bdb -> replica_sources' section
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/replica_sync/">
replica_sync
</a>
</td>
<td>
Enable, disable, or pause syncing from specified replica_sources
<br/>
Values:
<br/>
'enabled'
<br/>
<strong>
'disabled'
</strong>
<br/>
'paused'
<br/>
'stopped'
</td>
</tr>
<tr>
<td>
<span class="break-all">
replica_sync_connection_alarm_timeout_seconds
</span>
</td>
<td>
integer (default: 0); If the syncer takes longer than the specified number of seconds to connect to a replica, raise a connection alarm
</td>
</tr>
<tr>
<td>
replica_sync_dist
</td>
<td>
boolean; Enable/disable distributed syncer in replica-of
</td>
</tr>
<tr>
<td>
replication
</td>
<td>
boolean (default: false); In-memory database replication mode
</td>
</tr>
<tr>
<td>
resp3
</td>
<td>
boolean (default: true); Enables or deactivates RESP3 support
</td>
</tr>
<tr>
<td>
roles_permissions
</td>
<td>
<pre><code>[{<br/> "role_uid": integer,<br/> "redis_acl_uid": integer<br/>}, ...]</code></pre>
</td>
</tr>
<tr>
<td>
sched_policy
</td>
<td>
Controls how server-side connections are used when forwarding traffic to shards.
<br/>
Values:
<br/>
<strong>
cmp
</strong>
: Closest to max_pipelined policy. Pick the connection with the most pipelined commands that has not reached the max_pipelined limit.
<br/>
<strong>
mru
</strong>
: Try to use most recently used connections.
<br/>
<strong>
spread
</strong>
: Try to use all connections.
<br/>
<strong>
mnp
</strong>
: Minimal pipeline policy. Pick the connection with the least pipelined commands.
</td>
</tr>
<tr>
<td>
shard_block_crossslot_keys
</td>
<td>
boolean (default: false); In Lua scripts, prevent use of keys from different hash slots within the range owned by the current shard
</td>
</tr>
<tr>
<td>
shard_block_foreign_keys
</td>
<td>
boolean (default: true); In Lua scripts,
<code>
foreign_keys
</code>
prevent use of keys which could reside in a different shard (foreign keys)
</td>
</tr>
<tr>
<td>
shard_key_regex
</td>
<td>
Custom keyname-based sharding rules.
<br/>
<code>
[{"regex": string}, ...]
</code>
<br/>
To use the default rules you should set the value to:
<br/>
<code>
[{"regex": ".*{(?<tag>.*)}.*"}, {"regex": "(?<tag>.*)"}]
</code>
</td>
</tr>
<tr>
<td>
shard_list
</td>
<td>
array of integers; Cluster unique IDs of all database shards.
</td>
</tr>
<tr>
<td>
sharding
</td>
<td>
boolean (default: false); Cluster mode (server-side sharding). When true, shard hashing rules must be provided by either
<code>
oss_sharding
</code>
or
<code>
shard_key_regex
</code>
</td>
</tr>
<tr>
<td>
shards_count
</td>
<td>
integer,
<nobr>
(range: 1-512)
</nobr>
(default: 1); Number of database server-side shards
</td>
</tr>
<tr>
<td>
shards_placement
</td>
<td>
Control the density of shards
<br/>
Values:
<br/>
<strong>
'dense'
</strong>
: Shards reside on as few nodes as possible
<br/>
<strong>
'sparse'
</strong>
: Shards reside on as many nodes as possible
</td>
</tr>
<tr>
<td>
skip_import_analyze
</td>
<td>
Enable/disable skipping the analysis stage when importing an RDB file
<br/>
Values:
<br/>
'enabled'
<br/>
'disabled'
</td>
</tr>
<tr>
<td>
slave_buffer
</td>
<td>
Redis replica output buffer limits
<br/>
Values:
<br/>
'auto'
<br/>
value in MB
<br/>
hard:soft:time
</td>
</tr>
<tr>
<td>
slave_ha
</td>
<td>
boolean; Enable replica high availability mechanism for this database (default takes the cluster setting)
</td>
</tr>
<tr>
<td>
slave_ha_priority
</td>
<td>
integer; Priority of the BDB in replica high availability mechanism
</td>
</tr>
<tr>
<td>
snapshot_policy
</td>
<td>
array of
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/snapshot_policy/">
snapshot_policy
</a>
objects; Policy for snapshot-based data persistence. A dataset snapshot will be taken every N secs if there are at least M writes changes in the dataset
</td>
</tr>
<tr>
<td>
ssl
</td>
<td>
boolean (default: false); Require SSL authenticated and encrypted connections to the database (deprecated as of Redis Enterprise v5.0.1)
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/status/">
status
</a>
</td>
<td>
Database lifecycle status (read-only)
<br/>
Values:
<br/>
'pending'
<br/>
'active'
<br/>
'active-change-pending'
<br/>
'delete-pending'
<br/>
'import-pending'
<br/>
'creation-failed'
<br/>
'recovery'
</td>
</tr>
<tr>
<td>
support_syncer_reconf
</td>
<td>
boolean; Determines whether the syncer handles its own configuration changes. If false, the DMC restarts the syncer upon a configuration change.
</td>
</tr>
<tr>
<td>
sync
</td>
<td>
(deprecated as of Redis Enterprise v5.0.1, use
<a href="/docs/latest/operate/rs/references/rest-api/objects/bdb/replica_sync/">
replica_sync
</a>
or crdt_sync instead) Enable, disable, or pause syncing from specified sync_sources
<br/>
Values:
<br/>
'enabled'
<br/>
<strong>
'disabled'
</strong>
<br/>
'paused'
<br/>
'stopped'
</td>
</tr>
<tr>
<td>
sync_dedicated_threads
</td>
<td>
integer (range: 0-10) (default: 5); Number of dedicated Replica Of threads
</td>
</tr>
<tr>
<td>
sync_sources
</td>
<td>
<pre><code>[{<br/> "uid": integer,<br/> "uri": string,<br/> "compression": integer,<br/> "status": string,<br/> "rdb_transferred": integer,<br/> "rdb_size": integer,<br/> "last_update": string,<br/> "lag": integer,<br/> "last_error": string<br/>}, ...]</code></pre>
(deprecated as of Redis Enterprise v5.0.1, instead use replica_sources or crdt_sources) Remote endpoints of database to sync from. See the 'bdb -> replica_sources' section
<br/>
<strong>
uid
</strong>
: Numeric unique identification of this source
<br/>
<strong>
uri
</strong>
: Source Redis URI
<br/>
<strong>
compression
</strong>
: Compression level for the replication link
<br/>
<strong>
status
</strong>
: Sync status of this source
<br/>
<strong>
rdb_transferred
</strong>
: Number of bytes transferred from the source's RDB during the syncing phase
<br/>
<strong>
rdb_size
</strong>
: The source's RDB size to be transferred during the syncing phase
<br/>
<strong>
last_update
</strong>
: Time last update was received from the source
<br/>
<strong>
lag
</strong>
: Lag in millisec between source and destination (while synced)
<br/>
<strong>
last_error
</strong>
: Last error encountered when syncing from the source
</td>
</tr>
<tr>
<td>
syncer_log_level
</td>
<td>
Minimum syncer log level to log. Only logs with this level or higher will be logged.
<br/>
Values:
<br/>
‘crit’
<br/>
‘error’
<br/>
‘warn’
<br/>
<strong>
‘info’
</strong>
<br/>
‘trace’
<br/>
‘debug’
</td>
</tr>
<tr>
<td>
syncer_mode
</td>
<td>
The syncer for replication between database instances is either on a single node (centralized) or on each node that has a proxy according to the proxy policy (distributed). (read-only)
<br/>
Values:
<br/>
'distributed'
<br/>
'centralized'
</td>
</tr>
<tr>
<td>
tags
</td>
<td>
<pre><code>[{<br/> "key": string,<br/> "value": string<br/>}, ...]</code></pre>
Optional list of tag objects attached to the database. Each tag requires a key-value pair.
<br/>
<strong>
key
</strong>
: Represents the tag's meaning and must be unique among tags (pattern does not allow special characters &,<,>,")
<br/>
<strong>
value
</strong>
: The tag's value.
</td>
</tr>
<tr>
<td>
tls_mode
</td>
<td>
Require TLS-authenticated and encrypted connections to the database
<br/>
Values:
<br/>
'enabled'
<br/>
<strong>
'disabled'
</strong>
<br/>
'replica_ssl'
</td>
</tr>
<tr>
<td>
tracking_table_max_keys
</td>
<td>
integer; The client-side caching invalidation table size. 0 makes the cache unlimited.
</td>
</tr>
<tr>
<td>
type
</td>
<td>
Type of database
<br/>
Values:
<br/>
<strong>
'redis'
</strong>
<br/>
'memcached'
</td>
</tr>
<tr>
<td>
use_nodes
</td>
<td>
array of strings; Cluster node UIDs to use for database shards and bound endpoints
</td>
</tr>
<tr>
<td>
version
</td>
<td>
string; Database compatibility version: full Redis/memcached version number, such as 6.0.6. This value can only change during database creation and database upgrades.
</td>
</tr>
<tr>
<td>
wait_command
</td>
<td>
boolean (default: true); Supports Redis wait command (read-only)
</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/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/integrate/write-behind/monitoring-guide/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Monitoring guide
</h1>
<p class="text-lg -mt-5 mb-10">
Monitor Write-behind engine and data processing jobs
</p>
<p>
Write-behind accumulates operating statistics that you can:
</p>
<ul>
<li>
Observe and analyze to discover various types of problems.
</li>
<li>
Use for optimization purposes.
</li>
</ul>
<h2 id="console-metrics">
Console metrics
</h2>
<p>
Write-behind can display its operating metrics in the console using the
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-status/">
<code>
redis-di status
</code>
</a>
command. The command provides information about the current Write-behind engine status, target database configuration, and processing statistics broken down by stream. This tool is intended to be used by Operator to get the current snapshot of the system as well as monitoring ongoing data processing (when used in live mode).
</p>
<h2 id="prometheus-integration">
Prometheus integration
</h2>
<p>
Write-behind allows collecting and exporting its metrics to
<a href="https://prometheus.io/">
Prometheus
</a>
and visualizing them in
<a href="https://grafana.com/">
Grafana
</a>
. Operator can start the built-in exporter using the
<a href="/docs/latest/integrate/write-behind/reference/cli/redis-di-monitor/">
<code>
redis-di monitor
</code>
</a>
command. The diagram describes this flow and the components involved:
</p>
<a href="/docs/latest/images/rdi/monitoring-diagram.png" sdata-lightbox="/images/rdi/monitoring-diagram.png">
<img src="/docs/latest/images/rdi/monitoring-diagram.png"/>
</a>
<blockquote>
<p>
Note: The host names and ports above are examples only and can be changed as needed.
</p>
</blockquote>
<h3 id="test-write-behind-metrics-exporter">
Test Write-behind metrics exporter
</h3>
<p>
Start the Write-behind metrics exporter using the command below:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis-di monitor
</span></span></code></pre>
</div>
<blockquote>
<p>
Note: The default port for the exporter is
<code>
9121
</code>
. If you need to change it, use the
<code>
--exporter-port
</code>
option. The default metrics collection interval is 5 seconds. If you need to change it, use the
<code>
--collect-interval
</code>
option.
</p>
</blockquote>
<p>
Then navigate to
<code>
http://localhost:9121/
</code>
to see the exported metrics. You should be able to see the following metric:
</p>
<pre tabindex="0"><code>rdi_engine_state{state="RUNNING",sync_mode="UNKNOWN"} 1.0
</code></pre>
<blockquote>
<p>
Note: The actual value of the metric above can be 0 if you haven't started Write-behind engine yet (in which case, the
<code>
state
</code>
label should indicate that as well). You must have the Write-behind database created and configured before observing any metrics. If you are not seeing it or getting an error value instead, this indicates that the Write-behind database is not properly configured.
</p>
</blockquote>
<h2 id="configure-prometheus">
Configure Prometheus
</h2>
<p>
Next, configure the Prometheus scraper. Edit the
<code>
prometheus.yml
</code>
file to add the following scraper config:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">scrape_configs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="c"># scrape Write-behind metrics exporter</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">job_name</span><span class="p">:</span><span class="w"> </span><span class="l">rdi-exporter</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">static_configs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">targets</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"redis-exporter:9121"</span><span class="p">]</span><span class="w">
</span></span></span></code></pre>
</div>
<blockquote>
<p>
Notes:
</p>
</blockquote>
<ul>
<li>
Make sure the
<code>
targets
</code>
value above points to the host and port you configured to run the Write-behind metrics exporter.
</li>
<li>
The
<code>
scrape_interval
</code>
setting in Prometheus should be the same or higher than the
<code>
collect_interval
</code>
setting for the exporter. For example, if the
<code>
collect_interval
</code>
is set to 5 seconds, the
<code>
scrape_interval
</code>
should also be set to 5 seconds or more. If the
<code>
scrape_interval
</code>
is set to less than the
<code>
collect_interval
</code>
, Prometheus will scrape the exporter before it has a chance to collect and refresh metrics, and you will see duplicated values in Prometheus.
</li>
</ul>
<h2 id="test-the-prometheus-scraper">
Test the Prometheus scraper
</h2>
<p>
After the scraper config is added to the Prometheus configuration, you should now be able to navigate to
<code>
http://<HOSTNAME>:9090/graph
</code>
(replace
<code>
<HOSTNAME>
</code>
with a valid Prometheus hostname or IP address).
</p>
<p>
Explore Write-behind metrics using the
<a href="https://prometheus.io/docs/visualization/browser/">
expression browser
</a>
.
</p>
<p>
In the expression box, type in a metric name (for example,
<code>
rdi_engine_state
</code>
) and select
<code>
Enter
</code>
or the
<code>
Execute
</code>
button to see the following result:
</p>
<pre tabindex="0"><code>rdi_engine_state{instance="redis-exporter:9121", job="rdi-exporter", status="RUNNING", sync_mode="UNKNOWN"} 1
</code></pre>
<blockquote>
<p>
Note: You may see more than just one Write-behind metric if Write-behind engine has already processed some data. If you do not see any metrics, check your scraper job configuration in Prometheus.
</p>
</blockquote>
<h2 id="use-grafana-to-analyze-metrics">
Use Grafana to analyze metrics
</h2>
<p>
Optionally, you may deploy the sample Grafana dashboard to monitor the status of Write-behind engine and its individual jobs. Follow these steps to import the dashboard:
</p>
<ol>
<li>
<p>
Download the
<strong>
dashboard file
</strong>
to your local machine.
</p>
</li>
<li>
<p>
Log into Grafana and navigate to the list of dashboards, then choose
<strong>
New > Import
</strong>
:
</p>
</li>
</ol>
<a href="/docs/latest/images/rdi/monitoring-grafana-new-dash.png" sdata-lightbox="/images/rdi/monitoring-grafana-new-dash.png">
<img src="/docs/latest/images/rdi/monitoring-grafana-new-dash.png"/>
</a>
<ol>
<li>
On the next screen, select
<strong>
Upload JSON file
</strong>
and upload the file you downloaded in step 1. Make sure you select the data source that is connected to the Write-behind metrics exporter:
</li>
</ol>
<a href="/docs/latest/images/rdi/monitoring-grafana-dash-configure.png" sdata-lightbox="/images/rdi/monitoring-grafana-dash-configure.png">
<img src="/docs/latest/images/rdi/monitoring-grafana-dash-configure.png"/>
</a>
<ol>
<li>
Select
<strong>
Import
</strong>
and make sure you choose the jobs to monitor from the drop-down list (this will be empty if you don't have any jobs running yet):
</li>
</ol>
<a href="/docs/latest/images/rdi/monitoring-grafana-dash-running.png" sdata-lightbox="/images/rdi/monitoring-grafana-dash-running.png">
<img src="/docs/latest/images/rdi/monitoring-grafana-dash-running.png"/>
</a>
<h2 id="write-behind-metrics">
Write-behind metrics
</h2>
<p>
This list shows exported Write-behind metrics along with their descriptions:
</p>
<table>
<thead>
<tr>
<th>
Metric Name
</th>
<th>
Labels
</th>
<th>
Values
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
rdi_engine_state
</td>
<td>
{status=RUNNING | STOPPED, sync_mode=SNAPSHOT | STREAMING | UNKNOWN}
</td>
<td>
0, 1
</td>
<td>
Status of Write-behind engine. 0 - Write-behind engine is stopped, 1 - Write-behind engine is running. Sync mode label indicates the last reported ingest synchronization mode.
</td>
</tr>
<tr>
<td>
rdi_incoming_entries
</td>
<td>
{data_source=
<code>
<stream name>
</code>
, operation=pending | inserted | updated | deleted | filtered | rejected}
</td>
<td>
<code>
<count of records>
</code>
</td>
<td>
Counters, indicating the number of operations performed for each stream.
</td>
</tr>
<tr>
<td>
rdi_stream_event_latency_ms
</td>
<td>
{data_source=
<code>
<stream name>
</code>
}
</td>
<td>
0 - ∞
</td>
<td>
Latency calculated for each stream. Indicates the time in milliseconds the first available record has spent in the stream waiting to be processed by Write-behind engine. If no records pending it will always return zero.
</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/write-behind/monitoring-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/develop/clients/dotnet/connect/.html | <section class="prose w-full py-12">
<h1>
Connect to the server
</h1>
<p class="text-lg -mt-5 mb-10">
Connect your .NET application to a Redis database
</p>
<h2 id="basic-connection">
Basic connection
</h2>
<p>
You can connect to the server simply by passing a string of the
form "hostname:port" to the
<code>
Connect()
</code>
method (for example,
"localhost:6379"). However, you can also connect using a
<code>
ConfigurationOptions
</code>
parameter. Use this to specify a
username, password, and many other options:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="line"><span class="cl"><span class="k">using</span> <span class="nn">NRedisStack</span><span class="p">;</span>
</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">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="n">ConfigurationOptions</span> <span class="n">conf</span> <span class="p">=</span> <span class="k">new</span> <span class="n">ConfigurationOptions</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">EndPoints</span> <span class="p">=</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="n">User</span> <span class="p">=</span> <span class="s">"yourUsername"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">Password</span> <span class="p">=</span> <span class="s">"yourPassword"</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">ConnectionMultiplexer</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="n">conf</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="n">IDatabase</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></span><span class="line"><span class="cl"><span class="n">db</span><span class="p">.</span><span class="n">StringSet</span><span class="p">(</span><span class="s">"foo"</span><span class="p">,</span> <span class="s">"bar"</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">db</span><span class="p">.</span><span class="n">StringGet</span><span class="p">(</span><span class="s">"foo"</span><span class="p">));</span> <span class="c1">// prints bar</span>
</span></span></code></pre>
</div>
<h2 id="connect-to-a-redis-cluster">
Connect to a Redis cluster
</h2>
<p>
The basic connection will use the
<a href="/docs/latest/operate/rs/clusters/optimize/oss-cluster-api/">
Cluster API
</a>
if it is available without any special configuration. However, if you know
the addresses and ports of several cluster nodes, you can specify them all
during connection in the
<code>
Endpoints
</code>
parameter:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="line"><span class="cl"><span class="n">ConfigurationOptions</span> <span class="n">options</span> <span class="p">=</span> <span class="k">new</span> <span class="n">ConfigurationOptions</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="c1">//list of available nodes of the cluster along with the endpoint port.</span>
</span></span><span class="line"><span class="cl"> <span class="n">EndPoints</span> <span class="p">=</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="s">"localhost"</span><span class="p">,</span> <span class="m">16379</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span> <span class="s">"localhost"</span><span class="p">,</span> <span class="m">16380</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="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">ConnectionMultiplexer</span> <span class="n">cluster</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="n">options</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="n">IDatabase</span> <span class="n">db</span> <span class="p">=</span> <span class="n">cluster</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">db</span><span class="p">.</span><span class="n">StringSet</span><span class="p">(</span><span class="s">"foo"</span><span class="p">,</span> <span class="s">"bar"</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">db</span><span class="p">.</span><span class="n">StringGet</span><span class="p">(</span><span class="s">"foo"</span><span class="p">));</span> <span class="c1">// prints bar</span>
</span></span></code></pre>
</div>
<h2 id="connect-to-your-production-redis-with-tls">
Connect to your production Redis with TLS
</h2>
<p>
When you deploy your application, use TLS and follow the
<a href="/docs/latest/operate/oss_and_stack/management/security/">
Redis security
</a>
guidelines.
</p>
<p>
Before connecting your application to the TLS-enabled Redis server, ensure that your certificates and private keys are in the correct format.
</p>
<p>
To convert user certificate and private key from the PEM format to
<code>
pfx
</code>
, use this command:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">openssl pkcs12 -inkey redis_user_private.key -in redis_user.crt -export -out redis.pfx
</span></span></code></pre>
</div>
<p>
Enter password to protect your
<code>
pfx
</code>
file.
</p>
<p>
Establish a secure connection with your Redis database using this snippet.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="line"><span class="cl"><span class="n">ConfigurationOptions</span> <span class="n">options</span> <span class="p">=</span> <span class="k">new</span> <span class="n">ConfigurationOptions</span>
</span></span><span class="line"><span class="cl"><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">EndPoints</span> <span class="p">=</span> <span class="p">{</span> <span class="p">{</span> <span class="s">"my-redis.cloud.redislabs.com"</span><span class="p">,</span> <span class="m">6379</span> <span class="p">}</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">User</span> <span class="p">=</span> <span class="s">"default"</span><span class="p">,</span> <span class="c1">// use your Redis user. More info https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/</span>
</span></span><span class="line"><span class="cl"> <span class="n">Password</span> <span class="p">=</span> <span class="s">"secret"</span><span class="p">,</span> <span class="c1">// use your Redis password</span>
</span></span><span class="line"><span class="cl"> <span class="n">Ssl</span> <span class="p">=</span> <span class="k">true</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">SslProtocols</span> <span class="p">=</span> <span class="n">System</span><span class="p">.</span><span class="n">Security</span><span class="p">.</span><span class="n">Authentication</span><span class="p">.</span><span class="n">SslProtocols</span><span class="p">.</span><span class="n">Tls12</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">options</span><span class="p">.</span><span class="n">CertificateSelection</span> <span class="p">+=</span> <span class="k">delegate</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="k">new</span> <span class="n">X509Certificate2</span><span class="p">(</span><span class="s">"redis.pfx"</span><span class="p">,</span> <span class="s">"secret"</span><span class="p">);</span> <span class="c1">// use the password you specified for pfx file</span>
</span></span><span class="line"><span class="cl"><span class="p">};</span>
</span></span><span class="line"><span class="cl"><span class="n">options</span><span class="p">.</span><span class="n">CertificateValidation</span> <span class="p">+=</span> <span class="n">ValidateServerCertificate</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kt">bool</span> <span class="n">ValidateServerCertificate</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="kt">object</span> <span class="n">sender</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">X509Certificate</span><span class="p">?</span> <span class="n">certificate</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">X509Chain</span><span class="p">?</span> <span class="n">chain</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">SslPolicyErrors</span> <span class="n">sslPolicyErrors</span><span class="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">if</span> <span class="p">(</span><span class="n">certificate</span> <span class="p">==</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="k">false</span><span 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">ca</span> <span class="p">=</span> <span class="k">new</span> <span class="n">X509Certificate2</span><span class="p">(</span><span class="s">"redis_ca.pem"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kt">bool</span> <span class="n">verdict</span> <span class="p">=</span> <span class="p">(</span><span class="n">certificate</span><span class="p">.</span><span class="n">Issuer</span> <span class="p">==</span> <span class="n">ca</span><span class="p">.</span><span class="n">Subject</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="p">(</span><span class="n">verdict</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="k">true</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">"Certificate error: {0}"</span><span class="p">,</span> <span class="n">sslPolicyErrors</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="k">false</span><span 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">ConnectionMultiplexer</span> <span class="n">muxer</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="n">options</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">//Creation of the connection to the DB</span>
</span></span><span class="line"><span class="cl"><span class="n">IDatabase</span> <span class="n">conn</span> <span class="p">=</span> <span class="n">muxer</span><span class="p">.</span><span class="n">GetDatabase</span><span class="p">();</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">//send SET command</span>
</span></span><span class="line"><span class="cl"><span class="n">conn</span><span class="p">.</span><span class="n">StringSet</span><span class="p">(</span><span class="s">"foo"</span><span class="p">,</span> <span class="s">"bar"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">//send GET command and print the value</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">conn</span><span class="p">.</span><span class="n">StringGet</span><span class="p">(</span><span class="s">"foo"</span><span class="p">));</span>
</span></span></code></pre>
</div>
<h2 id="multiplexing">
Multiplexing
</h2>
<p>
Although example code typically works with a single connection,
real-world code often uses multiple connections at the same time.
Opening and closing connections repeatedly is inefficient, so it is best
to manage open connections carefully to avoid this.
</p>
<p>
Several other
Redis client libraries use
<em>
connection pools
</em>
to reuse a set of open
connections efficiently. NRedisStack uses a different approach called
<em>
multiplexing
</em>
, which sends all client commands and responses over a
single connection. NRedisStack manages multiplexing for you automatically.
This gives high performance without requiring any extra coding.
See
<a href="/docs/latest/develop/clients/pools-and-muxing/">
Connection pools and multiplexing
</a>
for more information.
</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/clients/dotnet/connect/"/>
<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/cluster-recovery/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Recover a failed cluster
</h1>
<p class="text-lg -mt-5 mb-10">
How to use the cluster configuration file and database data to recover a failed cluster.
</p>
<p>
When a Redis Enterprise Software cluster fails,
you must use the cluster configuration file and database data to recover the cluster.
</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 cluster recovery in a Kubernetes deployment, see
<a href="/docs/latest/operate/kubernetes/re-clusters/cluster-recovery/">
Recover a Redis Enterprise cluster on Kubernetes
</a>
.
</div>
</div>
<p>
Cluster failure can be caused by:
</p>
<ul>
<li>
A hardware or software failure that causes the cluster to be unresponsive to client requests or administrative actions.
</li>
<li>
More than half of the cluster nodes lose connection with the cluster, resulting in quorum loss.
</li>
</ul>
<p>
To recover a cluster and re-create it as it was before the failure,
you must restore the cluster configuration
<code>
ccs-redis.rdb
</code>
to the cluster nodes.
To recover databases in the new cluster, you must restore the databases from persistence files such as backup files, append-only files (AOF), or RDB snapshots.
These files are stored in the
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
persistent storage location
</a>
.
</p>
<p>
The cluster recovery process includes:
</p>
<ol>
<li>
Install Redis Enterprise Software on the nodes of the new cluster.
</li>
<li>
Mount the persistent storage with the recovery files from the original cluster to the nodes of the new cluster.
</li>
<li>
Recover the cluster configuration on the first node in the new cluster.
</li>
<li>
Join the remaining nodes to the new cluster.
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/databases/recover/">
Recover the databases
</a>
.
</li>
</ol>
<h2 id="prerequisites">
Prerequisites
</h2>
<ul>
<li>
We recommend that you recover the cluster to clean nodes.
If you use the original nodes,
make sure there are no Redis processes running on any nodes in the new cluster.
</li>
<li>
We recommend that you use clean persistent storage drives for the new cluster.
If you use the original storage drives,
make sure you back up the files on the original storage drives to a safe location.
</li>
<li>
Identify the cluster configuration file that you want to use as the configuration for the recovered cluster.
The cluster configuration file is
<code>
/css/ccs-redis.rdb
</code>
on the persistent storage for each node.
</li>
</ul>
<h2 id="recover-the-cluster">
Recover the cluster
</h2>
<ol>
<li>
<p>
(Optional) If you want to recover the cluster to the original cluster nodes, uninstall Redis Enterprise Software from the nodes.
</p>
</li>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/install-on-linux/">
Install Redis Enterprise Software
</a>
on the new cluster nodes.
</p>
<p>
The new servers must have the same basic hardware and software configuration as the original servers, including:
</p>
<ul>
<li>
The same number of nodes
</li>
<li>
At least the same amount of memory
</li>
<li>
The same Redis Enterprise Software version
</li>
<li>
The same installation user and paths
</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 cluster recovery can fail if these requirements are not met.
</div>
</div>
</li>
<li>
<p>
Mount the persistent storage drives with the recovery files to the new nodes.
These drives must contain the cluster configuration backup files and database persistence files.
</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>
Make sure that the user redislabs has permissions to access the storage location
of the configuration and persistence files on each of the nodes.
</div>
</div>
<p>
If you use local persistent storage, place all of the recovery files on each of the cluster nodes.
</p>
</li>
<li>
<p>
To recover the original cluster configuration, run
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/cluster/recover/">
<code>
rladmin cluster recover
</code>
</a>
on the first node in the new cluster:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster recover filename <span class="o">[</span> <persistent_path> <span class="p">|</span> <ephemeral_path> <span class="o">]</span><filename> node_uid <node_uid> rack_id <rack_id>
</span></span></code></pre>
</div>
<p>
For example:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster recover filename /tmp/persist/ccs/ccs-redis.rdb node_uid <span class="m">1</span> rack_id <span class="m">5</span>
</span></span></code></pre>
</div>
<p>
When the recovery command succeeds,
this node is configured as the node from the old cluster that has ID 1.
</p>
</li>
<li>
<p>
To join the remaining servers to the new cluster, run
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rladmin/cluster/join/">
<code>
rladmin cluster join
</code>
</a>
from each new node:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster join nodes <cluster_member_ip_address> username <username> password <password> replace_node <node_id>
</span></span></code></pre>
</div>
<p>
For example:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin cluster join nodes 10.142.0.4 username [email protected] password mysecret replace_node <span class="m">2</span>
</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
</code>
</a>
to verify the recovered nodes are now active and the databases are pending recovery:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin status
</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>
Make sure that you update your
<a href="/docs/latest/operate/rs/7.4/networking/cluster-dns/">
DNS records
</a>
with the IP addresses of the new nodes.
</div>
</div>
</li>
</ol>
<p>
After the cluster is recovered, you must
<a href="/docs/latest/operate/rs/7.4/databases/recover/">
recover the databases
</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/7.4/clusters/cluster-recovery/"/>
<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.create/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.CREATE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.CREATE key
[RETENTION retentionPeriod]
[ENCODING <COMPRESSED|UNCOMPRESSED>]
[CHUNK_SIZE size]
[DUPLICATE_POLICY policy]
[IGNORE ignoreMaxTimediff ignoreMaxValDiff]
[LABELS [label value ...]]
</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(1)
</dd>
</dl>
<p>
Create a new time series
</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 name for the time series.
</p>
</details>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
If a key already exists, you get a Redis error reply,
<code>
TSDB: key already exists
</code>
. You can check for the existence of a key with the
<a href="/docs/latest/commands/exists/">
<code>
EXISTS
</code>
</a>
command.
</li>
<li>
Other commands that also create a new time series when called with a key that does not exist are
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
, and
<a href="/docs/latest/commands/ts.decrby/">
<code>
TS.DECRBY
</code>
</a>
.
</li>
</ul>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
RETENTION retentionPeriod
</code>
</summary>
<p>
is maximum age for samples compared to the highest reported timestamp, in milliseconds. Samples are expired based solely on the difference between their timestamp and the timestamps passed to subsequent
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
, and
<a href="/docs/latest/commands/ts.decrby/">
<code>
TS.DECRBY
</code>
</a>
calls with this key.
</p>
<p>
When set to 0, samples never expire. When not specified, the option is set to the global
<a href="/docs/latest/develop/data-types/timeseries/configuration#retention_policy">
RETENTION_POLICY
</a>
configuration of the database, which by default is 0.
</p>
</details>
<details open="">
<summary>
<code>
ENCODING enc
</code>
</summary>
<p>
specifies the series samples encoding format as one of the following values:
</p>
<ul>
<li>
<code>
COMPRESSED
</code>
, applies compression to the series samples.
</li>
<li>
<code>
UNCOMPRESSED
</code>
, keeps the raw samples in memory. Adding this flag keeps data in an uncompressed form.
</li>
</ul>
<p>
<code>
COMPRESSED
</code>
is almost always the right choice. Compression not only saves memory but usually improves performance due to a lower number of memory accesses. It can result in about 90% memory reduction. The exception are highly irregular timestamps or values, which occur rarely.
</p>
<p>
When not specified, the option is set to
<code>
COMPRESSED
</code>
.
</p>
</details>
<details open="">
<summary>
<code>
CHUNK_SIZE size
</code>
</summary>
<p>
is initial allocation size, in bytes, for the data part of each new chunk. Actual chunks may consume more memory. Changing chunkSize (using
<a href="/docs/latest/commands/ts.alter/">
<code>
TS.ALTER
</code>
</a>
) does not affect existing chunks.
</p>
<p>
Must be a multiple of 8 in the range [48 .. 1048576]. When not specified, it is set to the global
<a href="/docs/latest/develop/data-types/timeseries/configuration#chunk_size_bytes">
CHUNK_SIZE_BYTES
</a>
configuration of the database, which by default is 4096 (a single memory page).
</p>
<p>
Note: Before v1.6.10 no minimum was enforced. Between v1.6.10 and v1.6.17 and in v1.8.0 the minimum value was 128. Since v1.8.1 the minimum value is 48.
</p>
<p>
The data in each key is stored in chunks. Each chunk contains header and data for a given timeframe. An index contains all chunks. Iterations occur inside each chunk. Depending on your use case, consider these tradeoffs for having smaller or larger sizes of chunks:
</p>
<ul>
<li>
Insert performance: Smaller chunks result in slower inserts (more chunks need to be created).
</li>
<li>
Query performance: Queries for a small subset when the chunks are very large are slower, as we need to iterate over the chunk to find the data.
</li>
<li>
Larger chunks may take more memory when you have a very large number of keys and very few samples per key, or less memory when you have many samples per key.
</li>
</ul>
<p>
If you are unsure about your use case, select the default.
</p>
</details>
<details open="">
<summary>
<code>
DUPLICATE_POLICY policy
</code>
</summary>
<p>
is policy for handling insertion (
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
and
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
) of multiple samples with identical timestamps, with one of the following values:
</p>
<ul>
<li>
<code>
BLOCK
</code>
: ignore any newly reported value and reply with an error
</li>
<li>
<code>
FIRST
</code>
: ignore any newly reported value
</li>
<li>
<code>
LAST
</code>
: override with the newly reported value
</li>
<li>
<code>
MIN
</code>
: only override if the value is lower than the existing value
</li>
<li>
<code>
MAX
</code>
: only override if the value is higher than the existing value
</li>
<li>
<code>
SUM
</code>
: If a previous sample exists, add the new sample to it so that the updated value is equal to (previous + new). If no previous sample exists, set the updated value equal to the new value.
</li>
</ul>
<p>
When not specified: set to the global
<a href="/docs/latest/develop/data-types/timeseries/configuration#duplicate_policy">
DUPLICATE_POLICY
</a>
configuration of the database (which, by default, is
<code>
BLOCK
</code>
).
</p>
<p>
<code>
BLOCK
</code>
is often used to avoid accidental changes.
<code>
FIRST
</code>
can be used as an optimization when duplicate reports are possible.
<code>
LAST
</code>
can be used when updates are being reported.
<code>
SUM
</code>
is used for counters (e.g., the number of cars entering a parking lot per minute when there are multiple reporting counting devices).
<code>
MIN
</code>
and
<code>
MAX
</code>
can be used, for example, to store the minimal/maximal stock price per minute (instead of storing all the samples and defining a compaction rule).
</p>
</details>
<details open="">
<summary>
<code>
IGNORE ignoreMaxTimediff ignoreMaxValDiff
</code>
</summary>
<p>
is the policy for handling duplicate samples. A new sample is considered a duplicate and is ignored if the following conditions are met:
</p>
<ul>
<li>
The time series is not a compaction;
</li>
<li>
The time series'
<code>
DUPLICATE_POLICY
</code>
IS
<code>
LAST
</code>
;
</li>
<li>
The sample is added in-order (
<code>
timestamp ≥ max_timestamp
</code>
);
</li>
<li>
The difference of the current timestamp from the previous timestamp (
<code>
timestamp - max_timestamp
</code>
) is less than or equal to
<code>
IGNORE_MAX_TIME_DIFF
</code>
;
</li>
<li>
The absolute value difference of the current value from the value at the previous maximum timestamp (
<code>
abs(value - value_at_max_timestamp
</code>
) is less than or equal to
<code>
IGNORE_MAX_VAL_DIFF
</code>
.
</li>
</ul>
<p>
where
<code>
max_timestamp
</code>
is the timestamp of the sample with the largest timestamp in the time series, and
<code>
value_at_max_timestamp
</code>
is the value at
<code>
max_timestamp
</code>
.
</p>
<p>
When not specified: set to the global
<a href="/docs/latest/develop/data-types/timeseries/configuration#ignore_max_time_diff-and-ignore_max_val_diff">
IGNORE_MAX_TIME_DIFF
</a>
and
<a href="/docs/latest/develop/data-types/timeseries/configuration#ignore_max_time_diff-and-ignore_max_val_diff">
IGNORE_MAX_VAL_DIFF
</a>
, which are, by default, both set to 0.
</p>
</details>
<details open="">
<summary>
<code>
LABELS {label value}...
</code>
</summary>
<p>
is set of label-value pairs that represent metadata labels of the key and serve as a secondary index.
</p>
<p>
The
<a href="/docs/latest/commands/ts.mget/">
<code>
TS.MGET
</code>
</a>
,
<a href="/docs/latest/commands/ts.mrange/">
<code>
TS.MRANGE
</code>
</a>
, and
<a href="/docs/latest/commands/ts.mrevrange/">
<code>
TS.MREVRANGE
</code>
</a>
commands operate on multiple time series based on their labels. The
<a href="/docs/latest/commands/ts.queryindex/">
<code>
TS.QUERYINDEX
</code>
</a>
command returns all time series keys matching a given filter based on their labels.
</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/#simple-strings">
Simple string reply
</a>
-
<code>
OK
</code>
if executed correctly
</li>
<li>
[] on error (invalid arguments, key already exists, etc.)
</li>
</ul>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Create a temperature time series
</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> TS.CREATE temperature:2:32 RETENTION <span class="m">60000</span> DUPLICATE_POLICY MAX LABELS sensor_id <span class="m">2</span> area_id <span class="m">32</span>
</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/ts.add/">
<code>
TS.ADD
</code>
</a>
|
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
|
<a href="/docs/latest/commands/ts.decrby/">
<code>
TS.DECRBY
</code>
</a>
|
<a href="/docs/latest/commands/ts.mget/">
<code>
TS.MGET
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrange/">
<code>
TS.MRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.mrevrange/">
<code>
TS.MREVRANGE
</code>
</a>
|
<a href="/docs/latest/commands/ts.queryindex/">
<code>
TS.QUERYINDEX
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/data-types/timeseries/">
RedisTimeSeries
</a>
</li>
<li>
<a href="https://redis.com/blog/redistimeseries-version-1-2-is-here/">
RedisTimeSeries Version 1.2 Is Here!
</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/ts.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/ts.del.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.DEL
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.DEL key fromTimestamp toTimestamp
</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.6.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 data points that will be removed
</dd>
</dl>
<p>
Delete all samples between two timestamps for a given time series
</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 name for the time series.
</p>
</details>
<details open="">
<summary>
<code>
fromTimestamp
</code>
</summary>
<p>
is start timestamp for the range deletion.
</p>
</details>
<details open="">
<summary>
<code>
toTimestamp
</code>
</summary>
<p>
is end timestamp for the range deletion.
</p>
<p>
The given timestamp interval is closed (inclusive), meaning that samples whose timestamp eqauls the
<code>
fromTimestamp
</code>
or
<code>
toTimestamp
</code>
are also deleted.
</p>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
If fromTimestamp is older than the retention period compared to the maximum existing timestamp, the deletion is discarded and an error is returned.
</li>
<li>
When deleting a sample from a time series for which compaction rules are defined:
<ul>
<li>
If all the original samples for an affected compaction bucket are available, the compacted value is recalculated based on the remaining original samples, or removed if all original samples within the compaction bucket were deleted.
</li>
<li>
If original samples for an affected compaction bucket were expired, the deletion is discarded and an error is returned.
</li>
</ul>
</li>
<li>
Explicitly deleting samples from a compacted time series may result in inconsistencies between the raw and the compacted data. The compaction process may override such samples. That being said, it is safe to explicitly delete samples from a compacted time series beyond the retention period of the original time series.
</li>
</ul>
<h2 id="return-value">
Return value
</h2>
<p>
Returns one of these replies:
</p>
<ul>
<li>
<a href="/docs/latest/develop/reference/protocol-spec/#integers">
Integer reply
</a>
- the number of samples that were deleted
</li>
<li>
[] on error (invalid arguments, wrong key type, etc.), when
<code>
timestamp
</code>
is older than the retention period compared to the maximum existing timestamp, or when an affected compaction bucket cannot be recalculated
</li>
</ul>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Delete range of data points
</b>
</summary>
<p>
Create time series for temperature in Tel Aviv and Jerusalem, then add different temperature samples.
</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.CREATE temp:JLM LABELS <span class="nb">type</span> temp location JLM
</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><span class="line"><span class="cl">127.0.0.1:6379> TS.MADD temp:JLM <span class="m">1005</span> <span class="m">30</span> temp:JLM <span class="m">1015</span> <span class="m">35</span> temp:JLM <span class="m">1025</span> <span class="m">9999</span> temp:JLM <span class="m">1035</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">1005</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">1015</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">1025</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">1035</span></span></span></code></pre>
</div>
<p>
Delete the range of data points for temperature in Tel Aviv.
</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.DEL temp:TLV <span class="m">1000</span> <span class="m">1030</span>
</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>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</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.del/"/>
<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>
</details>
</section>
|
https://redis.io/docs/latest/develop/tools/insight/release-notes/v.2.34.0/.html | <section class="prose w-full py-12">
<h1>
RedisInsight v2.34.0, September 2023
</h1>
<p class="text-lg -mt-5 mb-10">
RedisInsight v2.34
</p>
<h2 id="234-september-2023">
2.34 (September 2023)
</h2>
<p>
This is the General Availability (GA) release of RedisInsight 2.34.
</p>
<h3 id="highlights">
Highlights
</h3>
<ul>
<li>
UX improvements to simplify the in-app provisioning and usage of a free
<a href="https://redis.com/comparisons/oss-vs-enterprise/?utm_source=redisinsight&utm_medium=rel_notes&utm_campaign=2_34">
Redis Cloud
</a>
database with RedisInsight interactive tutorials. This will allow you to learn easily, among other things, how to leverage the native JSON data structure supporting structured querying and full-text search, including vector similarity search for your AI use cases
</li>
<li>
Ability to refresh the list of
<a href="https://redis.io/docs/interact/search-and-query/?utm_source=redisinsight&utm_medium=main&utm_campaign=main">
search indexes
</a>
displayed in Browser
</li>
<li>
Set the color theme to follow the local system preferences
</li>
</ul>
<h3 id="details">
Details
</h3>
<p>
<strong>
Features and improvements
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2585">
#2585
</a>
UX improvements to simplify the in-app provisioning and usage of a free
<a href="https://redis.com/comparisons/oss-vs-enterprise/?utm_source=redisinsight&utm_medium=rel_notes&utm_campaign=2_34">
Redis Cloud
</a>
database with RedisInsight interactive tutorials. To provision a new database, click the "Try Redis Cloud" banner in the list of database connections page and follow the steps
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2606">
#2606
</a>
Ability to refresh the list of
<a href="https://redis.io/docs/interact/search-and-query/?utm_source=redisinsight&utm_medium=main&utm_campaign=main">
search indexes
</a>
displayed in Browser
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2593">
#2593
</a>
UX optimizations to improve the back navigation to the list of databases, including for small resolutions
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2599">
#2599
</a>
Added an option to set the color theme to follow the local system preferences
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2563">
#2563
</a>
Load a new library from the Functions tab within the
<a href="https://redis.com/blog/introducing-triggers-and-functions/?utm_source=redisinsight&utm_medium=main&utm_campaign=main">
Triggers and Functions
</a>
tool
</li>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2496">
#2496
</a>
Set milliseconds as a default unit in Slow Log
</li>
</ul>
<p>
<strong>
Bugs
</strong>
</p>
<ul>
<li>
<a href="https://github.com/RedisInsight/RedisInsight/pull/2587">
#2587
</a>
Display detailed
<a href="https://github.com/RedisInsight/RedisInsight/issues/2562">
errors
</a>
in transactions run via CLI or Workbench
</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.34.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/rs/networking/configuring-aws-route53-dns-redis-enterprise/.html | <section class="prose w-full py-12 max-w-none">
<h1>
AWS Route53 DNS management
</h1>
<p class="text-lg -mt-5 mb-10">
How to configure AWS Route 53 DNS
</p>
<p>
Redis Enterprise Software uses DNS to achieve high availability and fail-over regardless of where it is installed.
</p>
<h2 id="what-is-aws-route-53">
What is AWS Route 53?
</h2>
<p>
Route 53 is a scalable DNS service by Amazon Web Service (AWS). It routes user traffic to AWS resources and external sites, offering DNS health checks, traffic management, and failover capabilities. It's integral for high-availability architectures and also provides domain registration services.
</p>
<h2 id="create-a-hosted-zone">
Create a hosted zone
</h2>
<p>
Creating a hosted zone in Amazon Route 53 is a foundational step in managing your domain's DNS settings.
</p>
<p>
A hosted zone functions as a container for the DNS records of a specific domain. To create one, you first need to:
</p>
<ol>
<li>
Log into the AWS Management Console
</li>
<li>
Navigate to the Route 53 dashboard
</li>
<li>
Select "Create Hosted Zone"
</li>
<li>
Enter your domain name, and choose public hosted zone
</li>
</ol>
<p>
The hosted zone provides you with a set of Name Server (NS) records, which you will need to update at your domain registrar. This process effectively delegates the DNS management of your domain to Route 53, allowing you to create, update, and manage DNS records for your domain within the AWS ecosystem.
</p>
<a href="/docs/latest/images/rs/00-CreateHostedZone-en.png" sdata-lightbox="/images/rs/00-CreateHostedZone-en.png">
<img src="/docs/latest/images/rs/00-CreateHostedZone-en.png"/>
</a>
<p>
Once created, it will appear in the list of
<strong>
Hosted zones
</strong>
</p>
<a href="/docs/latest/images/rs/03-HostedZoneSelection-en.png" sdata-lightbox="/images/rs/03-HostedZoneSelection-en.png">
<img src="/docs/latest/images/rs/03-HostedZoneSelection-en.png"/>
</a>
<h2 id="create-glue-records">
Create glue records
</h2>
<p>
A
<strong>
glue record
</strong>
is a type of DNS record that helps prevent circular dependencies by providing the IP addresses of your nameservers. To create glue records in Route 53, you first need to set up a hosted zone for your domain. You will create a separate A record for each node in your Redis Enterprise cluster. The
<strong>
Record name
</strong>
will be a subdomain definition of the NS record you will define and the
<strong>
value
</strong>
should be set to the IP address of the node in your cluster.
</p>
<a href="/docs/latest/images/rs/05-NS1Configuration-en.png" sdata-lightbox="/images/rs/05-NS1Configuration-en.png">
<img src="/docs/latest/images/rs/05-NS1Configuration-en.png"/>
</a>
<p>
Once complete, it should look something like this
</p>
<a href="/docs/latest/images/rs/06-NSList-en.png" sdata-lightbox="/images/rs/06-NSList-en.png">
<img src="/docs/latest/images/rs/06-NSList-en.png"/>
</a>
<h2 id="create-nameserver-record">
Create nameserver record
</h2>
<p>
When you create a new hosted zone in Route 53 for your domain, a set of NS records is automatically generated. These records list the nameservers assigned by Route 53 to your domain.
</p>
<p>
You will need to create a new NS record which will point to the glue records created in the previous step.
</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>
It is important to make sure that the
<strong>
Record Name
</strong>
of the NS record equals the FQDN (Fully Qualified Domain Name) of your Redis Enterprise cluster. If not, DNS resolution will not function correctly.
</div>
</div>
<a href="/docs/latest/images/rs/07-NSRecord-en.png" sdata-lightbox="/images/rs/07-NSRecord-en.png">
<img src="/docs/latest/images/rs/07-NSRecord-en.png"/>
</a>
<h2 id="validate">
Validate
</h2>
<p>
Once all steps are completed, the configuration should look similar to this
</p>
<a href="/docs/latest/images/rs/08-FinalConfig-en.png" sdata-lightbox="/images/rs/08-FinalConfig-en.png">
<img src="/docs/latest/images/rs/08-FinalConfig-en.png"/>
</a>
<p>
You can test and validate your settings by using the
<code>
dig
</code>
command.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">dig ns test.demo-rlec.redislabs.com
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">;</span> <<>> DiG 9.9.5-9+deb8u9-Debian <<>> ns test.demo-rlec.redislabs.com
</span></span><span class="line"><span class="cl"><span class="p">;;</span> global options: +cmd
</span></span><span class="line"><span class="cl"><span class="p">;;</span> Got answer:
</span></span><span class="line"><span class="cl"><span class="p">;;</span> ->>HEADER<span class="s"><<- opco</span>de: QUERY, status: NOERROR, id: <span class="m">25061</span>
</span></span><span class="line"><span class="cl"><span class="p">;;</span> flags: qr rd ra<span class="p">;</span> QUERY: 1, ANSWER: 3, AUTHORITY: 0, ADDITIONAL: <span class="m">1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">;;</span> OPT PSEUDOSECTION:
</span></span><span class="line"><span class="cl"><span class="p">;</span> EDNS: version: 0, flags:<span class="p">;</span> udp: <span class="m">4096</span>
</span></span><span class="line"><span class="cl"><span class="p">;;</span> QUESTION SECTION:
</span></span><span class="line"><span class="cl"><span class="p">;</span>test.demo-rlec.redislabs.com. IN NS
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">;;</span> ANSWER SECTION:
</span></span><span class="line"><span class="cl">test.demo-rlec.redislabs.com. <span class="m">3409</span> IN NS node2.test.demo-rlec.redislabs.com.
</span></span><span class="line"><span class="cl">test.demo-rlec.redislabs.com. <span class="m">3409</span> IN NS node1.test.demo-rlec.redislabs.com.
</span></span><span class="line"><span class="cl">test.demo-rlec.redislabs.com. <span class="m">3409</span> IN NS node3.test.demo-rlec.redislabs.com.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="p">;;</span> Query time: <span class="m">31</span> msec
</span></span><span class="line"><span class="cl"><span class="p">;;</span> SERVER: 192.168.1.254#53<span class="o">(</span>192.168.1.254<span class="o">)</span>
</span></span><span class="line"><span class="cl"><span class="p">;;</span> WHEN: Tue Feb <span class="m">14</span> 16:49:13 CET <span class="m">2017</span>
</span></span><span class="line"><span class="cl"><span class="p">;;</span> MSG SIZE rcvd: <span class="m">120</span>
</span></span></code></pre>
</div>
<p>
You can see that the name are given a prefix of
<code>
ns-
</code>
. This answer does not come
from
<em>
Route53
</em>
but from the cluster nameservers themselves.
</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/networking/configuring-aws-route53-dns-redis-enterprise/"/>
<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/crdbs/health_report/.html | <section class="prose w-full py-12 max-w-none">
<h1>
CRDB health report requests
</h1>
<p class="text-lg -mt-5 mb-10">
Active-Active database health report requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-crdbs-health">
GET
</a>
</td>
<td>
<code>
/v1/crdbs/{crdb_guid}/health_report
</code>
</td>
<td>
Get a health report for an Active-Active database
</td>
</tr>
</tbody>
</table>
<h2 id="get-crdbs-health">
Get health report
</h2>
<pre><code>GET /v1/crdbs/{crdb_guid}/health_report
</code></pre>
<p>
Get a health report for an Active-Active database.
</p>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /crdbs/{crdb_guid}/health_report
</code></pre>
<h4 id="url-parameters">
URL parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
crdb_guid
</td>
<td>
string
</td>
<td>
Globally unique Active-Active database ID (GUID)
</td>
</tr>
</tbody>
</table>
<h4 id="query-parameters">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
instance_id
</td>
<td>
integer
</td>
<td>
The request retrieves information from the specified Active-Active database instance. If this instance doesn’t exist, the request retrieves information from all instances. (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a JSON array of
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/crdb/health_report/">
CRDB health report objects
</a>
.
</p>
<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>
Action was successful.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
Configuration or Active-Active database not found.
</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/crdbs/health_report/"/>
<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/data-transformation/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Data transformation reference
</h1>
<p class="text-lg -mt-5 mb-10">
View reference material for RDI data transformations
</p>
<nav>
<a href="/docs/latest/integrate/redis-data-integration/reference/data-transformation/add_field/">
add_field
</a>
<p>
Add fields to a record
</p>
<a href="/docs/latest/integrate/redis-data-integration/reference/data-transformation/filter/">
filter
</a>
<p>
Filter records
</p>
<a href="/docs/latest/integrate/redis-data-integration/reference/data-transformation/map/">
map
</a>
<p>
Map a record into a new output based on expressions
</p>
<a href="/docs/latest/integrate/redis-data-integration/reference/data-transformation/remove_field/">
remove_field
</a>
<p>
Remove fields
</p>
<a href="/docs/latest/integrate/redis-data-integration/reference/data-transformation/rename_field/">
rename_field
</a>
<p>
Rename fields. All other fields remain unchanged.
</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/reference/data-transformation/"/>
<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/networking/routes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Use OpenShift routes for external database access
</h1>
<p>
OpenShift routes allow requests to be routed to the database or cluster API from outside the cluster. For more information about routes, see
<a href="https://docs.openshift.com/container-platform/4.13/networking/routes/route-configuration.html">
OpenShift documentation
</a>
.
</p>
<h2 id="prerequisites">
Prerequisites
</h2>
<ul>
<li>
<p>
Before you can connect to your database from outside the cluster, you'll need the root CA certificate of the DMC Proxy server to validate the server certificate.
</p>
<p>
By default, the DMC Proxy uses a self-signed certificate. You can retrieve it from the Redis Enterprise admin console and save it as a file (for example, named "ca.pem") on the client machine.
</p>
</li>
<li>
<p>
Your database also needs TLS encryption enabled.
</p>
</li>
</ul>
<h2 id="create-openshift-route">
Create OpenShift route
</h2>
<ol>
<li>
<p>
Select the
<strong>
Networking/Routes
</strong>
section of the OpenShift web console.
</p>
</li>
<li>
<p>
Select
<strong>
Create route
</strong>
and fill out the following fields:
</p>
<ul>
<li>
<strong>
Name
</strong>
: Choose any name you want as the first part of your generated hostname
</li>
<li>
<strong>
Hostname
</strong>
: Leave blank
</li>
<li>
<strong>
Path
</strong>
: Leave as is ("/")
</li>
<li>
<strong>
Service
</strong>
: Select the service for the database you want to access
</li>
<li>
<strong>
TLS Termination
</strong>
: Choose "passthrough"
</li>
<li>
<strong>
Insecure Traffic
</strong>
: Select "None"
</li>
</ul>
</li>
<li>
<p>
Select
<strong>
Create
</strong>
.
</p>
</li>
<li>
<p>
Find the hostname for your new route. After route creation, it appears in the "Host" field.
</p>
</li>
<li>
<p>
Verify you have a DNS entry to resolve the hostname for your new route to the cluster's load balancer.
</p>
</li>
</ol>
<h2 id="access-database">
Access database
</h2>
<p>
Access the database from outside the cluster using
<code>
redis-cli
</code>
or
<code>
openssl
</code>
.
</p>
<p>
To connect 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 <hostname> -p <span class="m">443</span> --tls --cacert ./ca.pem --sni <hostname>
</span></span></code></pre>
</div>
<p>
Replace the
<code>
<hostname>
</code>
value with the hostname for your new route.
</p>
<p>
To connect with
<code>
openssl
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">openssl s_client -connect <hostname>:443 -crlf -CAfile ./ca.pem -servername <hostname>
</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/kubernetes/networking/routes/"/>
<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/ldap/map-ldap-groups-to-roles/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Map LDAP groups to roles
</h1>
<p class="text-lg -mt-5 mb-10">
Describes how to map LDAP authorization groups to Redis Enterprise roles using the Cluster Manager UI.
</p>
<p>
Redis Enterprise Software uses a role-based mechanism to enable LDAP authentication and authorization.
</p>
<p>
Once LDAP is enabled, you need to map LDAP groups to Redis Enterprise access control roles.
</p>
<h2 id="map-ldap-groups-to-roles">
Map LDAP groups to roles
</h2>
<p>
To map LDAP groups to access control roles in the Cluster Manager UI:
</p>
<ol>
<li>
<p>
Select
<strong>
Access Control > LDAP > Mapping
</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>
You can map LDAP roles when LDAP configuration is not enabled, but they won't have any effect until you
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap/">
configure and enable LDAP
</a>
.
</div>
</div>
<a href="/docs/latest/images/rs/access-control-ldap-mappings-panel.png" sdata-lightbox="/images/rs/access-control-ldap-mappings-panel.png">
<img alt="Enable LDAP mappings Panel" src="/docs/latest/images/rs/access-control-ldap-mappings-panel.png"/>
</a>
</li>
<li>
<p>
Select the
<strong>
+ Add LDAP Mapping
</strong>
button to create a new mapping and then enter the following details:
</p>
<table>
<thead>
<tr>
<th style="text-align:left">
<em>
Setting
</em>
</th>
<th style="text-align:left">
<em>
Description
</em>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">
<strong>
Name
</strong>
</td>
<td style="text-align:left">
A descriptive, unique name for the mapping
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Distinguished Name
</strong>
</td>
<td style="text-align:left">
The distinguished name of the LDAP group to be mapped.
<br/>
Example:
<code>
cn=admins,ou=groups,dc=example,dc=com
</code>
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Role
</strong>
</td>
<td style="text-align:left">
The Redis Software access control role defined for this group
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Email
</strong>
</td>
<td style="text-align:left">
<em>
(Optional)
</em>
An address to receive alerts
</td>
</tr>
<tr>
<td style="text-align:left">
<strong>
Alerts
</strong>
</td>
<td style="text-align:left">
Selections identifying the desired alerts.
</td>
</tr>
</tbody>
</table>
<a href="/docs/latest/images/rs/access-control-ldap-mappings-add.png" sdata-lightbox="/images/rs/access-control-ldap-mappings-add.png">
<img alt="Enable LDAP mappings Panel" src="/docs/latest/images/rs/access-control-ldap-mappings-add.png"/>
</a>
</li>
<li>
<p>
When finished, select the
<strong>
Save
</strong>
button.
</p>
</li>
</ol>
<p>
Create a mapping for each LDAP group used to authenticate and/or authorize access to Redis Enterprise Software resources.
</p>
<p>
The scope of the authorization depends on the access control role:
</p>
<ul>
<li>
<p>
If the role authorizes admin management, LDAP users are authorized as cluster management administrators.
</p>
</li>
<li>
<p>
If the role authorizes database access, LDAP users are authorized to use the database to the limits specified in the role.
</p>
</li>
<li>
<p>
To authorize LDAP users to specific databases, update the database access control lists (ACLs) to include the mapped LDAP role.
</p>
</li>
</ul>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
Enable and configure
<a href="/docs/latest/operate/rs/7.4/security/access-control/ldap/enable-role-based-ldap/">
role-based LDAP
</a>
</li>
<li>
Update database ACLs to
<a href="/docs/latest/operate/rs/7.4/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/7.4/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/7.4/security/access-control/ldap/map-ldap-groups-to-roles/"/>
<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/quick-start/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software REST API quick start
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Enterprise Software REST API quick start
</p>
<p>
Redis Enterprise Software includes a REST API that allows you to automate certain tasks. This article shows you how to send a request to the Redis Enterprise Software REST API.
</p>
<h2 id="fundamentals">
Fundamentals
</h2>
<p>
No matter which method you use to send API requests, there are a few common concepts to remember.
</p>
<table>
<thead>
<tr>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/#authentication">
Authentication
</a>
</td>
<td>
Use
<a href="https://en.wikipedia.org/wiki/Basic_access_authentication">
Basic Auth
</a>
with your cluster username (email) and password
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/#ports">
Ports
</a>
</td>
<td>
All calls are made to port 9443 by default
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/#versions">
Versions
</a>
</td>
<td>
Specify the version in the request
<a href="https://en.wikipedia.org/wiki/Uniform_Resource_Identifier">
URI
</a>
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/#headers">
Headers
</a>
</td>
<td>
<code>
Accept
</code>
and
<code>
Content-Type
</code>
should be
<code>
application/json
</code>
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/#response-types-and-error-codes">
Response types and error codes
</a>
</td>
<td>
A response of
<code>
200 OK
</code>
means success; otherwise, the request failed due to an error
</td>
</tr>
</tbody>
</table>
<p>
For more information, see
<a href="/docs/latest/operate/rs/7.4/references/rest-api/">
Redis Enterprise Software REST API
</a>
.
</p>
<h2 id="curl-example-requests">
cURL example requests
</h2>
<p>
<a href="https://curl.se/">
cURL
</a>
is a command-line tool that allows you to send HTTP requests from a terminal.
</p>
<p>
You can use the following options to build a cURL request:
</p>
<table>
<thead>
<tr>
<th>
Option
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
-X
</td>
<td>
Method (GET, PUT, PATCH, POST, or DELETE)
</td>
</tr>
<tr>
<td>
-H
</td>
<td>
Request header, can be specified multiple times
</td>
</tr>
<tr>
<td>
-u
</td>
<td>
Username and password information
</td>
</tr>
<tr>
<td>
-d
</td>
<td>
JSON data for PUT or POST requests
</td>
</tr>
<tr>
<td>
-F
</td>
<td>
Form data for PUT or POST requests, such as for the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/modules/#post-module">
<code>
POST /v1/modules
</code>
</a>
or
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/modules/#post-module-v2">
<code>
POST /v2/modules
</code>
</a>
endpoint
</td>
</tr>
<tr>
<td>
-k
</td>
<td>
Turn off SSL verification
</td>
</tr>
<tr>
<td>
-i
</td>
<td>
Show headers and status code as well as the response body
</td>
</tr>
</tbody>
</table>
<p>
See the
<a href="https://curl.se/docs/">
cURL documentation
</a>
for more information.
</p>
<h3 id="get-request">
GET request
</h3>
<p>
Use the following cURL command to get a list of databases with the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/#get-all-bdbs">
GET
<code>
/v1/bdbs/
</code>
</a>
endpoint.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ curl -X GET -H <span class="s2">"accept: application/json"</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -u <span class="s2">"[username]:[password]"</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> https://<span class="o">[</span>host<span class="o">][</span>:port<span class="o">]</span>/v1/bdbs -k -i
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">HTTP/1.1 <span class="m">200</span> OK
</span></span><span class="line"><span class="cl">server: envoy
</span></span><span class="line"><span class="cl">date: Tue, <span class="m">14</span> Jun <span class="m">2022</span> 19:24:30 GMT
</span></span><span class="line"><span class="cl">content-type: application/json
</span></span><span class="line"><span class="cl">content-length: <span class="m">2833</span>
</span></span><span class="line"><span class="cl">cluster-state-id: <span class="m">42</span>
</span></span><span class="line"><span class="cl">x-envoy-upstream-service-time: <span class="m">25</span>
</span></span><span class="line"><span class="cl">
</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="s2">"name"</span>: <span class="s2">"tr01"</span>,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"uid"</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s2">"version"</span>: <span class="s2">"6.0.16"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"wait_command"</span>: <span class="nb">true</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>
<p>
In the response body, the
<code>
uid
</code>
is the database ID. You can use the database ID to view or update the database using the API.
</p>
<p>
For more information about the fields returned by
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/#get-all-bdbs">
GET
<code>
/v1/bdbs/
</code>
</a>
, see the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb/">
<code>
bdbs
</code>
object
</a>
.
</p>
<h3 id="put-request">
PUT request
</h3>
<p>
Once you have the database ID, you can use
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/#put-bdbs">
PUT
<code>
/v1/bdbs/
</code>
</a>
to update the configuration of the database.
</p>
<p>
For example, you can pass the database
<code>
uid
</code>
1 as a URL parameter and use the
<code>
-d
</code>
option to specify the new
<code>
name
</code>
when you send the request. This changes the database's
<code>
name
</code>
from
<code>
tr01
</code>
to
<code>
database1
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ curl -X PUT -H <span class="s2">"accept: application/json"</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -H <span class="s2">"content-type: application/json"</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -u <span class="s2">"[email protected]:test123"</span> <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> https://<span class="o">[</span>host<span class="o">]</span>:<span class="o">[</span>port<span class="o">]</span>/v1/bdbs/1 <span class="se">\
</span></span></span><span class="line"><span class="cl"><span class="se"></span> -d <span class="s1">'{ "name": "database1" }'</span> -k -i
</span></span><span class="line"><span class="cl">HTTP/1.1 <span class="m">200</span> OK
</span></span><span class="line"><span class="cl">server: envoy
</span></span><span class="line"><span class="cl">date: Tue, <span class="m">14</span> Jun <span class="m">2022</span> 20:00:25 GMT
</span></span><span class="line"><span class="cl">content-type: application/json
</span></span><span class="line"><span class="cl">content-length: <span class="m">2933</span>
</span></span><span class="line"><span class="cl">cluster-state-id: <span class="m">43</span>
</span></span><span class="line"><span class="cl">x-envoy-upstream-service-time: <span class="m">159</span>
</span></span><span class="line"><span class="cl">
</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="s2">"name"</span> : <span class="s2">"database1"</span>,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"uid"</span> : 1,
</span></span><span class="line"><span class="cl"> <span class="s2">"version"</span> : <span class="s2">"6.0.16"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"wait_command"</span> : <span class="nb">true</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span></code></pre>
</div>
<p>
For more information about the fields you can update with
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/bdbs/#put-bdbs">
PUT
<code>
/v1/bdbs/
</code>
</a>
, see the
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb/">
<code>
bdbs
</code>
object
</a>
.
</p>
<h2 id="client-examples">
Client examples
</h2>
<p>
You can also use client libraries to make API requests in your preferred language.
</p>
<p>
To follow these examples, you need:
</p>
<ul>
<li>
A
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/quickstarts/redis-enterprise-software-quickstart/">
Redis Enterprise Software
</a>
node
</li>
<li>
Python 3 and the
<a href="https://pypi.org/project/requests/">
requests
</a>
Python library
</li>
<li>
<a href="https://nodejs.dev/">
node.js
</a>
and
<a href="https://www.npmjs.com/package/node-fetch">
node-fetch
</a>
</li>
</ul>
<h3 id="python">
Python
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><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">requests</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># Required connection information - replace with your host, port, username, and password</span>
</span></span><span class="line"><span class="cl"><span class="n">host</span> <span class="o">=</span> <span class="s2">"[host]"</span>
</span></span><span class="line"><span class="cl"><span class="n">port</span> <span class="o">=</span> <span class="s2">"[port]"</span>
</span></span><span class="line"><span class="cl"><span class="n">username</span> <span class="o">=</span> <span class="s2">"[username]"</span>
</span></span><span class="line"><span class="cl"><span class="n">password</span> <span class="o">=</span> <span class="s2">"[password]"</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># Get the list of databases using GET /v1/bdbs</span>
</span></span><span class="line"><span class="cl"><span class="n">bdbs_uri</span> <span class="o">=</span> <span class="s2">"https://</span><span class="si">{}</span><span class="s2">:</span><span class="si">{}</span><span class="s2">/v1/bdbs"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"GET </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">bdbs_uri</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="n">get_resp</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">bdbs_uri</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">auth</span> <span class="o">=</span> <span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">headers</span> <span class="o">=</span> <span class="p">{</span> <span class="s2">"accept"</span> <span class="p">:</span> <span class="s2">"application/json"</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">verify</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 class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">get_resp</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span> <span class="n">get_resp</span><span class="o">.</span><span class="n">reason</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">header</span> <span class="ow">in</span> <span class="n">get_resp</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">keys</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">"</span><span class="si">{}</span><span class="s2">: </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="n">get_resp</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="n">header</span><span class="p">]))</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">get_resp</span><span class="o">.</span><span class="n">json</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># Rename all databases using PUT /v1/bdbs</span>
</span></span><span class="line"><span class="cl"><span class="k">for</span> <span class="n">bdb</span> <span class="ow">in</span> <span class="n">get_resp</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">uid</span> <span class="o">=</span> <span class="n">bdb</span><span class="p">[</span><span class="s2">"uid"</span><span class="p">]</span> <span class="c1"># Get the database ID from the JSON response</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">put_uri</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">bdbs_uri</span><span class="p">,</span> <span class="n">uid</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">new_name</span> <span class="o">=</span> <span class="s2">"database</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">uid</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="n">put_data</span> <span class="o">=</span> <span class="p">{</span> <span class="s2">"name"</span> <span class="p">:</span> <span class="n">new_name</span> <span class="p">}</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="s2">"PUT </span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">put_uri</span><span class="p">,</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">put_data</span><span class="p">)))</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">put_resp</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">put</span><span class="p">(</span><span class="n">put_uri</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">data</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">put_data</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">auth</span> <span class="o">=</span> <span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">),</span>
</span></span><span class="line"><span class="cl"> <span class="n">headers</span> <span class="o">=</span> <span class="p">{</span> <span class="s2">"content-type"</span> <span class="p">:</span> <span class="s2">"application/json"</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="n">verify</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 class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">put_resp</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span> <span class="n">put_resp</span><span class="o">.</span><span class="n">reason</span><span class="p">))</span>
</span></span><span class="line"><span class="cl"> <span class="k">for</span> <span class="n">header</span> <span class="ow">in</span> <span class="n">put_resp</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">keys</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">"</span><span class="si">{}</span><span class="s2">: </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="n">put_resp</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="n">header</span><span class="p">]))</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> <span class="o">+</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">put_resp</span><span class="o">.</span><span class="n">json</span><span class="p">(),</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">))</span>
</span></span></code></pre>
</div>
<p>
See the
<a href="https://requests.readthedocs.io/en/latest/">
Python requests library documentation
</a>
for more information.
</p>
<h4 id="output">
Output
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ python rs_api.py
</span></span><span class="line"><span class="cl">python rs_api.py
</span></span><span class="line"><span class="cl">GET https://<span class="o">[</span>host<span class="o">]</span>:<span class="o">[</span>port<span class="o">]</span>/v1/bdbs
</span></span><span class="line"><span class="cl">InsecureRequestWarning: Unverified HTTPS request is being made to host <span class="s1">'[host]'</span>.
</span></span><span class="line"><span class="cl">Adding certificate verification is strongly advised.
</span></span><span class="line"><span class="cl">See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
</span></span><span class="line"><span class="cl"> warnings.warn<span class="o">(</span>
</span></span><span class="line"><span class="cl"><span class="m">200</span> OK
</span></span><span class="line"><span class="cl">server: envoy
</span></span><span class="line"><span class="cl">date: Wed, <span class="m">15</span> Jun <span class="m">2022</span> 15:49:43 GMT
</span></span><span class="line"><span class="cl">content-type: application/json
</span></span><span class="line"><span class="cl">content-length: <span class="m">2832</span>
</span></span><span class="line"><span class="cl">cluster-state-id: <span class="m">89</span>
</span></span><span class="line"><span class="cl">x-envoy-upstream-service-time: <span class="m">27</span>
</span></span><span class="line"><span class="cl">
</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="s2">"name"</span>: <span class="s2">"tr01"</span>,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"uid"</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s2">"version"</span>: <span class="s2">"6.0.16"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"wait_command"</span>: <span class="nb">true</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">PUT https://<span class="o">[</span>host<span class="o">]</span>:<span class="o">[</span>port<span class="o">]</span>/v1/bdbs/1 <span class="o">{</span><span class="s2">"name"</span>: <span class="s2">"database1"</span><span class="o">}</span>
</span></span><span class="line"><span class="cl">InsecureRequestWarning: Unverified HTTPS request is being made to host <span class="s1">'[host]'</span>.
</span></span><span class="line"><span class="cl">Adding certificate verification is strongly advised.
</span></span><span class="line"><span class="cl">See: https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html#ssl-warnings
</span></span><span class="line"><span class="cl"> warnings.warn<span class="o">(</span>
</span></span><span class="line"><span class="cl"><span class="m">200</span> OK
</span></span><span class="line"><span class="cl">server: envoy
</span></span><span class="line"><span class="cl">date: Wed, <span class="m">15</span> Jun <span class="m">2022</span> 15:49:43 GMT
</span></span><span class="line"><span class="cl">content-type: application/json
</span></span><span class="line"><span class="cl">content-length: <span class="m">2933</span>
</span></span><span class="line"><span class="cl">cluster-state-id: <span class="m">90</span>
</span></span><span class="line"><span class="cl">x-envoy-upstream-service-time: <span class="m">128</span>
</span></span><span class="line"><span class="cl">
</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="s2">"name"</span> : <span class="s2">"database1"</span>,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"uid"</span> : 1,
</span></span><span class="line"><span class="cl"> <span class="s2">"version"</span> : <span class="s2">"6.0.16"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"wait_command"</span> : <span class="nb">true</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span></code></pre>
</div>
<h3 id="nodejs">
node.js
</h3>
<div class="highlight">
<pre class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fetch</span><span class="p">,</span> <span class="p">{</span> <span class="nx">Headers</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'node-fetch'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="o">*</span> <span class="nx">as</span> <span class="nx">https</span> <span class="nx">from</span> <span class="s1">'https'</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">HOST</span> <span class="o">=</span> <span class="s1">'[host]'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">PORT</span> <span class="o">=</span> <span class="s1">'[port]'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">USERNAME</span> <span class="o">=</span> <span class="s1">'[username]'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">PASSWORD</span> <span class="o">=</span> <span class="s1">'[password]'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">// Get the list of databases using GET /v1/bdbs
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">BDBS_URI</span> <span class="o">=</span> <span class="sb">`https://</span><span class="si">${</span><span class="nx">HOST</span><span class="si">}</span><span class="sb">:</span><span class="si">${</span><span class="nx">PORT</span><span class="si">}</span><span class="sb">/v1/bdbs`</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">USER_CREDENTIALS</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="sb">`</span><span class="si">${</span><span class="nx">USERNAME</span><span class="si">}</span><span class="sb">:</span><span class="si">${</span><span class="nx">PASSWORD</span><span class="si">}</span><span class="sb">`</span><span class="p">).</span><span class="nx">toString</span><span class="p">(</span><span class="s1">'base64'</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">AUTH_HEADER</span> <span class="o">=</span> <span class="sb">`Basic </span><span class="si">${</span><span class="nx">USER_CREDENTIALS</span><span class="si">}</span><span class="sb">`</span><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="sb">`GET </span><span class="si">${</span><span class="nx">BDBS_URI</span><span class="si">}</span><span class="sb">`</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">HTTPS_AGENT</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">https</span><span class="p">.</span><span class="nx">Agent</span><span class="p">({</span>
</span></span><span class="line"><span class="cl"> <span class="nx">rejectUnauthorized</span><span class="o">:</span> <span class="kc">false</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">const</span> <span class="nx">response</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">fetch</span><span class="p">(</span><span class="nx">BDBS_URI</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">method</span><span class="o">:</span> <span class="s1">'GET'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">headers</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Accept'</span><span class="o">:</span> <span class="s1">'application/json'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Authorization'</span><span class="o">:</span> <span class="nx">AUTH_HEADER</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">agent</span><span class="o">:</span> <span class="nx">HTTPS_AGENT</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">const</span> <span class="nx">responseObject</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">response</span><span class="p">.</span><span class="nx">json</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="sb">`</span><span class="si">${</span><span class="nx">response</span><span class="p">.</span><span class="nx">status</span><span class="si">}</span><span class="sb">: </span><span class="si">${</span><span class="nx">response</span><span class="p">.</span><span class="nx">statusText</span><span class="si">}</span><span class="sb">`</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="nx">responseObject</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1">// Rename all databases using PUT /v1/bdbs
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="k">for</span> <span class="p">(</span><span class="kr">const</span> <span class="nx">database</span> <span class="k">of</span> <span class="nx">responseObject</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">DATABASE_URI</span> <span class="o">=</span> <span class="sb">`</span><span class="si">${</span><span class="nx">BDBS_URI</span><span class="si">}</span><span class="sb">/</span><span class="si">${</span><span class="nx">database</span><span class="p">.</span><span class="nx">uid</span><span class="si">}</span><span class="sb">`</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">new_name</span> <span class="o">=</span> <span class="sb">`database</span><span class="si">${</span><span class="nx">database</span><span class="p">.</span><span class="nx">uid</span><span class="si">}</span><span class="sb">`</span><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="sb">`PUT </span><span class="si">${</span><span class="nx">DATABASE_URI</span><span class="si">}</span><span class="sb">`</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">response</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">fetch</span><span class="p">(</span><span class="nx">DATABASE_URI</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">method</span><span class="o">:</span> <span class="s1">'PUT'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">headers</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Authorization'</span><span class="o">:</span> <span class="nx">AUTH_HEADER</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'Content-Type'</span><span class="o">:</span> <span class="s1">'application/json'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">body</span><span class="o">:</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">({</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'name'</span><span class="o">:</span> <span class="nx">new_name</span>
</span></span><span class="line"><span class="cl"> <span class="p">}),</span>
</span></span><span class="line"><span class="cl"> <span class="nx">agent</span><span class="o">:</span> <span class="nx">HTTPS_AGENT</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="sb">`</span><span class="si">${</span><span class="nx">response</span><span class="p">.</span><span class="nx">status</span><span class="si">}</span><span class="sb">: </span><span class="si">${</span><span class="nx">response</span><span class="p">.</span><span class="nx">statusText</span><span class="si">}</span><span class="sb">`</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="kr">await</span><span class="p">(</span><span class="nx">response</span><span class="p">.</span><span class="nx">json</span><span class="p">()));</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<p>
See the
<a href="https://www.npmjs.com/package/node-fetch">
node-fetch documentation
</a>
for more info.
</p>
<h4 id="output-1">
Output
</h4>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ node rs_api.js
</span></span><span class="line"><span class="cl">GET https://<span class="o">[</span>host<span class="o">]</span>:<span class="o">[</span>port<span class="o">]</span>/v1/bdbs
</span></span><span class="line"><span class="cl">200: OK
</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="s2">"name"</span>: <span class="s2">"tr01"</span>,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"slave_ha"</span> : false,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"uid"</span>: 1,
</span></span><span class="line"><span class="cl"> <span class="s2">"version"</span>: <span class="s2">"6.0.16"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"wait_command"</span>: <span class="nb">true</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">PUT https://<span class="o">[</span>host<span class="o">]</span>:<span class="o">[</span>port<span class="o">]</span>/v1/bdbs/1
</span></span><span class="line"><span class="cl">200: OK
</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="s2">"name"</span> : <span class="s2">"tr01"</span>,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"slave_ha"</span> : true,
</span></span><span class="line"><span class="cl"> ...
</span></span><span class="line"><span class="cl"> <span class="s2">"uid"</span> : 1,
</span></span><span class="line"><span class="cl"> <span class="s2">"version"</span> : <span class="s2">"6.0.16"</span>,
</span></span><span class="line"><span class="cl"> <span class="s2">"wait_command"</span> : <span class="nb">true</span>
</span></span><span class="line"><span class="cl"><span class="o">}</span>
</span></span></code></pre>
</div>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/">
Redis Enterprise Software REST API
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/7.4/references/rest-api/requests/">
Redis Enterprise Software REST API requests
</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/rest-api/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/operate/rs/7.4/references/cli-utilities/rladmin/verify/.html | <section class="prose w-full py-12 max-w-none">
<h1>
rladmin verify
</h1>
<p class="text-lg -mt-5 mb-10">
Prints verification reports for the cluster.
</p>
<p>
Prints verification reports for the cluster.
</p>
<h2 id="verify-balance">
<code>
verify balance
</code>
</h2>
<p>
Prints a balance report that displays all of the unbalanced endpoints or nodes in the cluster.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin verify balance <span class="o">[</span> node <ID> <span class="o">]</span>
</span></span></code></pre>
</div>
<p>
The
<a href="/docs/latest/operate/rs/7.4/databases/configure/proxy-policy/#proxy-policies">
proxy policy
</a>
determines which nodes or endpoints to report as unbalanced.
</p>
<p>
A node is unbalanced if:
</p>
<ul>
<li>
<code>
all-nodes
</code>
proxy policy and the node has no endpoint
</li>
</ul>
<p>
An endpoint is unbalanced in the following cases:
</p>
<ul>
<li>
<code>
single
</code>
proxy policy and one of the following is true:
<ul>
<li>
Shard placement is
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/shard-placement-policy/#sparse-shard-placement-policy">
<code>
sparse
</code>
</a>
and none of the master shards are on the node
</li>
<li>
Shard placement is
<a href="/docs/latest/operate/rs/7.4/databases/memory-performance/shard-placement-policy/#dense-shard-placement-policy">
<code>
dense
</code>
</a>
and some master shards are on a different node from the endpoint
</li>
</ul>
</li>
<li>
<code>
all-master-shards
</code>
proxy policy and one of the following is true:
<ul>
<li>
None of the master shards are on the node
</li>
<li>
Some master shards are on a different node from the endpoint
</li>
</ul>
</li>
</ul>
<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>
Specify a node ID to return a balance table for that node only (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns a table of unbalanced endpoints and nodes in the cluster.
</p>
<h3 id="examples">
Examples
</h3>
<p>
Verify all nodes:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin verify balance
</span></span><span class="line"><span class="cl">The table presents all of the unbalanced endpoints/nodes in the cluster
</span></span><span class="line"><span class="cl">BALANCE:
</span></span><span class="line"><span class="cl">NODE:ID DB:ID NAME ENDPOINT:ID PROXY_POLICY LOCAL SHARDS TOTAL SHARDS
</span></span></code></pre>
</div>
<p>
Verify a specific node:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">$ rladmin verify balance node <span class="m">1</span>
</span></span><span class="line"><span class="cl">The table presents all of the unbalanced endpoints/nodes in the cluster
</span></span><span class="line"><span class="cl">BALANCE:
</span></span><span class="line"><span class="cl">NODE:ID DB:ID NAME ENDPOINT:ID PROXY_POLICY LOCAL SHARDS TOTAL SHARDS
</span></span></code></pre>
</div>
<h2 id="verify-rack_aware">
<code>
verify rack_aware
</code>
</h2>
<p>
Verifies that the cluster complies with the rack awareness policy and reports any discovered rack collisions, if
<a href="/docs/latest/operate/rs/7.4/clusters/configure/rack-zone-awareness/">
rack-zone awareness
</a>
is enabled.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin verify rack_aware
</span></span></code></pre>
</div>
<h3 id="parameters-1">
Parameters
</h3>
<p>
None
</p>
<h3 id="returns-1">
Returns
</h3>
<p>
Returns whether the cluster is rack aware. If rack awareness is enabled, it returns any rack collisions.
</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 verify rack_aware
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Cluster policy is not configured <span class="k">for</span> rack awareness.
</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/verify/"/>
<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/bootstrap/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Bootstrap requests
</h1>
<p class="text-lg -mt-5 mb-10">
Bootstrap requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-bootstrap">
GET
</a>
</td>
<td>
<code>
/v1/boostrap
</code>
</td>
<td>
Get the local node's bootstrap status
</td>
</tr>
<tr>
<td>
<a href="#post-bootstrap">
POST
</a>
</td>
<td>
<code>
/v1/bootstrap/{action}
</code>
</td>
<td>
Initiate bootstrapping
</td>
</tr>
</tbody>
</table>
<h2 id="get-bootstrap">
Get bootstrap status
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/bootstrap
</span></span></code></pre>
</div>
<p>
Get the local node's bootstrap status.
</p>
<p>
This request is accepted as soon the cluster software is installed and before the node is part of an active cluster.
</p>
<p>
Once the node is part of an active cluster, authentication is required.
</p>
<h3 id="get-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 /bootstrap
</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>
Accept
</td>
<td>
application/json
</td>
<td>
Accepted media type
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
The JSON response object contains a
<code>
bootstrap_status
</code>
object and a
<code>
local_node_info
</code>
object.
</p>
<p>
The
<code>
bootstrap_status
</code>
object contains the following information:
</p>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
state
</td>
<td>
Current bootstrap state.
<br/>
<br/>
<code>
idle
</code>
: No bootstrapping started.
<br/>
<br/>
<code>
initiated
</code>
: Bootstrap request received.
<br/>
<br/>
<code>
creating_cluster
</code>
: In the process of creating a new cluster.
<br/>
<br/>
<code>
recovering_cluster
</code>
: In the process of recovering a cluster.
<br/>
<br/>
<code>
joining_cluster
</code>
: In the process of joining an existing cluster.
<br/>
<br/>
<code>
error
</code>
: The last bootstrap action failed.
<br/>
<br/>
<code>
completed
</code>
: The last bootstrap action completed successfully.
</td>
</tr>
<tr>
<td>
start_time
</td>
<td>
Bootstrap process start time
</td>
</tr>
<tr>
<td>
end_time
</td>
<td>
Bootstrap process end time
</td>
</tr>
<tr>
<td>
error_code
</td>
<td>
If state is
<code>
error
</code>
, this error code describes the type of error encountered.
</td>
</tr>
<tr>
<td>
error_details
</td>
<td>
An error-specific object that may contain additional information about the error. A common field in use is
<code>
message
</code>
which provides a more verbose error message.
</td>
</tr>
</tbody>
</table>
<p>
The
<code>
local_node_info
</code>
object is a subset of a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/node/">
node object
</a>
that provides information about the node configuration.
</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">"bootstrap_status"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"start_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">"end_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">"state"</span><span class="p">:</span> <span class="s2">"completed"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"local_node_info"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"uid"</span><span class="p">:</span> <span class="mi">3</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">"cores"</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">"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">"ephemeral_storage_size"</span><span class="p">:</span> <span class="mf">1018889.8304</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 LTS"</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/redis"</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="mf">1018889.8304</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">24137</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">50278</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"available_addrs"</span><span class="p">:</span> <span class="p">[{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"address"</span><span class="p">:</span> <span class="s2">"172.16.50.122"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"format"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"if_name"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"private"</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><span class="line"><span class="cl"> <span class="nt">"address"</span><span class="p">:</span> <span class="s2">"10.0.3.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"format"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"if_name"</span><span class="p">:</span> <span class="s2">"lxcbr0"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"private"</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><span class="line"><span class="cl"> <span class="nt">"address"</span><span class="p">:</span> <span class="s2">"172.17.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"format"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"if_name"</span><span class="p">:</span> <span class="s2">"docker0"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"private"</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><span class="line"><span class="cl"> <span class="nt">"address"</span><span class="p">:</span> <span class="s2">"2001:db8:0:f101::1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"format"</span><span class="p">:</span> <span class="s2">"ipv6"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"if_name"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"private"</span><span class="p">:</span> <span class="kc">false</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>
<h3 id="get-error-codes">
Error codes
</h3>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
config_error
</td>
<td>
An error related to the bootstrap configuration provided (e.g. bad JSON).
</td>
</tr>
<tr>
<td>
connect_error
</td>
<td>
Failed to connect to cluster (e.g. FQDN DNS could not resolve, no/wrong node IP provided, etc.
</td>
</tr>
<tr>
<td>
access_denied
</td>
<td>
Invalid credentials supplied.
</td>
</tr>
<tr>
<td>
invalid_license
</td>
<td>
The license string provided is invalid. Additional info can be fetched from the
<code>
error_details
</code>
object, which includes the violation code in case the license is valid but its terms are violated.
</td>
</tr>
<tr>
<td>
repair_required
</td>
<td>
Cluster is in degraded mode and can only accept replacement nodes. When this happens,
<code>
error_details
</code>
contains two fields:
<code>
failed_nodes
</code>
and
<code>
replace_candidate
</code>
. The
<code>
failed_nodes
</code>
field is an array of objects, each describing a failed node with at least a
<code>
uid
</code>
field and an optional
<code>
rack_id
</code>
.
<code>
replace_candidate
</code>
is the UID of the node most suitable for replacement.
</td>
</tr>
<tr>
<td>
insufficient_node_memory
</td>
<td>
An attempt to replace a dead node fails because the replaced node does not have enough memory. When this happens, error_details contains a required_memory field which indicates the node memory requirement.
</td>
</tr>
<tr>
<td>
insufficient_node_flash
</td>
<td>
An attempt to replace a dead node fails because the replaced node does not have enough flash. When this happens,
<code>
error_details
</code>
contains a
<code>
required_flash
</code>
field which indicates the node flash requirement.
</td>
</tr>
<tr>
<td>
time_not_sync
</td>
<td>
An attempt to join a node with system time not synchronized with the rest of the cluster.
</td>
</tr>
<tr>
<td>
rack_id_required
</td>
<td>
An attempt to join a node with no
<code>
rack_id
</code>
in a rack-aware cluster. In addition, a
<code>
current_rack_ids
</code>
field will include an array of currently used rack ids.
</td>
</tr>
<tr>
<td>
socket_directory_mismatch
</td>
<td>
An attempt to join a node with a socket directory setting that differs from the cluster
</td>
</tr>
<tr>
<td>
node_config_mismatch
</td>
<td>
An attempt to join a node with a configuration setting (e.g. confdir, osuser, installdir) that differs from the cluster
</td>
</tr>
<tr>
<td>
path_error
</td>
<td>
A needed path does not exist or is not accessable.
</td>
</tr>
<tr>
<td>
internal_error
</td>
<td>
A different, unspecified internal error was encountered.
</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>
No error
</td>
</tr>
</tbody>
</table>
<h2 id="post-bootstrap">
Start bootstrapping
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">POST /v1/bootstrap/<span class="o">{</span>action<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Initiate bootstrapping.
</p>
<p>
The request must contain a bootstrap configuration JSON object, as
described in
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/">
Object attributes
</a>
or a minimal subset.
</p>
<p>
Bootstrapping is permitted only when the current bootstrap state is
<code>
idle
</code>
or
<code>
error
</code>
(in which case the process will restart with the new
configuration).
</p>
<p>
This request is asynchronous - once the request has been accepted,
the caller is expected to poll bootstrap status while waiting for it to
complete.
</p>
<h3 id="post-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">POST /bootstrap/create_cluster
</span></span></code></pre>
</div>
<h4 id="example-json-body-1">
Example JSON body
</h4>
<h5 id="join-cluster">
Join cluster
</h5>
<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">"action"</span><span class="p">:</span> <span class="s2">"join_cluster"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"nodes"</span><span class="p">:[</span> <span class="s2">"1.1.1.1"</span><span class="p">,</span> <span class="s2">"2.2.2.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="nt">"node"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"paths"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_path"</span><span class="p">:</span> <span class="s2">"/path/to/persistent/storage"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_path"</span><span class="p">:</span> <span class="s2">"/path/to/ephemeral/storage"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bigstore_path"</span><span class="p">:</span> <span class="s2">"/path/to/bigstore/storage"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bigstore_driver"</span><span class="p">:</span> <span class="s2">"speedb"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"identity"</span><span class="p">:</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">"1.2.3.4"</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="s2">"2001:0db8:85a3:0000:0000:8a2e:0370:7334"</span><span class="p">,</span> <span class="s2">"3.4.5.6"</span><span class="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="nt">"credentials"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"my_username"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"password"</span><span class="p">:</span> <span class="s2">"my_password"</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>
<h5 id="create-cluster">
Create cluster
</h5>
<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">"action"</span><span class="p">:</span> <span class="s2">"create_cluster"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"cluster"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"nodes"</span><span class="p">:</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">"my.cluster"</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"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"paths"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"persistent_path"</span><span class="p">:</span> <span class="s2">"/path/to/persistent/storage"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ephemeral_path"</span><span class="p">:</span> <span class="s2">"/path/to/ephemeral/storage"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bigstore_path"</span><span class="p">:</span> <span class="s2">"/path/to/bigredis/storage"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"identity"</span><span class="p">:</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">"1.2.3.4"</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="s2">"2001:0db8:85a3:0000:0000:8a2e:0370:7334"</span><span class="p">,</span> <span class="s2">"3.4.5.6"</span><span class="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">"bigstore_driver"</span><span class="p">:</span> <span class="s2">"rocksdb"</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"license"</span><span class="p">:</span> <span class="s2">"----- LICENSE START -----\ndi+iK...KniI9\n----- LICENSE END -----\n"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"credentials"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"my_username"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"password"</span><span class="p">:</span> <span class="s2">"my_password"</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="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>
<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 a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bootstrap/">
bootstrap object
</a>
in the request body.
</p>
<h3 id="post-response">
Response
</h3>
<h4 id="post-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>
Request received and processing begins.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10">
409 Conflict
</a>
</td>
<td>
Bootstrap already in progress (check state)
</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/bootstrap/"/>
<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/query/aggregation/.html | <section class="prose w-full py-12">
<h1>
Aggregation queries
</h1>
<p class="text-lg -mt-5 mb-10">
Group and aggregate query results
</p>
<p>
An aggregation query allows you to perform the following actions:
</p>
<ul>
<li>
Apply simple mapping functions.
</li>
<li>
Group data based on field values.
</li>
<li>
Apply aggregation functions on the grouped data.
</li>
</ul>
<p>
This article explains the basic usage of the
<a href="/docs/latest/commands/ft.aggregate">
FT.AGGREGATE
</a>
command. For further details, see the
<a href="/docs/latest/commands/ft.aggregate">
command specification
</a>
and the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/aggregations/">
aggregations reference documentation
</a>
.
</p>
<p>
The examples in this article use a schema with the following fields:
</p>
<table>
<thead>
<tr>
<th>
Field name
</th>
<th>
Field type
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
condition
</code>
</td>
<td>
<code>
TAG
</code>
</td>
</tr>
<tr>
<td>
<code>
price
</code>
</td>
<td>
<code>
NUMERIC
</code>
</td>
</tr>
</tbody>
</table>
<h2 id="simple-mapping">
Simple mapping
</h2>
<p>
The
<code>
APPLY
</code>
clause allows you to apply a simple mapping function to a result set that is returned based on the query expression.
</p>
<pre tabindex="0"><code>FT.AGGREGATE index "query_expr" LOAD n "field_1" .. "field_n" APPLY "function_expr" AS "result_field"
</code></pre>
<p>
Here is a more detailed explanation of the query syntax:
</p>
<ol>
<li>
<strong>
Query expression
</strong>
: you can use the same query expressions as you would use with the
<a href="/docs/latest/commands/ft.search/">
<code>
FT.SEARCH
</code>
</a>
command. You can substitute
<code>
query_expr
</code>
with any of the expressions explained in the articles of this
<a href="/docs/latest/develop/interact/search-and-query/query/">
query topic
</a>
. Vector search queries are an exception. You can't combine a vector search with an aggregation query.
</li>
<li>
<strong>
Loaded fields
</strong>
: if field values weren't already loaded into the aggregation pipeline, you can force their presence via the
<code>
LOAD
</code>
clause. This clause takes the number of fields (
<code>
n
</code>
), followed by the field names (
<code>
"field_1" .. "field_n"
</code>
).
</li>
<li>
<strong>
Mapping function
</strong>
: this mapping function operates on the field values. A specific field is referenced as
<code>
@field_name
</code>
within the function expression. The result is returned as
<code>
result_field
</code>
.
</li>
</ol>
<p>
The following example shows you how to calculate a discounted price for new bicycles:
</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="query_agg-stepagg1">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_agg-stepagg1" name="query_agg-stepagg1" 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_query_agg-stepagg1" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_agg-stepagg1" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_agg-stepagg1" 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.AGGREGATE idx:bicycle "@condition:{new}" LOAD 2 "__key" "price" APPLY "@price - (@price * 0.1)" AS "discounted"</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_query_agg-stepagg1')" 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_query_agg-stepagg1" name="query_agg-stepagg1" 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_query_agg-stepagg1" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_agg-stepagg1" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_agg-stepagg1" 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="kn">import</span> <span class="nn">json</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.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</span> <span class="kn">import</span> <span class="n">Search</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.aggregation</span> <span class="kn">import</span> <span class="n">AggregateRequest</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></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">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></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">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="c1"># create index</span>
</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">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="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="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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_em.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line hl"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'@condition:</span><span class="si">{new}</span><span class="s1">'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">discounted</span><span class="o">=</span><span class="s1">'@price - (@price * 0.1)'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</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="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 5</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="o">.</span><span class="n">rows</span><span class="p">)</span> <span class="c1"># >>> [['__key', 'bicycle:0', ...</span>
</span></span><span class="line hl"><span class="cl"><span class="c1">#[['__key', 'bicycle:0', 'price', '270', 'discounted', '243'],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['__key', 'bicycle:5', 'price', '810', 'discounted', '729'],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['__key', 'bicycle:6', 'price', '2300', 'discounted', '2070'],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['__key', 'bicycle:7', 'price', '430', 'discounted', '387'],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['__key', 'bicycle:8', 'price', '1200', 'discounted', '1080']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">price_category</span><span class="o">=</span><span class="s1">'@price<1000'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="s1">'@price_category'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'num_affordable'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'num_affordable', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'num_affordable', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'num_affordable', '3']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"'bicycle'"</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@type'</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="s1">'num_total'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 1</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">rows</span><span class="p">)</span> <span class="c1"># >>> [['type', 'bicycle', 'num_total', '10']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">tolist</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'bicycles'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'bicycles', ['bicycle:9']],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'bicycles', ['bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4']],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'bicycles', ['bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8']]]</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_Python_query_agg-stepagg1')" 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_query_agg-stepagg1" 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/query_agg.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_query_agg-stepagg1" name="query_agg-stepagg1" 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_query_agg-stepagg1" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_agg-stepagg1" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_agg-stepagg1" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">AggregateGroupByReducers</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</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">client</span> <span class="o">=</span> <span class="nx">createClient</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 class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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="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="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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_em.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">res1</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">aggregate</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'@condition:{new}'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">],</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">APPLY</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price - (@price * 0.1)'</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">'discounted'</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">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 5
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <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">// [Object: null prototype] { __key: 'bicycle:0', price: '270' },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:5', price: '810' },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:6', price: '2300' },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:7', price: '430' },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:8', price: '1200' }
</span></span></span><span class="line hl"><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="kr">const</span> <span class="nx">res2</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'@price'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price<1000'</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_category'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">SUM</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'@price_category'</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">'num_affordable'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[[Object: null prototype] { condition: 'refurbished', num_affordable: '1' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'used', num_affordable: '1' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'new', num_affordable: '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"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res3</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">aggregate</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">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s2">"'bicycle'"</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">'type'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@type'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">COUNT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="kc">null</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">'num_total'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[ [Object: null prototype] { type: 'bicycle', num_total: '10' } ]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res4</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">TOLIST</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'__key'</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">'bicycles'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[[Object: null prototype] {condition: 'refurbished', bicycles: [ 'bicycle:9' ]},
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'used', bicycles: [ 'bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4' ]},
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'new', bicycles: [ 'bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8' ]}]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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_Nodejs_query_agg-stepagg1')" 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_query_agg-stepagg1" 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/query-agg.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_query_agg-stepagg1" name="query_agg-stepagg1" 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_query_agg-stepagg1" title="Open example">
Java
</label>
<div aria-labelledby="tab-query_agg-stepagg1" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_query_agg-stepagg1" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.List</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.stream.Stream</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.ArrayList</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.UnifiedJedis</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.json.Path2</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.FTCreateParams</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.IndexDataType</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 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.exceptions.JedisDataException</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">QueryAggExample</span> <span class="o">{</span>
</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="n">UnifiedJedis</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">UnifiedJedis</span><span class="o">(</span><span class="s">"redis://localhost:6379"</span><span class="o">);</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">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">String</span><span class="o">[]</span> <span class="n">bicycleJsons</span> <span class="o">=</span> <span class="k">new</span> <span class="n">String</span><span class="o">[]</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-74.0610 40.6678, -74.0610 40.7578))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-74.0060,40.7128\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Velorim\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Jigger\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 270,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"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="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-118.2887 33.9872, -118.2887 34.0972))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-118.2437,34.0522\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Bicyk\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Hillcraft\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Kids want to ride with as little weight as possible. Especially "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on an incline! They may be at the age when a 27.5'' wheel bike is just too clumsy coming "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"off a 24'' bike. The Hillcraft 26 is just the solution they need!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-87.6848 41.8231, -87.6848 41.9331))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-87.6298,41.8781\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Nord\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Chook air 5\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The Chook Air 5 gives kids aged six years and older a durable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and uberlight mountain bike for their first experience on tracks and easy cruising through "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"forests and fields. The lower top tube makes it easy to mount and dismount in any "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"situation, giving your kids greater safety on the trails.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-80.2433 25.6967, -80.2433 25.8067))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-80.1918,25.7617\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Eva\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Eva 291\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3400,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The sister company to Nord, Eva launched in 2005 as the first "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and only women-dedicated bicycle brand. Designed by women for women, allEva bikes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"are optimized for the feminine physique using analytics from a body metrics database. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"If you like 29ers, try the Eva 291. It’s a brand new bike for 2022.. This "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"full-suspension, cross-country ride has been designed for velocity. The 291 has "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"100mm of front and rear travel, a superlight aluminum frame and fast-rolling "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"29-inch wheels. Yippee!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-122.4644 37.7099, -122.4644 37.8199))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-122.4194,37.7749\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Noka Bikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Kahuna\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Whether you want to try your hand at XC racing or are looking "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"for a lively trail bike that's just as inspiring on the climbs as it is over rougher "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ground, the Wilder is one heck of a bike built specifically for short women. Both the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"frames and components have been tweaked to include a women’s saddle, different bars "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and unique colourway.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-0.1778 51.4024, -0.1778 51.5524))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-0.1278,51.5074\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Breakout\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"XBN 2.1 Alloy\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 810,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"not to say that it’s a basic machine. With an internal weld aluminium frame, a full "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"doesn’t break the bank and delivers craved performance.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"2.1767 48.5516, 2.1767 48.9016))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.3522,48.8566\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"ScramBikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"WattBike\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 2300,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The WattBike is the best e-bike for people who still "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"charge. It’s great for tackling hilly terrain or if you just fancy a more "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"leisurely ride. With three working modes, you can choose between E-bike, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"assisted bicycle, and normal bike modes.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"13.3260 52.2700, 13.3260 52.5700))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"13.4050,52.5200\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Peaknetic\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Secto\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 430,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"If you struggle with stiff fingers or a kinked neck or "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"back after a few minutes on the road, this lightweight, aluminum bike alleviates "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"those issues and allows you to enjoy the ride. From the ergonomic grips to the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The rear-inclined seat tube facilitates stability by allowing you to put a foot "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on the 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="o">+</span> <span class="s">"accessible for all ability and mobility levels. The saddle is very soft, with "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"a wide back to support your hip joints and a cutout in the center to redistribute "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"that pressure. Rim brakes deliver satisfactory braking control, and the wide tires "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"facilitate setting up the Roll Low-Entry as your preferred commuter, and the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"1.9450 41.1987, 1.9450 41.4301))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.1734, 41.3851\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"nHill\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Summit\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"This budget mountain bike from nHill performs well both "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on bike paths and on the trail. The fork with 100mm of travel absorbs rough "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The Shimano Tourney drivetrain offered enough gears for finding a comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Whether you want an affordable bike that you can take to work, but also take "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"trail in mountains on the weekends or you’re just after a stable, comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ride for the bike path, the Summit gives a good value for money.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((12.4464 42.1028, 12.5464 42.1028, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"12.4964,41.9028\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"ThrillCycle\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"BikeShind\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"An artsy, retro-inspired bicycle that’s as "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"suggest taking it to the mountains. Fenders protect you from mud, and a rear "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"basket lets you transport groceries, flowers and books. The ThrillCycle comes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"with a limited lifetime warranty, so this little guy will last you long "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"past graduation.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"refurbished\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</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">bicycleJsons</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">jsonSet</span><span class="o">(</span><span class="s">"bicycle:"</span> <span class="o">+</span> <span class="n">i</span><span class="o">,</span> <span class="k">new</span> <span class="n">Path2</span><span class="o">(</span><span class="s">"$"</span><span class="o">),</span> <span class="n">bicycleJsons</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">AggregationResult</span> <span class="n">res1</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></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"@condition:{new}"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</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="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="o">,</span> <span class="s">"discounted"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows1</span> <span class="o">=</span> <span class="n">res1</span><span class="o">.</span><span class="na">getRows</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">rows1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 5
</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="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">rows1</span><span class="o">.</span><span class="na">size</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">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">rows1</span><span class="o">.</span><span class="na">get</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 hl"><span class="cl"> <span class="c1">// >>> {__key=bicycle:0, discounted=243, price=270}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:5, discounted=729, price=810}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:6, discounted=2070, price=2300}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:7, discounted=387, price=430}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:8, discounted=1080, 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">// Tests for 'agg1' step.
</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">AggregationResult</span> <span class="n">res2</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"price"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price<1000"</span><span class="o">,</span> <span class="s">"price_category"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <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">sum</span><span class="o">(</span><span class="s">"@price_category"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"num_affordable"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows2</span> <span class="o">=</span> <span class="n">res2</span><span class="o">.</span><span class="na">getRows</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">rows2</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 3
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows2</span><span class="o">.</span><span class="na">size</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">rows2</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {condition=refurbished, num_affordable=1}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, num_affordable=1}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, num_affordable=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">// Tests for 'agg2' step.
</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">AggregationResult</span> <span class="n">res3</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"'bicycle'"</span><span class="o">,</span> <span class="s">"type"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@type"</span><span class="o">,</span> <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">"num_total"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows3</span> <span class="o">=</span> <span class="n">res3</span><span class="o">.</span><span class="na">getRows</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">rows3</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows3</span><span class="o">.</span><span class="na">size</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">rows3</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {type=bicycle, num_total=10}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.
</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">AggregationResult</span> <span class="n">res4</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <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">to_list</span><span class="o">(</span><span class="s">"__key"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"bicycles"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows4</span> <span class="o">=</span> <span class="n">res4</span><span class="o">.</span><span class="na">getRows</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">rows4</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 3
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows4</span><span class="o">.</span><span class="na">size</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">rows4</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {condition=refurbished, bicycles=[bicycle:9]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, bicycles=[bicycle:3, bicycle:4, bicycle:1, bicycle:2]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, bicycles=[bicycle:7, bicycle:0, bicycle:5, bicycle:6, bicycle:8]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg4' step.
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</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><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_Java_query_agg-stepagg1')" 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_query_agg-stepagg1" 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/QueryAggExample.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_query_agg-stepagg1" name="query_agg-stepagg1" 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_query_agg-stepagg1" title="Open example">
C#
</label>
<div aria-labelledby="tab-query_agg-stepagg1" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_query_agg-stepagg1" 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></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">QueryAggExample</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">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">muxer</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">muxer</span><span class="p">.</span><span class="n">GetDatabase</span><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="n">bikeSchema</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">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 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></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span> <span class="n">bikeParams</span> <span class="p">=</span> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddPrefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Create</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">bikeParams</span><span class="p">,</span> <span class="n">bikeSchema</span><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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-74.0060,40.7128"</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">"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="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 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 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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-118.2437,34.0522"</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">"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="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. 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-87.6298,41.8781"</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">"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="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 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, -80.2433 25.6967, -80.2433 25.8067))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-80.1918,25.7617"</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">"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="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 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’s 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, -122.4644 37.7099, -122.4644 37.8199))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-122.4194,37.7749"</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">"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="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 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 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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, -0.1778 51.4024, -0.1778 51.5524))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-0.1278,51.5074"</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">"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="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 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."</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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, 2.1767 48.5516, 2.1767 48.9016))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.3522,48.8566"</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">"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="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 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’s 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, 13.3260 52.2700, 13.3260 52.5700))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"13.4050,52.5200"</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">"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="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 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, 1.9450 41.1987, 1.9450 41.4301))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.1734, 41.3851"</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">"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="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 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’re 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((12.4464 42.1028, 12.5464 42.1028, 12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"12.4964,41.9028"</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">"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="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 pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t 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="n">condition</span> <span class="p">=</span> <span class="s">"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></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">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">db</span><span class="p">.</span><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></span><span class="line hl"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"@condition:{new}"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">Load</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"__key"</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></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="p">,</span> <span class="s">"discounted"</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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res1</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 5</span>
</span></span><span class="line hl"><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">res1</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 hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Row</span> <span class="n">res1Row</span> <span class="p">=</span> <span class="n">res1</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 hl"><span class="cl">
</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></span><span class="line hl"><span class="cl"> <span class="s">$"Key: {res1Row["</span><span class="n">__key</span><span class="s">"]}, Price: {res1Row["</span><span class="n">price</span><span class="s">"]}, Discounted: {res1Row["</span><span class="n">discounted</span><span class="s">"]}"</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="c1">// >>> Key: bicycle:0, Price: 270, Discounted: 243</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Key: bicycle:5, Price: 810, Discounted: 729</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Key: bicycle:6, Price: 2300, Discounted: 2070</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Key: bicycle:7, Price: 430, Discounted: 387</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Key: bicycle:8, Price: 1200, Discounted: 1080</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg1' step.</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">AggregationResult</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Load</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></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price<1000"</span><span class="p">,</span> <span class="s">"price_category"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="p">.</span><span class="n">Sum</span><span class="p">(</span><span class="s">"@price_category"</span><span class="p">).</span><span class="n">As</span><span class="p">(</span><span class="s">"num_affordable"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res2</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 3</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">res2</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="n">Row</span> <span class="n">res2Row</span> <span class="p">=</span> <span class="n">res2</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></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></span><span class="line"><span class="cl"> <span class="s">$"Condition: {res2Row["</span><span class="n">condition</span><span class="s">"]}, Num affordable: {res2Row["</span><span class="n">num_affordable</span><span class="s">"]}"</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="c1">// >>> Condition: refurbished, Num affordable: 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Condition: used, Num affordable: 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Condition: new, Num affordable: 3</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg2' step.</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">AggregationResult</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"'bicycle'"</span><span class="p">,</span> <span class="s">"type"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">GroupBy</span><span class="p">(</span><span class="s">"@type"</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">"num_total"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res3</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Row</span> <span class="n">res3Row</span> <span class="p">=</span> <span class="n">res3</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="m">0</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">$"Type: {res3Row["</span><span class="n">type</span><span class="s">"]}, Num total: {res3Row["</span><span class="n">num_total</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Type: bicycle, Num total: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.</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="c1">// Not supported in NRedisStack.</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="c1">// Tests for 'agg4' step.</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="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</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_Csharp_query_agg-stepagg1')" 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_query_agg-stepagg1" 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/QueryAggExample.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>
The field
<code>
__key
</code>
is a built-in field.
</p>
<p>
The output of this query is:
</p>
<pre tabindex="0"><code>1) "1"
2) 1) "__key"
1) "bicycle:0"
2) "price"
3) "270"
4) "discounted"
5) "243"
3) 1) "__key"
1) "bicycle:5"
2) "price"
3) "810"
4) "discounted"
5) "729"
4) 1) "__key"
1) "bicycle:6"
2) "price"
3) "2300"
4) "discounted"
5) "2070"
...
</code></pre>
<h2 id="grouping-with-aggregation">
Grouping with aggregation
</h2>
<p>
The previous example did not group the data. You can group and aggregate data based on one or many criteria in the following way:
</p>
<pre tabindex="0"><code>FT.AGGREGATE index "query_expr" ... GROUPBY n "field_1" .. "field_n" REDUCE AGG_FUNC m "@field_param_1" .. "@field_param_m" AS "aggregated_result_field"
</code></pre>
<p>
Here is an explanation of the additional constructs:
</p>
<ol>
<li>
<strong>
Grouping
</strong>
: you can group by one or many fields. Each ordered sequence of field values then defines one group. It's also possible to group by values that resulted from a previous
<code>
APPLY ... AS
</code>
.
</li>
<li>
<strong>
Aggregation
</strong>
: you must replace
<code>
AGG_FUNC
</code>
with one of the supported aggregation functions (e.g.,
<code>
SUM
</code>
or
<code>
COUNT
</code>
). A complete list of functions is available in the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/aggregations/">
aggregations reference documentation
</a>
. Replace
<code>
aggregated_result_field
</code>
with a value of your choice.
</li>
</ol>
<p>
The following query shows you how to group by the field
<code>
condition
</code>
and apply a reduction based on the previously derived
<code>
price_category
</code>
. The expression
<code>
@price<1000
</code>
causes a bicycle to have the price category
<code>
1
</code>
if its price is lower than 1000 USD. Otherwise, it has the price category
<code>
0
</code>
. The output is the number of affordable bicycles grouped by price category.
</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="query_agg-stepagg2">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_agg-stepagg2" name="query_agg-stepagg2" 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_query_agg-stepagg2" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_agg-stepagg2" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_agg-stepagg2" 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.AGGREGATE idx:bicycle "*" LOAD 1 price APPLY "@price<1000" AS price_category GROUPBY 1 @condition REDUCE SUM 1 "@price_category" AS "num_affordable"</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_query_agg-stepagg2')" 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_query_agg-stepagg2" name="query_agg-stepagg2" 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_query_agg-stepagg2" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_agg-stepagg2" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_agg-stepagg2" 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="kn">import</span> <span class="nn">json</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.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</span> <span class="kn">import</span> <span class="n">Search</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.aggregation</span> <span class="kn">import</span> <span class="n">AggregateRequest</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></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">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></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">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="c1"># create index</span>
</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">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="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="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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_em.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'@condition:</span><span class="si">{new}</span><span class="s1">'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">discounted</span><span class="o">=</span><span class="s1">'@price - (@price * 0.1)'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 5</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">rows</span><span class="p">)</span> <span class="c1"># >>> [['__key', 'bicycle:0', ...</span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['__key', 'bicycle:0', 'price', '270', 'discounted', '243'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:5', 'price', '810', 'discounted', '729'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:6', 'price', '2300', 'discounted', '2070'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:7', 'price', '430', 'discounted', '387'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:8', 'price', '1200', 'discounted', '1080']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">price_category</span><span class="o">=</span><span class="s1">'@price<1000'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="s1">'@price_category'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'num_affordable'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</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="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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="o">.</span><span class="n">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line hl"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'num_affordable', '1'],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['condition', 'used', 'num_affordable', '1'],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['condition', 'new', 'num_affordable', '3']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"'bicycle'"</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@type'</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="s1">'num_total'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 1</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">rows</span><span class="p">)</span> <span class="c1"># >>> [['type', 'bicycle', 'num_total', '10']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">tolist</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'bicycles'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'bicycles', ['bicycle:9']],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'bicycles', ['bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4']],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'bicycles', ['bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8']]]</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_Python_query_agg-stepagg2')" 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_query_agg-stepagg2" 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/query_agg.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_query_agg-stepagg2" name="query_agg-stepagg2" 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_query_agg-stepagg2" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_agg-stepagg2" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_agg-stepagg2" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">AggregateGroupByReducers</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</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">client</span> <span class="o">=</span> <span class="nx">createClient</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 class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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="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="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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_em.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">aggregate</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'@condition:{new}'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">APPLY</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price - (@price * 0.1)'</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">'discounted'</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">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 5
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <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">// [Object: null prototype] { __key: 'bicycle:0', price: '270' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:5', price: '810' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:6', price: '2300' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:7', price: '430' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:8', 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"></span>
</span></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">res2</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'@price'</span><span class="p">],</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price<1000'</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_category'</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">type</span><span class="o">:</span> <span class="nx">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">SUM</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'@price_category'</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">'num_affordable'</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 class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line hl"><span class="cl"><span class="c1">//[[Object: null prototype] { condition: 'refurbished', num_affordable: '1' },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'used', num_affordable: '1' },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'new', num_affordable: '3' }
</span></span></span><span class="line hl"><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="kr">const</span> <span class="nx">res3</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">aggregate</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">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s2">"'bicycle'"</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">'type'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@type'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">COUNT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="kc">null</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">'num_total'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[ [Object: null prototype] { type: 'bicycle', num_total: '10' } ]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res4</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">TOLIST</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'__key'</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">'bicycles'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[[Object: null prototype] {condition: 'refurbished', bicycles: [ 'bicycle:9' ]},
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'used', bicycles: [ 'bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4' ]},
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'new', bicycles: [ 'bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8' ]}]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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_Nodejs_query_agg-stepagg2')" 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_query_agg-stepagg2" 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/query-agg.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_query_agg-stepagg2" name="query_agg-stepagg2" 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_query_agg-stepagg2" title="Open example">
Java
</label>
<div aria-labelledby="tab-query_agg-stepagg2" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_query_agg-stepagg2" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.List</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.stream.Stream</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.ArrayList</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.UnifiedJedis</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.json.Path2</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.FTCreateParams</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.IndexDataType</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 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.exceptions.JedisDataException</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">QueryAggExample</span> <span class="o">{</span>
</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="n">UnifiedJedis</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">UnifiedJedis</span><span class="o">(</span><span class="s">"redis://localhost:6379"</span><span class="o">);</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">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">String</span><span class="o">[]</span> <span class="n">bicycleJsons</span> <span class="o">=</span> <span class="k">new</span> <span class="n">String</span><span class="o">[]</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-74.0610 40.6678, -74.0610 40.7578))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-74.0060,40.7128\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Velorim\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Jigger\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 270,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"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="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-118.2887 33.9872, -118.2887 34.0972))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-118.2437,34.0522\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Bicyk\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Hillcraft\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Kids want to ride with as little weight as possible. Especially "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on an incline! They may be at the age when a 27.5'' wheel bike is just too clumsy coming "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"off a 24'' bike. The Hillcraft 26 is just the solution they need!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-87.6848 41.8231, -87.6848 41.9331))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-87.6298,41.8781\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Nord\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Chook air 5\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The Chook Air 5 gives kids aged six years and older a durable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and uberlight mountain bike for their first experience on tracks and easy cruising through "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"forests and fields. The lower top tube makes it easy to mount and dismount in any "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"situation, giving your kids greater safety on the trails.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-80.2433 25.6967, -80.2433 25.8067))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-80.1918,25.7617\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Eva\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Eva 291\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3400,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The sister company to Nord, Eva launched in 2005 as the first "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and only women-dedicated bicycle brand. Designed by women for women, allEva bikes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"are optimized for the feminine physique using analytics from a body metrics database. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"If you like 29ers, try the Eva 291. It’s a brand new bike for 2022.. This "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"full-suspension, cross-country ride has been designed for velocity. The 291 has "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"100mm of front and rear travel, a superlight aluminum frame and fast-rolling "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"29-inch wheels. Yippee!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-122.4644 37.7099, -122.4644 37.8199))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-122.4194,37.7749\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Noka Bikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Kahuna\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Whether you want to try your hand at XC racing or are looking "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"for a lively trail bike that's just as inspiring on the climbs as it is over rougher "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ground, the Wilder is one heck of a bike built specifically for short women. Both the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"frames and components have been tweaked to include a women’s saddle, different bars "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and unique colourway.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-0.1778 51.4024, -0.1778 51.5524))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-0.1278,51.5074\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Breakout\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"XBN 2.1 Alloy\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 810,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"not to say that it’s a basic machine. With an internal weld aluminium frame, a full "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"doesn’t break the bank and delivers craved performance.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"2.1767 48.5516, 2.1767 48.9016))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.3522,48.8566\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"ScramBikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"WattBike\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 2300,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The WattBike is the best e-bike for people who still "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"charge. It’s great for tackling hilly terrain or if you just fancy a more "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"leisurely ride. With three working modes, you can choose between E-bike, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"assisted bicycle, and normal bike modes.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"13.3260 52.2700, 13.3260 52.5700))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"13.4050,52.5200\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Peaknetic\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Secto\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 430,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"If you struggle with stiff fingers or a kinked neck or "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"back after a few minutes on the road, this lightweight, aluminum bike alleviates "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"those issues and allows you to enjoy the ride. From the ergonomic grips to the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The rear-inclined seat tube facilitates stability by allowing you to put a foot "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on the 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="o">+</span> <span class="s">"accessible for all ability and mobility levels. The saddle is very soft, with "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"a wide back to support your hip joints and a cutout in the center to redistribute "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"that pressure. Rim brakes deliver satisfactory braking control, and the wide tires "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"facilitate setting up the Roll Low-Entry as your preferred commuter, and the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"1.9450 41.1987, 1.9450 41.4301))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.1734, 41.3851\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"nHill\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Summit\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"This budget mountain bike from nHill performs well both "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on bike paths and on the trail. The fork with 100mm of travel absorbs rough "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The Shimano Tourney drivetrain offered enough gears for finding a comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Whether you want an affordable bike that you can take to work, but also take "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"trail in mountains on the weekends or you’re just after a stable, comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ride for the bike path, the Summit gives a good value for money.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((12.4464 42.1028, 12.5464 42.1028, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"12.4964,41.9028\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"ThrillCycle\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"BikeShind\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"An artsy, retro-inspired bicycle that’s as "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"suggest taking it to the mountains. Fenders protect you from mud, and a rear "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"basket lets you transport groceries, flowers and books. The ThrillCycle comes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"with a limited lifetime warranty, so this little guy will last you long "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"past graduation.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"refurbished\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</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">bicycleJsons</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">jsonSet</span><span class="o">(</span><span class="s">"bicycle:"</span> <span class="o">+</span> <span class="n">i</span><span class="o">,</span> <span class="k">new</span> <span class="n">Path2</span><span class="o">(</span><span class="s">"$"</span><span class="o">),</span> <span class="n">bicycleJsons</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">AggregationResult</span> <span class="n">res1</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"@condition:{new}"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">,</span> <span class="s">"price"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="o">,</span> <span class="s">"discounted"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows1</span> <span class="o">=</span> <span class="n">res1</span><span class="o">.</span><span class="na">getRows</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">rows1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows1</span><span class="o">.</span><span class="na">size</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">rows1</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {__key=bicycle:0, discounted=243, price=270}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:5, discounted=729, price=810}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:6, discounted=2070, price=2300}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:7, discounted=387, price=430}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:8, discounted=1080, 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">// Tests for 'agg1' step.
</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">AggregationResult</span> <span class="n">res2</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></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">load</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="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price<1000"</span><span class="o">,</span> <span class="s">"price_category"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <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 hl"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">sum</span><span class="o">(</span><span class="s">"@price_category"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"num_affordable"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows2</span> <span class="o">=</span> <span class="n">res2</span><span class="o">.</span><span class="na">getRows</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">rows2</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 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="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">rows2</span><span class="o">.</span><span class="na">size</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">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">rows2</span><span class="o">.</span><span class="na">get</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 hl"><span class="cl"> <span class="c1">// >>> {condition=refurbished, num_affordable=1}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, num_affordable=1}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, num_affordable=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">// Tests for 'agg2' step.
</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">AggregationResult</span> <span class="n">res3</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"'bicycle'"</span><span class="o">,</span> <span class="s">"type"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@type"</span><span class="o">,</span> <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">"num_total"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows3</span> <span class="o">=</span> <span class="n">res3</span><span class="o">.</span><span class="na">getRows</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">rows3</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows3</span><span class="o">.</span><span class="na">size</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">rows3</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {type=bicycle, num_total=10}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.
</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">AggregationResult</span> <span class="n">res4</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <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">to_list</span><span class="o">(</span><span class="s">"__key"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"bicycles"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows4</span> <span class="o">=</span> <span class="n">res4</span><span class="o">.</span><span class="na">getRows</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">rows4</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 3
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows4</span><span class="o">.</span><span class="na">size</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">rows4</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {condition=refurbished, bicycles=[bicycle:9]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, bicycles=[bicycle:3, bicycle:4, bicycle:1, bicycle:2]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, bicycles=[bicycle:7, bicycle:0, bicycle:5, bicycle:6, bicycle:8]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg4' step.
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</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><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_Java_query_agg-stepagg2')" 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_query_agg-stepagg2" 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/QueryAggExample.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_query_agg-stepagg2" name="query_agg-stepagg2" 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_query_agg-stepagg2" title="Open example">
C#
</label>
<div aria-labelledby="tab-query_agg-stepagg2" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_query_agg-stepagg2" 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></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">QueryAggExample</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">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">muxer</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">muxer</span><span class="p">.</span><span class="n">GetDatabase</span><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="n">bikeSchema</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">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 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></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span> <span class="n">bikeParams</span> <span class="p">=</span> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddPrefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Create</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">bikeParams</span><span class="p">,</span> <span class="n">bikeSchema</span><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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-74.0060,40.7128"</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">"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="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 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 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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-118.2437,34.0522"</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">"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="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. 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-87.6298,41.8781"</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">"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="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 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, -80.2433 25.6967, -80.2433 25.8067))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-80.1918,25.7617"</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">"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="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 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’s 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, -122.4644 37.7099, -122.4644 37.8199))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-122.4194,37.7749"</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">"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="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 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 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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, -0.1778 51.4024, -0.1778 51.5524))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-0.1278,51.5074"</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">"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="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 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."</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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, 2.1767 48.5516, 2.1767 48.9016))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.3522,48.8566"</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">"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="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 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’s 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, 13.3260 52.2700, 13.3260 52.5700))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"13.4050,52.5200"</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">"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="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 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, 1.9450 41.1987, 1.9450 41.4301))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.1734, 41.3851"</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">"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="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 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’re 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((12.4464 42.1028, 12.5464 42.1028, 12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"12.4964,41.9028"</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">"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="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 pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t 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="n">condition</span> <span class="p">=</span> <span class="s">"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></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">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">db</span><span class="p">.</span><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></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"@condition:{new}"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Load</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"__key"</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></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="p">,</span> <span class="s">"discounted"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res1</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 5</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">res1</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="n">Row</span> <span class="n">res1Row</span> <span class="p">=</span> <span class="n">res1</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></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></span><span class="line"><span class="cl"> <span class="s">$"Key: {res1Row["</span><span class="n">__key</span><span class="s">"]}, Price: {res1Row["</span><span class="n">price</span><span class="s">"]}, Discounted: {res1Row["</span><span class="n">discounted</span><span class="s">"]}"</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="c1">// >>> Key: bicycle:0, Price: 270, Discounted: 243</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:5, Price: 810, Discounted: 729</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:6, Price: 2300, Discounted: 2070</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:7, Price: 430, Discounted: 387</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:8, Price: 1200, Discounted: 1080</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg1' step.</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">AggregationResult</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">Load</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></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price<1000"</span><span class="p">,</span> <span class="s">"price_category"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">GroupBy</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s">"@condition"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Reducers</span><span class="p">.</span><span class="n">Sum</span><span class="p">(</span><span class="s">"@price_category"</span><span class="p">).</span><span class="n">As</span><span class="p">(</span><span class="s">"num_affordable"</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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res2</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 3</span>
</span></span><span class="line hl"><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">res2</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 hl"><span class="cl"> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">Row</span> <span class="n">res2Row</span> <span class="p">=</span> <span class="n">res2</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 hl"><span class="cl">
</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></span><span class="line hl"><span class="cl"> <span class="s">$"Condition: {res2Row["</span><span class="n">condition</span><span class="s">"]}, Num affordable: {res2Row["</span><span class="n">num_affordable</span><span class="s">"]}"</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="c1">// >>> Condition: refurbished, Num affordable: 1</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Condition: used, Num affordable: 1</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Condition: new, Num affordable: 3</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg2' step.</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">AggregationResult</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"'bicycle'"</span><span class="p">,</span> <span class="s">"type"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">GroupBy</span><span class="p">(</span><span class="s">"@type"</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">"num_total"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res3</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Row</span> <span class="n">res3Row</span> <span class="p">=</span> <span class="n">res3</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="m">0</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">$"Type: {res3Row["</span><span class="n">type</span><span class="s">"]}, Num total: {res3Row["</span><span class="n">num_total</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Type: bicycle, Num total: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.</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="c1">// Not supported in NRedisStack.</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="c1">// Tests for 'agg4' step.</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="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</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_Csharp_query_agg-stepagg2')" 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_query_agg-stepagg2" 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/QueryAggExample.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>
<pre tabindex="0"><code>1) "3"
2) 1) "condition"
1) "refurbished"
2) "num_affordable"
3) "1"
3) 1) "condition"
1) "used"
2) "num_affordable"
3) "1"
4) 1) "condition"
1) "new"
2) "num_affordable"
3) "3"
</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">
Note:
</div>
You can also create more complex aggregation pipelines with
<a href="/docs/latest/commands/ft.aggregate">
FT.AGGREGATE
</a>
. Applying multiple reduction functions under one
<code>
GROUPBY
</code>
clause is possible. In addition, you can also chain groupings and mix in additional mapping steps (e.g.,
<code>
GROUPBY ... REDUCE ... APPLY ... GROUPBY ... REDUCE
</code>
)
</div>
</div>
<h2 id="aggregating-without-grouping">
Aggregating without grouping
</h2>
<p>
You can't use an aggregation function outside of a
<code>
GROUPBY
</code>
clause, but you can construct your pipeline in a way that the aggregation happens on a single group that spans all documents. If your documents don't share a common attribute, you can add it via an extra
<code>
APPLY
</code>
step.
</p>
<p>
Here is an example that adds a type attribute
<code>
bicycle
</code>
to each document before counting all documents with that type:
</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="query_agg-stepagg3">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_agg-stepagg3" name="query_agg-stepagg3" 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_query_agg-stepagg3" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_agg-stepagg3" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_agg-stepagg3" 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.AGGREGATE idx:bicycle "*" APPLY "'bicycle'" AS type GROUPBY 1 @type REDUCE COUNT 0 AS num_total</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_query_agg-stepagg3')" 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_query_agg-stepagg3" name="query_agg-stepagg3" 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_query_agg-stepagg3" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_agg-stepagg3" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_agg-stepagg3" 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="kn">import</span> <span class="nn">json</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.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</span> <span class="kn">import</span> <span class="n">Search</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.aggregation</span> <span class="kn">import</span> <span class="n">AggregateRequest</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></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">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></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">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="c1"># create index</span>
</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">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="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="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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_em.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'@condition:</span><span class="si">{new}</span><span class="s1">'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">discounted</span><span class="o">=</span><span class="s1">'@price - (@price * 0.1)'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 5</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">rows</span><span class="p">)</span> <span class="c1"># >>> [['__key', 'bicycle:0', ...</span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['__key', 'bicycle:0', 'price', '270', 'discounted', '243'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:5', 'price', '810', 'discounted', '729'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:6', 'price', '2300', 'discounted', '2070'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:7', 'price', '430', 'discounted', '387'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:8', 'price', '1200', 'discounted', '1080']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">price_category</span><span class="o">=</span><span class="s1">'@price<1000'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="s1">'@price_category'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'num_affordable'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'num_affordable', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'num_affordable', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'num_affordable', '3']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"'bicycle'"</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@type'</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="s1">'num_total'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</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="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 1</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="o">.</span><span class="n">rows</span><span class="p">)</span> <span class="c1"># >>> [['type', 'bicycle', 'num_total', '10']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">tolist</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'bicycles'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'bicycles', ['bicycle:9']],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'bicycles', ['bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4']],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'bicycles', ['bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8']]]</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_Python_query_agg-stepagg3')" 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_query_agg-stepagg3" 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/query_agg.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_query_agg-stepagg3" name="query_agg-stepagg3" 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_query_agg-stepagg3" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_agg-stepagg3" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_agg-stepagg3" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">AggregateGroupByReducers</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</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">client</span> <span class="o">=</span> <span class="nx">createClient</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 class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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="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="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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_em.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">aggregate</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'@condition:{new}'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">APPLY</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price - (@price * 0.1)'</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">'discounted'</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">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 5
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <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">// [Object: null prototype] { __key: 'bicycle:0', price: '270' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:5', price: '810' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:6', price: '2300' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:7', price: '430' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:8', 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"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res2</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'@price'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price<1000'</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_category'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">SUM</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'@price_category'</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">'num_affordable'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[[Object: null prototype] { condition: 'refurbished', num_affordable: '1' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'used', num_affordable: '1' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'new', num_affordable: '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"></span>
</span></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">res3</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">aggregate</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">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s2">"'bicycle'"</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">'type'</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">},</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@type'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">COUNT</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="kc">null</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">'num_total'</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 class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line hl"><span class="cl"><span class="c1">//[ [Object: null prototype] { type: 'bicycle', num_total: '10' } ]
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res4</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">TOLIST</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'__key'</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">'bicycles'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[[Object: null prototype] {condition: 'refurbished', bicycles: [ 'bicycle:9' ]},
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'used', bicycles: [ 'bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4' ]},
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'new', bicycles: [ 'bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8' ]}]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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_Nodejs_query_agg-stepagg3')" 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_query_agg-stepagg3" 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/query-agg.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_query_agg-stepagg3" name="query_agg-stepagg3" 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_query_agg-stepagg3" title="Open example">
Java
</label>
<div aria-labelledby="tab-query_agg-stepagg3" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_query_agg-stepagg3" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.List</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.stream.Stream</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.ArrayList</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.UnifiedJedis</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.json.Path2</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.FTCreateParams</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.IndexDataType</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 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.exceptions.JedisDataException</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">QueryAggExample</span> <span class="o">{</span>
</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="n">UnifiedJedis</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">UnifiedJedis</span><span class="o">(</span><span class="s">"redis://localhost:6379"</span><span class="o">);</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">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">String</span><span class="o">[]</span> <span class="n">bicycleJsons</span> <span class="o">=</span> <span class="k">new</span> <span class="n">String</span><span class="o">[]</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-74.0610 40.6678, -74.0610 40.7578))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-74.0060,40.7128\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Velorim\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Jigger\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 270,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"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="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-118.2887 33.9872, -118.2887 34.0972))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-118.2437,34.0522\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Bicyk\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Hillcraft\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Kids want to ride with as little weight as possible. Especially "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on an incline! They may be at the age when a 27.5'' wheel bike is just too clumsy coming "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"off a 24'' bike. The Hillcraft 26 is just the solution they need!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-87.6848 41.8231, -87.6848 41.9331))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-87.6298,41.8781\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Nord\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Chook air 5\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The Chook Air 5 gives kids aged six years and older a durable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and uberlight mountain bike for their first experience on tracks and easy cruising through "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"forests and fields. The lower top tube makes it easy to mount and dismount in any "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"situation, giving your kids greater safety on the trails.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-80.2433 25.6967, -80.2433 25.8067))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-80.1918,25.7617\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Eva\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Eva 291\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3400,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The sister company to Nord, Eva launched in 2005 as the first "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and only women-dedicated bicycle brand. Designed by women for women, allEva bikes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"are optimized for the feminine physique using analytics from a body metrics database. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"If you like 29ers, try the Eva 291. It’s a brand new bike for 2022.. This "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"full-suspension, cross-country ride has been designed for velocity. The 291 has "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"100mm of front and rear travel, a superlight aluminum frame and fast-rolling "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"29-inch wheels. Yippee!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-122.4644 37.7099, -122.4644 37.8199))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-122.4194,37.7749\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Noka Bikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Kahuna\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Whether you want to try your hand at XC racing or are looking "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"for a lively trail bike that's just as inspiring on the climbs as it is over rougher "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ground, the Wilder is one heck of a bike built specifically for short women. Both the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"frames and components have been tweaked to include a women’s saddle, different bars "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and unique colourway.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-0.1778 51.4024, -0.1778 51.5524))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-0.1278,51.5074\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Breakout\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"XBN 2.1 Alloy\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 810,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"not to say that it’s a basic machine. With an internal weld aluminium frame, a full "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"doesn’t break the bank and delivers craved performance.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"2.1767 48.5516, 2.1767 48.9016))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.3522,48.8566\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"ScramBikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"WattBike\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 2300,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The WattBike is the best e-bike for people who still "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"charge. It’s great for tackling hilly terrain or if you just fancy a more "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"leisurely ride. With three working modes, you can choose between E-bike, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"assisted bicycle, and normal bike modes.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"13.3260 52.2700, 13.3260 52.5700))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"13.4050,52.5200\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Peaknetic\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Secto\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 430,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"If you struggle with stiff fingers or a kinked neck or "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"back after a few minutes on the road, this lightweight, aluminum bike alleviates "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"those issues and allows you to enjoy the ride. From the ergonomic grips to the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The rear-inclined seat tube facilitates stability by allowing you to put a foot "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on the 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="o">+</span> <span class="s">"accessible for all ability and mobility levels. The saddle is very soft, with "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"a wide back to support your hip joints and a cutout in the center to redistribute "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"that pressure. Rim brakes deliver satisfactory braking control, and the wide tires "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"facilitate setting up the Roll Low-Entry as your preferred commuter, and the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"1.9450 41.1987, 1.9450 41.4301))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.1734, 41.3851\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"nHill\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Summit\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"This budget mountain bike from nHill performs well both "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on bike paths and on the trail. The fork with 100mm of travel absorbs rough "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The Shimano Tourney drivetrain offered enough gears for finding a comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Whether you want an affordable bike that you can take to work, but also take "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"trail in mountains on the weekends or you’re just after a stable, comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ride for the bike path, the Summit gives a good value for money.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((12.4464 42.1028, 12.5464 42.1028, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"12.4964,41.9028\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"ThrillCycle\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"BikeShind\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"An artsy, retro-inspired bicycle that’s as "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"suggest taking it to the mountains. Fenders protect you from mud, and a rear "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"basket lets you transport groceries, flowers and books. The ThrillCycle comes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"with a limited lifetime warranty, so this little guy will last you long "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"past graduation.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"refurbished\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</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">bicycleJsons</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">jsonSet</span><span class="o">(</span><span class="s">"bicycle:"</span> <span class="o">+</span> <span class="n">i</span><span class="o">,</span> <span class="k">new</span> <span class="n">Path2</span><span class="o">(</span><span class="s">"$"</span><span class="o">),</span> <span class="n">bicycleJsons</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">AggregationResult</span> <span class="n">res1</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"@condition:{new}"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">,</span> <span class="s">"price"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="o">,</span> <span class="s">"discounted"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows1</span> <span class="o">=</span> <span class="n">res1</span><span class="o">.</span><span class="na">getRows</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">rows1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows1</span><span class="o">.</span><span class="na">size</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">rows1</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {__key=bicycle:0, discounted=243, price=270}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:5, discounted=729, price=810}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:6, discounted=2070, price=2300}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:7, discounted=387, price=430}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:8, discounted=1080, 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">// Tests for 'agg1' step.
</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">AggregationResult</span> <span class="n">res2</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"price"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price<1000"</span><span class="o">,</span> <span class="s">"price_category"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <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">sum</span><span class="o">(</span><span class="s">"@price_category"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"num_affordable"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows2</span> <span class="o">=</span> <span class="n">res2</span><span class="o">.</span><span class="na">getRows</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">rows2</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 3
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows2</span><span class="o">.</span><span class="na">size</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">rows2</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {condition=refurbished, num_affordable=1}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, num_affordable=1}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, num_affordable=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">// Tests for 'agg2' step.
</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">AggregationResult</span> <span class="n">res3</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></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"'bicycle'"</span><span class="o">,</span> <span class="s">"type"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@type"</span><span class="o">,</span> <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">"num_total"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows3</span> <span class="o">=</span> <span class="n">res3</span><span class="o">.</span><span class="na">getRows</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">rows3</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 1
</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="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">rows3</span><span class="o">.</span><span class="na">size</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">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">rows3</span><span class="o">.</span><span class="na">get</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 hl"><span class="cl"> <span class="c1">// >>> {type=bicycle, num_total=10}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.
</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">AggregationResult</span> <span class="n">res4</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <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">to_list</span><span class="o">(</span><span class="s">"__key"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"bicycles"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows4</span> <span class="o">=</span> <span class="n">res4</span><span class="o">.</span><span class="na">getRows</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">rows4</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 3
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows4</span><span class="o">.</span><span class="na">size</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">rows4</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {condition=refurbished, bicycles=[bicycle:9]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, bicycles=[bicycle:3, bicycle:4, bicycle:1, bicycle:2]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, bicycles=[bicycle:7, bicycle:0, bicycle:5, bicycle:6, bicycle:8]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg4' step.
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</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><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_Java_query_agg-stepagg3')" 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_query_agg-stepagg3" 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/QueryAggExample.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_query_agg-stepagg3" name="query_agg-stepagg3" 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_query_agg-stepagg3" title="Open example">
C#
</label>
<div aria-labelledby="tab-query_agg-stepagg3" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_query_agg-stepagg3" 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></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">QueryAggExample</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">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">muxer</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">muxer</span><span class="p">.</span><span class="n">GetDatabase</span><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="n">bikeSchema</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">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 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></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span> <span class="n">bikeParams</span> <span class="p">=</span> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddPrefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Create</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">bikeParams</span><span class="p">,</span> <span class="n">bikeSchema</span><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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-74.0060,40.7128"</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">"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="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 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 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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-118.2437,34.0522"</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">"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="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. 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-87.6298,41.8781"</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">"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="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 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, -80.2433 25.6967, -80.2433 25.8067))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-80.1918,25.7617"</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">"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="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 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’s 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, -122.4644 37.7099, -122.4644 37.8199))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-122.4194,37.7749"</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">"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="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 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 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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, -0.1778 51.4024, -0.1778 51.5524))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-0.1278,51.5074"</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">"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="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 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."</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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, 2.1767 48.5516, 2.1767 48.9016))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.3522,48.8566"</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">"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="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 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’s 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, 13.3260 52.2700, 13.3260 52.5700))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"13.4050,52.5200"</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">"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="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 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, 1.9450 41.1987, 1.9450 41.4301))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.1734, 41.3851"</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">"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="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 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’re 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((12.4464 42.1028, 12.5464 42.1028, 12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"12.4964,41.9028"</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">"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="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 pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t 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="n">condition</span> <span class="p">=</span> <span class="s">"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></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">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">db</span><span class="p">.</span><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></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"@condition:{new}"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Load</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"__key"</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></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="p">,</span> <span class="s">"discounted"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res1</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 5</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">res1</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="n">Row</span> <span class="n">res1Row</span> <span class="p">=</span> <span class="n">res1</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></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></span><span class="line"><span class="cl"> <span class="s">$"Key: {res1Row["</span><span class="n">__key</span><span class="s">"]}, Price: {res1Row["</span><span class="n">price</span><span class="s">"]}, Discounted: {res1Row["</span><span class="n">discounted</span><span class="s">"]}"</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="c1">// >>> Key: bicycle:0, Price: 270, Discounted: 243</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:5, Price: 810, Discounted: 729</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:6, Price: 2300, Discounted: 2070</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:7, Price: 430, Discounted: 387</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:8, Price: 1200, Discounted: 1080</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg1' step.</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">AggregationResult</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Load</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></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price<1000"</span><span class="p">,</span> <span class="s">"price_category"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="p">.</span><span class="n">Sum</span><span class="p">(</span><span class="s">"@price_category"</span><span class="p">).</span><span class="n">As</span><span class="p">(</span><span class="s">"num_affordable"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res2</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 3</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">res2</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="n">Row</span> <span class="n">res2Row</span> <span class="p">=</span> <span class="n">res2</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></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></span><span class="line"><span class="cl"> <span class="s">$"Condition: {res2Row["</span><span class="n">condition</span><span class="s">"]}, Num affordable: {res2Row["</span><span class="n">num_affordable</span><span class="s">"]}"</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="c1">// >>> Condition: refurbished, Num affordable: 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Condition: used, Num affordable: 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Condition: new, Num affordable: 3</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg2' step.</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">AggregationResult</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"'bicycle'"</span><span class="p">,</span> <span class="s">"type"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">.</span><span class="n">GroupBy</span><span class="p">(</span><span class="s">"@type"</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">"num_total"</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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res3</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 1</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="n">Row</span> <span class="n">res3Row</span> <span class="p">=</span> <span class="n">res3</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="m">0</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="s">$"Type: {res3Row["</span><span class="n">type</span><span class="s">"]}, Num total: {res3Row["</span><span class="n">num_total</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Type: bicycle, Num total: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.</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="c1">// Not supported in NRedisStack.</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="c1">// Tests for 'agg4' step.</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="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</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_Csharp_query_agg-stepagg3')" 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_query_agg-stepagg3" 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/QueryAggExample.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>
The result is:
</p>
<pre tabindex="0"><code>1) "1"
2) 1) "type"
1) "bicycle"
2) "num_total"
3) "10"
</code></pre>
<h2 id="grouping-without-aggregation">
Grouping without aggregation
</h2>
<p>
It's sometimes necessary to group your data without applying a mathematical aggregation function. If you need a grouped list of values, then the
<code>
TOLIST
</code>
function is helpful.
</p>
<p>
The following example shows how to group all bicycles by
<code>
condition
</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="query_agg-stepagg4">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_agg-stepagg4" name="query_agg-stepagg4" 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_query_agg-stepagg4" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_agg-stepagg4" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_agg-stepagg4" 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.AGGREGATE idx:bicycle "*" LOAD 1 "__key" GROUPBY 1 "@condition" REDUCE TOLIST 1 "__key" AS bicycles</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_query_agg-stepagg4')" 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_query_agg-stepagg4" name="query_agg-stepagg4" 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_query_agg-stepagg4" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_agg-stepagg4" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_agg-stepagg4" 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="kn">import</span> <span class="nn">json</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.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</span> <span class="kn">import</span> <span class="n">Search</span>
</span></span><span class="line"><span class="cl"><span class="kn">from</span> <span class="nn">redis.commands.search.aggregation</span> <span class="kn">import</span> <span class="n">AggregateRequest</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></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">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></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">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="c1"># create index</span>
</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">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="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="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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_em.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'@condition:</span><span class="si">{new}</span><span class="s1">'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">discounted</span><span class="o">=</span><span class="s1">'@price - (@price * 0.1)'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 5</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">rows</span><span class="p">)</span> <span class="c1"># >>> [['__key', 'bicycle:0', ...</span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['__key', 'bicycle:0', 'price', '270', 'discounted', '243'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:5', 'price', '810', 'discounted', '729'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:6', 'price', '2300', 'discounted', '2070'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:7', 'price', '430', 'discounted', '387'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['__key', 'bicycle:8', 'price', '1200', 'discounted', '1080']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'price'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">price_category</span><span class="o">=</span><span class="s1">'@price<1000'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">sum</span><span class="p">(</span><span class="s1">'@price_category'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'num_affordable'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'num_affordable', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'used', 'num_affordable', '1'],</span>
</span></span><span class="line"><span class="cl"><span class="c1"># ['condition', 'new', 'num_affordable', '3']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s2">"'bicycle'"</span><span class="p">)</span> \
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@type'</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="s1">'num_total'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 1</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">rows</span><span class="p">)</span> <span class="c1"># >>> [['type', 'bicycle', 'num_total', '10']]</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">search</span> <span class="o">=</span> <span class="n">Search</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">index_name</span><span class="o">=</span><span class="s2">"idx:bicycle"</span><span class="p">)</span>
</span></span><span class="line hl"><span class="cl"><span class="n">aggregate_request</span> <span class="o">=</span> <span class="n">AggregateRequest</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="s1">'*'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span> \
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="n">group_by</span><span class="p">(</span><span class="s1">'@condition'</span><span class="p">,</span> <span class="n">reducers</span><span class="o">.</span><span class="n">tolist</span><span class="p">(</span><span class="s1">'__key'</span><span class="p">)</span><span class="o">.</span><span class="n">alias</span><span class="p">(</span><span class="s1">'bicycles'</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">search</span><span class="o">.</span><span class="n">aggregate</span><span class="p">(</span><span class="n">aggregate_request</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="nb">len</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">rows</span><span class="p">))</span> <span class="c1"># >>> 3</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="o">.</span><span class="n">rows</span><span class="p">)</span> <span class="c1"># >>></span>
</span></span><span class="line hl"><span class="cl"><span class="c1">#[['condition', 'refurbished', 'bicycles', ['bicycle:9']],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['condition', 'used', 'bicycles', ['bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4']],</span>
</span></span><span class="line hl"><span class="cl"><span class="c1"># ['condition', 'new', 'bicycles', ['bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8']]]</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_Python_query_agg-stepagg4')" 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_query_agg-stepagg4" 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/query_agg.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_query_agg-stepagg4" name="query_agg-stepagg4" 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_query_agg-stepagg4" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_agg-stepagg4" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_agg-stepagg4" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">AggregateSteps</span><span class="p">,</span> <span class="nx">AggregateGroupByReducers</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</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">client</span> <span class="o">=</span> <span class="nx">createClient</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 class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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="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="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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_em.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">aggregate</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <span class="s1">'@condition:{new}'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">APPLY</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price - (@price * 0.1)'</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">'discounted'</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">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 5
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <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">// [Object: null prototype] { __key: 'bicycle:0', price: '270' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:5', price: '810' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:6', price: '2300' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:7', price: '430' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { __key: 'bicycle:8', 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"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res2</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'@price'</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s1">'@price<1000'</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_category'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">type</span><span class="o">:</span> <span class="nx">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">SUM</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'@price_category'</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">'num_affordable'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[[Object: null prototype] { condition: 'refurbished', num_affordable: '1' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'used', num_affordable: '1' },
</span></span></span><span class="line"><span class="cl"><span class="c1">// [Object: null prototype] { condition: 'new', num_affordable: '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"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res3</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">aggregate</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">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">APPLY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">expression</span><span class="o">:</span> <span class="s2">"'bicycle'"</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">'type'</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@type'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">COUNT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="kc">null</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">'num_total'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line"><span class="cl"><span class="c1">//[ [Object: null prototype] { type: 'bicycle', num_total: '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="kr">const</span> <span class="nx">res4</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">aggregate</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">LOAD</span><span class="o">:</span> <span class="p">[</span><span class="s1">'__key'</span><span class="p">],</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">STEPS</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">AggregateSteps</span><span class="p">.</span><span class="nx">GROUPBY</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">properties</span><span class="o">:</span> <span class="s1">'@condition'</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">REDUCE</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">AggregateGroupByReducers</span><span class="p">.</span><span class="nx">TOLIST</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">property</span><span class="o">:</span> <span class="s1">'__key'</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">'bicycles'</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 class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">.</span><span class="nx">length</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">.</span><span class="nx">results</span><span class="p">);</span> <span class="c1">// >>>
</span></span></span><span class="line hl"><span class="cl"><span class="c1">//[[Object: null prototype] {condition: 'refurbished', bicycles: [ 'bicycle:9' ]},
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'used', bicycles: [ 'bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4' ]},
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// [Object: null prototype] {condition: 'new', bicycles: [ 'bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8' ]}]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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_Nodejs_query_agg-stepagg4')" 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_query_agg-stepagg4" 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/query-agg.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_query_agg-stepagg4" name="query_agg-stepagg4" 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_query_agg-stepagg4" title="Open example">
Java
</label>
<div aria-labelledby="tab-query_agg-stepagg4" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_query_agg-stepagg4" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.List</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.stream.Stream</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.ArrayList</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.UnifiedJedis</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.json.Path2</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.FTCreateParams</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.IndexDataType</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 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.exceptions.JedisDataException</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">QueryAggExample</span> <span class="o">{</span>
</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="n">UnifiedJedis</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">UnifiedJedis</span><span class="o">(</span><span class="s">"redis://localhost:6379"</span><span class="o">);</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">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">String</span><span class="o">[]</span> <span class="n">bicycleJsons</span> <span class="o">=</span> <span class="k">new</span> <span class="n">String</span><span class="o">[]</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-74.0610 40.6678, -74.0610 40.7578))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-74.0060,40.7128\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Velorim\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Jigger\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 270,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"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="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-118.2887 33.9872, -118.2887 34.0972))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-118.2437,34.0522\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Bicyk\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Hillcraft\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Kids want to ride with as little weight as possible. Especially "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on an incline! They may be at the age when a 27.5'' wheel bike is just too clumsy coming "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"off a 24'' bike. The Hillcraft 26 is just the solution they need!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-87.6848 41.8231, -87.6848 41.9331))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-87.6298,41.8781\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Nord\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Chook air 5\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The Chook Air 5 gives kids aged six years and older a durable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and uberlight mountain bike for their first experience on tracks and easy cruising through "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"forests and fields. The lower top tube makes it easy to mount and dismount in any "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"situation, giving your kids greater safety on the trails.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-80.2433 25.6967, -80.2433 25.8067))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-80.1918,25.7617\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Eva\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Eva 291\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3400,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The sister company to Nord, Eva launched in 2005 as the first "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and only women-dedicated bicycle brand. Designed by women for women, allEva bikes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"are optimized for the feminine physique using analytics from a body metrics database. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"If you like 29ers, try the Eva 291. It’s a brand new bike for 2022.. This "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"full-suspension, cross-country ride has been designed for velocity. The 291 has "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"100mm of front and rear travel, a superlight aluminum frame and fast-rolling "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"29-inch wheels. Yippee!\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-122.4644 37.7099, -122.4644 37.8199))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-122.4194,37.7749\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Noka Bikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Kahuna\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 3200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"Whether you want to try your hand at XC racing or are looking "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"for a lively trail bike that's just as inspiring on the climbs as it is over rougher "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ground, the Wilder is one heck of a bike built specifically for short women. Both the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"frames and components have been tweaked to include a women’s saddle, different bars "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"and unique colourway.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"used\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"-0.1778 51.4024, -0.1778 51.5524))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"-0.1278,51.5074\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Breakout\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"XBN 2.1 Alloy\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 810,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"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="o">+</span> <span class="s">"not to say that it’s a basic machine. With an internal weld aluminium frame, a full "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"carbon fork, and the slick-shifting Claris gears from Shimano’s, this is a bike which "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"doesn’t break the bank and delivers craved performance.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"2.1767 48.5516, 2.1767 48.9016))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.3522,48.8566\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"ScramBikes\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"WattBike\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 2300,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"The WattBike is the best e-bike for people who still "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"charge. It’s great for tackling hilly terrain or if you just fancy a more "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"leisurely ride. With three working modes, you can choose between E-bike, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"assisted bicycle, and normal bike modes.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"13.3260 52.2700, 13.3260 52.5700))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"13.4050,52.5200\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"Peaknetic\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Secto\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 430,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"If you struggle with stiff fingers or a kinked neck or "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"back after a few minutes on the road, this lightweight, aluminum bike alleviates "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"those issues and allows you to enjoy the ride. From the ergonomic grips to the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The rear-inclined seat tube facilitates stability by allowing you to put a foot "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on the 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="o">+</span> <span class="s">"accessible for all ability and mobility levels. The saddle is very soft, with "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"a wide back to support your hip joints and a cutout in the center to redistribute "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"that pressure. Rim brakes deliver satisfactory braking control, and the wide tires "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"facilitate setting up the Roll Low-Entry as your preferred commuter, and the "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"1.9450 41.1987, 1.9450 41.4301))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"2.1734, 41.3851\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"nHill\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"Summit\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 1200,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"This budget mountain bike from nHill performs well both "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"on bike paths and on the trail. The fork with 100mm of travel absorbs rough "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"The Shimano Tourney drivetrain offered enough gears for finding a comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"Whether you want an affordable bike that you can take to work, but also take "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"trail in mountains on the weekends or you’re just after a stable, comfortable "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"ride for the bike path, the Summit gives a good value for money.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"new\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">" {"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"pickup_zone\": \"POLYGON((12.4464 42.1028, 12.5464 42.1028, "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"store_location\": \"12.4964,41.9028\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"model\": \"ThrillCycle\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"brand\": \"BikeShind\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"price\": 815,"</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"description\": \"An artsy, retro-inspired bicycle that’s as "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"suggest taking it to the mountains. Fenders protect you from mud, and a rear "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"basket lets you transport groceries, flowers and books. The ThrillCycle comes "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"with a limited lifetime warranty, so this little guy will last you long "</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">"past graduation.\","</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" \"condition\": \"refurbished\""</span>
</span></span><span class="line"><span class="cl"> <span class="o">+</span> <span class="s">" }"</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">bicycleJsons</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">jsonSet</span><span class="o">(</span><span class="s">"bicycle:"</span> <span class="o">+</span> <span class="n">i</span><span class="o">,</span> <span class="k">new</span> <span class="n">Path2</span><span class="o">(</span><span class="s">"$"</span><span class="o">),</span> <span class="n">bicycleJsons</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">AggregationResult</span> <span class="n">res1</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"@condition:{new}"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">,</span> <span class="s">"price"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="o">,</span> <span class="s">"discounted"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows1</span> <span class="o">=</span> <span class="n">res1</span><span class="o">.</span><span class="na">getRows</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">rows1</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 5
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows1</span><span class="o">.</span><span class="na">size</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">rows1</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {__key=bicycle:0, discounted=243, price=270}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:5, discounted=729, price=810}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:6, discounted=2070, price=2300}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:7, discounted=387, price=430}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {__key=bicycle:8, discounted=1080, 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">// Tests for 'agg1' step.
</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">AggregationResult</span> <span class="n">res2</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"price"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"@price<1000"</span><span class="o">,</span> <span class="s">"price_category"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <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">sum</span><span class="o">(</span><span class="s">"@price_category"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"num_affordable"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows2</span> <span class="o">=</span> <span class="n">res2</span><span class="o">.</span><span class="na">getRows</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">rows2</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 3
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows2</span><span class="o">.</span><span class="na">size</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">rows2</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {condition=refurbished, num_affordable=1}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, num_affordable=1}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, num_affordable=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">// Tests for 'agg2' step.
</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">AggregationResult</span> <span class="n">res3</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></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="s">"'bicycle'"</span><span class="o">,</span> <span class="s">"type"</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="o">.</span><span class="na">groupBy</span><span class="o">(</span><span class="s">"@type"</span><span class="o">,</span> <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">"num_total"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows3</span> <span class="o">=</span> <span class="n">res3</span><span class="o">.</span><span class="na">getRows</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">rows3</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">rows3</span><span class="o">.</span><span class="na">size</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">rows3</span><span class="o">.</span><span class="na">get</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 class="c1">// >>> {type=bicycle, num_total=10}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.
</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">AggregationResult</span> <span class="n">res4</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></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">AggregationBuilder</span><span class="o">(</span><span class="s">"*"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">.</span><span class="na">load</span><span class="o">(</span><span class="s">"__key"</span><span class="o">)</span>
</span></span><span class="line hl"><span class="cl"> <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 hl"><span class="cl"> <span class="n">Reducers</span><span class="o">.</span><span class="na">to_list</span><span class="o">(</span><span class="s">"__key"</span><span class="o">).</span><span class="na">as</span><span class="o">(</span><span class="s">"bicycles"</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">List</span><span class="o"><</span><span class="n">Row</span><span class="o">></span> <span class="n">rows4</span> <span class="o">=</span> <span class="n">res4</span><span class="o">.</span><span class="na">getRows</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">rows4</span><span class="o">.</span><span class="na">size</span><span class="o">());</span> <span class="c1">// >>> 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="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">rows4</span><span class="o">.</span><span class="na">size</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">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">rows4</span><span class="o">.</span><span class="na">get</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 hl"><span class="cl"> <span class="c1">// >>> {condition=refurbished, bicycles=[bicycle:9]}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=used, bicycles=[bicycle:3, bicycle:4, bicycle:1, bicycle:2]}
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="c1">// >>> {condition=new, bicycles=[bicycle:7, bicycle:0, bicycle:5, bicycle:6, bicycle:8]}
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg4' step.
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</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><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_Java_query_agg-stepagg4')" 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_query_agg-stepagg4" 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/QueryAggExample.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_query_agg-stepagg4" name="query_agg-stepagg4" 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_query_agg-stepagg4" title="Open example">
C#
</label>
<div aria-labelledby="tab-query_agg-stepagg4" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_query_agg-stepagg4" 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></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">QueryAggExample</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">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">muxer</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">muxer</span><span class="p">.</span><span class="n">GetDatabase</span><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="n">bikeSchema</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">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 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></span><span class="line"><span class="cl"> <span class="n">FTCreateParams</span> <span class="n">bikeParams</span> <span class="p">=</span> <span class="k">new</span> <span class="n">FTCreateParams</span><span class="p">()</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">AddPrefix</span><span class="p">(</span><span class="s">"bicycle:"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Create</span><span class="p">(</span><span class="s">"idx:bicycle"</span><span class="p">,</span> <span class="n">bikeParams</span><span class="p">,</span> <span class="n">bikeSchema</span><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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-74.0060,40.7128"</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">"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="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 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 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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-118.2437,34.0522"</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">"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="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. 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-87.6298,41.8781"</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">"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="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 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, -80.2433 25.6967, -80.2433 25.8067))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-80.1918,25.7617"</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">"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="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 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’s 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="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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, -122.4644 37.7099, -122.4644 37.8199))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-122.4194,37.7749"</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">"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="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 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 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 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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, -0.1778 51.4024, -0.1778 51.5524))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"-0.1278,51.5074"</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">"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="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 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."</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></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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, 2.1767 48.5516, 2.1767 48.9016))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.3522,48.8566"</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">"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="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 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’s 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, 13.3260 52.2700, 13.3260 52.5700))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"13.4050,52.5200"</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">"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="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 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, 1.9450 41.1987, 1.9450 41.4301))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"2.1734, 41.3851"</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">"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="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 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’re 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="n">condition</span> <span class="p">=</span> <span class="s">"new"</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">pickup_zone</span> <span class="p">=</span> <span class="s">"POLYGON((12.4464 42.1028, 12.5464 42.1028, 12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">store_location</span> <span class="p">=</span> <span class="s">"12.4964,41.9028"</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">"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="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 pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn’t 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="n">condition</span> <span class="p">=</span> <span class="s">"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></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">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">db</span><span class="p">.</span><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></span><span class="line"><span class="cl"> <span class="n">AggregationResult</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"@condition:{new}"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Load</span><span class="p">(</span><span class="k">new</span> <span class="n">FieldName</span><span class="p">(</span><span class="s">"__key"</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></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price - (@price * 0.1)"</span><span class="p">,</span> <span class="s">"discounted"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res1</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 5</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">res1</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="n">Row</span> <span class="n">res1Row</span> <span class="p">=</span> <span class="n">res1</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></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></span><span class="line"><span class="cl"> <span class="s">$"Key: {res1Row["</span><span class="n">__key</span><span class="s">"]}, Price: {res1Row["</span><span class="n">price</span><span class="s">"]}, Discounted: {res1Row["</span><span class="n">discounted</span><span class="s">"]}"</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="c1">// >>> Key: bicycle:0, Price: 270, Discounted: 243</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:5, Price: 810, Discounted: 729</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:6, Price: 2300, Discounted: 2070</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:7, Price: 430, Discounted: 387</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Key: bicycle:8, Price: 1200, Discounted: 1080</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg1' step.</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">AggregationResult</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Load</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></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"@price<1000"</span><span class="p">,</span> <span class="s">"price_category"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <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></span><span class="line"><span class="cl"> <span class="n">Reducers</span><span class="p">.</span><span class="n">Sum</span><span class="p">(</span><span class="s">"@price_category"</span><span class="p">).</span><span class="n">As</span><span class="p">(</span><span class="s">"num_affordable"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res2</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 3</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">res2</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="n">Row</span> <span class="n">res2Row</span> <span class="p">=</span> <span class="n">res2</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></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></span><span class="line"><span class="cl"> <span class="s">$"Condition: {res2Row["</span><span class="n">condition</span><span class="s">"]}, Num affordable: {res2Row["</span><span class="n">num_affordable</span><span class="s">"]}"</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="c1">// >>> Condition: refurbished, Num affordable: 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Condition: used, Num affordable: 1</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Condition: new, Num affordable: 3</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg2' step.</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">AggregationResult</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">FT</span><span class="p">().</span><span class="n">Aggregate</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">AggregationRequest</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">Apply</span><span class="p">(</span><span class="s">"'bicycle'"</span><span class="p">,</span> <span class="s">"type"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"> <span class="p">.</span><span class="n">GroupBy</span><span class="p">(</span><span class="s">"@type"</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">"num_total"</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="n">res3</span><span class="p">.</span><span class="n">TotalResults</span><span class="p">);</span> <span class="c1">// >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="n">Row</span> <span class="n">res3Row</span> <span class="p">=</span> <span class="n">res3</span><span class="p">.</span><span class="n">GetRow</span><span class="p">(</span><span class="m">0</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">$"Type: {res3Row["</span><span class="n">type</span><span class="s">"]}, Num total: {res3Row["</span><span class="n">num_total</span><span class="s">"]}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Type: bicycle, Num total: 10</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'agg3' step.</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></span><span class="line hl"><span class="cl"> <span class="c1">// Not supported in NRedisStack.</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="c1">// Tests for 'agg4' step.</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="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</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_Csharp_query_agg-stepagg4')" 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_query_agg-stepagg4" 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/QueryAggExample.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>
The output of this query is:
</p>
<pre tabindex="0"><code>1) "3"
2) 1) "condition"
1) "refurbished"
2) "bicycles"
3) 1) "bicycle:9"
3) 1) "condition"
1) "used"
2) "bicycles"
3) 1) "bicycle:1"
1) "bicycle:2"
2) "bicycle:3"
3) "bicycle:4"
4) 1) "condition"
1) "new"
2) "bicycles"
3) 1) "bicycle:0"
1) "bicycle:5"
2) "bicycle:6"
3) "bicycle:8"
4) "bicycle:7"
</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/query/aggregation/"/>
<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/cluster/auditing-db-conns/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Auditing database connections requests
</h1>
<p class="text-lg -mt-5 mb-10">
Auditing database connections requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-cluster-audit-db-conns">
GET
</a>
</td>
<td>
<code>
/v1/cluster/auditing/db_conns
</code>
</td>
<td>
Get database connection auditing settings
</td>
</tr>
<tr>
<td>
<a href="#put-cluster-audit-db-conns">
PUT
</a>
</td>
<td>
<code>
/v1/cluster/auditing/db_conns
</code>
</td>
<td>
Update database connection auditing settings
</td>
</tr>
<tr>
<td>
<a href="#delete-cluster-audit-db-conns">
DELETE
</a>
</td>
<td>
<code>
/v1/cluster/auditing/db_conns
</code>
</td>
<td>
Delete database connection auditing settings
</td>
</tr>
</tbody>
</table>
<h2 id="get-cluster-audit-db-conns">
Get database auditing settings
</h2>
<pre><code>GET /v1/cluster/auditing/db_conns
</code></pre>
<p>
Gets the configuration settings for
<a href="/docs/latest/operate/rs/7.4/security/audit-events/">
auditing database connections
</a>
.
</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_cluster_info">
view_cluster_info
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /cluster/auditing/db_conns
</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-response">
Response
</h3>
<p>
Returns a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config/">
database connection auditing configuration object
</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="nt">"audit_address"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_port"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_protocol"</span><span class="p">:</span> <span class="s2">"TCP"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_interval"</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">"audit_reconnect_max_attempts"</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>
<h3 id="get-error-codes">
Error codes
</h3>
<p>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db_conns_auditing_unsupported_by_capability
</td>
<td>
Not all nodes support DB Connections Auditing capability
</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="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable">
406 Not Acceptable
</a>
</td>
<td>
Feature not supported for all nodes
</td>
</tr>
</tbody>
</table>
<h2 id="put-cluster-audit-db-conns">
Update database auditing
</h2>
<pre><code>PUT /v1/cluster/auditing/db_conns
</code></pre>
<p>
Updates the configuration settings for
<a href="/docs/latest/operate/rs/7.4/security/audit-events/">
auditing database connections
</a>
.
</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/#update_cluster">
update_cluster
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="put-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>PUT /cluster/auditing/db_conns
</code></pre>
<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">"audit_protocol"</span><span class="p">:</span> <span class="s2">"TCP"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_address"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_port"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_interval"</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">"audit_reconnect_max_attempts"</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>
<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="request-body">
Request body
</h4>
<p>
Include a
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config/">
database connection auditing configuration object
</a>
with updated fields in the request body.
</p>
<h3 id="put-response">
Response
</h3>
<p>
Returns the updated
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/db-conns-auditing-config/">
database connection auditing configuration object
</a>
.
</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">"audit_address"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_port"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_protocol"</span><span class="p">:</span> <span class="s2">"TCP"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"audit_reconnect_interval"</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">"audit_reconnect_max_attempts"</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>
<h3 id="put-error-codes">
Error codes
</h3>
<p>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db_conns_auditing_unsupported_by_capability
</td>
<td>
Not all nodes support DB Connections Auditing capability
</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="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable">
406 Not Acceptable
</a>
</td>
<td>
Feature not supported for all nodes
</td>
</tr>
</tbody>
</table>
<h2 id="delete-cluster-audit-db-conns">
Delete database auditing settings
</h2>
<pre><code>DELETE /v1/cluster/auditing/db_conns
</code></pre>
<p>
Resets the configuration settings for
<a href="/docs/latest/operate/rs/7.4/security/audit-events/">
auditing database connections
</a>
.
</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/#update_cluster">
update_cluster
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="delete-request">
Request
</h3>
<h4 id="example-http-request-2">
Example HTTP request
</h4>
<pre><code>DELETE /cluster/auditing/db_conns
</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>
<h3 id="delete-response">
Response
</h3>
<p>
Returns a status code that indicates whether the database connection auditing settings reset successfully or failed to reset.
</p>
<h3 id="delete-error-codes">
Error codes
</h3>
<p>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
fields that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
db_conns_audit_config_not_found
</td>
<td>
Unable to find the auditing configuration
</td>
</tr>
<tr>
<td>
cannot_delete_audit_config_when_policy_enabled
</td>
<td>
Auditing cluster policy is 'enabled' when trying to delete the auditing configuration
</td>
</tr>
<tr>
<td>
cannot_delete_audit_config_when_bdb_enabled
</td>
<td>
One of the databases has auditing configuration 'enabled' when trying to delete the auditing configuration
</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="https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok">
200 OK
</a>
</td>
<td>
Success
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found">
404 Not Found
</a>
</td>
<td>
Configuration not found
</td>
</tr>
<tr>
<td>
<a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable">
406 Not Acceptable
</a>
</td>
<td>
Feature not supported for all nodes
</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/cluster/auditing-db-conns/"/>
<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/function-help/.html | <section class="prose w-full py-12">
<h1 class="command-name">
FUNCTION HELP
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FUNCTION HELP</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.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>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@scripting
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
The
<code>
FUNCTION HELP
</code>
command returns a helpful text describing the different subcommands.
</p>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of sub-commands and their descriptions
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a list of sub-commands and their descriptions.
<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/function-help/"/>
<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/llen/.html | <section class="prose w-full py-12">
<h1 class="command-name">
LLEN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">LLEN 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">
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>
@read
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@list
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Returns the length of the list stored at
<code>
key
</code>
.
If
<code>
key
</code>
does not exist, it is interpreted as an empty list and
<code>
0
</code>
is returned.
An error is returned when the value stored at
<code>
key
</code>
is not a list.
</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> LPUSH mylist "World"
(integer) 1
redis> LPUSH mylist "Hello"
(integer) 2
redis> LLEN mylist
(integer) 2
</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 length of the list.
<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/llen/"/>
<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/httl/.html | <section class="prose w-full py-12">
<h1 class="command-name">
HTTL
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">HTTL key 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>
@read
</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>
Returns the remaining TTL (time to live) of a hash key's field(s) that have a set expiration.
This introspection capability allows you to check how many seconds a
given hash field will continue to be part of the hash key.
</p>
<p>
See also the
<a href="/docs/latest/commands/hpttl/">
<code>
HPTTL
</code>
</a>
command that returns the same information with millisecond resolution.
</p>
<h2 id="example">
Example
</h2>
<pre tabindex="0"><code>redis> HTTL no-key FIELDS 3 field1 field2 field3
(nil)
redis> HSET mykey field1 "hello" field2 "world"
(integer) 2
redis> HEXPIRE mykey 300 FIELDS 2 field1 field3
1) (integer) 1
2) (integer) -2
redis> HTTL mykey FIELDS 3 field1 field2 field3
1) (integer) 283
2) (integer) -1
3) (integer) -2
</code></pre>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
<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>
-1
</code>
if the field exists but has no associated expiration set.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the TTL in seconds.
</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/httl/"/>
<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.arrlen.html | <section class="prose w-full py-12">
<h1 class="command-name">
JSON.ARRLEN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">JSON.ARRLEN 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 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1) where path is evaluated to a single value, O(N) where path is evaluated to multiple values, where N is the size of the key
</dd>
</dl>
<p>
Report the length of the JSON array at
<code>
path
</code>
in
<code>
key
</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>
, if not provided. Returns null if the
<code>
key
</code>
or
<code>
path
</code>
do not exist.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
<code>
JSON.ARRLEN
</code>
returns an
<a href="/docs/latest/develop/reference/protocol-spec#resp-arrays">
array
</a>
of integer replies, an integer for each matching value, each is the array's length, or
<code>
nil
</code>
, if the matching value is not an array.
For more information about replies, see
<a href="/docs/latest/develop/reference/protocol-spec/">
Redis serialization protocol specification
</a>
.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Get lengths of JSON arrays in a document
</b>
</summary>
<p>
Create a document for wireless earbuds.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.SET item:2 $ <span class="s1">'{"name":"Wireless earbuds","description":"Wireless Bluetooth in-ear headphones","connection":{"wireless":true,"type":"Bluetooth"},"price":64.99,"stock":17,"colors":["black","white"], "max_level":[80, 100, 120]}'</span>
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<p>
Find lengths of arrays in all objects of the document.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.ARRLEN item:2 <span class="s1">'$.[*]'</span>
</span></span><span class="line"><span class="cl">1<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> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</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">2</span>
</span></span><span class="line"><span class="cl">7<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3</span></span></span></code></pre>
</div>
<p>
Return the length of the
<code>
max_level
</code>
array.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.ARRLEN item:2 <span class="s1">'$..max_level'</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">3</span></span></span></code></pre>
</div>
<p>
Get all the maximum level values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.GET item:2 <span class="s1">'$..max_level'</span>
</span></span><span class="line"><span class="cl"><span class="s2">"[[80,100,120]]"</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.arrlen/"/>
<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/jwt_authorize/.html | <section class="prose w-full py-12 max-w-none">
<h1>
JWT authorize object
</h1>
<p class="text-lg -mt-5 mb-10">
An object for user authentication or a JW token refresh request
</p>
<p>
An API object for user authentication or a JW token refresh request.
</p>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type/Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
password
</td>
<td>
string
</td>
<td>
The user’s password (required)
</td>
</tr>
<tr>
<td>
ttl
</td>
<td>
integer (range: 1-86400) (default: 300)
</td>
<td>
Time to live - The amount of time in seconds the token will be valid
</td>
</tr>
<tr>
<td>
username
</td>
<td>
string
</td>
<td>
The user’s username (required)
</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/jwt_authorize/"/>
<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/rotate_ccs_job_settings/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Rotate CCS job settings object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the rotate_ccs_job_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>
cron_expression
</td>
<td>
string
</td>
<td>
<a href="https://en.wikipedia.org/wiki/Cron#CRON_expression">
CRON expression
</a>
that defines the CCS rotation schedule
</td>
</tr>
<tr>
<td>
file_suffix
</td>
<td>
string (default: 5min)
</td>
<td>
String added to the end of the rotated RDB files
</td>
</tr>
<tr>
<td>
rotate_max_num
</td>
<td>
integer, (range: 1-100) (default: 24)
</td>
<td>
The maximum number of saved RDB files
</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/rotate_ccs_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/operate/rs/7.4/references/rest-api/objects/bootstrap/credentials/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Credentials object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the credentials 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>
password
</td>
<td>
string
</td>
<td>
Admin password
</td>
</tr>
<tr>
<td>
username
</td>
<td>
string
</td>
<td>
Admin username (pattern does not allow special characters &,<,>,")
</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/bootstrap/credentials/"/>
<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/eval_ro/.html | <section class="prose w-full py-12">
<h1 class="command-name">
EVAL_RO
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">EVAL_RO script numkeys [key [key ...]] [arg [arg ...]]</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.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
Depends on the script that is executed.
</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>
This is a read-only variant of the
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
command that cannot execute commands that modify data.
</p>
<p>
For more information about when to use this command vs
<a href="/docs/latest/commands/eval/">
<code>
EVAL
</code>
</a>
, please refer to
<a href="/docs/latest/develop/interact/programmability#read-only-scripts">
Read-only scripts
</a>
.
</p>
<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="examples">
Examples
</h2>
<pre tabindex="0"><code>> SET mykey "Hello"
OK
> EVAL_RO "return redis.call('GET', KEYS[1])" 1 mykey
"Hello"
> EVAL_RO "return redis.call('DEL', KEYS[1])" 1 mykey
(error) ERR Error running script (call to b0d697da25b13e49157b2c214a4033546aba2104): @user_script:1: @user_script: 1: Write commands are not allowed from read-only scripts.
</code></pre>
<h2 id="resp2resp3-reply">
RESP2/RESP3 Reply
</h2>
The return value depends on the script that was 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/eval_ro/"/>
<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/bootstrap/cluster_identity/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster identity object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the cluster_identity 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>
name
</td>
<td>
string
</td>
<td>
Fully qualified cluster name. Limited to 64 characters and must comply with the IETF's RFC 952 standard and section 2.1 of the RFC 1123 standard.
</td>
</tr>
<tr>
<td>
nodes
</td>
<td>
array of strings
</td>
<td>
Array of IP addresses of existing cluster nodes
</td>
</tr>
<tr>
<td>
wait_command
</td>
<td>
boolean (default: true)
</td>
<td>
Supports Redis wait command
</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/bootstrap/cluster_identity/"/>
<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/upgrade/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Database upgrade requests
</h1>
<p class="text-lg -mt-5 mb-10">
Database upgrade requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#post-bdbs-upgrade">
POST
</a>
</td>
<td>
<code>
/v1/bdbs/{uid}/upgrade
</code>
</td>
<td>
Upgrade database
</td>
</tr>
</tbody>
</table>
<h2 id="post-bdbs-upgrade">
Upgrade database
</h2>
<pre><code>POST /v1/bdbs/{int: uid}/upgrade
</code></pre>
<p>
Upgrade a database.
</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/#update_bdb_with_action">
update_bdb_with_action
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="post-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>POST /bdbs/1/upgrade
</code></pre>
<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">"swap_roles"</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">"may_discard_data"</span><span class="p">:</span> <span class="kc">false</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>
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>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
force_restart
</td>
<td>
boolean
</td>
<td>
Restart shards even if no version change (default: false)
</td>
</tr>
<tr>
<td>
keep_redis_version
</td>
<td>
boolean
</td>
<td>
Keep current Redis version (default: false)
</td>
</tr>
<tr>
<td>
keep_crdt_protocol_version
</td>
<td>
boolean
</td>
<td>
Keep current crdt protocol version (default: false)
</td>
</tr>
<tr>
<td>
may_discard_data
</td>
<td>
boolean
</td>
<td>
Discard data in a non-replicated, non-persistent bdb (default: false)
</td>
</tr>
<tr>
<td>
force_discard
</td>
<td>
boolean
</td>
<td>
Discard data even if the bdb is replicated and/or persistent (default: false)
</td>
</tr>
<tr>
<td>
preserve_roles
</td>
<td>
boolean
</td>
<td>
Preserve shards' master/replica roles (requires an extra failover) (default: false)
</td>
</tr>
<tr>
<td>
parallel_shards_upgrade
</td>
<td>
integer
</td>
<td>
Max number of shards to upgrade in parallel (default: all)
</td>
</tr>
<tr>
<td>
modules
</td>
<td>
list of modules
</td>
<td>
List of dicts representing the modules that will be upgraded.
<br/>
<br/>
Each dict includes:
<br/>
<br/>
•
<code>
current_module
</code>
: uid of a module to upgrade
<br/>
<br/>
•
<code>
new_module
</code>
: uid of the module we want to upgrade to
<br/>
<br/>
•
<code>
new_module_args
</code>
: args list for the new module (no defaults for the three module-related parameters).
</td>
</tr>
<tr>
<td>
redis_version
</td>
<td>
version number
</td>
<td>
Upgrades the database to the specified Redis version instead of the latest version
</td>
</tr>
<tr>
<td>
latest_with_modules
</td>
<td>
boolean
</td>
<td>
Upgrades the database to the latest Redis version and latest supported versions of modules available in the cluster
</td>
</tr>
</tbody>
</table>
<h3 id="post-response">
Response
</h3>
<p>
Returns the upgraded
<a href="/docs/latest/operate/rs/7.4/references/rest-api/objects/bdb/">
BDB 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">"replication"</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">"data_persistence"</span><span class="p">:</span> <span class="s2">"aof"</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="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, bdb upgrade initiated (
<code>
action_uid
</code>
can be used to track progress)
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">
400 Bad Request
</a>
</td>
<td>
Malformed or bad command
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
bdb not found
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
New module version capabilities don't comply with the database configuration
</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>
Internal error
</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/upgrade/"/>
<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/write-behind/reference/jmespath-custom-functions/.html | <section class="prose w-full py-12 max-w-none">
<h1>
JMESPath custom functions
</h1>
<p class="text-lg -mt-5 mb-10">
JMESPath custom function reference
</p>
<table>
<thead>
<tr>
<th>
Function
</th>
<th>
Description
</th>
<th>
Example
</th>
<th>
Comments
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
base64_decode
</code>
</td>
<td>
Decodes a base64(RFC 4648) encoded string
</td>
<td>
Input:
<code>
{"encoded": "SGVsbG8gV29ybGQh"}
</code>
<br/>
Expression:
<code>
base64_decode(encoded)
</code>
<br/>
Output:
<code>
Hello World!
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
capitalize
</code>
</td>
<td>
Capitalizes all the words in the string
</td>
<td>
Input:
<code>
{"name": "john doe"}
</code>
<br/>
Expression:
<code>
capitalize(name)
</code>
<br/>
Output:
<code>
John Doe
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
concat
</code>
</td>
<td>
Concatenates an array of variables or literals
</td>
<td>
Input:
<code>
{"fname": "john", "lname": "doe"}
</code>
<br/>
Expression:
<code>
concat([fname, ' ' ,lname])
</code>
<br/>
Output:
<code>
john doe
</code>
</td>
<td>
This is equivalent to the more verbose built-in expression:
<code>
' '.join([fname,lname])
</code>
</td>
</tr>
<tr>
<td>
<code>
filter_entries
</code>
</td>
<td>
Filters entries in a dictionary (object) using the given JMESPath predicate
</td>
<td>
Input:
<code>
{ "name": "John", "age": 30, "country": "US", "score": 15}
</code>
<br/>
Expression:
<code>
filter_entries(@, `key == 'name' || key == 'age'`)
</code>
<br/>
Output:
<code>
{"name": "John", "age": 30 }
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
from_entries
</code>
</td>
<td>
Converts an array of objects with
<code>
key
</code>
and
<code>
value
</code>
properties into a single object
</td>
<td>
Input:
<code>
[{"key": "name", "value": "John"}, {"key": "age", "value": 30}, {"key": "city", "value": null}]
</code>
<br/>
Expression:
<code>
from_entries(@)
</code>
<br/>
Output:
<code>
{"name": "John", "age": 30, "city": null}
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
hash
</code>
</td>
<td>
Calculates a hash using the
<code>
hash_name
</code>
hash function and returns its hexadecimal representation
</td>
<td>
Input:
<code>
{"some_str": "some_value"}
</code>
<br/>
Expression:
<code>
hash(some_str, &#96;sha1&#96;)
</code>
<br/>
Output:
<code>
8c818171573b03feeae08b0b4ffeb6999e3afc05
</code>
</td>
<td>
Supported algorithms: sha1 (default), sha256, md5, sha384, sha3_384, blake2b, sha512, sha3_224, sha224, sha3_256, sha3_512, blake2s
</td>
</tr>
<tr>
<td>
<code>
in
</code>
</td>
<td>
Checks if an element matches any value in a list of values
</td>
<td>
Input:
<code>
{"el": "b"}
</code>
<br/>
Expression:
<code>
in(el,
</code>
["a", "b", "c"]
<code>
)
</code>
<br/>
Output:
<code>
True
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
left
</code>
</td>
<td>
Returns a specified number of characters from the start of a given text string
</td>
<td>
Input:
<code>
{"greeting": "hello world!"}
</code>
<br/>
Expression:
<code>
left(greeting,
</code>
5
<code>
)
</code>
<br/>
Output:
<code>
hello
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
lower
</code>
</td>
<td>
Converts all uppercase characters in a string into lowercase characters
</td>
<td>
Input:
<code>
{"fname": "John"}
</code>
<br/>
Expression:
<code>
lower(fname)
</code>
<br/>
Output:
<code>
john
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
mid
</code>
</td>
<td>
Returns a specified number of characters from the middle of a given text string
</td>
<td>
Input:
<code>
{"greeting": "hello world!"}
</code>
<br/>
Expression:
<code>
mid(greeting,
</code>
4
<code>
,
</code>
3
<code>
)
</code>
<br/>
Output:
<code>
o w
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
json_parse
</code>
</td>
<td>
Returns parsed object from the given json string
</td>
<td>
Input:
<code>
{"data": '{"greeting": "hello world!"}'}
</code>
<br/>
Expression:
<code>
parse_json(data)
</code>
<br/>
Output:
<code>
{"greeting": "hello world!"}
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
regex_replace
</code>
</td>
<td>
Replaces a string that matches a regular expression
</td>
<td>
Input:
<code>
{"text": "Banana Bannnana"}
</code>
<br/>
Expression:
<code>
regex_replace(text, 'Ban\w+', 'Apple Apple')
</code>
<br/>
Output:
<code>
Apple Apple
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
replace
</code>
</td>
<td>
Replaces all the occurrences of a substring with a new one
</td>
<td>
Input:
<code>
{"sentence": "one four three four!"}
</code>
<br/>
Expression:
<code>
replace(sentence, 'four', 'two')
</code>
<br/>
Output:
<code>
one two three two!
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
right
</code>
</td>
<td>
Returns a specified number of characters from the end of a given text string
</td>
<td>
Input:
<code>
{"greeting": "hello world!"}
</code>
<br/>
Expression:
<code>
right(greeting,
</code>
6
<code>
)
</code>
<br/>
Output:
<code>
world!
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
split
</code>
</td>
<td>
Splits a string into a list of strings after breaking the given string by the specified delimiter (comma by default)
</td>
<td>
Input:
<code>
{"departments": "finance,hr,r&d"}
</code>
<br/>
Expression:
<code>
split(departments)
</code>
<br/>
Output:
<code>
['finance', 'hr', 'r&d']
</code>
</td>
<td>
Default delimiter is comma - a different delimiter can be passed to the function as the second argument, for example:
<code>
split(departments, ';')
</code>
</td>
</tr>
<tr>
<td>
<code>
time_delta_days
</code>
</td>
<td>
Returns the number of days between a given
<code>
dt
</code>
and now (positive) or the number of days that have passed from now (negative)
</td>
<td>
Input:
<code>
{"dt": '2021-10-06T18:56:16.701670+00:00'}
</code>
<br/>
Expression:
<code>
time_delta_days(dt)
</code>
<br/>
Output:
<code>
365
</code>
</td>
<td>
If
<code>
dt
</code>
is a string, ISO datetime (2011-11-04T00:05:23+04:00, for example) is assumed. If
<code>
dt
</code>
is a number, Unix timestamp (1320365123, for example) is assumed.
</td>
</tr>
<tr>
<td>
<code>
time_delta_seconds
</code>
</td>
<td>
Returns the number of seconds between a given
<code>
dt
</code>
and now (positive) or the number of seconds that have passed from now (negative)
</td>
<td>
Input:
<code>
{"dt": '2021-10-06T18:56:16.701670+00:00'}
</code>
<br/>
Expression:
<code>
time_delta_days(dt)
</code>
<br/>
Output:
<code>
31557600
</code>
</td>
<td>
If
<code>
dt
</code>
is a string, ISO datetime (2011-11-04T00:05:23+04:00, for example) is assumed. If
<code>
dt
</code>
is a number, Unix timestamp (1320365123, for example) is assumed.
</td>
</tr>
<tr>
<td>
<code>
to_entries
</code>
</td>
<td>
Converts a given object into an array of objects with
<code>
key
</code>
and
<code>
value
</code>
properties
</td>
<td>
Input:
<code>
{"name": "John", "age": 30, "city": null}
</code>
<br/>
Expression:
<code>
to_entries(@)
</code>
<br/>
Output:
<code>
[{"key": "name", "value": "John"}, {"key": "age", "value": 30}, {"key": "city", "value": null}]
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
upper
</code>
</td>
<td>
Converts all lowercase characters in a string into uppercase characters
</td>
<td>
Input:
<code>
{"fname": "john"}
</code>
<br/>
Expression:
<code>
upper(fname)
</code>
<br/>
Output:
<code>
JOHN
</code>
</td>
<td>
</td>
</tr>
<tr>
<td>
<code>
uuid
</code>
</td>
<td>
Generates a random UUID4 and returns it as a string in standard format
</td>
<td>
Input: None
<br/>
Expression:
<code>
uuid()
</code>
<br/>
Output:
<code>
3264b35c-ff5d-44a8-8bc7-9be409dac2b7
</code>
</td>
<td>
</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/write-behind/reference/jmespath-custom-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/references/rest-api/requests/bdbs/stats/last/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Latest database stats requests
</h1>
<p class="text-lg -mt-5 mb-10">
Most recent database statistics requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-bdbs-stats-last">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/stats/last
</code>
</td>
<td>
Get most recent stats for all databases
</td>
</tr>
<tr>
<td>
<a href="#get-bdbs-stats-last">
GET
</a>
</td>
<td>
<code>
/v1/bdbs/stats/last/{uid}
</code>
</td>
<td>
Get most recent stats for a specific database
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-bdbs-stats-last">
Get latest stats for all databases
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/bdbs/stats/last
</span></span></code></pre>
</div>
<p>
Get the most recent statistics for all databases.
</p>
<h4 id="required-permissions">
Required permissions
</h4>
<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_bdb_stats">
view_all_bdb_stats
</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>
<ol>
<li>
<p>
Without metrics filter (returns all metrics by default)
</p>
<pre tabindex="0"><code>GET /bdbs/stats/last
</code></pre>
</li>
<li>
<p>
With metrics filter
</p>
<pre tabindex="0"><code>GET /bdbs/stats/last?metrics=no_of_keys,used_memory
</code></pre>
</li>
</ol>
<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="query-parameters">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
metrics
</td>
<td>
string
</td>
<td>
Comma-separated list of metric names for which we want statistics (default is all). (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns
<a href="/docs/latest/operate/rs/references/rest-api/objects/statistics/">
statistics
</a>
for all databases.
</p>
<h4 id="example-json-body">
Example JSON body
</h4>
<ol>
<li>
<p>
Without metrics filter (returns all metrics by default)
</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">"1"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:37Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:44Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"conns"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"egress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:44Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"evicted_objects"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"expired_objects"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"ingress_bytes"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"instantaneous_ops_per_sec"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"last_req_time"</span><span class="p">:</span> <span class="s2">"1970-01-01T00:00:00Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"last_res_time"</span><span class="p">:</span> <span class="s2">"1970-01-01T00:00:00Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"used_memory"</span><span class="p">:</span> <span class="mf">5651336.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"mem_size_lua"</span><span class="p">:</span> <span class="mf">35840.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"monitor_sessions_count"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"no_of_keys"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"other_req"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"other_res"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"read_hits"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"read_misses"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"read_req"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"read_res"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_connections_received"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_req"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"total_res"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"write_hits"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"write_misses"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"write_req"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"write_res"</span><span class="p">:</span> <span class="mf">0.0</span>
</span></span><span class="line"><span class="cl"><span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="nt">"2"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:37Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:44Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl">
</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></span><span class="line"><span class="cl"><span class="nt">"// Additional BDBs..."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
</li>
<li>
<p>
With metrics filter
</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">"1"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:44Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"used_memory"</span><span class="p">:</span> <span class="mf">5651576.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"no_of_keys"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:37Z"</span>
</span></span><span class="line"><span class="cl"><span class="p">},</span>
</span></span><span class="line"><span class="cl"><span class="nt">"2"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:44ZZ"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"used_memory"</span><span class="p">:</span> <span class="mf">5651440.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"no_of_keys"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-05-28T08:06:37Z"</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="nt">"// Additional BDBs.."</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
</li>
</ol>
<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>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
No bdbs exist
</td>
</tr>
</tbody>
</table>
<h2 id="get-bdbs-stats-last">
Get latest database stats
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">GET /v1/bdbs/stats/last/<span class="o">{</span>int: uid<span class="o">}</span>
</span></span></code></pre>
</div>
<p>
Get the most recent statistics for a specific database.
</p>
<h4 id="permissions">
Permissions
</h4>
<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_bdb_stats">
view_bdb_stats
</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 /bdbs/stats/last/1?metrics<span class="o">=</span>no_of_keys,used_memory
</span></span></code></pre>
</div>
<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 requested BDB.
</td>
</tr>
</tbody>
</table>
<h4 id="query-parameters-1">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
metrics
</td>
<td>
string
</td>
<td>
Comma-separated list of metric names for which we want statistics (default is all). (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns the most recent
<a href="/docs/latest/operate/rs/references/rest-api/objects/statistics/">
statistics
</a>
for a specific database.
</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">"1"</span><span class="p">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"etime"</span><span class="p">:</span> <span class="s2">"2015-06-23T12:05:08Z"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"used_memory"</span><span class="p">:</span> <span class="mf">5651576.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"no_of_keys"</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"stime"</span><span class="p">:</span> <span class="s2">"2015-06-23T12:05:03Z"</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">
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>
bdb does not exist
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7">
406 Not Acceptable
</a>
</td>
<td>
bdb isn't currently active
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4">
503 Service Unavailable
</a>
</td>
<td>
bdb is in recovery state
</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/stats/last/"/>
<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-info/.html | <section class="prose w-full py-12">
<h1 class="command-name">
CLUSTER INFO
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CLUSTER INFO</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(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>
</dd>
</dl>
<p>
<code>
CLUSTER INFO
</code>
provides
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
style information about Redis Cluster vital parameters.
The following fields are always present in the reply:
</p>
<pre tabindex="0"><code>cluster_state:ok
cluster_slots_assigned:16384
cluster_slots_ok:16384
cluster_slots_pfail:0
cluster_slots_fail:0
cluster_known_nodes:6
cluster_size:3
cluster_current_epoch:6
cluster_my_epoch:2
cluster_stats_messages_sent:1483972
cluster_stats_messages_received:1483968
total_cluster_links_buffer_limit_exceeded:0
</code></pre>
<ul>
<li>
<code>
cluster_state
</code>
: State is
<code>
ok
</code>
if the node is able to receive queries.
<code>
fail
</code>
if there is at least one hash slot which is unbound (no node associated), in error state (node serving it is flagged with FAIL flag), or if the majority of masters can't be reached by this node.
</li>
<li>
<code>
cluster_slots_assigned
</code>
: Number of slots which are associated to some node (not unbound). This number should be 16384 for the node to work properly, which means that each hash slot should be mapped to a node.
</li>
<li>
<code>
cluster_slots_ok
</code>
: Number of hash slots mapping to a node not in
<code>
FAIL
</code>
or
<code>
PFAIL
</code>
state.
</li>
<li>
<code>
cluster_slots_pfail
</code>
: Number of hash slots mapping to a node in
<code>
PFAIL
</code>
state. Note that those hash slots still work correctly, as long as the
<code>
PFAIL
</code>
state is not promoted to
<code>
FAIL
</code>
by the failure detection algorithm.
<code>
PFAIL
</code>
only means that we are currently not able to talk with the node, but may be just a transient error.
</li>
<li>
<code>
cluster_slots_fail
</code>
: Number of hash slots mapping to a node in
<code>
FAIL
</code>
state. If this number is not zero the node is not able to serve queries unless
<code>
cluster-require-full-coverage
</code>
is set to
<code>
no
</code>
in the configuration.
</li>
<li>
<code>
cluster_known_nodes
</code>
: The total number of known nodes in the cluster, including nodes in
<code>
HANDSHAKE
</code>
state that may not currently be proper members of the cluster.
</li>
<li>
<code>
cluster_size
</code>
: The number of master nodes serving at least one hash slot in the cluster.
</li>
<li>
<code>
cluster_current_epoch
</code>
: The local
<code>
Current Epoch
</code>
variable. This is used in order to create unique increasing version numbers during fail overs.
</li>
<li>
<code>
cluster_my_epoch
</code>
: The
<code>
Config Epoch
</code>
of the node we are talking with. This is the current configuration version assigned to this node.
</li>
<li>
<code>
cluster_stats_messages_sent
</code>
: Number of messages sent via the cluster node-to-node binary bus.
</li>
<li>
<code>
cluster_stats_messages_received
</code>
: Number of messages received via the cluster node-to-node binary bus.
</li>
<li>
<code>
total_cluster_links_buffer_limit_exceeded
</code>
: Accumulated count of cluster links freed due to exceeding the
<code>
cluster-link-sendbuf-limit
</code>
configuration.
</li>
</ul>
<p>
The following message-related fields may be included in the reply if the value is not 0:
Each message type includes statistics on the number of messages sent and received.
Here are the explanation of these fields:
</p>
<ul>
<li>
<code>
cluster_stats_messages_ping_sent
</code>
and
<code>
cluster_stats_messages_ping_received
</code>
: Cluster bus PING (not to be confused with the client command
<a href="/docs/latest/commands/ping/">
<code>
PING
</code>
</a>
).
</li>
<li>
<code>
cluster_stats_messages_pong_sent
</code>
and
<code>
cluster_stats_messages_pong_received
</code>
: PONG (reply to PING).
</li>
<li>
<code>
cluster_stats_messages_meet_sent
</code>
and
<code>
cluster_stats_messages_meet_received
</code>
: Handshake message sent to a new node, either through gossip or
<a href="/docs/latest/commands/cluster-meet/">
<code>
CLUSTER MEET
</code>
</a>
.
</li>
<li>
<code>
cluster_stats_messages_fail_sent
</code>
and
<code>
cluster_stats_messages_fail_received
</code>
: Mark node xxx as failing.
</li>
<li>
<code>
cluster_stats_messages_publish_sent
</code>
and
<code>
cluster_stats_messages_publish_received
</code>
: Pub/Sub Publish propagation, see
<a href="/docs/latest/develop/interact/pubsub/#pubsub">
Pubsub
</a>
.
</li>
<li>
<code>
cluster_stats_messages_auth-req_sent
</code>
and
<code>
cluster_stats_messages_auth-req_received
</code>
: Replica initiated leader election to replace its master.
</li>
<li>
<code>
cluster_stats_messages_auth-ack_sent
</code>
and
<code>
cluster_stats_messages_auth-ack_received
</code>
: Message indicating a vote during leader election.
</li>
<li>
<code>
cluster_stats_messages_update_sent
</code>
and
<code>
cluster_stats_messages_update_received
</code>
: Another node slots configuration.
</li>
<li>
<code>
cluster_stats_messages_mfstart_sent
</code>
and
<code>
cluster_stats_messages_mfstart_received
</code>
: Pause clients for manual failover.
</li>
<li>
<code>
cluster_stats_messages_module_sent
</code>
and
<code>
cluster_stats_messages_module_received
</code>
: Module cluster API message.
</li>
<li>
<code>
cluster_stats_messages_publishshard_sent
</code>
and
<code>
cluster_stats_messages_publishshard_received
</code>
: Pub/Sub Publish shard propagation, see
<a href="/docs/latest/develop/interact/pubsub/#sharded-pubsub">
Sharded Pubsub
</a>
.
</li>
</ul>
<p>
More information about the Current Epoch and Config Epoch variables are available in the
<a href="/docs/latest/operate/oss_and_stack/reference/cluster-spec/#cluster-current-epoch">
Redis Cluster specification document
</a>
.
</p>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
: A map between named fields and values in the form of
<code>
<field>:<value>
</code>
lines separated by newlines composed by the two bytes
<code>
CRLF
</code>
.
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Bulk string reply
</a>
: A map between named fields and values in the form of
<field>
:
<value>
lines separated by newlines composed by the two bytes CRLF
<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-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>
</value>
</field>
</section>
|
https://redis.io/docs/latest/operate/rs/7.4/clusters/logging/redis-slow-log/.html | <section class="prose w-full py-12 max-w-none">
<h1>
View Redis slow log
</h1>
<p>
On the
<strong>
Databases
</strong>
>
<strong>
Slowlog
</strong>
page, you can view Slow Log details
for Redis Enterprise Software databases.
</p>
<p>
<a href="http://redis.io/commands/slowlog">
Redis Slow Log
</a>
is one of the best
tools for debugging and tracing your Redis database, especially if you
experience high latency and high CPU usage with Redis operations.
Because Redis is based on a single threaded architecture, Redis Slow Log
can be much more useful than slow log mechanisms of multi-threaded
database systems such as MySQL Slow Query Log.
</p>
<p>
Unlike tools that introduce lock overhead (which complicates the debugging
process), Redis Slow Log is highly effective at showing the actual processing time of each command.
</p>
<p>
Redis Enterprise Software includes enhancements to the standard Redis
Slow Log capabilities that allow you to analyze the execution time
complexity of each command. This enhancement can help you better analyze
Redis operations, allowing you to compare the differences between
execution times of the same command, observe spikes in CPU usage, and
more.
</p>
<p>
This is especially useful with complex commands such as
<a href="http://redis.io/commands/zunionstore">
ZUNIONSTORE
</a>
,
<a href="http://redis.io/commands/zinterstore">
ZINTERSTORE
</a>
and
<a href="http://redis.io/commands/zrangebyscore">
ZRANGEBYSCORE
</a>
.
</p>
<p>
The enhanced Redis Enterprise Software Slow Log adds the
<strong>
Complexity info
</strong>
field to the
output data.
</p>
<p>
View the complexity info data by its respective command in the table
below:
</p>
<table>
<thead>
<tr>
<th>
Command
</th>
<th>
Value of interest
</th>
<th>
Complexity
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
LINSERT
</td>
<td>
N - list len
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
LREM
</td>
<td>
N - list len
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
LTRIM
</td>
<td>
N - number of removed elements
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
PUBLISH
</td>
<td>
N - number of channel subscribers
<br/>
M - number of subscribed patterns
</td>
<td>
O(N+M)
</td>
</tr>
<tr>
<td>
PSUBSCRIBE
</td>
<td>
N - number of patterns client is subscribed to
<br/>
argc - number of arguments passed to the command
</td>
<td>
O(argc*N)
</td>
</tr>
<tr>
<td>
PUNSUBSCRIBE
</td>
<td>
N - number of patterns client is subscribed to
<br/>
M - total number of subscribed patterns
<br/>
argc - number of arguments passed to the command
</td>
<td>
O(argc*(N+M))
</td>
</tr>
<tr>
<td>
SDIFF
</td>
<td>
N - total number of elements in all sets
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
SDIFFSTORE
</td>
<td>
N - total number of elements in all sets
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
SINTER
</td>
<td>
N - number of elements in smallest set
<br/>
argc - number of arguments passed to the command
</td>
<td>
O(argc*N)
</td>
</tr>
<tr>
<td>
SINTERSTORE
</td>
<td>
N - number of elements in smallest set
<br/>
argc - number of arguments passed to the command
</td>
<td>
O(argc*N)
</td>
</tr>
<tr>
<td>
SMEMBERS
</td>
<td>
N - number of elements in a set
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
SORT
</td>
<td>
N - number of elements in the when no sorting list/set/zset
<br/>
M - number of elements in result
</td>
<td>
O(N+M*log(M))O(N)
</td>
</tr>
<tr>
<td>
SUNION
</td>
<td>
N - number of elements in all sets
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
SUNIONSTORE
</td>
<td>
N - number of elements in all sets
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
UNSUBSCRIBE
</td>
<td>
N - total number of clients subscribed to all channels
</td>
<td>
O(N)
</td>
</tr>
<tr>
<td>
ZADD
</td>
<td>
N - number of elements in the zset
</td>
<td>
O(log(N))
</td>
</tr>
<tr>
<td>
ZCOUNT
</td>
<td>
N - number of elements in the zset
<br/>
M - number of elements between min and max
</td>
<td>
O(log(N)+M)
</td>
</tr>
<tr>
<td>
ZINCRBY
</td>
<td>
N - number of elements in the zset
</td>
<td>
O(log(N))
</td>
</tr>
<tr>
<td>
ZINTERSTORE
</td>
<td>
N – number of elements in the smallest zset
<br/>
K – number of zsets
<br/>
M – number of elements in the results set
</td>
<td>
O(N*K)+O(M*log(M))
</td>
</tr>
<tr>
<td>
ZRANGE
</td>
<td>
N – number of elements in the zset
<br/>
M – number of results
</td>
<td>
O(log(N)+M)
</td>
</tr>
<tr>
<td>
ZRANGEBYSCORE
</td>
<td>
N – number of elements in the zset
<br/>
M – number of results
</td>
<td>
O(log(N)+M)
</td>
</tr>
<tr>
<td>
ZRANK
</td>
<td>
N – number of elements in the zset
</td>
<td>
O(log(N))
</td>
</tr>
<tr>
<td>
ZREM
</td>
<td>
N – number of elements in the zset
<br/>
argc – number of arguments passed to the command
</td>
<td>
O(argc*log(N))
</td>
</tr>
<tr>
<td>
ZREMRANGEBYRANK
</td>
<td>
N – number of elements in the zset
<br/>
argc – number of arguments passed to the command
</td>
<td>
O(log(N)+M)
</td>
</tr>
<tr>
<td>
ZREMRANGEBYSCORE
</td>
<td>
N – number of elements in the zset
<br/>
M – number of elements removed
</td>
<td>
O(log(N)+M)
</td>
</tr>
<tr>
<td>
ZREVRANGE
</td>
<td>
N – number of elements in the zset
<br/>
M – number of results
</td>
<td>
O(log(N)+M)
</td>
</tr>
<tr>
<td>
ZREVRANK
</td>
<td>
N – number of elements in the zset
</td>
<td>
O(log(N))
</td>
</tr>
<tr>
<td>
ZUNIONSTORE
</td>
<td>
N – sum of element counts of all zsets
<br/>
M – element count of result
</td>
<td>
O(N)+O(M*log(M))
</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/clusters/logging/redis-slow-log/"/>
<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-passwords/active-active-admin-credentials/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Update admin credentials for Active-Active databases
</h1>
<p class="text-lg -mt-5 mb-10">
Update admin credentials for Active-Active databases.
</p>
<p>
Active-Active databases use administrator credentials to manage operations.
</p>
<p>
To update the administrator user password on a cluster with Active-Active databases:
</p>
<ol>
<li>
<p>
From the user management page, update the administrator user password on the clusters you want to update.
</p>
</li>
<li>
<p>
For each participating cluster
<em>
and
</em>
each Active-Active database, update the admin user credentials to match the changes in step 1.
</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">
Warning:
</div>
Do not perform any management operations on the databases until these steps are complete.
</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/rs/7.4/security/access-control/manage-passwords/active-active-admin-credentials/"/>
<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/exec/.html | <section class="prose w-full py-12">
<h1 class="command-name">
EXEC
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">EXEC</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">
Depends on commands in the transaction
</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>
@transaction
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Executes all previously queued commands in a
<a href="/develop/interact/transactions">
transaction
</a>
and restores the
connection state to normal.
</p>
<p>
When using
<a href="/docs/latest/commands/watch/">
<code>
WATCH
</code>
</a>
,
<code>
EXEC
</code>
will execute commands only if the watched keys were
not modified, allowing for a
<a href="/develop/interact/transactions#cas">
check-and-set mechanism
</a>
.
</p>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: each element being the reply to each of the commands in the atomic transaction.
</li>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
: the transaction was aborted because a
<code>
WATCH
</code>
ed key was touched.
</li>
</ul>
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: each element being the reply to each of the commands in the atomic transaction.
</li>
<li>
<a href="../../develop/reference/protocol-spec#nulls">
Null reply
</a>
: the transaction was aborted because a
<code>
WATCH
</code>
ed key was touched.
</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/exec/"/>
<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/add-node/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Add a cluster node
</h1>
<p class="text-lg -mt-5 mb-10">
Add a node to your existing Redis Enterprise cluster.
</p>
<p>
When you install Redis Enterprise Software on the first node of a cluster, you create the new cluster.
After you install the first node, you can add more nodes to the cluster.
</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>
<p>
Before you add a node to the cluster:
</p>
<ul>
<li>
<p>
The clocks on all nodes must always be
<a href="/docs/latest/operate/rs/7.4/clusters/configure/sync-clocks/">
synchronized
</a>
.
</p>
<p>
If the clock in the node you are trying to join to the cluster is not synchronized with the nodes already in the cluster,
the action fails and an error message is shown indicating that you must synchronize the clocks first.
</p>
</li>
<li>
<p>
You must
<a href="/docs/latest/operate/rs/7.4/networking/cluster-dns/">
update the DNS records
</a>
each time a node is added or replaced.
</p>
</li>
<li>
<p>
We recommend that you add nodes one after the other rather than in parallel
to avoid errors that occur because the connection to the other nodes in the cluster cannot be verified.
</p>
</li>
</ul>
</div>
</div>
<p>
To add a node to an existing cluster:
</p>
<ol>
<li>
<p>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/">
Install the Redis Enterprise Software installation package
</a>
on a clean installation
of a
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/supported-platforms/">
supported operating system
</a>
.
</p>
</li>
<li>
<p>
To connect to the Cluster Manager UI of the new Redis Enterprise Software installation, go to: <https://URL or IP address:8443>
</p>
<p>
For example, if you installed Redis Enterprise Software on a machine with IP address 10.0.1.34, go to
<code>
https://10.0.1.34:8443
</code>
.
</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>
The management UI uses TLS encryption with a default certificate.
You can also
<a href="/docs/latest/operate/rs/7.4/security/certificates/updating-certificates/">
replace the TLS certificate
</a>
with a custom certificate.
</div>
</div>
</li>
<li>
<p>
Select
<strong>
Join cluster
</strong>
.
</p>
</li>
<li>
<p>
For
<strong>
Cluster identification
</strong>
, enter the internal IP address or DNS name of a node that is a cluster member.
</p>
<p>
If the node only has one IP address, enter that IP address.
</p>
</li>
<li>
<p>
For
<strong>
Cluster sign in
</strong>
, enter the credentials of the cluster administrator.
</p>
<p>
The cluster administrator is the user account that you create when you configure the first node in the cluster.
</p>
</li>
<li>
<p>
Click
<strong>
Next
</strong>
.
</p>
</li>
<li>
<p>
Configure storage and network settings:
</p>
<ol>
<li>
<p>
Enter a path for
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
<em>
Ephemeral storage
</em>
</a>
, or leave the default path.
</p>
</li>
<li>
<p>
Enter a path for
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/install/plan-deployment/persistent-ephemeral-storage/">
<em>
Persistent storage
</em>
</a>
,
or leave the default path.
</p>
</li>
<li>
<p>
To enable
<a href="/docs/latest/operate/rs/7.4/databases/auto-tiering/">
<em>
Auto Tiering
</em>
</a>
,
select
<strong>
Enable flash storage
</strong>
and enter the path to the flash storage.
</p>
</li>
<li>
<p>
If the cluster is configured to support
<a href="/docs/latest/operate/rs/7.4/clusters/configure/rack-zone-awareness/">
rack-zone awareness
</a>
, set the
<strong>
Rack-zone ID
</strong>
for the new node.
</p>
</li>
<li>
<p>
If your machine has multiple IP addresses, assign a single IPv4 type address for
<strong>
Node-to-node communication (internal traffic)
</strong>
and multiple IPv4/IPv6 type addresses for
<strong>
External traffic
</strong>
.
</p>
</li>
</ol>
</li>
<li>
<p>
Select
<strong>
Join cluster
</strong>
.
</p>
</li>
</ol>
<p>
The node is added to the cluster.
You can see it in the list of nodes in the cluster.
</p>
<p>
If you see an error when you add the node, try adding the node again.
</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>
We recommend that you run the
<a href="/docs/latest/operate/rs/7.4/references/cli-utilities/rlcheck/">
rlcheck utility
</a>
to verify that the node is functioning properly.
</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/rs/7.4/clusters/add-node/"/>
<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/classes/gearsfuture/setresult/.html | <section class="prose w-full py-12 max-w-none">
<h1>
SetResult
</h1>
<p class="text-lg -mt-5 mb-10">
Sets a computation to run asynchronously.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><span class="kd">public</span> <span class="kt">void</span> <span class="n">setResult</span><span class="err"></span><span class="o">(</span><span class="n">I</span> <span class="n">result</span><span class="o">)</span>
</span></span><span class="line"><span class="cl"> <span class="kd">throws</span> <span class="n">java</span><span class="o">.</span><span class="na">lang</span><span class="o">.</span><span class="na">Exception</span>
</span></span></code></pre>
</div>
<p>
Sets a computation to run asynchronously.
</p>
<h2 id="parameters">
Parameters
</h2>
<table>
<thead>
<tr>
<th>
Name
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
result
</td>
<td>
template type I
</td>
<td>
The result of a computation
</td>
</tr>
</tbody>
</table>
<h2 id="returns">
Returns
</h2>
<p>
None
</p>
<h2 id="example">
Example
</h2>
<div class="highlight">
<pre class="chroma"><code class="language-java" data-lang="java"><span class="line"><span class="cl"><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 class="na">map</span><span class="o">(</span><span class="n">r</span><span class="o">-></span><span class="n">r</span><span class="o">.</span><span class="na">getKey</span><span class="o">()).</span>
</span></span><span class="line"><span class="cl"> <span class="n">asyncFilter</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">GearsFuture</span><span class="o"><</span><span class="n">Boolean</span><span class="o">></span> <span class="n">f</span> <span class="o">=</span> <span class="k">new</span> <span class="n">GearsFuture</span><span class="o"><</span><span class="n">Boolean</span><span class="o">>();</span>
</span></span><span class="line"><span class="cl"> <span class="k">try</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">f</span><span class="o">.</span><span class="na">setResult</span><span class="o">(</span><span class="n">r</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="s">"x"</span><span class="o">));</span>
</span></span><span class="line"><span class="cl"> <span class="o">}</span> <span class="k">catch</span> <span class="o">(</span><span class="n">Exception</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl"> <span class="n">e</span><span class="o">.</span><span class="na">printStackTrace</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="k">return</span> <span class="n">f</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><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/oss_and_stack/stack-with-enterprise/gears-v1/jvm/classes/gearsfuture/setresult/"/>
<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/module-list/.html | <section class="prose w-full py-12">
<h1 class="command-name">
MODULE LIST
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">MODULE LIST</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">
O(N) where N is the number of loaded modules.
</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>
Returns information about the modules loaded to the server.
</p>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<p>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: list of loaded modules. Each element in the list represents a represents a module, and is in itself a list of property names and their values. The following properties is reported for each loaded module:
</p>
<ul>
<li>
name: the name of the module.
</li>
<li>
ver: the version of the module.
</li>
</ul>
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<p>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: list of loaded modules. Each element in the list represents a represents a module, and is a
<a href="../../develop/reference/protocol-spec#maps">
Map reply
</a>
of property names and their values. The following properties is reported for each loaded module:
</p>
<ul>
<li>
name: the name of the module.
</li>
<li>
ver: the version of the module.
</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/module-list/"/>
<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/pexpire/.html | <section class="prose w-full py-12">
<h1 class="command-name">
PEXPIRE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">PEXPIRE key milliseconds [NX | XX | GT | LT]</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.6.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>
@keyspace
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@write
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
This command works exactly like
<a href="/docs/latest/commands/expire/">
<code>
EXPIRE
</code>
</a>
but the time to live of the key is
specified in milliseconds instead of seconds.
</p>
<h2 id="options">
Options
</h2>
<p>
The
<code>
PEXPIRE
</code>
command supports a set of options since Redis 7.0:
</p>
<ul>
<li>
<code>
NX
</code>
-- Set expiry only when the key has no expiry
</li>
<li>
<code>
XX
</code>
-- Set expiry only when the key has an existing expiry
</li>
<li>
<code>
GT
</code>
-- Set expiry only when the new expiry is greater than current one
</li>
<li>
<code>
LT
</code>
-- Set expiry only when the new expiry is less than current one
</li>
</ul>
<p>
A non-volatile key is treated as an infinite TTL for the purpose of
<code>
GT
</code>
and
<code>
LT
</code>
.
The
<code>
GT
</code>
,
<code>
LT
</code>
and
<code>
NX
</code>
options are mutually exclusive.
</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> SET mykey "Hello"
"OK"
redis> PEXPIRE mykey 1500
(integer) 1
redis> TTL mykey
(integer) 2
redis> PTTL mykey
(integer) 1499
redis> PEXPIRE mykey 1000 XX
(integer) 1
redis> TTL mykey
(integer) 1
redis> PEXPIRE mykey 1000 NX
(integer) 0
redis> TTL mykey
(integer) 1
</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>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
:
<code>
0
</code>
if the timeout was not set. For example, if the key doesn't exist, or the operation skipped because of the provided arguments.
</li>
<li>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
:
<code>
1
</code>
if the timeout was set.
</li>
</ul>
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 7.0.0: Added options:
<code>
NX
</code>
,
<code>
XX
</code>
,
<code>
GT
</code>
and
<code>
LT
</code>
.
</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/pexpire/"/>
<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/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Cloud
</h1>
<p class="text-lg -mt-5 mb-10">
The fastest way to set up Redis - a fully managed Redis database on major public cloud services.
</p>
<p>
<a href="https://redis.io/cloud/">
Redis Cloud
</a>
is a fully managed database-as-a-service that brings the speed and reliability of Redis to the cloud, offering seamless scalability and high availability for modern applications.
</p>
<p>
With Redis Cloud, you get all of the features of Redis Software, including:
</p>
<ul>
<li>
<a href="/docs/latest/develop/">
Redis
</a>
and
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/">
Redis Stack
</a>
support
</li>
<li>
Linear scalability
</li>
<li>
Instant failover, backups, and recovery
</li>
<li>
Predictable performance
</li>
<li>
24/7 monitoring and support
</li>
</ul>
<p>
<a href="https://redis.io/try-free/">
Try Redis Cloud
</a>
to set up your free 30MB database.
</p>
<h2 id="get-started">
Get started
</h2>
<p>
Use the
<a href="/docs/latest/operate/rc/rc-quickstart/">
Quick start
</a>
to learn how to create your free database.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/rc-quickstart/#using-rediscli">
Connect with redis-cli
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/rc-quickstart/#using-redis-client">
Connect with Redis client
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/rc-quickstart/#using-redisinsight">
Connect with Redis Insight
</a>
</li>
</ul>
<h2 id="databases">
Databases
</h2>
<p>
Create and manage
<a href="/docs/latest/operate/rc/databases/">
Redis databases
</a>
in the cloud.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/databases/create-database/">
Create database
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/databases/view-edit-database/">
View and edit databases
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/databases/monitor-performance/">
Monitor performance
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/databases/configuration/">
Manage databases
</a>
</li>
<li>
<a href="/docs/latest/commands/">
Redis commands
</a>
&
<a href="/docs/latest/operate/rc/compatibility/">
compatibility
</a>
</li>
</ul>
<h2 id="subscriptions">
Subscriptions
</h2>
<p>
Learn about the
<a href="/docs/latest/operate/rc/subscriptions/">
types of subscriptions
</a>
.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/subscriptions/view-essentials-subscription/">
View and upgrade Essentials plan
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/subscriptions/view-essentials-subscription/essentials-plan-details/">
Essentials plans
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/subscriptions/view-pro-subscription/">
View and edit Pro plan
</a>
</li>
</ul>
<h2 id="accounts--settings">
Accounts & settings
</h2>
<p>
Manage Redis Cloud
<a href="/docs/latest/operate/rc/accounts/">
accounts and settings
</a>
.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/billing-and-payments/">
Billing and payments
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/cloud-integrations/">
Manage marketplace integrations
</a>
</li>
</ul>
<h2 id="security">
Security
</h2>
<p>
Manage
<a href="/docs/latest/operate/rc/security/">
secure connections
</a>
to cloud databases.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/security/access-control/access-management/">
Access management
</a>
for Redis Cloud console security and account management
</li>
<li>
<a href="/docs/latest/operate/rc/security/database-security/">
Cloud database security
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/multi-factor-authentication/">
Multi-factor authentication
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/saml-sso/">
Single sign-on
</a>
and
<a href="/docs/latest/operate/rc/security/access-control/social-login/">
social login
</a>
</li>
<li>
<a href="/docs/latest/operate/rc/security/access-control/data-access-control/">
Data access control
</a>
</li>
</ul>
<h2 id="rest-api">
REST API
</h2>
<p>
Use the
<a href="/docs/latest/operate/rc/api/">
REST API
</a>
to manage the database.
</p>
<ul>
<li>
<a href="/docs/latest/operate/rc/api/get-started/">
Get started with the REST API
</a>
</li>
<li>
REST API
<a href="https://api.redislabs.com/v1/swagger-ui.html">
reference
</a>
&
<a href="/docs/latest/operate/rc/api/examples/">
examples
</a>
</li>
</ul>
<h2 id="related-info">
Related info
</h2>
<ul>
<li>
<a href="/docs/latest/operate/rs/">
Redis Enterprise Software
</a>
</li>
<li>
<a href="/docs/latest/develop/">
Develop with Redis
</a>
</li>
<li>
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/">
Redis Stack
</a>
</li>
<li>
<a href="/docs/latest/glossary/">
Glossary
</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/rc/"/>
<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.initbyprob.html | <section class="prose w-full py-12">
<h1 class="command-name">
CMS.INITBYPROB
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">CMS.INITBYPROB key error probability</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 accommodate requested tolerances.
</p>
<h3 id="parameters">
Parameters:
</h3>
<ul>
<li>
<strong>
key
</strong>
: The name of the sketch.
</li>
<li>
<strong>
error
</strong>
: Estimate size of error. The error is a percent of total counted
items. This effects the width of the sketch.
</li>
<li>
<strong>
probability
</strong>
: The desired probability for inflated count. This should
be a decimal value between 0 and 1. This effects the depth of the sketch.
For example, for a desired false positive rate of 0.1% (1 in 1000),
error_rate should be set to 0.001. The closer this number is to zero, the
greater the memory consumption per item and the more CPU usage per operation.
</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.INITBYPROB test 0.001 0.01
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.initbyprob/"/>
<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/topk.incrby/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TOPK.INCRBY
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TOPK.INCRBY key item increment [item increment ...]</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(n * k * incr) where n is the number of items, k is the depth and incr is the increment
</dd>
</dl>
<p>
Increase the score of an item in the data structure by increment.
Multiple items' score can be increased at once.
If an item enters the Top-K list, the item which is expelled is returned.
</p>
<h3 id="parameters">
Parameters
</h3>
<ul>
<li>
<strong>
key
</strong>
: Name of sketch where item is added.
</li>
<li>
<strong>
item
</strong>
: Item/s to be added.
</li>
<li>
<strong>
increment
</strong>
: increment to current item score. Increment must be greater or equal to 1. Increment is limited to 100,000 to avoid server freeze.
</li>
</ul>
<h2 id="return">
Return
</h2>
<p>
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
of
<a href="/docs/latest/develop/reference/protocol-spec/#simple-strings">
Simple string reply
</a>
- if an element was dropped from the TopK list,
<a href="/docs/latest/develop/reference/protocol-spec/#bulk-strings">
Nil reply
</a>
otherwise..
</p>
<p>
@example
</p>
<pre tabindex="0"><code>redis> TOPK.INCRBY topk foo 3 bar 2 42 30
1) (nil)
2) (nil)
3) foo
</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/topk.incrby/"/>
<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/install/install-stack/windows/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Install Redis Stack on Windows
</h1>
<p class="text-lg -mt-5 mb-10">
How to install Redis Stack on Windows
</p>
<p>
To install Redis Stack on Windows, you will need to have Docker installed. When Docker is up and running, open Windows PowerShell and follow the instructions described in
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/docker/">
Run Redis Stack on Docker
</a>
. Then, use Docker to connect with
<code>
redis-cli
</code>
as explained in that topic.
</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">
About using WSL and Ubuntu for Windows :
</div>
<p>
If you attempt to use Windows Subsystem for Linux (WSL) or Ubuntu for Windows to follow
<a href="/docs/latest/operate/oss_and_stack/install/install-stack/linux/">
Linux instructions
</a>
, you will get a
<code>
systemd
</code>
error telling you
<code>
System has not been booted with systemd as init system (PID 1). Can't operate.
</code>
Do not fret. Just use Docker.
</p>
<p>
<em>
<code>
systemd
</code>
is a suite of basic building blocks for a Linux system.
</em>
For more information about its function, see
<a href="https://systemd.io/">
System and Service Manager
</a>
. This becomes an issue due to the lack of support for Linux workflows on WSL. But, you can test the instructions listed in
<a href="https://devblogs.microsoft.com/commandline/systemd-support-is-now-available-in-wsl/">
Systemd support is now available in WSL!
</a>
. Let us know how that worked for you.
</p>
</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/install/install-stack/windows/"/>
<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/data-types/geospatial/.html | <section class="prose w-full py-12">
<h1>
Redis geospatial
</h1>
<p class="text-lg -mt-5 mb-10">
Introduction to the Redis Geospatial data type
</p>
<p>
Redis geospatial indexes let you store coordinates and search for them.
This data structure is useful for finding nearby points within a given radius or bounding box.
</p>
<h2 id="basic-commands">
Basic commands
</h2>
<ul>
<li>
<a href="/docs/latest/commands/geoadd/">
<code>
GEOADD
</code>
</a>
adds a location to a given geospatial index (note that longitude comes before latitude with this command).
</li>
<li>
<a href="/docs/latest/commands/geosearch/">
<code>
GEOSEARCH
</code>
</a>
returns locations with a given radius or a bounding box.
</li>
</ul>
<p>
See the
<a href="/docs/latest/commands/?group=geo">
complete list of geospatial index commands
</a>
.
</p>
<h2 id="examples">
Examples
</h2>
<p>
Suppose you're building a mobile app that lets you find all of the bike rental stations closest to your current location.
</p>
<p>
Add several locations to a geospatial index:
</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="geo_tutorial-stepgeoadd">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_geo_tutorial-stepgeoadd" name="geo_tutorial-stepgeoadd" 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_geo_tutorial-stepgeoadd" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeoadd" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_geo_tutorial-stepgeoadd" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> GEOADD bikes:rentable -122.27652 37.805186 station:1
</span></span><span class="line hl"><span class="cl">(integer) 1
</span></span><span class="line hl"><span class="cl">> GEOADD bikes:rentable -122.2674626 37.8062344 station:2
</span></span><span class="line hl"><span class="cl">(integer) 1
</span></span><span class="line hl"><span class="cl">> GEOADD bikes:rentable -122.2469854 37.8104049 station:3
</span></span><span class="line hl"><span class="cl">(integer) 1</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_geo_tutorial-stepgeoadd')" 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_geo_tutorial-stepgeoadd" name="geo_tutorial-stepgeoadd" 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_geo_tutorial-stepgeoadd" title="Open example">
Python
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeoadd" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_geo_tutorial-stepgeoadd" 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 Geospatial doc pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/data-types/geospatial/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</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></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">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 hl"><span class="cl"><span class="n">res1</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geoadd</span><span class="p">(</span><span class="s2">"bikes:rentable"</span><span class="p">,</span> <span class="p">[</span><span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span> <span class="mf">37.805186</span><span class="p">,</span> <span class="s2">"station:1"</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">res1</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res2</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geoadd</span><span class="p">(</span><span class="s2">"bikes:rentable"</span><span class="p">,</span> <span class="p">[</span><span class="o">-</span><span class="mf">122.2674626</span><span class="p">,</span> <span class="mf">37.8062344</span><span class="p">,</span> <span class="s2">"station:2"</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">res2</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">res3</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geoadd</span><span class="p">(</span><span class="s2">"bikes:rentable"</span><span class="p">,</span> <span class="p">[</span><span class="o">-</span><span class="mf">122.2469854</span><span class="p">,</span> <span class="mf">37.8104049</span><span class="p">,</span> <span class="s2">"station:3"</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">res3</span><span class="p">)</span> <span class="c1"># >>> 1</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">res4</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geosearch</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">longitude</span><span class="o">=-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">latitude</span><span class="o">=</span><span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">radius</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">unit</span><span class="o">=</span><span class="s2">"km"</span><span class="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">res4</span><span class="p">)</span> <span class="c1"># >>> ['station:1', 'station:2', 'station:3']</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_Python_geo_tutorial-stepgeoadd')" 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_geo_tutorial-stepgeoadd" 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/dt_geo.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_geo_tutorial-stepgeoadd" name="geo_tutorial-stepgeoadd" 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_geo_tutorial-stepgeoadd" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeoadd" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_geo_tutorial-stepgeoadd" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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></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="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></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">res1</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoAdd</span><span class="p">(</span><span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">member</span><span class="o">:</span> <span class="s1">'station:1'</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">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">)</span> <span class="c1">// 1
</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="kr">const</span> <span class="nx">res2</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoAdd</span><span class="p">(</span><span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.2674626</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.8062344</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">member</span><span class="o">:</span> <span class="s1">'station:2'</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">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">)</span> <span class="c1">// 1
</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="kr">const</span> <span class="nx">res3</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoAdd</span><span class="p">(</span><span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.2469854</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.8104049</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">member</span><span class="o">:</span> <span class="s1">'station:3'</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">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">)</span> <span class="c1">// 1
</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="kr">const</span> <span class="nx">res4</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoSearch</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.805186</span><span class="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="nx">radius</span><span class="o">:</span> <span class="mi">5</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">unit</span><span class="o">:</span> <span class="s1">'km'</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">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">)</span> <span class="c1">// ['station:1', 'station:2', 'station:3']
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">quit</span><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_Nodejs_geo_tutorial-stepgeoadd')" 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_geo_tutorial-stepgeoadd" 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/dt-geo.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_geo_tutorial-stepgeoadd" name="geo_tutorial-stepgeoadd" 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_geo_tutorial-stepgeoadd" title="Open example">
Java
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeoadd" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_geo_tutorial-stepgeoadd" 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">redis.clients.jedis.GeoCoordinate</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.UnifiedJedis</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.args.GeoUnit</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.resps.GeoRadiusResponse</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.util.List</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.stream.Collectors</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 static</span> <span class="nn">org.junit.Assert.assertEquals</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">GeoExample</span> <span class="o">{</span>
</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="k">try</span> <span class="o">(</span><span class="n">UnifiedJedis</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">UnifiedJedis</span><span class="o">(</span><span class="s">"redis://localhost:6379"</span><span class="o">))</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">long</span> <span class="n">res1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geoadd</span><span class="o">(</span><span class="s">"bikes:rentable"</span><span class="o">,</span> <span class="o">-</span><span class="mf">122.27652</span><span class="o">,</span> <span class="mf">37.805186</span><span class="o">,</span> <span class="s">"station:1"</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">res1</span><span class="o">);</span> <span class="c1">// 1
</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="kt">long</span> <span class="n">res2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geoadd</span><span class="o">(</span><span class="s">"bikes:rentable"</span><span class="o">,</span> <span class="o">-</span><span class="mf">122.2674626</span><span class="o">,</span> <span class="mf">37.8062344</span><span class="o">,</span> <span class="s">"station:2"</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">res2</span><span class="o">);</span> <span class="c1">// 1
</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="kt">long</span> <span class="n">res3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geoadd</span><span class="o">(</span><span class="s">"bikes:rentable"</span><span class="o">,</span> <span class="o">-</span><span class="mf">122.2469854</span><span class="o">,</span> <span class="mf">37.8104049</span><span class="o">,</span> <span class="s">"station:3"</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">res2</span><span class="o">);</span> <span class="c1">// 1
</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">List</span><span class="o"><</span><span class="n">GeoRadiusResponse</span><span class="o">></span> <span class="n">res4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geosearch</span><span class="o">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"bikes:rentable"</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">GeoCoordinate</span><span class="o">(-</span><span class="mf">122.27652</span><span class="o">,</span> <span class="mf">37.805186</span><span class="o">),</span>
</span></span><span class="line"><span class="cl"> <span class="mi">5</span><span class="o">,</span>
</span></span><span class="line"><span class="cl"> <span class="n">GeoUnit</span><span class="o">.</span><span class="na">KM</span>
</span></span><span class="line"><span class="cl"> <span class="o">);</span>
</span></span><span class="line"><span class="cl"> <span class="n">List</span><span class="o"><</span><span class="n">String</span><span class="o">></span> <span class="n">members</span> <span class="o">=</span> <span class="n">res4</span><span class="o">.</span><span class="na">stream</span><span class="o">()</span> <span class="c1">//
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="o">.</span><span class="na">map</span><span class="o">(</span><span class="n">GeoRadiusResponse</span><span class="o">::</span><span class="n">getMemberByString</span><span class="o">)</span> <span class="c1">//
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="o">.</span><span class="na">collect</span><span class="o">(</span><span class="n">Collectors</span><span class="o">.</span><span class="na">toList</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">members</span><span class="o">);</span> <span class="c1">// [station:1, station:2, station:3]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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 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_geo_tutorial-stepgeoadd')" 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_geo_tutorial-stepgeoadd" 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/GeoExample.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="go" id="Go_geo_tutorial-stepgeoadd" name="geo_tutorial-stepgeoadd" 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="Go_geo_tutorial-stepgeoadd" title="Open example">
Go
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeoadd" class="panel order-last hidden w-full mt-0 relative" id="panel_Go_geo_tutorial-stepgeoadd" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nx">example_commands_test</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"context"</span>
</span></span><span class="line"><span class="cl"> <span class="s">"fmt"</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">"github.com/redis/go-redis/v9"</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></span><span class="line"><span class="cl"><span class="kd">func</span> <span class="nf">ExampleClient_geoadd</span><span class="p">()</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ctx</span> <span class="o">:=</span> <span class="nx">context</span><span class="p">.</span><span class="nf">Background</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="nx">rdb</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">"localhost:6379"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Password</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> <span class="c1">// no password docs
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">DB</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1">// use default DB
</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></span><span class="line hl"><span class="cl"> <span class="nx">res1</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoAdd</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoLocation</span><span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Name</span><span class="p">:</span> <span class="s">"station:1"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}).</span><span class="nf">Result</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="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</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="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res1</span><span class="p">)</span> <span class="c1">// >>> 1
</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="nx">res2</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoAdd</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoLocation</span><span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.2674626</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.8062344</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Name</span><span class="p">:</span> <span class="s">"station:2"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}).</span><span class="nf">Result</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="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</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="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res2</span><span class="p">)</span> <span class="c1">// >>> 1
</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="nx">res3</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoAdd</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoLocation</span><span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.2469854</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.8104049</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Name</span><span class="p">:</span> <span class="s">"station:3"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">}).</span><span class="nf">Result</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="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</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="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res3</span><span class="p">)</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">func</span> <span class="nf">ExampleClient_geosearch</span><span class="p">()</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ctx</span> <span class="o">:=</span> <span class="nx">context</span><span class="p">.</span><span class="nf">Background</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="nx">rdb</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">"localhost:6379"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Password</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> <span class="c1">// no password docs
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">DB</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1">// use default DB
</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></span><span class="line"><span class="cl"> <span class="nx">res4</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoSearch</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoSearchQuery</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Radius</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">RadiusUnit</span><span class="p">:</span> <span class="s">"km"</span><span class="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="nf">Result</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</span><span 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">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res4</span><span class="p">)</span> <span class="c1">// >>> [station:1 station:2 station:3]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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_Go_geo_tutorial-stepgeoadd')" 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_Go_geo_tutorial-stepgeoadd" 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/go/" tabindex="1" title="Quick-Start">
Go 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/go-redis/tree/master/doctests/geo_tutorial_test.go" 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_geo_tutorial-stepgeoadd" name="geo_tutorial-stepgeoadd" 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_geo_tutorial-stepgeoadd" title="Open example">
C#
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeoadd" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_geo_tutorial-stepgeoadd" 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.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></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">Geo_tutorial</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">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">muxer</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">muxer</span><span class="p">.</span><span class="n">GetDatabase</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="kt">bool</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoAdd</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span> <span class="p">-</span><span class="m">122.27652</span><span class="p">,</span> <span class="m">37.805186</span><span class="p">,</span> <span class="s">"station:1"</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="n">res1</span><span class="p">);</span> <span class="c1">// >>> True</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">bool</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoAdd</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span> <span class="p">-</span><span class="m">122.2674626</span><span class="p">,</span> <span class="m">37.8062344</span><span class="p">,</span> <span class="s">"station:2"</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="n">res2</span><span class="p">);</span> <span class="c1">// >>> True</span>
</span></span><span class="line hl"><span class="cl">
</span></span><span class="line hl"><span class="cl"> <span class="kt">bool</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoAdd</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span> <span class="p">-</span><span class="m">122.2469854</span><span class="p">,</span> <span class="m">37.8104049</span><span class="p">,</span> <span class="s">"station:3"</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="n">res3</span><span class="p">);</span> <span class="c1">// >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'geoadd' step.</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">GeoRadiusResult</span><span class="p">[]</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoSearch</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">-</span><span class="m">122.27652</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="m">37.805186</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="k">new</span> <span class="n">GeoSearchCircle</span><span class="p">(</span><span class="m">5</span><span class="p">,</span> <span class="n">GeoUnit</span><span class="p">.</span><span class="n">Kilometers</span><span 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">foreach</span> <span class="p">(</span><span class="n">GeoRadiusResult</span> <span class="n">member</span> <span class="k">in</span> <span class="n">res4</span><span class="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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"Member: '{member.Member}', distance: {member.Distance}, position: {member.Position}"</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Member: 'station:1', distance: 0.0001, position: -122.27652043104172 37.80518485897756</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Member: 'station:2', distance: 0.8047, position: -122.26745992898941 37.80623423353753</span>
</span></span><span class="line"><span class="cl"> <span class="c1">// >>> Member: 'station:3', distance: 2.6596, position: -122.24698394536972 37.81040384984464</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'geosearch' step.</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="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</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_Csharp_geo_tutorial-stepgeoadd')" 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_geo_tutorial-stepgeoadd" 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/Geo_tutorial.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>
</p>
<p>
Find all locations within a 5 kilometer radius of a given location, and return the distance to each location:
</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="geo_tutorial-stepgeosearch">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_geo_tutorial-stepgeosearch" name="geo_tutorial-stepgeosearch" 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_geo_tutorial-stepgeosearch" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeosearch" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_geo_tutorial-stepgeosearch" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line hl"><span class="cl">> GEOSEARCH bikes:rentable FROMLONLAT -122.2612767 37.7936847 BYRADIUS 5 km WITHDIST
</span></span><span class="line hl"><span class="cl">1) 1) "station:1"
</span></span><span class="line hl"><span class="cl"> 2) "1.8523"
</span></span><span class="line hl"><span class="cl">2) 1) "station:2"
</span></span><span class="line hl"><span class="cl"> 2) "1.4979"
</span></span><span class="line hl"><span class="cl">3) 1) "station:3"
</span></span><span class="line hl"><span class="cl"> 2) "2.2441"</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_geo_tutorial-stepgeosearch')" 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_geo_tutorial-stepgeosearch" name="geo_tutorial-stepgeosearch" 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_geo_tutorial-stepgeosearch" title="Open example">
Python
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeosearch" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_geo_tutorial-stepgeosearch" 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 Geospatial doc pages:
</span></span></span><span class="line"><span class="cl"><span class="s2"> https://redis.io/docs/latest/develop/data-types/geospatial/
</span></span></span><span class="line"><span class="cl"><span class="s2">"""</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></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">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">res1</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geoadd</span><span class="p">(</span><span class="s2">"bikes:rentable"</span><span class="p">,</span> <span class="p">[</span><span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span> <span class="mf">37.805186</span><span class="p">,</span> <span class="s2">"station:1"</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">res1</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res2</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geoadd</span><span class="p">(</span><span class="s2">"bikes:rentable"</span><span class="p">,</span> <span class="p">[</span><span class="o">-</span><span class="mf">122.2674626</span><span class="p">,</span> <span class="mf">37.8062344</span><span class="p">,</span> <span class="s2">"station: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">res2</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">res3</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geoadd</span><span class="p">(</span><span class="s2">"bikes:rentable"</span><span class="p">,</span> <span class="p">[</span><span class="o">-</span><span class="mf">122.2469854</span><span class="p">,</span> <span class="mf">37.8104049</span><span class="p">,</span> <span class="s2">"station:3"</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">res3</span><span class="p">)</span> <span class="c1"># >>> 1</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">res4</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">geosearch</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s2">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">longitude</span><span class="o">=-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">latitude</span><span class="o">=</span><span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">radius</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">unit</span><span class="o">=</span><span class="s2">"km"</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="nb">print</span><span class="p">(</span><span class="n">res4</span><span class="p">)</span> <span class="c1"># >>> ['station:1', 'station:2', 'station:3']</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_Python_geo_tutorial-stepgeosearch')" 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_geo_tutorial-stepgeosearch" 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/dt_geo.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_geo_tutorial-stepgeosearch" name="geo_tutorial-stepgeosearch" 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_geo_tutorial-stepgeosearch" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeosearch" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_geo_tutorial-stepgeosearch" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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></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="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></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res1</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoAdd</span><span class="p">(</span><span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">member</span><span class="o">:</span> <span class="s1">'station:1'</span>
</span></span><span class="line"><span class="cl"><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="nx">res1</span><span class="p">)</span> <span class="c1">// 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res2</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoAdd</span><span class="p">(</span><span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.2674626</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.8062344</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">member</span><span class="o">:</span> <span class="s1">'station:2'</span>
</span></span><span class="line"><span class="cl"><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="nx">res2</span><span class="p">)</span> <span class="c1">// 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res3</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoAdd</span><span class="p">(</span><span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.2469854</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.8104049</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">member</span><span class="o">:</span> <span class="s1">'station:3'</span>
</span></span><span class="line"><span class="cl"><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="nx">res3</span><span class="p">)</span> <span class="c1">// 1
</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="kr">const</span> <span class="nx">res4</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">geoSearch</span><span class="p">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s1">'bikes:rentable'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">longitude</span><span class="o">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">latitude</span><span class="o">:</span> <span class="mf">37.805186</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 class="nx">radius</span><span class="o">:</span> <span class="mi">5</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">unit</span><span class="o">:</span> <span class="s1">'km'</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">)</span> <span class="c1">// ['station:1', 'station:2', 'station:3']
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">quit</span><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_Nodejs_geo_tutorial-stepgeosearch')" 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_geo_tutorial-stepgeosearch" 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/dt-geo.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_geo_tutorial-stepgeosearch" name="geo_tutorial-stepgeosearch" 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_geo_tutorial-stepgeosearch" title="Open example">
Java
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeosearch" class="panel order-last hidden w-full mt-0 relative" id="panel_Java_geo_tutorial-stepgeosearch" 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">redis.clients.jedis.GeoCoordinate</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.UnifiedJedis</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.args.GeoUnit</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">redis.clients.jedis.resps.GeoRadiusResponse</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.util.List</span><span class="o">;</span>
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="nn">java.util.stream.Collectors</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 static</span> <span class="nn">org.junit.Assert.assertEquals</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">GeoExample</span> <span class="o">{</span>
</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="k">try</span> <span class="o">(</span><span class="n">UnifiedJedis</span> <span class="n">jedis</span> <span class="o">=</span> <span class="k">new</span> <span class="n">UnifiedJedis</span><span class="o">(</span><span class="s">"redis://localhost:6379"</span><span class="o">))</span> <span class="o">{</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">long</span> <span class="n">res1</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geoadd</span><span class="o">(</span><span class="s">"bikes:rentable"</span><span class="o">,</span> <span class="o">-</span><span class="mf">122.27652</span><span class="o">,</span> <span class="mf">37.805186</span><span class="o">,</span> <span class="s">"station:1"</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">res1</span><span class="o">);</span> <span class="c1">// 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="kt">long</span> <span class="n">res2</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geoadd</span><span class="o">(</span><span class="s">"bikes:rentable"</span><span class="o">,</span> <span class="o">-</span><span class="mf">122.2674626</span><span class="o">,</span> <span class="mf">37.8062344</span><span class="o">,</span> <span class="s">"station:2"</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">res2</span><span class="o">);</span> <span class="c1">// 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="kt">long</span> <span class="n">res3</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geoadd</span><span class="o">(</span><span class="s">"bikes:rentable"</span><span class="o">,</span> <span class="o">-</span><span class="mf">122.2469854</span><span class="o">,</span> <span class="mf">37.8104049</span><span class="o">,</span> <span class="s">"station:3"</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">res2</span><span class="o">);</span> <span class="c1">// 1
</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">List</span><span class="o"><</span><span class="n">GeoRadiusResponse</span><span class="o">></span> <span class="n">res4</span> <span class="o">=</span> <span class="n">jedis</span><span class="o">.</span><span class="na">geosearch</span><span class="o">(</span>
</span></span><span class="line hl"><span class="cl"> <span class="s">"bikes:rentable"</span><span class="o">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">GeoCoordinate</span><span class="o">(-</span><span class="mf">122.27652</span><span class="o">,</span> <span class="mf">37.805186</span><span class="o">),</span>
</span></span><span class="line hl"><span class="cl"> <span class="mi">5</span><span class="o">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="n">GeoUnit</span><span class="o">.</span><span class="na">KM</span>
</span></span><span class="line hl"><span class="cl"> <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">String</span><span class="o">></span> <span class="n">members</span> <span class="o">=</span> <span class="n">res4</span><span class="o">.</span><span class="na">stream</span><span class="o">()</span> <span class="c1">//
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="o">.</span><span class="na">map</span><span class="o">(</span><span class="n">GeoRadiusResponse</span><span class="o">::</span><span class="n">getMemberByString</span><span class="o">)</span> <span class="c1">//
</span></span></span><span class="line hl"><span class="cl"><span class="c1"></span> <span class="o">.</span><span class="na">collect</span><span class="o">(</span><span class="n">Collectors</span><span class="o">.</span><span class="na">toList</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">members</span><span class="o">);</span> <span class="c1">// [station:1, station:2, station:3]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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 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_geo_tutorial-stepgeosearch')" 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_geo_tutorial-stepgeosearch" 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/GeoExample.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="go" id="Go_geo_tutorial-stepgeosearch" name="geo_tutorial-stepgeosearch" 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="Go_geo_tutorial-stepgeosearch" title="Open example">
Go
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeosearch" class="panel order-last hidden w-full mt-0 relative" id="panel_Go_geo_tutorial-stepgeosearch" role="tabpanel" tabindex="0">
<div class="highlight">
<pre class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="kn">package</span> <span class="nx">example_commands_test</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kn">import</span> <span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s">"context"</span>
</span></span><span class="line"><span class="cl"> <span class="s">"fmt"</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="s">"github.com/redis/go-redis/v9"</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></span><span class="line"><span class="cl"><span class="kd">func</span> <span class="nf">ExampleClient_geoadd</span><span class="p">()</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ctx</span> <span class="o">:=</span> <span class="nx">context</span><span class="p">.</span><span class="nf">Background</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="nx">rdb</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">"localhost:6379"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Password</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> <span class="c1">// no password docs
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">DB</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1">// use default DB
</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></span><span class="line"><span class="cl"> <span class="nx">res1</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoAdd</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoLocation</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Name</span><span class="p">:</span> <span class="s">"station:1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}).</span><span class="nf">Result</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</span><span 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">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res1</span><span class="p">)</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="nx">res2</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoAdd</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoLocation</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.2674626</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.8062344</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Name</span><span class="p">:</span> <span class="s">"station:2"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}).</span><span class="nf">Result</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</span><span 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">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res2</span><span class="p">)</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></span>
</span></span><span class="line"><span class="cl"> <span class="nx">res3</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoAdd</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoLocation</span><span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.2469854</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.8104049</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Name</span><span class="p">:</span> <span class="s">"station:3"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">}).</span><span class="nf">Result</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</span><span 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">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res3</span><span class="p">)</span> <span class="c1">// >>> 1
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">func</span> <span class="nf">ExampleClient_geosearch</span><span class="p">()</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ctx</span> <span class="o">:=</span> <span class="nx">context</span><span class="p">.</span><span class="nf">Background</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="nx">rdb</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">"localhost:6379"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">Password</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> <span class="c1">// no password docs
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="nx">DB</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="c1">// use default DB
</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></span><span class="line hl"><span class="cl"> <span class="nx">res4</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">rdb</span><span class="p">.</span><span class="nf">GeoSearch</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="o">&</span><span class="nx">redis</span><span class="p">.</span><span class="nx">GeoSearchQuery</span><span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Longitude</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.27652</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Latitude</span><span class="p">:</span> <span class="mf">37.805186</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">Radius</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">RadiusUnit</span><span class="p">:</span> <span class="s">"km"</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 class="nf">Result</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="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nb">panic</span><span class="p">(</span><span class="nx">err</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="nx">fmt</span><span class="p">.</span><span class="nf">Println</span><span class="p">(</span><span class="nx">res4</span><span class="p">)</span> <span class="c1">// >>> [station:1 station:2 station:3]
</span></span></span><span class="line"><span class="cl"><span class="c1"></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_Go_geo_tutorial-stepgeosearch')" 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_Go_geo_tutorial-stepgeosearch" 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/go/" tabindex="1" title="Quick-Start">
Go 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/go-redis/tree/master/doctests/geo_tutorial_test.go" 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_geo_tutorial-stepgeosearch" name="geo_tutorial-stepgeosearch" 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_geo_tutorial-stepgeosearch" title="Open example">
C#
</label>
<div aria-labelledby="tab-geo_tutorial-stepgeosearch" class="panel order-last hidden w-full mt-0 relative" id="panel_Csharp_geo_tutorial-stepgeosearch" 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.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></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">Geo_tutorial</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">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">muxer</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">muxer</span><span class="p">.</span><span class="n">GetDatabase</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">bool</span> <span class="n">res1</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoAdd</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span> <span class="p">-</span><span class="m">122.27652</span><span class="p">,</span> <span class="m">37.805186</span><span class="p">,</span> <span class="s">"station:1"</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">res1</span><span class="p">);</span> <span class="c1">// >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">bool</span> <span class="n">res2</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoAdd</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span> <span class="p">-</span><span class="m">122.2674626</span><span class="p">,</span> <span class="m">37.8062344</span><span class="p">,</span> <span class="s">"station:2"</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">res2</span><span class="p">);</span> <span class="c1">// >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="kt">bool</span> <span class="n">res3</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoAdd</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span> <span class="p">-</span><span class="m">122.2469854</span><span class="p">,</span> <span class="m">37.8104049</span><span class="p">,</span> <span class="s">"station:3"</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">res3</span><span class="p">);</span> <span class="c1">// >>> True</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'geoadd' step.</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">GeoRadiusResult</span><span class="p">[]</span> <span class="n">res4</span> <span class="p">=</span> <span class="n">db</span><span class="p">.</span><span class="n">GeoSearch</span><span class="p">(</span><span class="s">"bikes:rentable"</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="p">-</span><span class="m">122.27652</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="m">37.805186</span><span class="p">,</span>
</span></span><span class="line hl"><span class="cl"> <span class="k">new</span> <span class="n">GeoSearchCircle</span><span class="p">(</span><span class="m">5</span><span class="p">,</span> <span class="n">GeoUnit</span><span class="p">.</span><span class="n">Kilometers</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="k">foreach</span> <span class="p">(</span><span class="n">GeoRadiusResult</span> <span class="n">member</span> <span class="k">in</span> <span class="n">res4</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">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">$"Member: '{member.Member}', distance: {member.Distance}, position: {member.Position}"</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="c1">// >>> Member: 'station:1', distance: 0.0001, position: -122.27652043104172 37.80518485897756</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Member: 'station:2', distance: 0.8047, position: -122.26745992898941 37.80623423353753</span>
</span></span><span class="line hl"><span class="cl"> <span class="c1">// >>> Member: 'station:3', distance: 2.6596, position: -122.24698394536972 37.81040384984464</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c1">// Tests for 'geosearch' step.</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="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">}</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_Csharp_geo_tutorial-stepgeosearch')" 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_geo_tutorial-stepgeosearch" 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/Geo_tutorial.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>
</p>
<h2 id="learn-more">
Learn more
</h2>
<ul>
<li>
<a href="https://www.youtube.com/watch?v=qftiVQraxmI">
Redis Geospatial Explained
</a>
introduces geospatial indexes by showing you how to build a map of local park attractions.
</li>
<li>
<a href="https://university.redis.com/courses/ru101/">
Redis University's RU101
</a>
covers Redis geospatial indexes in detail.
</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/data-types/geospatial/"/>
<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.arrlen/.html | <section class="prose w-full py-12">
<h1 class="command-name">
JSON.ARRLEN
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">JSON.ARRLEN 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 1.0.0
</a>
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(1) where path is evaluated to a single value, O(N) where path is evaluated to multiple values, where N is the size of the key
</dd>
</dl>
<p>
Report the length of the JSON array at
<code>
path
</code>
in
<code>
key
</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>
, if not provided. Returns null if the
<code>
key
</code>
or
<code>
path
</code>
do not exist.
</p>
</details>
<h2 id="return">
Return
</h2>
<p>
<code>
JSON.ARRLEN
</code>
returns an
<a href="/docs/latest/develop/reference/protocol-spec#resp-arrays">
array
</a>
of integer replies, an integer for each matching value, each is the array's length, or
<code>
nil
</code>
, if the matching value is not an array.
For more information about replies, see
<a href="/docs/latest/develop/reference/protocol-spec/">
Redis serialization protocol specification
</a>
.
</p>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Get lengths of JSON arrays in a document
</b>
</summary>
<p>
Create a document for wireless earbuds.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.SET item:2 $ <span class="s1">'{"name":"Wireless earbuds","description":"Wireless Bluetooth in-ear headphones","connection":{"wireless":true,"type":"Bluetooth"},"price":64.99,"stock":17,"colors":["black","white"], "max_level":[80, 100, 120]}'</span>
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<p>
Find lengths of arrays in all objects of the document.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.ARRLEN item:2 <span class="s1">'$.[*]'</span>
</span></span><span class="line"><span class="cl">1<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> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">3<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">4<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</span></span><span class="line"><span class="cl">5<span class="o">)</span> <span class="o">(</span>nil<span class="o">)</span>
</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">2</span>
</span></span><span class="line"><span class="cl">7<span class="o">)</span> <span class="o">(</span>integer<span class="o">)</span> <span class="m">3</span></span></span></code></pre>
</div>
<p>
Return the length of the
<code>
max_level
</code>
array.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.ARRLEN item:2 <span class="s1">'$..max_level'</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">3</span></span></span></code></pre>
</div>
<p>
Get all the maximum level values.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> JSON.GET item:2 <span class="s1">'$..max_level'</span>
</span></span><span class="line"><span class="cl"><span class="s2">"[[80,100,120]]"</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.arrlen/"/>
<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/cluster/alerts/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Cluster alerts requests
</h1>
<p class="text-lg -mt-5 mb-10">
Cluster alert requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-all-alerts">
GET
</a>
</td>
<td>
<code>
/v1/cluster/alerts
</code>
</td>
<td>
Get all cluster alerts
</td>
</tr>
<tr>
<td>
<a href="#get-alert">
GET
</a>
</td>
<td>
<code>
/v1/cluster/alerts/{alert}
</code>
</td>
<td>
Get a specific cluster alert
</td>
</tr>
</tbody>
</table>
<h2 id="get-all-alerts">
Get all cluster alerts
</h2>
<pre><code>GET /v1/cluster/alerts
</code></pre>
<p>
Get all alert states for the cluster object.
</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_cluster_alerts">
view_cluster_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 /cluster/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>
<h4 id="query-parameters">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
ignore_settings
</td>
<td>
boolean
</td>
<td>
Retrieve updated alert state regardless of the cluster’s alert_settings. When not present, a disabled alert will always be retrieved as disabled with a false state. (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-all-response">
Response
</h3>
<p>
Returns a hash of
<a href="/docs/latest/operate/rs/references/rest-api/objects/alert/">
alert objects
</a>
and their states.
</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">"cluster_too_few_nodes_for_replication"</span><span class="p">:</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-12-22T11:48:00Z"</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">false</span>
</span></span><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="s2">"off"</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="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-alert">
Get cluster alert
</h2>
<pre><code>GET /v1/cluster/alerts/{alert}
</code></pre>
<p>
Get a cluster alert state.
</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_cluster_alerts">
view_cluster_alerts
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request-1">
Example HTTP request
</h4>
<pre><code>GET /cluster/alerts/cluster_too_few_nodes_for_replication
</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="query-parameters-1">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
ignore_settings
</td>
<td>
boolean
</td>
<td>
Retrieve updated alert state regardless of the cluster’s alert_settings. When not present, a disabled alert will always be retrieved as disabled with a false state. (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns an
<a href="/docs/latest/operate/rs/references/rest-api/objects/alert/">
alert 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">"change_time"</span><span class="p">:</span> <span class="s2">"2014-12-22T11:48:00Z"</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">false</span>
</span></span><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="s2">"off"</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="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>
Specified alert 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/cluster/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/rs/references/rest-api/objects/shard/loading/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Loading object
</h1>
<p class="text-lg -mt-5 mb-10">
Documents the loading 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>
progress
</td>
<td>
number, (range: 0-100)
</td>
<td>
Percentage of bytes already loaded
</td>
</tr>
<tr>
<td>
status
</td>
<td>
'in_progress'
<br/>
'idle'
</td>
<td>
Status of the load of a dump file (read-only)
</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/shard/loading/"/>
<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.createrule.html | <section class="prose w-full py-12">
<h1 class="command-name">
TS.CREATERULE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TS.CREATERULE sourceKey destKey
AGGREGATION aggregator bucketDuration
[alignTimestamp]
</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(1)
</dd>
</dl>
<p>
Create a compaction rule
</p>
<p>
<a href="#examples">
Examples
</a>
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
sourceKey
</code>
</summary>
<p>
is key name for the source time series.
</p>
</details>
<details open="">
<summary>
<code>
destKey
</code>
</summary>
<p>
is key name for destination (compacted) time series. It must be created before
<code>
TS.CREATERULE
</code>
is called.
</p>
</details>
<details open="">
<summary>
<code>
AGGREGATION aggregator bucketDuration
</code>
</summary>
<p>
aggregates results into time buckets.
</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 highest and the lowest 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>
<note>
<b>
Notes
</b>
</note>
</p>
<ul>
<li>
Only new samples that are added into the source series after the creation of the rule will be aggregated.
</li>
<li>
Calling
<code>
TS.CREATERULE
</code>
with a nonempty
<code>
destKey
</code>
may result in inconsistencies between the raw and the compacted data.
</li>
<li>
Explicitly adding samples to a compacted time series (using
<a href="/docs/latest/commands/ts.add/">
<code>
TS.ADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.madd/">
<code>
TS.MADD
</code>
</a>
,
<a href="/docs/latest/commands/ts.incrby/">
<code>
TS.INCRBY
</code>
</a>
, or
<a href="/docs/latest/commands/ts.decrby/">
<code>
TS.DECRBY
</code>
</a>
) may result in inconsistencies between the raw and the compacted data. The compaction process may override such samples.
</li>
<li>
If no samples are added to the source time series during a bucket period. no
<em>
compacted sample
</em>
is added to the destination time series.
</li>
<li>
The timestamp of a compacted sample added to the destination time series is set to the start timestamp the appropriate compaction bucket. For example, for a 10-minute compaction bucket with no alignment, the compacted samples timestamps are
<code>
x:00
</code>
,
<code>
x:10
</code>
,
<code>
x:20
</code>
, and so on.
</li>
<li>
Deleting
<code>
destKey
</code>
will cause the compaction rule to be deleted as well.
</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>
On a clustered environment, you must use
<a href="/docs/latest/operate/oss_and_stack/reference/cluster-spec/#hash-tags">
hash tags
</a>
to force
<code>
sourceKey
</code>
and
<code>
destKey
</code>
to be stored in the same hash slot.
</div>
</div>
<h2 id="optional-arguments">
Optional arguments
</h2>
<details open="">
<summary>
<code>
alignTimestamp
</code>
(since RedisTimeSeries v1.8)
</summary>
<p>
ensures that there is a bucket that starts exactly at
<code>
alignTimestamp
</code>
and aligns all other buckets accordingly. It is expressed in milliseconds. The default value is 0: aligned with the Unix epoch.
</p>
<p>
For example, if
<code>
bucketDuration
</code>
is 24 hours (
<code>
24 * 3600 * 1000
</code>
), setting
<code>
alignTimestamp
</code>
to 6 hours after the Unix epoch (
<code>
6 * 3600 * 1000
</code>
) ensures that each bucket’s timeframe is
<code>
[06:00 .. 06:00)
</code>
.
</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/#simple-strings">
Simple string reply
</a>
-
<code>
OK
</code>
if executed correctly
</li>
<li>
[] on error (invalid arguments, wrong key type, etc.), when
<code>
sourceKey
</code>
does not exist, when
<code>
destKey
</code>
does not exist, when
<code>
sourceKey
</code>
is already a destination of a compaction rule, when
<code>
destKey
</code>
is already a source or a destination of a compaction rule, or when
<code>
sourceKey
</code>
and
<code>
destKey
</code>
are identical
</li>
</ul>
<h2 id="examples">
Examples
</h2>
<details open="">
<summary>
<b>
Create a compaction rule
</b>
</summary>
<p>
Create a time series to store the temperatures measured in Tel Aviv.
</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></code></pre>
</div>
<p>
Next, create a compacted time series named
<em>
dailyAvgTemp
</em>
containing one compacted sample per 24 hours: the time-weighted average of all measurements taken from midnight to next midnight.
</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 dailyAvgTemp:TLV LABELS <span class="nb">type</span> temp location TLV
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATERULE temp:TLV dailyAvgTemp:TLV AGGREGATION twa <span class="m">86400000</span> </span></span></code></pre>
</div>
<p>
Now, also create a compacted time series named
<em>
dailyDiffTemp
</em>
. This time series will contain one compacted sample per 24 hours: the difference between the minimum and the maximum temperature measured between 06:00 and 06:00 next day.
Here, 86400000 is the number of milliseconds in 24 hours, 21600000 is the number of milliseconds in 6 hours.
</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 dailyDiffTemp:TLV LABELS <span class="nb">type</span> temp location TLV
</span></span><span class="line"><span class="cl">127.0.0.1:6379> TS.CREATERULE temp:TLV dailyDiffTemp:TLV AGGREGATION range <span class="m">86400000</span> <span class="m">21600000</span></span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ts.deleterule/">
<code>
TS.DELETERULE
</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.createrule/"/>
<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>
</details>
</section>
|
https://redis.io/docs/latest/commands/zscore/.html | <section class="prose w-full py-12">
<h1 class="command-name">
ZSCORE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">ZSCORE key 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(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>
@sortedset
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@fast
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Returns the score of
<code>
member
</code>
in the sorted set at
<code>
key
</code>
.
</p>
<p>
If
<code>
member
</code>
does not exist in the sorted set, or
<code>
key
</code>
does not exist,
<code>
nil
</code>
is
returned.
</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> ZSCORE myzset "one"
"1"
</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 score of the member (a double-precision floating point number), represented as a string.
</li>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
: if
<em>
member
</em>
does not exist in the sorted set, or 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#doubles">
Double reply
</a>
: the score of the member (a double-precision floating point number).
</li>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
: if
<em>
member
</em>
does not exist in the sorted set, or 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/zscore/"/>
<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/tdigest.add/.html | <section class="prose w-full py-12">
<h1 class="command-name">
TDIGEST.ADD
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TDIGEST.ADD key value [value ...]</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.4.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 samples to add
</dd>
</dl>
<p>
Adds one or more observations to a t-digest sketch.
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
is key name for an existing t-digest sketch.
</details>
<details open="">
<summary>
<code>
value
</code>
</summary>
is value of an observation (floating-point).
</details>
<h2 id="return-value">
Return value
</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>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> TDIGEST.ADD t <span class="m">1</span> <span class="m">2</span> <span class="m">3</span>
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> TDIGEST.ADD t string
</span></span><span class="line"><span class="cl"><span class="o">(</span>error<span class="o">)</span> ERR T-Digest: error parsing val parameter</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/tdigest.add/"/>
<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/bzpopmax/.html | <section class="prose w-full py-12">
<h1 class="command-name">
BZPOPMAX
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">BZPOPMAX key [key ...] timeout</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(log(N)) with N being the number of elements in the sorted set.
</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>
<code>
@blocking
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
<code>
BZPOPMAX
</code>
is the blocking variant of the sorted set
<a href="/docs/latest/commands/zpopmax/">
<code>
ZPOPMAX
</code>
</a>
primitive.
</p>
<p>
It is the blocking version because it blocks the connection when there are no
members to pop from any of the given sorted sets.
A member with the highest score is popped from first sorted set that is
non-empty, with the given keys being checked in the order that they are given.
</p>
<p>
The
<code>
timeout
</code>
argument is interpreted as a double value specifying the maximum
number of seconds to block. A timeout of zero can be used to block indefinitely.
</p>
<p>
See the
<a href="/commands/bzpopmin">
BZPOPMIN documentation
</a>
for the exact semantics, since
<code>
BZPOPMAX
</code>
is identical to
<a href="/docs/latest/commands/bzpopmin/">
<code>
BZPOPMIN
</code>
</a>
with the only difference being that it pops members
with the highest scores instead of popping the ones with the lowest scores.
</p>
<h2 id="examples">
Examples
</h2>
<pre tabindex="0"><code>redis> DEL zset1 zset2
(integer) 0
redis> ZADD zset1 0 a 1 b 2 c
(integer) 3
redis> BZPOPMAX zset1 zset2 0
1) "zset1"
2) "c"
3) "2"
</code></pre>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
: when no element could be popped and the
<em>
timeout
</em>
expired.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: the keyname, popped member, and its score.
</li>
</ul>
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#nulls">
Null reply
</a>
: when no element could be popped and the
<em>
timeout
</em>
expired.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: the keyname, popped member, and its score.
</li>
</ul>
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 6.0.0:
<code>
timeout
</code>
is interpreted as a double instead of an integer.
</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/bzpopmax/"/>
<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/release-notes/legacy-release-notes/rs-5-2-2-august-2018/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software 5.2.2 (August 2018)
</h1>
<p>
Redis Enterprise Software (RS) 5.2.2 is now available.
</p>
<p>
RS 5.2.2 is a minor version that includes important fixes and minor enhancements to Redis Enterprise 5.2.
</p>
<h2 id="overview">
Overview
</h2>
<p>
If you are upgrading from a previous version, make sure to review the upgrade instructions before beginning the upgrade process. You can upgrade to RS 5.2.2 from RS 4.5 and above. If you have a version older than 4.5, you should first upgrade to version 5.0 (or at least 4.5).
</p>
<h2 id="new-capabilities">
New capabilities
</h2>
<p>
Support for Redis version 4.0.10
RediSearch Enterprise, which is installed with Redis Enterprise Software by default, has been updated to a newer version (1.4.0)
</p>
<h2 id="important-fixes">
Important fixes
</h2>
<ul>
<li>
RED-21080 – Fixed the memory limit calculation for RoF databases
</li>
<li>
RED-20825 – Updated the ‘RAM limit’ of RoF databases to a range between 10% and 100%
</li>
<li>
RED-20506 – Fixed high CPU and File Descriptors utilization by the node watchdog process (node_wd)
</li>
<li>
RED-20275 – Fixed wrong metrics values while importing a dataset into an RoF database
</li>
<li>
RED-20214 – Fixed obstacles to login to the UI when using an LDAP integration
</li>
<li>
RED-20162 – Fixed known limitation of being able to activate “Require SSL for All Communication” to Redis Enterprise CRDBs via Rest API without providing a certificate
</li>
<li>
RED-19758 – Upgraded NGINX from 1.10.3 to 1.13.12
</li>
<li>
RED-19415, RED-18945 – Improved support for Lettuce client with OSS Cluster enabled
</li>
<li>
RED-19287 – Fixed a scenario of a stuck shard migration process
</li>
<li>
RED-18459 – Updated the data persistence (AOF / Snapshot) of RoF databases to be handled, by default, by the replica shard/s
</li>
<li>
RED-20541– Improved handling of aof file when its tail is corrupted (using aof-load-corrupt-tail flag)
</li>
<li>
RED-21936 – Improved handling of CRDB configuration update when URL parameter was supplied at creation time
</li>
<li>
RED-19760 – Added the capability to control the minimum TLS version that can be used for encrypting the Discovery Service data
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<ul>
<li>
When updating the general settings of a cluster, the ‘username’ and ‘password’ fields in the email server settings cannot be left empty. In case one wants to update the general settings and prefer to leave the ‘username’ and ‘password’ fields empty, the REST API should be used.
</li>
<li>
An issue prevents the user from defining ‘min_data_TLS_version’ on the source cluster when working with Replica Of or CRDB.
</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/release-notes/legacy-release-notes/rs-5-2-2-august-2018/"/>
<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/installing-upgrading/product-lifecycle/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software product lifecycle
</h1>
<p class="text-lg -mt-5 mb-10">
The product lifecycle of Redis Enterprise Software.
</p>
<p>
The Redis Enterprise Software product lifecycle fully reflects the
<a href="https://redis.com/software-subscription-agreement">
subscription agreement
</a>
.
However, for any discrepancy between the two policies, the subscription agreement prevails.
</p>
<p>
Redis Enterprise modules follow the
<a href="/docs/latest/operate/oss_and_stack/stack-with-enterprise/modules-lifecycle/">
modules lifecycle
</a>
.
</p>
<h2 id="release-numbers">
Release numbers
</h2>
<p>
Redis uses a four-place numbering scheme to designate released versions of its products.
The format is “Major1.Major2.Minor-Build”.
</p>
<ul>
<li>
Major sections of the version number represents fundamental changes and additions in
capabilities to Redis Enterprise Software. The Major1 and Major2 part of the
version number are incremented based on the size and scale of the changes in each
release.
</li>
<li>
The Minor section of the version number represents quality improvements, fixes to
existing capabilities, and new capabilities which are typically minor, feature-flagged, or optional.
</li>
<li>
Build number is incremented with any changes to the product. Build number is
incremented with each build when any change is made to the binaries.
</li>
</ul>
<p>
Redis Enterprise Software typically gets two major releases every year but the product shipping cycles may vary.
Maintenance releases, typically available on the last minor release of the current major1.major2 release are typically made available on a monthly cadence, although cycles may vary.
</p>
<h2 id="endoflife-schedule">
End-of-life schedule
</h2>
<p>
For Redis Enterprise Software versions 6.2 and later, the end-of-life (EOL) for each major release occurs 24 months after the formal release of the subsequent major version. Monthly maintenance will be provided on the last minor release of the major1.major2 releases.
This update to the EOL policy allows a lead time of at least 24 months to upgrade to the new release after it is available.
</p>
<table>
<thead>
<tr>
<th>
Version - Release date
</th>
<th>
End of Life (EOL)
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
7.8 – November 2024
</td>
<td>
-
</td>
</tr>
<tr>
<td>
7.4 – February 2024
</td>
<td>
November 30, 2026
</td>
</tr>
<tr>
<td>
7.2 – August 2023
</td>
<td>
February 28, 2026
</td>
</tr>
<tr>
<td>
6.4 – February 2023
</td>
<td>
August 31, 2025
</td>
</tr>
<tr>
<td>
6.2 – August 2021
</td>
<td>
February 28, 2025
</td>
</tr>
<tr>
<td>
6.0 – May 2020
</td>
<td>
May 31, 2022
</td>
</tr>
<tr>
<td>
5.6 – April 2020
</td>
<td>
October 31, 2021
</td>
</tr>
<tr>
<td>
5.4 – December 2018
</td>
<td>
December 31, 2020
</td>
</tr>
<tr>
<td>
5.2 – June 2018
</td>
<td>
December 31, 2019
</td>
</tr>
</tbody>
</table>
<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/installing-upgrading/upgrading/upgrade-cluster/">
Upgrade a Redis Enterprise Software cluster
</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>
Redis Enterprise for Kubernetes has its own support lifecycle, which accounts for the Kubernetes distribution lifecycle. For details, see
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Supported Kubernetes distributions
</a>
.
</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/rs/installing-upgrading/product-lifecycle/"/>
<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/zremrangebyscore/.html | <section class="prose w-full py-12">
<h1 class="command-name">
ZREMRANGEBYSCORE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">ZREMRANGEBYSCORE key min max</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(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
</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>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Removes all elements in the sorted set stored at
<code>
key
</code>
with a score between
<code>
min
</code>
and
<code>
max
</code>
(inclusive).
</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> ZREMRANGEBYSCORE myzset -inf (2
(integer) 1
redis> ZRANGE myzset 0 -1 WITHSCORES
1) "two"
2) "2"
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="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: the number of members removed.
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#integers">
Integer reply
</a>
: Number of members removed.
<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/zremrangebyscore/"/>
<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/supported-platforms/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Supported platforms
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Enterprise Software is supported on several operating systems, cloud environments, and virtual environments.
</p>
<p>
Redis Enterprise Software is supported on several operating systems, cloud environments, and virtual environments.
</p>
<h2 id="supported-platforms">
Supported platforms
</h2>
<p>
<span title="Check mark icon">
✅
</span>
Supported – The platform is supported for this version of Redis Enterprise Software and Redis Stack modules.
</p>
<p>
<span class="font-serif" title="Warning icon">
⚠️
</span>
Deprecation warning – The platform is still supported for this version of Redis Enterprise Software, but support will be removed in a future release.
</p>
<table>
<thead>
<tr>
<th>
Redis Software
<br/>
major versions
</th>
<th style="text-align:center">
7.8
</th>
<th style="text-align:center">
7.4
</th>
<th style="text-align:center">
7.2
</th>
<th style="text-align:center">
6.4
</th>
<th style="text-align:center">
6.2
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<strong>
Release date
</strong>
</td>
<td style="text-align:center">
Nov 2024
</td>
<td style="text-align:center">
Feb 2024
</td>
<td style="text-align:center">
Aug 2023
</td>
<td style="text-align:center">
Feb 2023
</td>
<td style="text-align:center">
Aug 2021
</td>
</tr>
<tr>
<td>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/product-lifecycle/#endoflife-schedule">
<strong>
End-of-life date
</strong>
</a>
</td>
<td style="text-align:center">
Determined after
<br/>
next major release
</td>
<td style="text-align:center">
Nov 2026
</td>
<td style="text-align:center">
Feb 2026
</td>
<td style="text-align:center">
Aug 2025
</td>
<td style="text-align:center">
Feb 2025
</td>
</tr>
<tr>
<td>
<strong>
Platforms
</strong>
</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">
</td>
</tr>
<tr>
<td>
RHEL 9 &
<br/>
compatible distros
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</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">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
</tr>
<tr>
<td>
RHEL 9
<br/>
FIPS mode
<sup>
<a href="#table-note-5">
5
</a>
</sup>
</td>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</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>
</tr>
<tr>
<td>
RHEL 8 &
<br/>
compatible distros
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</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>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
RHEL 7 &
<br/>
compatible distros
<sup>
<a href="#table-note-1">
1
</a>
</sup>
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</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>
Ubuntu 20.04
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</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>
<td style="text-align:center">
–
</td>
</tr>
<tr>
<td>
Ubuntu 18.04
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</span>
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</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>
Ubuntu 16.04
<sup>
<a href="#table-note-2">
2
</a>
</sup>
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
–
</td>
<td style="text-align:center">
<span class="font-serif" title="Deprecated">
⚠️
</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>
Amazon Linux 2
</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>
<td style="text-align:center">
–
</td>
</tr>
<tr>
<td>
Amazon Linux 1
</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>
Kubernetes
<sup>
<a href="#table-note-3">
3
</a>
</sup>
</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>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
<tr>
<td>
Docker
<sup>
<a href="#table-note-4">
4
</a>
</sup>
</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>
<td style="text-align:center">
<span title="Supported">
✅
</span>
</td>
</tr>
</tbody>
</table>
<ol>
<li>
<p>
<a name="table-note-1">
</a>
The RHEL-compatible distributions CentOS, CentOS Stream, Alma, and Rocky are supported if they have full RHEL compatibility. Oracle Linux running the Red Hat Compatible Kernel (RHCK) is supported, but the Unbreakable Enterprise Kernel (UEK) is not supported.
</p>
</li>
<li>
<p>
<a name="table-note-2">
</a>
The server version of Ubuntu is recommended for production installations. The desktop version is only recommended for development deployments.
</p>
</li>
<li>
<p>
<a name="table-note-3">
</a>
See the
<a href="/docs/latest/operate/kubernetes/reference/supported_k8s_distributions/">
Redis Enterprise for Kubernetes documentation
</a>
for details about support per version and Kubernetes distribution.
</p>
</li>
<li>
<p>
<a name="table-note-4">
</a>
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/quickstarts/docker-quickstart/">
Docker images
</a>
of Redis Enterprise Software are certified for development and testing only.
</p>
</li>
<li>
<p>
<a name="table-note-5">
</a>
Supported only if
<a href="https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/security_hardening/switching-rhel-to-fips-mode_security-hardening#proc_installing-the-system-with-fips-mode-enabled_switching-rhel-to-fips-mode">
FIPS was enabled during RHEL installation
</a>
to ensure FIPS compliance.
</p>
</li>
</ol>
<p>
The following table shows which Redis Enterprise Software version first tested and added support for each RHEL version:
</p>
<table>
<thead>
<tr>
<th>
RHEL version
</th>
<th>
Redis Enterprise version
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
8.4
</td>
<td>
6.2.8
</td>
</tr>
<tr>
<td>
8.5
</td>
<td>
6.2.10
</td>
</tr>
<tr>
<td>
8.6
</td>
<td>
6.2.10
</td>
</tr>
<tr>
<td>
8.7
</td>
<td>
6.4.2
</td>
</tr>
<tr>
<td>
8.8
</td>
<td>
6.4.2
</td>
</tr>
<tr>
<td>
8.9
</td>
<td>
7.2.4
</td>
</tr>
<tr>
<td>
9.3
</td>
<td>
7.4.2
</td>
</tr>
</tbody>
</table>
<h2 id="operating-system-compatibility-policy">
Operating system compatibility policy
</h2>
<p>
Redis maintains a list of
<a href="#supported-platforms">
supported operating systems
</a>
for each major version of Redis Enterprise Software and the specific OS versions tested with Redis Enterprise releases. Because the list is updated as new OS versions are introduced and old ones become obsolete, we encourage you to check the list and plan upgrades accordingly. We also suggest you keep Redis Enterprise and corresponding supported OS versions up to date.
</p>
<p>
We thoroughly test the most recent minor version of each supported major OS to ensure the best compatibility and performance with every Redis Enterprise release. This process helps detect and address potential compatibility issues early on.
</p>
<p>
Due to the vast array of minor updates and variations across operating systems, we cannot test compatibility with every minor OS version and each Redis Enterprise version. However, because OS vendors each have an Application Binary Interface (ABI) they support and avoid breaking, except to address severe security issues, newer minor OS versions are generally expected to work correctly. We will add a note to this document if specific OS minor versions have significant ABI or dependency changes. An earlier OS minor version also might work, although it is not guaranteed.
</p>
<p>
Despite our rigorous testing, we recommend users test their Redis applications with any new OS update before deploying it in a production environment. This additional testing layer can help identify any unique issues in your setup.
</p>
<h3 id="red-hat-enterprise-linux-rhel">
Red Hat Enterprise Linux (RHEL)
</h3>
<p>
Red Hat has a well-defined lifecycle for support. For details, see
<a href="https://access.redhat.com/support/policy/updates/errata#RHEL8_and_9_Life_Cycle">
Red Hat Enterprise Linux Life Cycle
</a>
.
</p>
<p>
Redis supports and tests RHEL 8 and 9 minor releases and extended update support timeframes. However, none of the longer Red Hat support cycles, such as SAP and EEUS, are supported.
</p>
<p>
We only support what the vendor supports in accordance with their policies. When Red Hat no longer supports a particular release, it is no longer supported by Redis as well. If future Redis Enterprise releases will not support a major RHEL version, the release notes and the
<a href="#supported-platforms">
supported platforms
</a>
table will include deprecation warnings.
</p>
<h3 id="rhel-clones-and-equivalent-enterprise-os">
RHEL clones and equivalent Enterprise OS
</h3>
<p>
The
<a href="#supported-platforms">
supported platforms
</a>
table lists the versions of Red Hat Enterprise Linux (RHEL) that Redis supports. This support extends to the ABI and package compatibility with RHEL of the same version.
</p>
<p>
The RHEL-compatible distributions CentOS, CentOS Stream, Alma Linux, Rocky Linux, and Oracle Linux running the Red Hat Compatible Kernel (RHCK) are supported if they provide full RHEL compatibility. If Redis identifies or questions some incompatibility from a clone, you might be asked to test on another clone or RHEL directly.
</p>
<h2 id="operating-system-limitations">
Operating system limitations
</h2>
<h3 id="tls-10-and-tls-11">
TLS 1.0 and TLS 1.1
</h3>
<p>
Redis Enterprise Software version 6.2.8 removed support for TLS 1.0 and TLS 1.1 on Red Hat Enterprise Linux 8 (RHEL 8) because that operating system
<a href="https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/security_hardening/using-the-system-wide-cryptographic-policies_security-hardening">
does not enable support
</a>
for these versions by default.
</p>
<h3 id="ubuntu-20-rejects-sha1-certificates">
Ubuntu 20 rejects SHA1 certificates
</h3>
<p>
With Ubuntu 20.04, you cannot use the SHA1 hash algorithm because
<a href="https://manpages.ubuntu.com/manpages/focal/man3/SSL_CTX_set_security_level.3ssl.html#notes">
OpenSSL's security level is set to 2 by default
</a>
. As a result, the operating system rejects SHA1 certificates, even if you enable the
<code>
mtls_allow_weak_hashing
</code>
option.
</p>
<p>
To avoid issues with SHA1 certificates, replace them with new certificates that use SHA-256. Note that certificates provided by Redis Enterprise Software use SHA-256.
</p>
<h3 id="upgrade-rhel-when-using-modules">
Upgrade RHEL when using modules
</h3>
<p>
RHEL 7 clusters cannot be directly upgraded to RHEL 8 when hosting databases using modules, due to binary differences in modules between the two operating systems. Instead, you need to create a new cluster on RHEL 8 and then migrate existing data from your RHEL 7 cluster. This does not apply to clusters that do not use modules.
</p>
<p>
This limitation is fixed for clusters using Redis Enterprise Software version 7.2.4 and later.
</p>
<h3 id="modules-cannot-load-in-oracle-linux-7--8">
Modules cannot load in Oracle Linux 7 & 8
</h3>
<p>
Databases hosted on Oracle Linux 7 & 8 cannot load modules.
</p>
<p>
As a temporary workaround, you can change the node's
<code>
os_name
</code>
in the Cluster Configuration Store (CCS):
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">ccs-cli hset node:<ID> os_name rhel
</span></span></code></pre>
</div>
<p>
This limitation was fixed in
<a href="/docs/latest/operate/rs/release-notes/rs-7-2-4-releases/rs-7-2-4-64/">
Redis Enterprise Software version 7.2.4-64
</a>
.
</p>
<h3 id="openssl-compatibility-issue-for-742-modules-on-amazon-linux-2">
OpenSSL compatibility issue for 7.4.2 modules on Amazon Linux 2
</h3>
<p>
Due to an OpenSSL 1.1 compatibility issue between modules and clusters, Redis Enterprise Software version 7.4.2-54 is not fully supported on Amazon Linux 2 clusters with databases that use the following modules: RedisGears, RediSearch, or RedisTimeSeries.
</p>
<p>
This issue will be fixed in a future maintenance release.
</p>
<h3 id="redisgraph-prevents-upgrade-to-rhel-9">
RedisGraph prevents upgrade to RHEL 9
</h3>
<p>
You cannot upgrade from a prior RHEL version to RHEL 9 if the Redis Enterprise cluster contains a RedisGraph module, even if unused by any database. The
<a href="https://redis.com/blog/redisgraph-eol/">
RedisGraph module has reached End-of-Life
</a>
and is completely unavailable in RHEL 9.
</p>
<h2 id="virtualization-platforms">
Virtualization platforms
</h2>
<p>
Redis Enterprise Software is compatible with VMware and other similar virtualization platforms. Make sure to do the following:
</p>
<ul>
<li>
Configure your memory, CPU, network, and storage settings to allow for optimal Redis Enterprise performance.
</li>
<li>
Pin each Redis Enterprise shard to a specific ESX or ESXi host by setting the appropriate affinity rules.
</li>
<li>
If you must manually migrate a virtual machine to another host, follow the best practices for
<a href="/docs/latest/operate/rs/7.4/clusters/maintenance-mode/">
shard maintenance
</a>
and contact support if you have questions.
</li>
<li>
Turn off VMware VMotion because Redis Enterprise is not compatible with VMotion.
</li>
<li>
Don't use snapshots because Redis Enterprise cluster manages states dynamically, so a snapshot might not have the correct node and cluster states.
</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/supported-platforms/"/>
<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/commands/ft.create.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.CREATE
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.CREATE index
[ON HASH | JSON]
[PREFIX count prefix [prefix ...]]
[FILTER {filter}]
[LANGUAGE default_lang]
[LANGUAGE_FIELD lang_attribute]
[SCORE default_score]
[SCORE_FIELD score_attribute]
[PAYLOAD_FIELD payload_attribute]
[MAXTEXTFIELDS]
[TEMPORARY seconds]
[NOOFFSETS]
[NOHL]
[NOFIELDS]
[NOFREQS]
[STOPWORDS count [stopword ...]]
[SKIPINITIALSCAN]
SCHEMA field_name [AS alias] TEXT | TAG | NUMERIC | GEO | VECTOR | GEOSHAPE [ SORTABLE [UNF]]
[NOINDEX] [ field_name [AS alias] TEXT | TAG | NUMERIC | GEO | VECTOR | GEOSHAPE [ SORTABLE [UNF]] [NOINDEX] ...]
</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(K) at creation where K is the number of fields, O(N) if scanning the keyspace is triggered, where N is the number of keys in the keyspace
</dd>
</dl>
<h2 id="description">
Description
</h2>
<p>
Create an index with the given specification. For usage, see
<a href="#examples">
Examples
</a>
.
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<p>
<a name="index">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
index
</code>
</summary>
<p>
is index name to create.
If such index already exists, returns an error reply
<code>
(error) Index already exists
</code>
.
</p>
</details>
<p>
<a name="SCHEMA">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
SCHEMA {identifier} AS {attribute} {attribute type} {options...
</code>
</summary>
<p>
after the SCHEMA keyword, declares which fields to index:
</p>
<ul>
<li>
<p>
<code>
{identifier}
</code>
for hashes, is a field name within the hash.
For JSON, the identifier is a JSON Path expression.
</p>
</li>
<li>
<p>
<code>
AS {attribute}
</code>
defines the attribute associated to the identifier. For example, you can use this feature to alias a complex JSONPath expression with more memorable (and easier to type) name.
</p>
</li>
</ul>
<p>
Field types are:
</p>
<ul>
<li>
<p>
<code>
TEXT
</code>
- Allows full-text search queries against the value in this attribute.
</p>
</li>
<li>
<p>
<code>
TAG
</code>
- Allows exact-match queries, such as categories or primary keys, against the value in this attribute. For more information, see
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/tags/">
Tag Fields
</a>
.
</p>
</li>
<li>
<p>
<code>
NUMERIC
</code>
- Allows numeric range queries against the value in this attribute. See
<a href="/docs/latest/develop/interact/search-and-query/query/">
query syntax docs
</a>
for details on how to use numeric ranges.
</p>
</li>
<li>
<p>
<code>
GEO
</code>
- Allows radius range queries against the value (point) in this attribute. The value of the attribute must be a string containing a longitude (first) and latitude separated by a comma.
</p>
</li>
<li>
<p>
<code>
VECTOR
</code>
- Allows vector queries against the value in this attribute. This requires
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/dialects/#dialect-2">
query dialect 2
</a>
or above (introduced in
<a href="https://github.com/RediSearch/RediSearch/releases/tag/v2.4.3">
RediSearch v2.4
</a>
). For more information, see
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/vectors/">
Vector Fields
</a>
.
</p>
</li>
<li>
<p>
<code>
GEOSHAPE
</code>
- Allows polygon queries against the value in this attribute. The value of the attribute must follow a
<a href="https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry">
WKT notation
</a>
list of 2D points representing the polygon edges
<code>
POLYGON((x1 y1, x2 y2, ...)
</code>
separated by a comma. A
<code>
GEOSHAPE
</code>
field type can be followed by one of the following coordinate systems:
</p>
<ul>
<li>
<code>
SPHERICAL
</code>
for Geographic longitude and latitude coordinates
</li>
<li>
<code>
FLAT
</code>
for Cartesian X Y coordinates
</li>
</ul>
<p>
The default coordinate system is
<code>
SPHERICAL
</code>
.
</p>
<p>
Currently
<code>
GEOSHAPE
</code>
doesn't support JSON multi-value and
<code>
SORTABLE
</code>
option.
</p>
</li>
</ul>
<p>
Field options are:
</p>
<ul>
<li>
<p>
<code>
SORTABLE
</code>
-
<code>
NUMERIC
</code>
,
<code>
TAG
</code>
,
<code>
TEXT
</code>
, or
<code>
GEO
</code>
attributes can have an optional
<strong>
SORTABLE
</strong>
argument. As the user
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/sorting/">
sorts the results by the value of this attribute
</a>
, the results are available with very low latency. Note that his adds memory overhead, so consider not declaring it on large text attributes. You can sort an attribute without the
<code>
SORTABLE
</code>
option, but the latency is not as good as with
<code>
SORTABLE
</code>
.
</p>
</li>
<li>
<p>
<code>
UNF
</code>
- By default, for hashes (not with JSON)
<code>
SORTABLE
</code>
applies a normalization to the indexed value (characters set to lowercase, removal of diacritics). When using the unnormalized form (UNF), you can disable the normalization and keep the original form of the value. With JSON,
<code>
UNF
</code>
is implicit with
<code>
SORTABLE
</code>
(normalization is disabled).
</p>
</li>
<li>
<p>
<code>
NOSTEM
</code>
- Text attributes can have the NOSTEM argument that disables stemming when indexing its values. This may be ideal for things like proper names.
</p>
</li>
<li>
<p>
<code>
NOINDEX
</code>
- Attributes can have the
<code>
NOINDEX
</code>
option, which means they will not be indexed. This is useful in conjunction with
<code>
SORTABLE
</code>
, to create attributes whose update using PARTIAL will not cause full reindexing of the document. If an attribute has NOINDEX and doesn't have SORTABLE, it will just be ignored by the index.
</p>
</li>
<li>
<p>
<code>
PHONETIC {matcher}
</code>
- Declaring a text attribute as
<code>
PHONETIC
</code>
will perform phonetic matching on it in searches by default. The obligatory {matcher} argument specifies the phonetic algorithm and language used. The following matchers are supported:
</p>
<ul>
<li>
<code>
dm:en
</code>
- Double metaphone for English
</li>
<li>
<code>
dm:fr
</code>
- Double metaphone for French
</li>
<li>
<code>
dm:pt
</code>
- Double metaphone for Portuguese
</li>
<li>
<code>
dm:es
</code>
- Double metaphone for Spanish
</li>
</ul>
<p>
For more information, see
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/phonetic_matching/">
Phonetic Matching
</a>
.
</p>
</li>
<li>
<p>
<code>
WEIGHT {weight}
</code>
for
<code>
TEXT
</code>
attributes, declares the importance of this attribute when calculating result accuracy. This is a multiplication factor, and defaults to 1 if not specified.
</p>
</li>
<li>
<p>
<code>
SEPARATOR {sep}
</code>
for
<code>
TAG
</code>
attributes, indicates how the text contained in the attribute is to be split into individual tags. The default is
<code>
,
</code>
. The value must be a single character.
</p>
</li>
<li>
<p>
<code>
CASESENSITIVE
</code>
for
<code>
TAG
</code>
attributes, keeps the original letter cases of the tags. If not specified, the characters are converted to lowercase.
</p>
</li>
<li>
<p>
<code>
WITHSUFFIXTRIE
</code>
for
<code>
TEXT
</code>
and
<code>
TAG
</code>
attributes, keeps a suffix trie with all terms which match the suffix. It is used to optimize
<code>
contains
</code>
(
<em>
foo
</em>
) and
<code>
suffix
</code>
(*foo) queries. Otherwise, a brute-force search on the trie is performed. If suffix trie exists for some fields, these queries will be disabled for other fields.
</p>
</li>
<li>
<p>
<code>
INDEXEMPTY
</code>
for
<code>
TEXT
</code>
and
<code>
TAG
</code>
attributes, introduced in v2.10, allows you to index and search for empty strings. By default, empty strings are not indexed.
</p>
</li>
<li>
<p>
<code>
INDEXMISSING
</code>
for all field types, introduced in v2.10, allows you to search for missing values, that is, documents that do not contain a specific field. Note the difference between a field with an empty value and a document with a missing value. By default, missing values are not indexed.
</p>
</li>
</ul>
</details>
<h2 id="optional-arguments">
Optional arguments
</h2>
<p>
<a name="ON">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
ON {data_type}
</code>
</summary>
<p>
currently supports HASH (default) and JSON. To index JSON, you must have the
<a href="/docs/latest/develop/data-types/json/">
RedisJSON
</a>
module installed.
</p>
</details>
<p>
<a name="PREFIX">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
PREFIX {count} {prefix}
</code>
</summary>
<p>
tells the index which keys it should index. You can add several prefixes to index. Because the argument is optional, the default is
<code>
*
</code>
(all keys).
</p>
</details>
<p>
<a name="FILTER">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
FILTER {filter}
</code>
</summary>
<p>
is a filter expression with the full RediSearch aggregation expression language. It is possible to use
<code>
@__key
</code>
to access the key that was just added/changed. A field can be used to set field name by passing
<code>
'FILTER @indexName=="myindexname"'
</code>
.
</p>
</details>
<p>
<a name="LANGUAGE">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
LANGUAGE {default_lang}
</code>
</summary>
<p>
if set, indicates the default language for documents in the index. Default is English.
</p>
</details>
<p>
<a name="LANGUAGE_FIELD">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
LANGUAGE_FIELD {lang_attribute}
</code>
</summary>
<p>
is a document attribute set as the document language.
</p>
<p>
A stemmer is used for the supplied language during indexing. If an unsupported language is sent, the command returns an error. The supported languages are Arabic, Basque, Catalan, Danish, Dutch, English, Finnish, French, German, Greek, Hungarian,
Indonesian, Irish, Italian, Lithuanian, Nepali, Norwegian, Portuguese, Romanian, Russian,
Spanish, Swedish, Tamil, Turkish, and Chinese.
</p>
<p>
When adding Chinese language documents, set
<code>
LANGUAGE chinese
</code>
for the indexer to properly tokenize the terms. If you use the default language, then search terms are extracted based on punctuation characters and whitespace. The Chinese language tokenizer makes use of a segmentation algorithm (via
<a href="https://github.com/lionsoul2014/friso">
Friso
</a>
), which segments text and checks it against a predefined dictionary. See
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/stemming/">
Stemming
</a>
for more information.
</p>
</details>
<p>
<a name="SCORE">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
SCORE {default_score}
</code>
</summary>
<p>
is default score for documents in the index. Default score is 1.0.
</p>
</details>
<p>
<a name="SCORE_FIELD">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
SCORE_FIELD {score_attribute}
</code>
</summary>
<p>
is document attribute that you use as the document rank based on the user ranking. Ranking must be between 0.0 and 1.0. If not set, the default score is 1.
</p>
</details>
<p>
<a name="PAYLOAD_FIELD">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
PAYLOAD_FIELD {payload_attribute}
</code>
</summary>
<p>
is document attribute that you use as a binary safe payload string to the document that can be evaluated at query time by a custom scoring function or retrieved to the client.
</p>
</details>
<p>
<a name="MAXTEXTFIELDS">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
MAXTEXTFIELDS
</code>
</summary>
<p>
forces RediSearch to encode indexes as if there were more than 32 text attributes, which allows you to add additional attributes (beyond 32) using
<a href="/docs/latest/commands/ft.alter/">
<code>
FT.ALTER
</code>
</a>
. For efficiency, RediSearch encodes indexes differently if they are created with less than 32 text attributes.
</p>
</details>
<p>
<a name="NOOFFSETS">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
NOOFFSETS
</code>
</summary>
<p>
does not store term offsets for documents. It saves memory, but does not allow exact searches or highlighting. It implies
<code>
NOHL
</code>
.
</p>
</details>
<p>
<a name="TEMPORARY">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
TEMPORARY {seconds}
</code>
</summary>
<p>
creates a lightweight temporary index that expires after a specified period of inactivity, in seconds. The internal idle timer is reset whenever the index is searched or added to. Because such indexes are lightweight, you can create thousands of such indexes without negative performance implications and, therefore, you should consider using
<code>
SKIPINITIALSCAN
</code>
to avoid costly scanning.
</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>
When temporary indexes expire, they drop all the records associated with them.
<a href="/docs/latest/commands/ft.dropindex/">
<code>
FT.DROPINDEX
</code>
</a>
was introduced with a default of not deleting docs and a
<code>
DD
</code>
flag that enforced deletion.
However, for temporary indexes, documents are deleted along with the index.
Historically, RediSearch used an FT.ADD command, which made a connection between the document and the index. Then, FT.DROP, also a hystoric command, deleted documents by default.
In version 2.x, RediSearch indexes hashes and JSONs, and the dependency between the index and documents no longer exists.
</div>
</div>
</details>
<p>
<a name="NOHL">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
NOHL
</code>
</summary>
<p>
conserves storage space and memory by disabling highlighting support. If set, the corresponding byte offsets for term positions are not stored.
<code>
NOHL
</code>
is also implied by
<code>
NOOFFSETS
</code>
.
</p>
</details>
<p>
<a name="NOFIELDS">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
NOFIELDS
</code>
</summary>
<p>
does not store attribute bits for each term. It saves memory, but it does not allow
filtering by specific attributes.
</p>
</details>
<p>
<a name="NOFREQS">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
NOFREQS
</code>
</summary>
<p>
avoids saving the term frequencies in the index. It saves memory, but does not allow sorting based on the frequencies of a given term within the document.
</p>
</details>
<p>
<a name="STOPWORDS">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
STOPWORDS {count}
</code>
</summary>
<p>
sets the index with a custom stopword list, to be ignored during indexing and search time.
<code>
{count}
</code>
is the number of stopwords, followed by a list of stopword arguments exactly the length of
<code>
{count}
</code>
.
</p>
<p>
If not set, FT.CREATE takes the default list of stopwords. If
<code>
{count}
</code>
is set to 0, the index does not have stopwords.
</p>
</details>
<p>
<a name="SKIPINITIALSCAN">
</a>
</p>
<details open="">
<p>
</p>
<summary>
<code>
SKIPINITIALSCAN
</code>
</summary>
<p>
if set, does not scan and index.
</p>
</details>
<p>
<note>
<b>
Notes:
</b>
</note>
</p>
<ul>
<li>
<p>
<strong>
Attribute number limits:
</strong>
RediSearch supports up to 1024 attributes per schema, out of which at most 128 can be TEXT attributes. On 32 bit builds, at most 64 attributes can be TEXT attributes. The more attributes you have, the larger your index, as each additional 8 attributes require one extra byte per index record to encode. You can always use the
<code>
NOFIELDS
</code>
option and not encode attribute information into the index, for saving space, if you do not need filtering by text attributes. This will still allow filtering by numeric and geo attributes.
</p>
</li>
<li>
<p>
<strong>
Running in clustered databases:
</strong>
When having several indices in a clustered database, you need to make sure the documents you want to index reside on the same shard as the index. You can achieve this by having your documents tagged by the index name.
</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> HSET doc:1<span class="o">{</span>idx<span class="o">}</span> ...
</span></span><span class="line"><span class="cl">127.0.0.1:6379> FT.CREATE idx ... PREFIX <span class="m">1</span> doc: ...</span></span></code></pre>
</div>
<p>
When Running RediSearch in a clustered database, you can span the index across shards using
<a href="https://github.com/RedisLabsModules/RSCoordinator">
RSCoordinator
</a>
. In this case the above does not apply.
</p>
</li>
</ul>
<h2 id="return">
Return
</h2>
<p>
FT.CREATE 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>
Create an index
</b>
</summary>
<p>
Create an index that stores the title, publication date, and categories of blog post hashes whose keys start with
<code>
blog:post:
</code>
(for example,
<code>
blog:post:1
</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> FT.CREATE idx ON HASH PREFIX <span class="m">1</span> blog:post: SCHEMA title TEXT SORTABLE published_at NUMERIC SORTABLE category TAG SORTABLE
</span></span><span class="line"><span class="cl">OK</span></span></code></pre>
</div>
<p>
Index the
<code>
sku
</code>
attribute from a hash as both a
<code>
TAG
</code>
and as
<code>
TEXT
</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> FT.CREATE idx ON HASH PREFIX <span class="m">1</span> blog:post: SCHEMA sku AS sku_text TEXT sku AS sku_tag TAG SORTABLE</span></span></code></pre>
</div>
<p>
Index two different hashes, one containing author data and one containing books, in the same index:
</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> FT.CREATE author-books-idx ON HASH PREFIX <span class="m">2</span> author:details: book:details: SCHEMA
</span></span><span class="line"><span class="cl">author_id TAG SORTABLE author_ids TAG title TEXT name TEXT</span></span></code></pre>
</div>
<p>
In this example, keys for author data use the key pattern
<code>
author:details:<id>
</code>
while keys for book data use the pattern
<code>
book:details:<id>
</code>
.
</p>
<p>
Index authors whose names start with G.
</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> FT.CREATE g-authors-idx ON HASH PREFIX <span class="m">1</span> author:details FILTER <span class="s1">'startswith(@name, "G")'</span> SCHEMA name TEXT</span></span></code></pre>
</div>
<p>
Index only books that have a subtitle.
</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> FT.CREATE subtitled-books-idx ON HASH PREFIX <span class="m">1</span> book:details FILTER <span class="s1">'@subtitle != ""'</span> SCHEMA title TEXT</span></span></code></pre>
</div>
<p>
Index books that have a "categories" attribute where each category is separated by a
<code>
;
</code>
character.
</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> FT.CREATE books-idx ON HASH PREFIX <span class="m">1</span> book:details SCHEMA title TEXT categories TAG SEPARATOR <span class="s2">";"</span></span></span></code></pre>
</div>
</details>
<details open="">
<summary>
<b>
Index a JSON document using a JSON Path expression
</b>
</summary>
<p>
The following example uses data similar to the hash examples above but uses JSON instead.
</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> FT.CREATE idx ON JSON SCHEMA $.title AS title TEXT $.categories AS categories TAG</span></span></code></pre>
</div>
</details>
<h2 id="see-also">
See also
</h2>
<p>
<a href="/docs/latest/commands/ft.alter/">
<code>
FT.ALTER
</code>
</a>
|
<a href="/docs/latest/commands/ft.dropindex/">
<code>
FT.DROPINDEX
</code>
</a>
</p>
<h2 id="related-topics">
Related topics
</h2>
<ul>
<li>
<a href="/docs/latest/develop/interact/search-and-query/">
RediSearch
</a>
</li>
<li>
<a href="/docs/latest/develop/data-types/json/">
RedisJSON
</a>
</li>
<li>
<a href="https://github.com/lionsoul2014/friso">
Friso
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/stemming/">
Stemming
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/phonetic_matching/">
Phonetic Matching
</a>
</li>
<li>
<a href="https://github.com/RedisLabsModules/RSCoordinator">
RSCoordinator
</a>
</li>
</ul>
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 2.0.0: Added
<code>
PAYLOAD_FIELD
</code>
argument for backward support of
<code>
FT.SEARCH
</code>
deprecated
<code>
WITHPAYLOADS
</code>
argument
</li>
<li>
Starting with Redis version 2.0.0: Deprecated
<code>
PAYLOAD_FIELD
</code>
argument
</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/ft.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/integrate/write-behind/reference/debezium/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Debezium Server configuration file
</h1>
<p class="text-lg -mt-5 mb-10">
Application properties settings used to configure Debezim Server for source database servers
</p>
<p>
The
<code>
application.properties
</code>
file configures Debezium Server configuration to support source databases. It contains sections that define the sink connector (Redis) configuration and the source connector configuration.
This file needs to be saved in the host running Debezium Server.
</p>
<p>
The following topics describe
<code>
application.properties
</code>
for specific database servers:
</p>
<nav>
<a href="/docs/latest/integrate/write-behind/reference/debezium/cassandra/">
Write-behind configuration for cassandra
</a>
<p>
Describes the
<code>
application.properties
</code>
settings that configure Debezium Server for cassandra
</p>
<a href="/docs/latest/integrate/write-behind/reference/debezium/mongodb/">
Write-behind configuration for mongodb
</a>
<p>
Describes the
<code>
application.properties
</code>
settings that configure Debezium Server for mongodb
</p>
<a href="/docs/latest/integrate/write-behind/reference/debezium/mysql/">
Write-behind configuration for mysql
</a>
<p>
Describes the
<code>
application.properties
</code>
settings that configure Debezium Server for mysql
</p>
<a href="/docs/latest/integrate/write-behind/reference/debezium/oracle/">
Write-behind configuration for oracle
</a>
<p>
Describes the
<code>
application.properties
</code>
settings that configure Debezium Server for oracle
</p>
<a href="/docs/latest/integrate/write-behind/reference/debezium/postgresql/">
Write-behind configuration for postgresql
</a>
<p>
Describes the
<code>
application.properties
</code>
settings that configure Debezium Server for postgresql
</p>
<a href="/docs/latest/integrate/write-behind/reference/debezium/sqlserver/">
Write-behind configuration for sqlserver
</a>
<p>
Describes the
<code>
application.properties
</code>
settings that configure Debezium Server for sqlserver
</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/write-behind/reference/debezium/"/>
<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-stats/.html | <section class="prose w-full py-12">
<h1 class="command-name">
MEMORY STATS
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">MEMORY STATS</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">
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>
</dd>
</dl>
<p>
The
<code>
MEMORY STATS
</code>
command returns an
<a href="/docs/latest/develop/reference/protocol-spec/#arrays">
Array reply
</a>
about the memory usage of the
server.
</p>
<p>
The information about memory usage is provided as metrics and their respective
values. The following metrics are reported:
</p>
<ul>
<li>
<code>
peak.allocated
</code>
: Peak memory consumed by Redis in bytes (see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
used_memory_peak
</code>
)
</li>
<li>
<code>
total.allocated
</code>
: Total number of bytes allocated by Redis using its
allocator (see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
used_memory
</code>
)
</li>
<li>
<code>
startup.allocated
</code>
: Initial amount of memory consumed by Redis at startup
in bytes (see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
used_memory_startup
</code>
)
</li>
<li>
<code>
replication.backlog
</code>
: Size in bytes of the replication backlog (see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
repl_backlog_active
</code>
)
</li>
<li>
<code>
clients.slaves
</code>
: The total size in bytes of all replicas overheads (output
and query buffers, connection contexts)
</li>
<li>
<code>
clients.normal
</code>
: The total size in bytes of all clients overheads (output
and query buffers, connection contexts)
</li>
<li>
<code>
cluster.links
</code>
: Memory usage by cluster links (Added in Redis 7.0, see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
mem_cluster_links
</code>
).
</li>
<li>
<code>
aof.buffer
</code>
: The summed size in bytes of AOF related buffers.
</li>
<li>
<code>
lua.caches
</code>
: the summed size in bytes of the overheads of the Lua scripts'
caches
</li>
<li>
<code>
functions.caches
</code>
: the summed size in bytes of the overheads of the Function scripts'
caches
</li>
<li>
<code>
dbXXX
</code>
: For each of the server's databases, the overheads of the main and
expiry dictionaries (
<code>
overhead.hashtable.main
</code>
and
<code>
overhead.hashtable.expires
</code>
, respectively) are reported in bytes
</li>
<li>
<code>
overhead.db.hashtable.lut
</code>
: Total overhead of dictionary buckets in databases (Added in Redis 7.4)
</li>
<li>
<code>
overhead.db.hashtable.rehashing
</code>
: Temporary memory overhead of database dictionaries currently being rehashed (Added in Redis 7.4)
</li>
<li>
<code>
overhead.total
</code>
: The sum of all overheads, i.e.
<code>
startup.allocated
</code>
,
<code>
replication.backlog
</code>
,
<code>
clients.slaves
</code>
,
<code>
clients.normal
</code>
,
<code>
aof.buffer
</code>
and
those of the internal data structures that are used in managing the
Redis keyspace (see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
used_memory_overhead
</code>
)
</li>
<li>
<code>
db.dict.rehashing.count
</code>
: Number of DB dictionaries currently being rehashed (Added in Redis 7.4)
</li>
<li>
<code>
keys.count
</code>
: The total number of keys stored across all databases in the
server
</li>
<li>
<code>
keys.bytes-per-key
</code>
: The ratio between
<code>
dataset.bytes
</code>
and
<code>
keys.count
</code>
</li>
<li>
<code>
dataset.bytes
</code>
: The size in bytes of the dataset, i.e.
<code>
overhead.total
</code>
subtracted from
<code>
total.allocated
</code>
(see
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
used_memory_dataset
</code>
)
</li>
<li>
<code>
dataset.percentage
</code>
: The percentage of
<code>
dataset.bytes
</code>
out of the total
memory usage
</li>
<li>
<code>
peak.percentage
</code>
: The percentage of
<code>
total.allocated
</code>
out of
<code>
peak.allocated
</code>
</li>
<li>
<code>
allocator.allocated
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_allocated
</code>
</li>
<li>
<code>
allocator.active
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_active
</code>
</li>
<li>
<code>
allocator.resident
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_resident
</code>
</li>
<li>
<code>
allocator.muzzy
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_muzzy
</code>
</li>
<li>
<code>
allocator-fragmentation.ratio
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_frag_ratio
</code>
</li>
<li>
<code>
allocator-fragmentation.bytes
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_frag_bytes
</code>
</li>
<li>
<code>
allocator-rss.ratio
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_rss_ratio
</code>
</li>
<li>
<code>
allocator-rss.bytes
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
allocator_rss_bytes
</code>
</li>
<li>
<code>
rss-overhead.ratio
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
rss_overhead_ratio
</code>
</li>
<li>
<code>
rss-overhead.bytes
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
rss_overhead_bytes
</code>
</li>
<li>
<code>
fragmentation
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
mem_fragmentation_ratio
</code>
</li>
<li>
<code>
fragmentation.bytes
</code>
: See
<a href="/docs/latest/commands/info/">
<code>
INFO
</code>
</a>
's
<code>
mem_fragmentation_bytes
</code>
</li>
</ul>
<p>
<strong>
A note about the word slave used in this man page
</strong>
: Starting with Redis 5, if not for backward compatibility, the Redis project no longer uses the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated.
</p>
<h2 id="resp2-reply">
RESP2 Reply
</h2>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a nested list of memory usage metrics and their values.
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<a href="../../develop/reference/protocol-spec#maps">
Map reply
</a>
: memory usage metrics and their values.
<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-stats/"/>
<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/modules/upgrade/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Upgrade module requests
</h1>
<p class="text-lg -mt-5 mb-10">
Upgrade module requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#post-modules-upgrade-bdb">
POST
</a>
</td>
<td>
<code>
/v1/modules/upgrade/bdb/{uid}
</code>
</td>
<td>
Upgrade module
</td>
</tr>
</tbody>
</table>
<h2 id="post-modules-upgrade-bdb">
Upgrade module
</h2>
<pre><code>POST /v1/modules/upgrade/bdb/{string: uid}
</code></pre>
<p>
Upgrades the module version on a specific database. Deprecated as of Redis Enterprise Software v7.8.2. Use
<a href="/docs/latest/operate/rs/references/rest-api/requests/bdbs/upgrade/#post-bdbs-upgrade">
<code>
POST /v1/bdbs/<uid>/upgrade
</code>
</a>
instead.
</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/#edit_bdb_module">
edit_bdb_module
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="post-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>POST /modules/upgrade/bdb/1
</code></pre>
<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">"modules"</span><span class="p">:</span> <span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span><span class="nt">"module_name"</span><span class="p">:</span> <span class="s2">"ReJson"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"current_semantic_version"</span><span class="p">:</span> <span class="s2">"2.2.1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"new_module"</span><span class="p">:</span> <span class="s2">"aa3648d79bd4082d414587c42ea0b234"</span><span class="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">"// Optional fields to fine-tune restart and failover behavior:"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"preserve_roles"</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">"may_discard_data"</span><span class="p">:</span> <span class="kc">false</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>
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>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
modules
</td>
<td>
list
</td>
<td>
List of dicts representing the modules that will be upgraded. Each dict must include:
<br/>
<br/>
•
<strong>
current_module
</strong>
: UID of a module to upgrade
<br/>
<br/>
•
<strong>
new_module
</strong>
: UID of the module we want to upgrade to
<br/>
<br/>
•
<strong>
new_module_args
</strong>
: args list for the new module
</td>
</tr>
<tr>
<td>
preserve_roles
</td>
<td>
boolean
</td>
<td>
Preserve shards’ master/replica roles (optional)
</td>
</tr>
<tr>
<td>
may_discard_data
</td>
<td>
boolean
</td>
<td>
Discard data in a non-replicated non-persistent database (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="post-response">
Response
</h3>
<p>
Returns the upgraded
<a href="/docs/latest/operate/rs/references/rest-api/objects/module/">
module 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">"name of database #1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"module_id"</span><span class="p">:</span> <span class="s2">"aa3648d79bd4082d414587c42ea0b234"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"module_name"</span><span class="p">:</span> <span class="s2">"ReJson"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"semantic_version"</span><span class="p">:</span> <span class="s2">"2.2.2"</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"// additional fields..."</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>
When errors are reported, the server may return a JSON object with
<code>
error_code
</code>
and
<code>
message
</code>
field that provide additional information. The following are possible
<code>
error_code
</code>
values:
</p>
<table>
<thead>
<tr>
<th>
Code
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
missing_module
</td>
<td>
Module is not present in cluster.
</td>
</tr>
<tr>
<td>
module_downgrade_unsupported
</td>
<td>
Module downgrade is not allowed.
</td>
</tr>
<tr>
<td>
redis_incompatible_version
</td>
<td>
Module min_redis_version is bigger than the current Redis version.
</td>
</tr>
<tr>
<td>
redis_pack_incompatible_version
</td>
<td>
Module min_redis_pack_version is bigger than the current Redis Enterprise version.
</td>
</tr>
<tr>
<td>
unsupported_module_capabilities
</td>
<td>
New version of module does support all the capabilities needed for the database configuration
</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, module updated on bdb.
</td>
</tr>
<tr>
<td>
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">
404 Not Found
</a>
</td>
<td>
bdb or node not found.
</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.7">
406 Not Acceptable
</a>
</td>
<td>
The requested configuration is invalid.
</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/modules/upgrade/"/>
<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/srandmember/.html | <section class="prose w-full py-12">
<h1 class="command-name">
SRANDMEMBER
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">SRANDMEMBER key [count]</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">
Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count.
</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>
@set
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
When called with just the
<code>
key
</code>
argument, return a random element from the set value stored at
<code>
key
</code>
.
</p>
<p>
If the provided
<code>
count
</code>
argument is positive, return an array of
<strong>
distinct elements
</strong>
.
The array's length is either
<code>
count
</code>
or the set's cardinality (
<a href="/docs/latest/commands/scard/">
<code>
SCARD
</code>
</a>
), whichever is lower.
</p>
<p>
If called with a negative
<code>
count
</code>
, the behavior changes and the command is allowed to return the
<strong>
same element multiple times
</strong>
.
In this case, the number of returned elements is the absolute value of the specified
<code>
count
</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> SADD myset one two three
(integer) 3
redis> SRANDMEMBER myset
"three"
redis> SRANDMEMBER myset 2
1) "one"
2) "two"
redis> SRANDMEMBER myset -5
1) "one"
2) "two"
3) "two"
4) "two"
5) "two"
</pre>
<div class="prompt" style="">
<span>
redis>
</span>
<input autocomplete="off" name="prompt" spellcheck="false" type="text"/>
</div>
</form>
<h2 id="specification-of-the-behavior-when-count-is-passed">
Specification of the behavior when count is passed
</h2>
<p>
When the
<code>
count
</code>
argument is a positive value this command behaves as follows:
</p>
<ul>
<li>
No repeated elements are returned.
</li>
<li>
If
<code>
count
</code>
is bigger than the set's cardinality, the command will only return the whole set without additional elements.
</li>
<li>
The order of elements in the reply is not truly random, so it is up to the client to shuffle them if needed.
</li>
</ul>
<p>
When the
<code>
count
</code>
is a negative value, the behavior changes as follows:
</p>
<ul>
<li>
Repeating elements are possible.
</li>
<li>
Exactly
<code>
count
</code>
elements, or an empty array if the set is empty (non-existing key), are always returned.
</li>
<li>
The order of elements in the reply is truly random.
</li>
</ul>
<h2 id="distribution-of-returned-elements">
Distribution of returned elements
</h2>
<p>
Note: this section is relevant only for Redis 5 or below, as Redis 6 implements a fairer algorithm.
</p>
<p>
The distribution of the returned elements is far from perfect when the number of elements in the set is small, this is due to the fact that we used an approximated random element function that does not really guarantees good distribution.
</p>
<p>
The algorithm used, that is implemented inside dict.c, samples the hash table buckets to find a non-empty one. Once a non empty bucket is found, since we use chaining in our hash table implementation, the number of elements inside the bucket is checked and a random element is selected.
</p>
<p>
This means that if you have two non-empty buckets in the entire hash table, and one has three elements while one has just one, the element that is alone in its bucket will be returned with much higher probability.
</p>
<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>
: without the additional
<em>
count
</em>
argument, the command returns a randomly selected member, or a
<a href="../../develop/reference/protocol-spec#bulk-strings">
Nil reply
</a>
when
<em>
key
</em>
doesn't exist.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: when the optional
<em>
count
</em>
argument is passed, the command returns an array of members, or an empty array when
<em>
key
</em>
doesn't 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>
: without the additional
<em>
count
</em>
argument, the command returns a randomly selected member, or a
<a href="../../develop/reference/protocol-spec#nulls">
Null reply
</a>
when
<em>
key
</em>
doesn't exist.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: when the optional
<em>
count
</em>
argument is passed, the command returns an array of members, or an empty array when
<em>
key
</em>
doesn't exist.
</li>
</ul>
<br/>
<h2>
History
</h2>
<ul>
<li>
Starting with Redis version 2.6.0: Added the optional
<code>
count
</code>
argument.
</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/srandmember/"/>
<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/concepts/javascript_api/.html | <section class="prose w-full py-12 max-w-none">
<h1>
JavaScript API
</h1>
<p class="text-lg -mt-5 mb-10">
Overview of the JavaScript API
</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>
<h2 id="redis-object">
Redis object
</h2>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
The triggers and functions JavaScript API provides a singleton instance of an object named
<em>
redis
</em>
. The
<em>
redis
</em>
instance enables registered functions to interact with the Redis server on which they are running. Following is the API provided by the
<em>
redis
</em>
instance.
</p>
<h3 id="redisregisterfunction">
<code>
redis.registerFunction
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Register a new function that can later be invoke using
<code>
TFCALL
</code>
command.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="c1">//name and callback mandatory
</span></span></span><span class="line"><span class="cl"><span class="c1">//object with optional arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="nx">redis</span><span class="p">.</span><span class="nx">registerFunction</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">//name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kd">function</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="nx">args</span><span class="p">)</span> <span class="p">{},</span> <span class="c1">//callback
</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="nx">description</span><span class="o">:</span> <span class="s1">'The description'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">flags</span><span class="o">:</span> <span class="p">[</span><span class="nx">redis</span><span class="p">.</span><span class="nx">functionFlags</span><span class="p">.</span><span class="nx">NO_WRITES</span><span class="p">,</span> <span class="nx">redis</span><span class="p">.</span><span class="nx">functionFlags</span><span class="p">.</span><span class="nx">ALLOW_OOM</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="c1">// optional arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">);</span>
</span></span></code></pre>
</div>
<h3 id="redisregisterasyncfunction">
<code>
redis.registerAsyncFunction
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Register a new async function that can later be invoke using
<code>
TFCALLASYNC
</code>
command.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><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></span><span class="line"><span class="cl"> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">//Function name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kd">function</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="nx">args</span><span class="p">){},</span> <span class="c1">//callback
</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="nx">description</span><span class="o">:</span> <span class="s1">'description'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">flags</span><span class="o">:</span> <span class="p">[</span><span class="nx">redis</span><span class="p">.</span><span class="nx">functionFlags</span><span class="p">.</span><span class="nx">NO_WRITES</span><span class="p">,</span> <span class="nx">redis</span><span class="p">.</span><span class="nx">functionFlags</span><span class="p">.</span><span class="nx">ALLOW_OOM</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="c1">//optional arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">);</span>
</span></span></code></pre>
</div>
<h3 id="redisregisterkeyspacetrigger">
<code>
redis.registerKeySpaceTrigger
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Register a key space notification trigger that will run whenever a key space notification fired.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><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></span><span class="line"><span class="cl"> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">// trigger name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="s1">'keys:*'</span><span class="p">,</span> <span class="c1">//key prefix
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kd">function</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 class="c1">//callback
</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="nx">description</span><span class="o">:</span> <span class="s1">'description'</span>
</span></span><span class="line"><span class="cl"> <span class="nx">onTriggerFired</span><span class="o">:</span> <span class="kd">function</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="p">}</span> <span class="c1">//optional arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="redisregisterstreamtrigger">
<code>
redis.registerStreamTrigger
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Register a stream trigger that will be invoke whenever a data is added to a stream.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">redis</span><span class="p">.</span><span class="nx">registerStreamTrigger</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">//trigger name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="s1">'stream:*'</span><span class="p">,</span> <span class="c1">//prefix
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kd">function</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="c1">//callback
</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="nx">description</span><span class="o">:</span> <span class="s1">'Description'</span>
</span></span><span class="line"><span class="cl"> <span class="nb">window</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">isStreamTrimmed</span><span class="o">:</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span> <span class="c1">//optional arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="redisregisterclusterfunction">
<code>
redis.registerClusterFunction
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Register a cluster function that can later be called using
<code>
async_client.runOnKey()
</code>
or
<code>
async_client.runOnShards()
</code>
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">redis</span><span class="p">.</span><span class="nx">registerClusterFunction</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">//name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="kr">async</span> <span class="kd">function</span><span class="p">(</span><span class="nx">client</span><span class="p">,</span> <span class="p">...</span><span class="nx">args</span><span class="p">){}</span> <span class="c1">//callback
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="redisconfig">
<code>
redis.config
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<div class="highlight">
<pre class="chroma"><code class="language-Shell" data-lang="Shell"><span class="line"><span class="cl">redis-cli -x RG.FUNCTION LOAD UPGRADE CONFIG <span class="s1">'{"example_config": "example_config_value"}'</span> < main.js
</span></span></code></pre>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="kd">var</span> <span class="nx">configExample</span> <span class="o">=</span> <span class="nx">redis</span><span class="p">.</span><span class="nx">config</span><span class="p">.</span><span class="nx">example_config</span><span class="p">;</span>
</span></span></code></pre>
</div>
<h2 id="client-object">
Client object
</h2>
<p>
Client object that is used to perform operations on Redis.
</p>
<h3 id="clientcall">
<code>
client.call
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Run a command on Redis. The command is executed on the current Redis instrance.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><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></span><span class="line"><span class="cl"> <span class="s1">''</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">...</span><span class="nx">args</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="clientcallraw">
<code>
client.callRaw
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Run a command on Redis but does not perform UTF8 decoding on the result. The command is executed on the current Redis instrance.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">callRaw</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">''</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">...</span><span class="nx">args</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="clientcallasync">
<code>
client.callAsync
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Call a command on Redis. Allow Redis to block the execution if needed (like
<code>
blpop
</code>
command) and return the result asynchronously. Returns a promise object that will be resolved when the command invocation finished.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">callAsync</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">''</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">...</span><span class="nx">args</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="clientcallasyncraw">
<code>
client.callAsyncRaw
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Call a command on Redis. Allow Redis to block the execution if needed (like
<code>
blpop
</code>
command) and return the result asynchronously. Returns a promise object that will be resolved when the command invocation finished. The command is executed on the current Redis instrance.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">callRaw</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">''</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="p">...</span><span class="nx">args</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="clientisblockallowed">
<code>
client.isBlockAllowed
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Return true if it is allow to return promise from the function callback. In case it is allowed and a promise is return, Redis will wait for the promise to be fulfilled and only then will return the function result.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">isBlockAllowed</span><span class="p">();</span> <span class="c1">// True / False
</span></span></span></code></pre>
</div>
<h3 id="clientexecuteasync">
<code>
client.executeAsync
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Execute the given function asynchroniusly. Return a promise that will be fulfilled when the promise will be resolved/rejected.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">client</span><span class="p">.</span><span class="nx">executeAsync</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="kr">async</span> <span class="kd">function</span><span class="p">(</span><span class="nx">client</span><span class="p">){}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h2 id="async-client-object">
Async client object
</h2>
<p>
Background client object that is used to perform background operation on Redis.
This client is given to any background task that runs as a JS coroutine.
</p>
<h3 id="async_clientblock">
<code>
async_client.block
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Blocks Redis for command invocation. All the command that are executed inside the given function is considered atomic and will be wrapped with
<code>
Multi/Exec
</code>
and send to the replica/AOF.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><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></span><span class="line"><span class="cl"> <span class="kd">function</span><span class="p">(</span><span class="nx">client</span><span class="p">){}</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="async_clientrunonkey">
<code>
async_client.runOnKey
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Runs a remote function on a given key. If the key located on the current shard on which we currently runs on, the remote function will run write away. Otherwise the remote function will run on the remote shard. Returns a promise which will be fulfilled when the invocation finishes. Notice that the remote function must return a json serializable result so we can serialize the result back to the original shard.
</p>
<p>
Notice that remote function can only perform read operations, not writes are allowed.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">async_client</span><span class="p">.</span><span class="nx">runOnKey</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'key1'</span><span class="p">,</span> <span class="c1">// key
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">// function name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="p">...</span><span class="nx">args</span>
</span></span><span class="line"><span class="cl"><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="async_clientrunonshards">
<code>
async_client.runOnShards
</code>
</h3>
<ul>
<li>
Since version: 2.0.0
</li>
</ul>
<p>
Runs a remote function on all the shards. Returns a promise which will be fulfilled when the invocation finishes on all the shards.
</p>
<p>
The result is array of 2 elements, the first is another array of all the results. The second is an array of all the errors happened durring the invocation. Notice that the remote function must return a json serializable result so we can serialize the result back to the original shard.
</p>
<p>
Notice that remote function can only perform read operations, not writes are allowed.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-JavaScript" data-lang="JavaScript"><span class="line"><span class="cl"><span class="nx">async_client</span><span class="p">.</span><span class="nx">runOnShards</span><span class="p">(</span>
</span></span><span class="line"><span class="cl"> <span class="s1">'foo'</span><span class="p">,</span> <span class="c1">//name
</span></span></span><span class="line"><span class="cl"><span class="c1"></span> <span class="p">...</span><span class="nx">args</span> <span class="c1">//arguments
</span></span></span><span class="line"><span class="cl"><span class="c1"></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/concepts/javascript_api/"/>
<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/configuring/change-location-socket-files/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Change socket file locations
</h1>
<p class="text-lg -mt-5 mb-10">
Change socket file locations.
</p>
<h2 id="default-socket-file-locations">
Default socket file locations
</h2>
<p>
There are two default locations for the socket files in Redis Enterprise Software:
</p>
<ul>
<li>
<p>
<code>
/tmp
</code>
- In clean installations of Redis Enterprise Software version earlier than 5.2.2
</p>
</li>
<li>
<p>
<code>
/var/opt/redislabs/run
</code>
- In clean installations of Redis Enterprise Software version 5.2.2 and later
</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 default location was changed in case you run any maintenance procedures that delete the
<code>
/tmp
</code>
directory.
</div>
</div>
</li>
</ul>
<p>
When you upgrade Redis Enterprise Software from an earlier version to 5.2.2 or later, the socket files
are not moved to the new location by default. You need to either specify a custom location
for the socket files during
<a href="/docs/latest/operate/rs/7.4/installing-upgrading/">
installation
</a>
or use the
<a href="#change-socket-file-locations">
following procedure
</a>
after installation.
</p>
<h2 id="change-socket-file-locations">
Change socket file locations
</h2>
<p>
To change the location of the socket files:
</p>
<ol>
<li>
<p>
On each node in the cluster, run:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo rlutil create_socket_path <span class="nv">socket_path</span><span class="o">=</span>/var/opt/redislabs/run
</span></span></code></pre>
</div>
</li>
<li>
<p>
Identify the node with the
<code>
master
</code>
role by running the following command on any node in the cluster:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin status nodes
</span></span></code></pre>
</div>
</li>
<li>
<p>
On the master node, change the socket file location:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo rlutil set_socket_path <span class="nv">socket_path</span><span class="o">=</span>/var/opt/redislabs/run
</span></span></code></pre>
</div>
</li>
<li>
<p>
To update the socket file location for all other nodes, restart Redis Enterprise Software on each node in the cluster, one at a time:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">sudo service rlec_supervisor restart
</span></span></code></pre>
</div>
</li>
<li>
<p>
Restart each database in the cluster to update the socket file location:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">rladmin restart db <db name>
</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>
Restarting databases can cause interruptions in data traffic.
</div>
</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/rs/7.4/installing-upgrading/configuring/change-location-socket-files/"/>
<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/redisgraph/redisgraph-1.2-release-notes/.html | <section class="prose w-full py-12 max-w-none">
<h1>
RedisGraph 1.2 release notes
</h1>
<p class="text-lg -mt-5 mb-10">
Support multiple relationships of the same type R connecting two nodes. Lexer elides escape characters in string creation. Performance improvements.
</p>
<h2 id="requirements">
Requirements
</h2>
<p>
RedisGraph v1.2.2 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="v122-may-2019">
v1.2.2 (May 2019)
</h2>
<p>
Update urgency: Medium
This is a maintenance release for version 1.2.
</p>
<p>
This release improves overall stability and provides fixes for issues found after the previous release.
</p>
<h2 id="v120-april-2019">
v1.2.0 (April 2019)
</h2>
<p>
This is a major release for RedisGraph.
Compared to previous release 1.0.15:
</p>
<ul>
<li>
Added functionality
<ul>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/452">
452
</a>
Support multiple relationships of the same type R connecting two nodes
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/392">
392
</a>
Lexer elides escape characters in string creation: support for property values with
<code>
'
</code>
or
<code>
"
</code>
</li>
</ul>
</li>
<li>
Performance improvements
<ul>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/442">
442
</a>
Seek graph entity by id:
<code>
MATCH (n) WHERE ID(n) = 5 RETURN n
</code>
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/422">
422
</a>
<code>
MATCH (n) RETURN COUNT(n)
</code>
is now O(1)
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/421">
421
</a>
and #
<a href="https://github.com/RedisGraph/RedisGraph/issues/459">
459
</a>
Lazy loading of matrices on subsequent writes of relationships and nodes
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/399">
399
</a>
Single transpose of matrices
</li>
</ul>
</li>
<li>
Minor Bugfixes:
<ul>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/456">
456
</a>
Memory leaks
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/439">
439
</a>
When label doesn't exists, the node count should return 0 #
<a href="https://github.com/RedisGraph/RedisGraph/issues/439">
439
</a>
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/435">
435
</a>
Referencing non existing properties #
<a href="https://github.com/RedisGraph/RedisGraph/issues/435">
435
</a>
</li>
</ul>
</li>
</ul>
<p>
Compared to 1.0:
</p>
<ul>
<li>
Added functionality
<ul>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/390">
390
</a>
GraphBLAS 2.3.0
<a href="https://github.com/RedisLabsModules/RedisGraph/pull/390#issuecomment-470620353">
release notes
</a>
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/452">
452
</a>
Support multiple relationships of the same type R connecting two nodes
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/392">
392
</a>
Lexer elides escape characters in string creation: support for property values with ' or "
</li>
<li>
Enhanced cypher
<ul>
<li>
Initial support for WITH clause: Allows query parts to be chained together, piping the results from one to be used as starting points or criteria of the next.
<a href="https://s3.amazonaws.com/artifacts.opencypher.org/openCypher9.pdf">
ref p.78
</a>
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/247">
247
</a>
Initial support for UNWIND
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/244">
244
</a>
RETURN * (give me everything bro)
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/236">
236
</a>
TYPE function (returns the type of a relationship)
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/288">
288
</a>
Querying patterns where a relationship between two nodes can be of different types. ()-[:A|:B]->()
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/252">
252
</a>
Multiple MATCH clauses
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/327">
327
</a>
Multiple CREATE clauses
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/305">
305
</a>
MERGE + SET
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/348">
348
</a>
Smaller memory footprint - encode properties
</li>
</ul>
</li>
<li>
<a href="https://github.com/RedisGraph/redisgraph-bulk-loader">
Faster and better bulk loading
</a>
</li>
</ul>
</li>
<li>
Performance improvements
<ul>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/442">
442
</a>
Seek graph entity by id: MATCH (n) WHERE ID(n) = 5 RETURN n
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/422">
422
</a>
MATCH (n) RETURN COUNT(n) is now O(1)
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/421">
421
</a>
and #
<a href="https://github.com/RedisGraph/RedisGraph/issues/459">
459
</a>
Lazy loading of matrices on subsequent writes of relationships and nodes
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/399">
399
</a>
Single transpose of matrices
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/393">
393
</a>
Discard distinct when performing aggregation
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/289">
289
</a>
Index utilization when performing Cartesian product
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/308">
308
</a>
Granular writer locking
</li>
</ul>
</li>
<li>
Most noticeable bugfixes
<ul>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/456">
456
</a>
Memory leaks
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/439">
439
</a>
When label doesn't exists, the node count should return 0
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/435">
435
</a>
Referencing non existing properties
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/359">
359
</a>
Adding ORDER BY changes the number of returned hits when used in combination with LIMIT
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/363">
363
</a>
Remove graph entity property when it is set to null
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/386">
386
</a>
Return updated values on queries that modify data
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/249">
249
</a>
reset operation within execution plan should propagate upwards
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/259">
259
</a>
Replace operations appropriately when rewriting execution plan
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/262">
262
</a>
Entity returned from datablock should have its internals cleared
</li>
<li>
#
<a href="https://github.com/RedisGraph/RedisGraph/issues/264">
264
</a>
Loaded triemap strings are not guaranteed space for a null terminator
</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/redisgraph/redisgraph-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/ft.explaincli.html | <section class="prose w-full py-12">
<h1 class="command-name">
FT.EXPLAINCLI
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">FT.EXPLAINCLI 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 but formatted for easier reading without using
<code>
redis-cli --raw
</code>
</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>
<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>
In the returned response, a
<code>
+
</code>
on a term is an indication of stemming.
</div>
</div>
</details>
<h2 id="return">
Return
</h2>
<p>
FT.EXPLAINCLI returns an array reply with 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
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">127.0.0.1:6379> FT.EXPLAINCLI rd <span class="s2">"(foo bar)|(hello world) @date:[100 200]|@date:[500 +inf]"</span>
</span></span><span class="line"><span class="cl"> 1<span class="o">)</span> INTERSECT <span class="o">{</span>
</span></span><span class="line"><span class="cl"> 2<span class="o">)</span> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl"> 3<span class="o">)</span> INTERSECT <span class="o">{</span>
</span></span><span class="line"><span class="cl"> 4<span class="o">)</span> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl"> 5<span class="o">)</span> foo
</span></span><span class="line"><span class="cl"> 6<span class="o">)</span> +foo<span class="o">(</span>expanded<span class="o">)</span>
</span></span><span class="line"><span class="cl"> 7<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl"> 8<span class="o">)</span> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl"> 9<span class="o">)</span> bar
</span></span><span class="line"><span class="cl">10<span class="o">)</span> +bar<span class="o">(</span>expanded<span class="o">)</span>
</span></span><span class="line"><span class="cl">11<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">12<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">13<span class="o">)</span> INTERSECT <span class="o">{</span>
</span></span><span class="line"><span class="cl">14<span class="o">)</span> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl">15<span class="o">)</span> hello
</span></span><span class="line"><span class="cl">16<span class="o">)</span> +hello<span class="o">(</span>expanded<span class="o">)</span>
</span></span><span class="line"><span class="cl">17<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">18<span class="o">)</span> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl">19<span class="o">)</span> world
</span></span><span class="line"><span class="cl">20<span class="o">)</span> +world<span class="o">(</span>expanded<span class="o">)</span>
</span></span><span class="line"><span class="cl">21<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">22<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">23<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">24<span class="o">)</span> UNION <span class="o">{</span>
</span></span><span class="line"><span class="cl">25<span class="o">)</span> NUMERIC <span class="o">{</span>100.000000 <<span class="o">=</span> @date <<span class="o">=</span> 200.000000<span class="o">}</span>
</span></span><span class="line"><span class="cl">26<span class="o">)</span> NUMERIC <span class="o">{</span>500.000000 <<span class="o">=</span> @date <<span class="o">=</span> inf<span class="o">}</span>
</span></span><span class="line"><span class="cl">27<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">28<span class="o">)</span> <span class="o">}</span>
</span></span><span class="line"><span class="cl">29<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.explaincli/"/>
<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/crdb-cli/crdb/get/.html | <section class="prose w-full py-12 max-w-none">
<h1>
crdb-cli crdb get
</h1>
<p class="text-lg -mt-5 mb-10">
Shows the current configuration of an Active-Active database.
</p>
<p>
Shows the current configuration of an Active-Active database.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">crdb-cli crdb get --crdb-guid <guid>
</span></span></code></pre>
</div>
<h3 id="parameters">
Parameters
</h3>
<table>
<thead>
<tr>
<th>
Parameter
</th>
<th>
Value
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
crdb-guid
</td>
<td>
string
</td>
<td>
The GUID of the database (required)
</td>
</tr>
</tbody>
</table>
<h3 id="returns">
Returns
</h3>
<p>
Returns the current configuration of the database.
</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">$ crdb-cli crdb get --crdb-guid d84f6fe4-5bb7-49d2-a188-8900e09c6f66
</span></span><span class="line"><span class="cl">CRDB-GUID: d84f6fe4-5bb7-49d2-a188-8900e09c6f66
</span></span><span class="line"><span class="cl">Name: database1
</span></span><span class="line"><span class="cl">Encryption: False
</span></span><span class="line"><span class="cl">Causal consistency: False
</span></span><span class="line"><span class="cl">Protocol version: <span class="m">1</span>
</span></span><span class="line"><span class="cl">FeatureSet version: <span class="m">5</span>
</span></span><span class="line"><span class="cl">Modules: <span class="o">[]</span>
</span></span><span class="line"><span class="cl">Default-DB-Config:
</span></span><span class="line"><span class="cl"> memory_size: <span class="m">1073741824</span>
</span></span><span class="line"><span class="cl"> port: <span class="m">12000</span>
</span></span><span class="line"><span class="cl"> replication: True
</span></span><span class="line"><span class="cl"> shard_key_regex: <span class="o">[{</span><span class="s1">'regex'</span>: <span class="s1">'.*\\{(?<tag>.*)\\}.*'</span><span class="o">}</span>, <span class="o">{</span><span class="s1">'regex'</span>: <span class="s1">'(?<tag>.*)'</span><span class="o">}]</span>
</span></span><span class="line"><span class="cl"> sharding: True
</span></span><span class="line"><span class="cl"> shards_count: <span class="m">1</span>
</span></span><span class="line"><span class="cl"> tls_mode: disabled
</span></span><span class="line"><span class="cl"> rack_aware: None
</span></span><span class="line"><span class="cl"> data_persistence: None
</span></span><span class="line"><span class="cl"> authentication_redis_pass: None
</span></span><span class="line"><span class="cl"> authentication_admin_pass: None
</span></span><span class="line"><span class="cl"> oss_sharding: None
</span></span><span class="line"><span class="cl"> oss_cluster: None
</span></span><span class="line"><span class="cl"> proxy_policy: None
</span></span><span class="line"><span class="cl"> shards_placement: None
</span></span><span class="line"><span class="cl"> oss_cluster_api_preferred_ip_type: None
</span></span><span class="line"><span class="cl"> bigstore: None
</span></span><span class="line"><span class="cl"> bigstore_ram_size: None
</span></span><span class="line"><span class="cl"> aof_policy: None
</span></span><span class="line"><span class="cl"> snapshot_policy: None
</span></span><span class="line"><span class="cl"> max_aof_load_time: None
</span></span><span class="line"><span class="cl"> max_aof_file_size: None
</span></span><span class="line"><span class="cl">Instance:
</span></span><span class="line"><span class="cl"> Id: <span class="m">1</span>
</span></span><span class="line"><span class="cl"> Cluster:
</span></span><span class="line"><span class="cl"> FQDN: cluster1.redis.local
</span></span><span class="line"><span class="cl"> URL: https://cluster1.redis.local:9443
</span></span><span class="line"><span class="cl"> Replication-Endpoint: <Default>
</span></span><span class="line"><span class="cl"> Replication TLS SNI: <Default>
</span></span><span class="line"><span class="cl"> Compression: <span class="m">3</span>
</span></span><span class="line"><span class="cl"> DB-Config:
</span></span><span class="line"><span class="cl"> authentication_admin_pass:
</span></span><span class="line"><span class="cl"> replication: None
</span></span><span class="line"><span class="cl"> rack_aware: None
</span></span><span class="line"><span class="cl"> memory_size: None
</span></span><span class="line"><span class="cl"> data_persistence: None
</span></span><span class="line"><span class="cl"> tls_mode: None
</span></span><span class="line"><span class="cl"> authentication_redis_pass: None
</span></span><span class="line"><span class="cl"> port: None
</span></span><span class="line"><span class="cl"> shards_count: None
</span></span><span class="line"><span class="cl"> shard_key_regex: None
</span></span><span class="line"><span class="cl"> oss_sharding: None
</span></span><span class="line"><span class="cl"> oss_cluster: None
</span></span><span class="line"><span class="cl"> proxy_policy: None
</span></span><span class="line"><span class="cl"> shards_placement: None
</span></span><span class="line"><span class="cl"> oss_cluster_api_preferred_ip_type: None
</span></span><span class="line"><span class="cl"> bigstore: None
</span></span><span class="line"><span class="cl"> bigstore_ram_size: None
</span></span><span class="line"><span class="cl"> aof_policy: None
</span></span><span class="line"><span class="cl"> snapshot_policy: None
</span></span><span class="line"><span class="cl"> max_aof_load_time: None
</span></span><span class="line"><span class="cl"> max_aof_file_size: None
</span></span><span class="line"><span class="cl">Instance:
</span></span><span class="line"><span class="cl"> Id: <span class="m">2</span>
</span></span><span class="line"><span class="cl"> Cluster:
</span></span><span class="line"><span class="cl"> FQDN: cluster2.redis.local
</span></span><span class="line"><span class="cl"> URL: https://cluster2.redis.local:9443
</span></span><span class="line"><span class="cl"> Replication-Endpoint: <Default>
</span></span><span class="line"><span class="cl"> Replication TLS SNI: <Default>
</span></span><span class="line"><span class="cl"> Compression: <span class="m">3</span>
</span></span><span class="line"><span class="cl"> DB-Config:
</span></span><span class="line"><span class="cl"> authentication_admin_pass:
</span></span><span class="line"><span class="cl"> replication: None
</span></span><span class="line"><span class="cl"> rack_aware: None
</span></span><span class="line"><span class="cl"> memory_size: None
</span></span><span class="line"><span class="cl"> data_persistence: None
</span></span><span class="line"><span class="cl"> tls_mode: None
</span></span><span class="line"><span class="cl"> authentication_redis_pass: None
</span></span><span class="line"><span class="cl"> port: None
</span></span><span class="line"><span class="cl"> shards_count: None
</span></span><span class="line"><span class="cl"> shard_key_regex: None
</span></span><span class="line"><span class="cl"> oss_sharding: None
</span></span><span class="line"><span class="cl"> oss_cluster: None
</span></span><span class="line"><span class="cl"> proxy_policy: None
</span></span><span class="line"><span class="cl"> shards_placement: None
</span></span><span class="line"><span class="cl"> oss_cluster_api_preferred_ip_type: None
</span></span><span class="line"><span class="cl"> bigstore: None
</span></span><span class="line"><span class="cl"> bigstore_ram_size: None
</span></span><span class="line"><span class="cl"> aof_policy: None
</span></span><span class="line"><span class="cl"> snapshot_policy: None
</span></span><span class="line"><span class="cl"> max_aof_load_time: None
</span></span><span class="line"><span class="cl"> max_aof_file_size: None
</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/crdb-cli/crdb/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/integrate/redis-data-integration/data-pipelines/prepare-dbs/oracle/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Prepare Oracle and Oracle RAC for RDI
</h1>
<p class="text-lg -mt-5 mb-10">
Prepare Oracle and Oracle RAC databases to work with RDI
</p>
<p>
The Oracle Debezium connector uses
<a href="https://docs.oracle.com/en/database/oracle/oracle-database/19/sutil/oracle-logminer-utility.html">
Oracle LogMiner
</a>
to get data from the commitlog to a view inside the database. Follow the
steps below to configure LogMiner and prepare your database for use with
RDI.
</p>
<h2 id="1-configure-oracle-logminer">
1. Configure Oracle LogMiner
</h2>
<p>
The following example shows the configuration for Oracle LogMiner.
</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>
<a href="https://aws.amazon.com/rds/oracle/">
Amazon RDS for Oracle
</a>
doesn't let you execute the commands
in the example below or let you log in as
<code>
sysdba
</code>
. See the
separate example below to
<a href="#config-aws">
configure Amazon RDS for Oracle
</a>
.
</div>
</div>
<div class="highlight">
<pre class="chroma"><code class="language-sql" data-lang="sql"><span class="line"><span class="cl"><span class="n">ORACLE_SID</span><span class="o">=</span><span class="n">ORACLCDB</span><span class="w"> </span><span class="n">dbz_oracle</span><span class="w"> </span><span class="n">sqlplus</span><span class="w"> </span><span class="o">/</span><span class="n">nolog</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">CONNECT</span><span class="w"> </span><span class="n">sys</span><span class="o">/</span><span class="n">top_secret</span><span class="w"> </span><span class="k">AS</span><span class="w"> </span><span class="n">SYSDBA</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">alter</span><span class="w"> </span><span class="k">system</span><span class="w"> </span><span class="k">set</span><span class="w"> </span><span class="n">db_recovery_file_dest_size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">10</span><span class="k">G</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">alter</span><span class="w"> </span><span class="k">system</span><span class="w"> </span><span class="k">set</span><span class="w"> </span><span class="n">db_recovery_file_dest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'/opt/oracle/oradata/recovery_area'</span><span class="w"> </span><span class="k">scope</span><span class="o">=</span><span class="n">spfile</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">shutdown</span><span class="w"> </span><span class="k">immediate</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">startup</span><span class="w"> </span><span class="n">mount</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">alter</span><span class="w"> </span><span class="k">database</span><span class="w"> </span><span class="n">archivelog</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">alter</span><span class="w"> </span><span class="k">database</span><span class="w"> </span><span class="k">open</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c1">-- You should now see "Database log mode: Archive Mode"
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="n">archive</span><span class="w"> </span><span class="n">log</span><span class="w"> </span><span class="n">list</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">exit</span><span class="p">;</span><span class="w">
</span></span></span></code></pre>
</div>
<h3 id="config-aws">
Configure Amazon RDS for Oracle
</h3>
<p>
AWS provides its own set of commands to configure LogMiner.
</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>
Before executing these commands,
you must enable backups on your Oracle AWS RDS instance.
</div>
</div>
<p>
Check that Oracle has backups enabled with the following command:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sql" data-lang="sql"><span class="line"><span class="cl"><span class="k">SQL</span><span class="o">></span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="n">LOG_MODE</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">V$DATABASE</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">LOG_MODE</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="c1">------------
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="n">ARCHIVELOG</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
The
<code>
LOG_MODE
</code>
should be set to
<code>
ARCHIVELOG
</code>
. If it isn't then you
should reboot your Oracle AWS RDS instance.
</p>
<p>
Once
<code>
LOG_MODE
</code>
is correctly set to ARCHIVELOG, execute the following
commands to complete the LogMiner configuration. The first command enables
archive logging and the second adds
<a href="#supp-logging">
supplemental logging
</a>
.
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sql" data-lang="sql"><span class="line"><span class="cl"><span class="k">exec</span><span class="w"> </span><span class="n">rdsadmin</span><span class="p">.</span><span class="n">rdsadmin_util</span><span class="p">.</span><span class="n">set_configuration</span><span class="p">(</span><span class="s1">'archivelog retention hours'</span><span class="p">,</span><span class="mi">24</span><span class="p">);</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">exec</span><span class="w"> </span><span class="n">rdsadmin</span><span class="p">.</span><span class="n">rdsadmin_util</span><span class="p">.</span><span class="n">alter_supplemental_logging</span><span class="p">(</span><span class="s1">'ADD'</span><span class="p">);</span><span class="w">
</span></span></span></code></pre>
</div>
<h2 id="supp-logging">
2. Enable supplemental logging
</h2>
<p>
You must enable supplemental logging for the tables you want to capture or
for the entire database. This lets Debezium capture the state of
database rows before and after changes occur.
</p>
<p>
The following example shows how to configure supplemental logging for all columns
in a single table called
<code>
inventory.customers
</code>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sql" data-lang="sql"><span class="line"><span class="cl"><span class="k">ALTER</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="n">inventory</span><span class="p">.</span><span class="n">customers</span><span class="w"> </span><span class="k">ADD</span><span class="w"> </span><span class="n">SUPPLEMENTAL</span><span class="w"> </span><span class="n">LOG</span><span class="w"> </span><span class="k">DATA</span><span class="w"> </span><span class="p">(</span><span class="k">ALL</span><span class="p">)</span><span class="w"> </span><span class="n">COLUMNS</span><span class="p">;</span><span class="w">
</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>
If you enable supplemental logging for
<em>
all
</em>
table columns, you will
probably see the size of the Oracle redo logs increase dramatically. Avoid this
by using supplemental logging only when you need it.
</div>
</div>
<p>
You must also enable minimal supplemental logging at the database level with
the following command:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sql" data-lang="sql"><span class="line"><span class="cl"><span class="k">ALTER</span><span class="w"> </span><span class="k">DATABASE</span><span class="w"> </span><span class="k">ADD</span><span class="w"> </span><span class="n">SUPPLEMENTAL</span><span class="w"> </span><span class="n">LOG</span><span class="w"> </span><span class="k">DATA</span><span class="p">;</span><span class="w">
</span></span></span></code></pre>
</div>
<h2 id="3-check-the-redo-log-sizing">
3. Check the redo log sizing
</h2>
<p>
Before you use the Debezium connector, you should check with your
database administrator that there are enough
redo logs with enough capacity to store the data dictionary for your
database. In general, the size of the data dictionary increases with the number
of tables and columns in the database. If you don't have enough capacity in
the logs then you might see performance problems with both the database and
the Debezium connector.
</p>
<h2 id="4-set-the-archive-log-destination">
4. Set the Archive log destination
</h2>
<p>
You can configure up to 31 different destinations for archive logs
(you must have administrator privileges to do this). You can set parameters for
each destination to specify its purpose, such as log shipping for physical
standbys, or external storage to allow for extended log retention. Oracle reports
details about archive log destinations in the
<code>
V$ARCHIVE_DEST_STATUS
</code>
view.
</p>
<p>
The Debezium Oracle connector only uses destinations that have a status of
<code>
VALID
</code>
and a type of
<code>
LOCAL
</code>
. If you only have one destination with these
settings then Debezium will use it automatically.
If you have more than one destination with these settings,
then you should consult your database administrator about which one to
choose for Debezium.
</p>
<p>
Use the
<code>
log.mining.archive.destination.name
</code>
property in the connector configuration
to select the archive log destination for Debezium.
</p>
<p>
For example, suppose you have two archive destinations,
<code>
LOG_ARCHIVE_DEST_2
</code>
and
<code>
LOG_ARCHIVE_DEST_3
</code>
, and they both have status set to
<code>
VALID
</code>
and type set to
<code>
LOCAL
</code>
. Debezium could use either of these destinations, so you must select one
of them explicitly in the configuration. To select
<code>
LOG_ARCHIVE_DEST_3
</code>
, you would
use the following setting:
</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">"log.mining.archive.destination.name"</span><span class="p">:</span> <span class="s2">"LOG_ARCHIVE_DEST_3"</span>
</span></span><span class="line"><span class="cl"><span class="p">}</span>
</span></span></code></pre>
</div>
<h2 id="5-create-a-user-for-the-connector">
5. Create a user for the connector
</h2>
<p>
The Debezium Oracle connector must run as an Oracle LogMiner user with
specific permissions. The following example shows some SQL that creates
an Oracle user account for the connector in a multi-tenant database model:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-sql" data-lang="sql"><span class="line"><span class="cl"><span class="n">sqlplus</span><span class="w"> </span><span class="n">sys</span><span class="o">/</span><span class="n">top_secret</span><span class="o">@//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">1521</span><span class="o">/</span><span class="n">ORCLCDB</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">sysdba</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">CREATE</span><span class="w"> </span><span class="n">TABLESPACE</span><span class="w"> </span><span class="n">logminer_tbs</span><span class="w"> </span><span class="n">DATAFILE</span><span class="w"> </span><span class="s1">'/opt/oracle/oradata/ORCLCDB/logminer_tbs.dbf'</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="k">SIZE</span><span class="w"> </span><span class="mi">25</span><span class="n">M</span><span class="w"> </span><span class="n">REUSE</span><span class="w"> </span><span class="n">AUTOEXTEND</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">MAXSIZE</span><span class="w"> </span><span class="n">UNLIMITED</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">exit</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">sqlplus</span><span class="w"> </span><span class="n">sys</span><span class="o">/</span><span class="n">top_secret</span><span class="o">@//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">1521</span><span class="o">/</span><span class="n">ORCLPDB1</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">sysdba</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">CREATE</span><span class="w"> </span><span class="n">TABLESPACE</span><span class="w"> </span><span class="n">logminer_tbs</span><span class="w"> </span><span class="n">DATAFILE</span><span class="w"> </span><span class="s1">'/opt/oracle/oradata/ORCLCDB/ORCLPDB1/logminer_tbs.dbf'</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="k">SIZE</span><span class="w"> </span><span class="mi">25</span><span class="n">M</span><span class="w"> </span><span class="n">REUSE</span><span class="w"> </span><span class="n">AUTOEXTEND</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">MAXSIZE</span><span class="w"> </span><span class="n">UNLIMITED</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">exit</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">sqlplus</span><span class="w"> </span><span class="n">sys</span><span class="o">/</span><span class="n">top_secret</span><span class="o">@//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">1521</span><span class="o">/</span><span class="n">ORCLCDB</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">sysdba</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">CREATE</span><span class="w"> </span><span class="k">USER</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">IDENTIFIED</span><span class="w"> </span><span class="k">BY</span><span class="w"> </span><span class="n">dbz</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="k">DEFAULT</span><span class="w"> </span><span class="n">TABLESPACE</span><span class="w"> </span><span class="n">logminer_tbs</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="n">QUOTA</span><span class="w"> </span><span class="n">UNLIMITED</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">logminer_tbs</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">CREATE</span><span class="w"> </span><span class="k">SESSION</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SET</span><span class="w"> </span><span class="n">CONTAINER</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$DATABASE</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="n">FLASHBACK</span><span class="w"> </span><span class="k">ANY</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ANY</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="n">SELECT_CATALOG_ROLE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="n">EXECUTE_CATALOG_ROLE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ANY</span><span class="w"> </span><span class="k">TRANSACTION</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="n">LOGMINING</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">CREATE</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">LOCK</span><span class="w"> </span><span class="k">ANY</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">CREATE</span><span class="w"> </span><span class="n">SEQUENCE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">EXECUTE</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">DBMS_LOGMNR</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">EXECUTE</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">DBMS_LOGMNR_D</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$LOG</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$LOG_HISTORY</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$LOGMNR_LOGS</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$LOGMNR_CONTENTS</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$LOGMNR_PARAMETERS</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$LOGFILE</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$ARCHIVED_LOG</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$ARCHIVE_DEST_STATUS</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$TRANSACTION</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$MYSTAT</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="k">GRANT</span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="k">ON</span><span class="w"> </span><span class="n">V_$STATNAME</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="k">c</span><span class="o">##</span><span class="n">dbzuser</span><span class="w"> </span><span class="n">CONTAINER</span><span class="o">=</span><span class="k">ALL</span><span class="p">;</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="n">exit</span><span class="p">;</span><span class="w">
</span></span></span></code></pre>
</div>
<h2 id="6-configuration-is-complete">
6. Configuration is complete
</h2>
<p>
Once you have followed the steps above, your Oracle database is ready
for Debezium to use.
</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/data-pipelines/prepare-dbs/oracle/"/>
<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/reference/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Reference
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Community Edition and Redis Stack reference documentation
</p>
<nav>
<a href="/docs/latest/operate/oss_and_stack/reference/signals/">
Redis signal handling
</a>
<p>
How Redis handles common Unix signals
</p>
<a href="/docs/latest/operate/oss_and_stack/reference/cluster-spec/">
Redis cluster specification
</a>
<p>
Detailed specification for Redis cluster
</p>
<a href="/docs/latest/operate/oss_and_stack/reference/arm/">
ARM support
</a>
<p>
Exploring Redis on the ARM CPU Architecture
</p>
<a href="/docs/latest/operate/oss_and_stack/reference/internals/">
Redis internals
</a>
<p>
Documents describing internals in early Redis implementations
</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/reference/"/>
<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/logs/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Logs requests
</h1>
<p class="text-lg -mt-5 mb-10">
Cluster event logs requests
</p>
<table>
<thead>
<tr>
<th>
Method
</th>
<th>
Path
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a href="#get-logs">
GET
</a>
</td>
<td>
<code>
/v1/logs
</code>
</td>
<td>
Get cluster events log
</td>
</tr>
</tbody>
</table>
<h2 id="get-logs">
Get cluster events log
</h2>
<pre><code>GET /v1/logs
</code></pre>
<p>
Get cluster events log.
</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_logged_events">
view_logged_events
</a>
</td>
</tr>
</tbody>
</table>
<h3 id="get-request">
Request
</h3>
<h4 id="example-http-request">
Example HTTP request
</h4>
<pre><code>GET /logs?order=desc
</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="query-parameters">
Query parameters
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Type
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
stime
</td>
<td>
ISO_8601
</td>
<td>
Start time before which we don't want events. (optional)
</td>
</tr>
<tr>
<td>
etime
</td>
<td>
ISO_8601
</td>
<td>
End time after which we don't want events. (optional)
</td>
</tr>
<tr>
<td>
order
</td>
<td>
string
</td>
<td>
desc/asc - get events in descending or ascending order. Defaults to asc.
</td>
</tr>
<tr>
<td>
limit
</td>
<td>
integer
</td>
<td>
Maximum number of events to return. (optional)
</td>
</tr>
<tr>
<td>
offset
</td>
<td>
integer
</td>
<td>
Skip offset events before returning first one (useful for pagination). (optional)
</td>
</tr>
</tbody>
</table>
<h3 id="get-response">
Response
</h3>
<p>
Returns a JSON array of events.
</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">"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">"type"</span><span class="p">:</span> <span class="s2">"bdb_name_updated"</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">"INFO"</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="s2">"1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"old_val"</span><span class="p">:</span> <span class="s2">"test"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"new_val"</span><span class="p">:</span> <span class="s2">"test123"</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">"time"</span><span class="p">:</span> <span class="s2">"2014-08-29T11:18:48Z"</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">"cluster_bdb_created"</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">"INFO"</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="s2">"1"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"bdb_name"</span><span class="p">:</span> <span class="s2">"test"</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">"time"</span><span class="p">:</span> <span class="s2">"2014-08-29T11:17:49Z"</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">"cluster_node_joined"</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">"INFO"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">"node_uid"</span><span class="p">:</span> <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></code></pre>
</div>
<h4 id="event-object">
Event object
</h4>
<table>
<thead>
<tr>
<th>
Field
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
time
</td>
<td>
Timestamp when event happened.
</td>
</tr>
<tr>
<td>
type
</td>
<td>
Event type. Additional fields may be available for certain event types.
</td>
</tr>
<tr>
<td>
additional fields
</td>
<td>
Additional fields may be present based on event type.
</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>
No error
</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/logs/"/>
<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/api/schema/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Schema
</h1>
<p class="text-lg -mt-5 mb-10">
The schema APIs
</p>
<p>
Schema in RedisVL provides a structured format to define index settings and
field configurations using the following three components:
</p>
<table>
<thead>
<tr>
<th>
Component
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
version
</td>
<td>
The version of the schema spec. Current supported version is 0.1.0.
</td>
</tr>
<tr>
<td>
index
</td>
<td>
Index specific settings like name, key prefix, key separator, and storage type.
</td>
</tr>
<tr>
<td>
fields
</td>
<td>
Subset of fields within your data to include in the index and any custom settings.
</td>
</tr>
</tbody>
</table>
<h2 id="indexschema">
IndexSchema
</h2>
<p>
<a id="indexschema-api">
</a>
</p>
<h3 id="class-indexschema-index-fields-version010">
<em>
class
</em>
IndexSchema(*, index, fields={}, version='0.1.0')
</h3>
<p>
A schema definition for a search index in Redis, used in RedisVL for
configuring index settings and organizing vector and metadata fields.
</p>
<p>
The class offers methods to create an index schema from a YAML file or a
Python dictionary, supporting flexible schema definitions and easy
integration into various workflows.
</p>
<p>
An example schema.yaml file might look like this:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="s1">'0.1.0'</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">index</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">user-index</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">prefix</span><span class="p">:</span><span class="w"> </span><span class="l">user</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">key_separator</span><span class="p">:</span><span class="w"> </span><span class="s2">":"</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">storage_type</span><span class="p">:</span><span class="w"> </span><span class="l">json</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">fields</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">user</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">tag</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">credit_score</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">tag</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">embedding</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">vector</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">attrs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">algorithm</span><span class="p">:</span><span class="w"> </span><span class="l">flat</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">dims</span><span class="p">:</span><span class="w"> </span><span class="m">3</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">distance_metric</span><span class="p">:</span><span class="w"> </span><span class="l">cosine</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">datatype</span><span class="p">:</span><span class="w"> </span><span class="l">float32</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
Loading the schema for RedisVL from yaml is as simple as:
</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.schema</span> <span class="kn">import</span> <span class="n">IndexSchema</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="n">IndexSchema</span><span class="o">.</span><span class="n">from_yaml</span><span class="p">(</span><span class="s2">"schema.yaml"</span><span class="p">)</span>
</span></span></code></pre>
</div>
<p>
Loading the schema for RedisVL from dict is as simple as:
</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.schema</span> <span class="kn">import</span> <span class="n">IndexSchema</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="n">IndexSchema</span><span class="o">.</span><span class="n">from_dict</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-index"</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"</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="s2">"key_separator"</span><span class="p">:</span> <span class="s2">":"</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></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></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"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">"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">"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">"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="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 fields attribute in the schema must contain unique field names to ensure
correct and unambiguous field references.
</div>
</div>
<p>
Create a new model by parsing and validating input data from keyword arguments.
</p>
<p>
Raises ValidationError if the input data cannot be parsed to form a valid model.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<ul>
<li>
<strong>
index
</strong>
(
<em>
IndexInfo
</em>
) –
</li>
<li>
<strong>
fields
</strong>
(
<em>
Dict
</em>
*[*
<em>
str
</em>
<em>
,
</em>
<em>
BaseField
</em>
<em>
]
</em>
) –
</li>
<li>
<strong>
version
</strong>
(
<em>
str
</em>
) –
</li>
</ul>
</li>
</ul>
<h3 id="add_fieldfield_inputs">
add_field(field_inputs)
</h3>
<p>
Adds a single field to the index schema based on the specified field
type and attributes.
</p>
<p>
This method allows for the addition of individual fields to the schema,
providing flexibility in defining the structure of the index.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<strong>
field_inputs
</strong>
(
<em>
Dict
</em>
*[*
<em>
str
</em>
<em>
,
</em>
<em>
Any
</em>
<em>
]
</em>
) – A field to add.
</li>
<li>
<strong>
Raises:
</strong>
<strong>
ValueError
</strong>
– If the field name or type are not provided or if the name
already exists within the schema.
</li>
</ul>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="c1"># Add a tag field</span>
</span></span><span class="line"><span class="cl"><span class="n">schema</span><span class="o">.</span><span class="n">add_field</span><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></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="c1"># Add a vector field</span>
</span></span><span class="line"><span class="cl"><span class="n">schema</span><span class="o">.</span><span class="n">add_field</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-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">1024</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></code></pre>
</div>
<h3 id="add_fieldsfields">
add_fields(fields)
</h3>
<p>
Extends the schema with additional fields.
</p>
<p>
This method allows dynamically adding new fields to the index schema. It
processes a list of field definitions.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<strong>
fields
</strong>
(
<em>
List
</em>
*[*
<em>
Dict
</em>
*[*
<em>
str
</em>
<em>
,
</em>
<em>
Any
</em>
<em>
]
</em>
<em>
]
</em>
) – A list of fields to add.
</li>
<li>
<strong>
Raises:
</strong>
<strong>
ValueError
</strong>
– If a field with the same name already exists in the
schema.
</li>
</ul>
<div class="highlight">
<pre class="chroma"><code class="language-python" data-lang="python"><span class="line"><span class="cl"><span class="n">schema</span><span class="o">.</span><span class="n">add_fields</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">"bio"</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></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">1024</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></code></pre>
</div>
<h3 id="classmethod-from_dictdata">
<em>
classmethod
</em>
from_dict(data)
</h3>
<p>
Create an IndexSchema from a dictionary.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<strong>
data
</strong>
(
<em>
Dict
</em>
*[*
<em>
str
</em>
<em>
,
</em>
<em>
Any
</em>
<em>
]
</em>
) – The index schema data.
</li>
<li>
<strong>
Returns:
</strong>
The index schema.
</li>
<li>
<strong>
Return type:
</strong>
<a href="#redisvl.schema.IndexSchema">
IndexSchema
</a>
</li>
</ul>
<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.schema</span> <span class="kn">import</span> <span class="n">IndexSchema</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="n">IndexSchema</span><span class="o">.</span><span class="n">from_dict</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">"docs-index"</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">"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></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></span><span class="line"><span class="cl"> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"doc-id"</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">"tag"</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">"name"</span><span class="p">:</span> <span class="s2">"doc-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">"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">"dims"</span><span class="p">:</span> <span class="mi">1536</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>
<h3 id="classmethod-from_yamlfile_path">
<em>
classmethod
</em>
from_yaml(file_path)
</h3>
<p>
Create an IndexSchema from a YAML file.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<strong>
file_path
</strong>
(
<em>
str
</em>
) – The path to the YAML file.
</li>
<li>
<strong>
Returns:
</strong>
The index schema.
</li>
<li>
<strong>
Return type:
</strong>
<a href="#redisvl.schema.IndexSchema">
IndexSchema
</a>
</li>
</ul>
<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.schema</span> <span class="kn">import</span> <span class="n">IndexSchema</span>
</span></span><span class="line"><span class="cl"><span class="n">schema</span> <span class="o">=</span> <span class="n">IndexSchema</span><span class="o">.</span><span class="n">from_yaml</span><span class="p">(</span><span class="s2">"schema.yaml"</span><span class="p">)</span>
</span></span></code></pre>
</div>
<h3 id="remove_fieldfield_name">
remove_field(field_name)
</h3>
<p>
Removes a field from the schema based on the specified name.
</p>
<p>
This method is useful for dynamically altering the schema by removing
existing fields.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<strong>
field_name
</strong>
(
<em>
str
</em>
) – The name of the field to be removed.
</li>
</ul>
<h3 id="to_dict">
to_dict()
</h3>
<p>
Convert the index schema to a dictionary.
</p>
<ul>
<li>
<strong>
Returns:
</strong>
The index schema as a dictionary.
</li>
<li>
<strong>
Return type:
</strong>
Dict[str, Any]
</li>
</ul>
<h3 id="to_yamlfile_path-overwritetrue">
to_yaml(file_path, overwrite=True)
</h3>
<p>
Write the index schema to a YAML file.
</p>
<ul>
<li>
<strong>
Parameters:
</strong>
<ul>
<li>
<strong>
file_path
</strong>
(
<em>
str
</em>
) – The path to the YAML file.
</li>
<li>
<strong>
overwrite
</strong>
(
<em>
bool
</em>
) – Whether to overwrite the file if it already exists.
</li>
</ul>
</li>
<li>
<strong>
Raises:
</strong>
<strong>
FileExistsError
</strong>
– If the file already exists and overwrite is False.
</li>
<li>
<strong>
Return type:
</strong>
None
</li>
</ul>
<h3 id="property-field_names--liststr">
<em>
property
</em>
field_names
<em>
: List[str]
</em>
</h3>
<p>
A list of field names associated with the index schema.
</p>
<ul>
<li>
<strong>
Returns:
</strong>
A list of field names from the schema.
</li>
<li>
<strong>
Return type:
</strong>
List[str]
</li>
</ul>
<h3 id="fields--dictstr-basefield">
fields
<em>
: Dict[str, BaseField]
</em>
</h3>
<p>
Fields associated with the search index and their properties
</p>
<h3 id="index--indexinfo">
index
<em>
: IndexInfo
</em>
</h3>
<p>
Details of the basic index configurations.
</p>
<h3 id="version--str">
version
<em>
: str
</em>
</h3>
<p>
Version of the underlying index schema.
</p>
<h2 id="defining-fields">
Defining Fields
</h2>
<p>
Fields in the schema can be defined in YAML format or as a Python dictionary, specifying a name, type, an optional path, and attributes for customization.
</p>
<p>
<strong>
YAML Example
</strong>
:
</p>
<div class="highlight">
<pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl">- <span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l">title</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">text</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l">$.document.title</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">attrs</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">weight</span><span class="p">:</span><span class="w"> </span><span class="m">1.0</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">no_stem</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">withsuffixtrie</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
<strong>
Python Dictionary Example
</strong>
:
</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">"location"</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">"geo"</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">"sortable"</span><span class="p">:</span> <span class="n">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>
<h2 id="supported-field-types-and-attributes">
Supported Field Types and Attributes
</h2>
<p>
Each field type supports specific attributes that customize its behavior. Below are the field types and their available attributes:
</p>
<p>
<strong>
Text Field Attributes
</strong>
:
</p>
<ul>
<li>
weight: Importance of the field in result calculation.
</li>
<li>
no_stem: Disables stemming during indexing.
</li>
<li>
withsuffixtrie: Optimizes queries by maintaining a suffix trie.
</li>
<li>
phonetic_matcher: Enables phonetic matching.
</li>
<li>
sortable: Allows sorting on this field.
</li>
</ul>
<p>
<strong>
Tag Field Attributes
</strong>
:
</p>
<ul>
<li>
separator: Character for splitting text into individual tags.
</li>
<li>
case_sensitive: Case sensitivity in tag matching.
</li>
<li>
withsuffixtrie: Suffix trie optimization for queries.
</li>
<li>
sortable: Enables sorting based on the tag field.
</li>
</ul>
<p>
<strong>
Numeric and Geo Field Attributes
</strong>
:
</p>
<ul>
<li>
Both numeric and geo fields support the sortable attribute, enabling sorting on these fields.
</li>
</ul>
<p>
<strong>
Common Vector Field Attributes
</strong>
:
</p>
<ul>
<li>
dims: Dimensionality of the vector.
</li>
<li>
algorithm: Indexing algorithm (flat or hnsw).
</li>
<li>
datatype: Float datatype of the vector (float32 or float64).
</li>
<li>
distance_metric: Metric for measuring query relevance (COSINE, L2, IP).
</li>
</ul>
<p>
<strong>
HNSW Vector Field Specific Attributes
</strong>
:
</p>
<ul>
<li>
m: Max outgoing edges per node in each layer.
</li>
<li>
ef_construction: Max edge candidates during build time.
</li>
<li>
ef_runtime: Max top candidates during search.
</li>
<li>
epsilon: Range search boundary factor.
</li>
</ul>
<dl>
<dt>
Note:
</dt>
<dd>
See fully documented Redis-supported fields and options here:
<a href="/docs/latest/commands/ft.create">
FT.CREATE
</a>
.
</dd>
</dl>
<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/api/schema/"/>
<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/security/access-control/data-access-control/create-roles/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Assign permissions to roles
</h1>
<p>
To assign
<a href="/docs/latest/operate/rc/security/access-control/data-access-control/configure-acls/">
Redis ACLs
</a>
to a data access role:
</p>
<ol>
<li>
<p>
Go to
<strong>
Data Access Control
</strong>
from the
<a href="https://cloud.redis.io/#/">
Redis Cloud console
</a>
menu.
</p>
<a href="/docs/latest/images/rc/data-access-control-menu.png" sdata-lightbox="/images/rc/data-access-control-menu.png">
<img alt="Menu for database access control." src="/docs/latest/images/rc/data-access-control-menu.png" width="200px"/>
</a>
</li>
<li>
<p>
Select the
<strong>
Roles
</strong>
tab.
</p>
<a href="/docs/latest/images/rc/data-access-control-roles.png" sdata-lightbox="/images/rc/data-access-control-roles.png">
<img alt="Role configuration area." src="/docs/latest/images/rc/data-access-control-roles.png"/>
</a>
</li>
<li>
<p>
Select
<code>
+
</code>
to create a new role or point to an existing role and select the pencil icon to edit it.
</p>
<a href="/docs/latest/images/rc/data-access-control-roles-add-or-edit.png" sdata-lightbox="/images/rc/data-access-control-roles-add-or-edit.png">
<img alt="Add or edit a role." src="/docs/latest/images/rc/data-access-control-roles-add-or-edit.png" width="300px"/>
</a>
</li>
<li>
<p>
Enter a name for the role.
</p>
<a href="/docs/latest/images/rc/data-access-control-roles-add.png" sdata-lightbox="/images/rc/data-access-control-roles-add.png">
<img alt="Role add screen." src="/docs/latest/images/rc/data-access-control-roles-add.png" width="400px"/>
</a>
</li>
<li>
<p>
Select an
<strong>
ACL rule
</strong>
to assign to the role.
</p>
<a href="/docs/latest/images/rc/data-access-control-roles-select-acl.png" sdata-lightbox="/images/rc/data-access-control-roles-select-acl.png">
<img alt="Select an ACL Rule." src="/docs/latest/images/rc/data-access-control-roles-select-acl.png" width="300px"/>
</a>
</li>
<li>
<p>
Select one or more databases from the
<strong>
Databases
</strong>
list and click the check mark to confirm the association.
</p>
<a href="/docs/latest/images/rc/data-access-control-roles-select-databases.png" sdata-lightbox="/images/rc/data-access-control-roles-select-databases.png">
<img alt="Select an databases." src="/docs/latest/images/rc/data-access-control-roles-select-databases.png" width="400px"/>
</a>
</li>
<li>
<p>
Select
<strong>
Save role
</strong>
.
</p>
</li>
</ol>
<p>
When you assign a user-defined ACL rule to a role and associate it with one or more databases, we'll verify that the ACL rule will work with the selected databases.
</p>
<p>
After you create a role, you can assign it to a user. Users with this role can access the databases according to the role's associated Redis ACLs. For more information, see
<a href="/docs/latest/operate/rc/security/access-control/data-access-control/create-assign-users/#assign-roles-to-existing-users">
Assign roles to users
</a>
.
</p>
<p>
To assign Redis ACLs to a role for an
<a href="/docs/latest/operate/rc/databases/configuration/active-active-redis/">
Active-Active database
</a>
, see
<a href="/docs/latest/operate/rc/security/access-control/data-access-control/active-active-roles/">
Active-Active access roles
</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>
Applying ACLs to the database is an asynchronous operation. You may notice a delay before an ACL is fully applied to the database.
</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/rc/security/access-control/data-access-control/create-roles/"/>
<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/management/security/acl/.html | <section class="prose w-full py-12 max-w-none">
<h1>
ACL
</h1>
<p class="text-lg -mt-5 mb-10">
Redis Access Control List
</p>
<p>
The Redis ACL, short for Access Control List, is the feature that allows certain
connections to be limited in terms of the commands that can be executed and the
keys that can be accessed. The way it works is that, after connecting, a client
is required to provide a username and a valid password to authenticate. If authentication succeeded, the connection is associated with a given
user and the limits the user has. Redis can be configured so that new
connections are already authenticated with a "default" user (this is the
default configuration). Configuring the default user has, as a side effect,
the ability to provide only a specific subset of functionalities to connections
that are not explicitly authenticated.
</p>
<p>
In the default configuration, Redis 6 (the first version to have ACLs) works
exactly like older versions of Redis. Every new connection is
capable of calling every possible command and accessing every key, so the
ACL feature is backward compatible with old clients and applications. Also
the old way to configure a password, using the
<strong>
requirepass
</strong>
configuration
directive, still works as expected. However, it now
sets a password for the default user.
</p>
<p>
The Redis
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
command was extended in Redis 6, so now it is possible to
use it in the two-arguments form:
</p>
<pre><code>AUTH <username> <password>
</code></pre>
<p>
Here's an example of the old form:
</p>
<pre><code>AUTH <password>
</code></pre>
<p>
What happens is that the username used to authenticate is "default", so
just specifying the password implies that we want to authenticate against
the default user. This provides backward compatibility.
</p>
<h2 id="when-acls-are-useful">
When ACLs are useful
</h2>
<p>
Before using ACLs, you may want to ask yourself what's the goal you want to
accomplish by implementing this layer of protection. Normally there are
two main goals that are well served by ACLs:
</p>
<ol>
<li>
You want to improve security by restricting the access to commands and keys, so that untrusted clients have no access and trusted clients have just the minimum access level to the database in order to perform the work needed. For instance, certain clients may just be able to execute read only commands.
</li>
<li>
You want to improve operational safety, so that processes or humans accessing Redis are not allowed to damage the data or the configuration due to software errors or manual mistakes. For instance, there is no reason for a worker that fetches delayed jobs from Redis to be able to call the
<a href="/commands/flushall">
<code>
FLUSHALL
</code>
</a>
command.
</li>
</ol>
<p>
Another typical usage of ACLs is related to managed Redis instances. Redis is
often provided as a managed service both by internal company teams that handle
the Redis infrastructure for the other internal customers they have, or is
provided in a software-as-a-service setup by cloud providers. In both
setups, we want to be sure that configuration commands are excluded for the
customers.
</p>
<h2 id="configure-acls-with-the-acl-command">
Configure ACLs with the ACL command
</h2>
<p>
ACLs are defined using a DSL (domain specific language) that describes what
a given user is allowed to do. Such rules are always implemented from the
first to the last, left-to-right, because sometimes the order of the rules is
important to understand what the user is really able to do.
</p>
<p>
By default there is a single user defined, called
<em>
default
</em>
. We
can use the
<a href="/commands/acl-list">
<code>
ACL LIST
</code>
</a>
command in order to check the currently active ACLs
and verify what the configuration of a freshly started, defaults-configured
Redis instance is:
</p>
<pre><code>> ACL LIST
1) "user default on nopass ~* &* +@all"
</code></pre>
<p>
The command above reports the list of users in the same format that is
used in the Redis configuration files, by translating the current ACLs set
for the users back into their description.
</p>
<p>
The first two words in each line are "user" followed by the username. The
next words are ACL rules that describe different things. We'll show how the rules work in detail, but for now it is enough to say that the default
user is configured to be active (on), to require no password (nopass), to
access every possible key (
<code>
~*
</code>
) and Pub/Sub channel (
<code>
&*
</code>
), and be able to
call every possible command (
<code>
+@all
</code>
).
</p>
<p>
Also, in the special case of the default user, having the
<em>
nopass
</em>
rule means
that new connections are automatically authenticated with the default user
without any explicit
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
call needed.
</p>
<h2 id="acl-rules">
ACL rules
</h2>
<p>
The following is the list of valid ACL rules. Certain rules are just
single words that are used in order to activate or remove a flag, or to
perform a given change to the user ACL. Other rules are char prefixes that
are concatenated with command or category names, key patterns, and
so forth.
</p>
<p>
Enable and disallow users:
</p>
<ul>
<li>
<code>
on
</code>
: Enable the user: it is possible to authenticate as this user.
</li>
<li>
<code>
off
</code>
: Disallow the user: it's no longer possible to authenticate with this user; however, previously authenticated connections will still work. Note that if the default user is flagged as
<em>
off
</em>
, new connections will start as not authenticated and will require the user to send
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
or
<a href="/commands/hello">
<code>
HELLO
</code>
</a>
with the AUTH option in order to authenticate in some way, regardless of the default user configuration.
</li>
</ul>
<p>
Allow and disallow commands:
</p>
<ul>
<li>
<code>
+<command>
</code>
: Add the command to the list of commands the user can call. Can be used with
<code>
|
</code>
for allowing subcommands (e.g "+config|get").
</li>
<li>
<code>
-<command>
</code>
: Remove the command to the list of commands the user can call. Starting Redis 7.0, it can be used with
<code>
|
</code>
for blocking subcommands (e.g "-config|set").
</li>
<li>
<code>
+@<category>
</code>
: Add all the commands in such category to be called by the user, with valid categories being like @admin, @set, @sortedset, ... and so forth, see the full list by calling the
<a href="/commands/acl-cat">
<code>
ACL CAT
</code>
</a>
command. The special category @all means all the commands, both the ones currently present in the server, and the ones that will be loaded in the future via modules.
</li>
<li>
<code>
-@<category>
</code>
: Like
<code>
+@<category>
</code>
but removes the commands from the list of commands the client can call.
</li>
<li>
<code>
+<command>|first-arg
</code>
: Allow a specific first argument of an otherwise disabled command. It is only supported on commands with no sub-commands, and is not allowed as negative form like -SELECT|1, only additive starting with "+". This feature is deprecated and may be removed in the future.
</li>
<li>
<code>
allcommands
</code>
: Alias for +@all. Note that it implies the ability to execute all the future commands loaded via the modules system.
</li>
<li>
<code>
nocommands
</code>
: Alias for -@all.
</li>
</ul>
<p>
Allow and disallow certain keys and key permissions:
</p>
<ul>
<li>
<code>
~<pattern>
</code>
: Add a pattern of keys that can be mentioned as part of commands. For instance
<code>
~*
</code>
allows all the keys. The pattern is a glob-style pattern like the one of
<a href="/commands/keys">
<code>
KEYS
</code>
</a>
. It is possible to specify multiple patterns.
</li>
<li>
<code>
%R~<pattern>
</code>
: (Available in Redis 7.0 and later) Add the specified read key pattern. This behaves similar to the regular key pattern but only grants permission to read from keys that match the given pattern. See
<a href="#key-permissions">
key permissions
</a>
for more information.
</li>
<li>
<code>
%W~<pattern>
</code>
: (Available in Redis 7.0 and later) Add the specified write key pattern. This behaves similar to the regular key pattern but only grants permission to write to keys that match the given pattern. See
<a href="#key-permissions">
key permissions
</a>
for more information.
</li>
<li>
<code>
%RW~<pattern>
</code>
: (Available in Redis 7.0 and later) Alias for
<code>
~<pattern>
</code>
.
</li>
<li>
<code>
allkeys
</code>
: Alias for
<code>
~*
</code>
.
</li>
<li>
<code>
resetkeys
</code>
: Flush the list of allowed keys patterns. For instance the ACL
<code>
~foo:* ~bar:* resetkeys ~objects:*
</code>
, will only allow the client to access keys that match the pattern
<code>
objects:*
</code>
.
</li>
</ul>
<p>
Allow and disallow Pub/Sub channels:
</p>
<ul>
<li>
<code>
&<pattern>
</code>
: (Available in Redis 6.2 and later) Add a glob style pattern of Pub/Sub channels that can be accessed by the user. It is possible to specify multiple channel patterns. Note that pattern matching is done only for channels mentioned by
<a href="/commands/publish">
<code>
PUBLISH
</code>
</a>
and
<a href="/commands/subscribe">
<code>
SUBSCRIBE
</code>
</a>
, whereas
<a href="/commands/psubscribe">
<code>
PSUBSCRIBE
</code>
</a>
requires a literal match between its channel patterns and those allowed for user.
</li>
<li>
<code>
allchannels
</code>
: Alias for
<code>
&*
</code>
that allows the user to access all Pub/Sub channels.
</li>
<li>
<code>
resetchannels
</code>
: Flush the list of allowed channel patterns and disconnect the user's Pub/Sub clients if these are no longer able to access their respective channels and/or channel patterns.
</li>
</ul>
<p>
Configure valid passwords for the user:
</p>
<ul>
<li>
<code>
><password>
</code>
: Add this password to the list of valid passwords for the user. For example
<code>
>mypass
</code>
will add "mypass" to the list of valid passwords. This directive clears the
<em>
nopass
</em>
flag (see later). Every user can have any number of passwords.
</li>
<li>
<code>
<<password>
</code>
: Remove this password from the list of valid passwords. Emits an error in case the password you are trying to remove is actually not set.
</li>
<li>
<code>
#<hash>
</code>
: Add this SHA-256 hash value to the list of valid passwords for the user. This hash value will be compared to the hash of a password entered for an ACL user. This allows users to store hashes in the
<code>
acl.conf
</code>
file rather than storing cleartext passwords. Only SHA-256 hash values are accepted as the password hash must be 64 characters and only contain lowercase hexadecimal characters.
</li>
<li>
<code>
!<hash>
</code>
: Remove this hash value from the list of valid passwords. This is useful when you do not know the password specified by the hash value but would like to remove the password from the user.
</li>
<li>
<code>
nopass
</code>
: All the set passwords of the user are removed, and the user is flagged as requiring no password: it means that every password will work against this user. If this directive is used for the default user, every new connection will be immediately authenticated with the default user without any explicit AUTH command required. Note that the
<em>
resetpass
</em>
directive will clear this condition.
</li>
<li>
<code>
resetpass
</code>
: Flushes the list of allowed passwords and removes the
<em>
nopass
</em>
status. After
<em>
resetpass
</em>
, the user has no associated passwords and there is no way to authenticate without adding some password (or setting it as
<em>
nopass
</em>
later).
</li>
</ul>
<p>
<em>
Note: if a user is not flagged with nopass and has no list of valid passwords, that user is effectively impossible to use because there will be no way to log in as that user.
</em>
</p>
<p>
Configure selectors for the user:
</p>
<ul>
<li>
<code>
(<rule list>)
</code>
: (Available in Redis 7.0 and later) Create a new selector to match rules against. Selectors are evaluated after the user permissions, and are evaluated according to the order they are defined. If a command matches either the user permissions or any selector, it is allowed. See
<a href="#selectors">
selectors
</a>
for more information.
</li>
<li>
<code>
clearselectors
</code>
: (Available in Redis 7.0 and later) Delete all of the selectors attached to the user.
</li>
</ul>
<p>
Reset the user:
</p>
<ul>
<li>
<code>
reset
</code>
Performs the following actions: resetpass, resetkeys, resetchannels, allchannels (if acl-pubsub-default is set), off, clearselectors, -@all. The user returns to the same state it had immediately after its creation.
</li>
</ul>
<h2 id="create-and-edit-user-acls-with-the-acl-setuser-command">
Create and edit user ACLs with the ACL SETUSER command
</h2>
<p>
Users can be created and modified in two main ways:
</p>
<ol>
<li>
Using the ACL command and its
<a href="/commands/acl-setuser">
<code>
ACL SETUSER
</code>
</a>
subcommand.
</li>
<li>
Modifying the server configuration, where users can be defined, and restarting the server. With an
<em>
external ACL file
</em>
, just call
<a href="/commands/acl-load">
<code>
ACL LOAD
</code>
</a>
.
</li>
</ol>
<p>
In this section we'll learn how to define users using the
<a href="/commands/acl">
<code>
ACL
</code>
</a>
command.
With such knowledge, it will be trivial to do the same things via the
configuration files. Defining users in the configuration deserves its own
section and will be discussed later separately.
</p>
<p>
To start, try the simplest
<a href="/commands/acl-setuser">
<code>
ACL SETUSER
</code>
</a>
command call:
</p>
<pre><code>> ACL SETUSER alice
OK
</code></pre>
<p>
The
<a href="/commands/acl-setuser">
<code>
ACL SETUSER
</code>
</a>
command takes the username and a list of ACL rules to apply
to the user. However the above example did not specify any rule at all.
This will just create the user if it did not exist, using the defaults for new
users. If the user already exists, the command above will do nothing at all.
</p>
<p>
Check the default user status:
</p>
<pre><code>> ACL LIST
1) "user alice off resetchannels -@all"
2) "user default on nopass ~* &* +@all"
</code></pre>
<p>
The new user "alice" is:
</p>
<ul>
<li>
In the off status, so
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
will not work for the user "alice".
</li>
<li>
The user also has no passwords set.
</li>
<li>
Cannot access any command. Note that the user is created by default without the ability to access any command, so the
<code>
-@all
</code>
in the output above could be omitted; however,
<a href="/commands/acl-list">
<code>
ACL LIST
</code>
</a>
attempts to be explicit rather than implicit.
</li>
<li>
There are no key patterns that the user can access.
</li>
<li>
There are no Pub/Sub channels that the user can access.
</li>
</ul>
<p>
New users are created with restrictive permissions by default. Starting with Redis 6.2, ACL provides Pub/Sub channels access management as well. To ensure backward compatibility with version 6.0 when upgrading to Redis 6.2, new users are granted the 'allchannels' permission by default. The default can be set to
<code>
resetchannels
</code>
via the
<code>
acl-pubsub-default
</code>
configuration directive.
</p>
<p>
From 7.0, The
<code>
acl-pubsub-default
</code>
value is set to
<code>
resetchannels
</code>
to restrict the channels access by default to provide better security.
The default can be set to
<code>
allchannels
</code>
via the
<code>
acl-pubsub-default
</code>
configuration directive to be compatible with previous versions.
</p>
<p>
Such user is completely useless. Let's try to define the user so that
it is active, has a password, and can access with only the
<a href="/commands/get">
<code>
GET
</code>
</a>
command
to key names starting with the string "cached:".
</p>
<pre><code>> ACL SETUSER alice on >p1pp0 ~cached:* +get
OK
</code></pre>
<p>
Now the user can do something, but will refuse to do other things:
</p>
<pre><code>> AUTH alice p1pp0
OK
> GET foo
(error) NOPERM this user has no permissions to access one of the keys used as arguments
> GET cached:1234
(nil)
> SET cached:1234 zap
(error) NOPERM this user has no permissions to run the 'set' command
</code></pre>
<p>
Things are working as expected. In order to inspect the configuration of the
user alice (remember that user names are case sensitive), it is possible to
use an alternative to
<a href="/commands/acl-list">
<code>
ACL LIST
</code>
</a>
which is designed to be more suitable for
computers to read, while
<a href="/commands/acl-getuser">
<code>
ACL GETUSER
</code>
</a>
is more human readable.
</p>
<pre><code>> ACL GETUSER alice
1) "flags"
2) 1) "on"
3) "passwords"
4) 1) "2d9c75..."
5) "commands"
6) "-@all +get"
7) "keys"
8) "~cached:*"
9) "channels"
10) ""
11) "selectors"
12) (empty array)
</code></pre>
<p>
The
<a href="/commands/acl-getuser">
<code>
ACL GETUSER
</code>
</a>
returns a field-value array that describes the user in more parsable terms. The output includes the set of flags, a list of key patterns, passwords, and so forth. The output is probably more readable if we use RESP3, so that it is returned as a map reply:
</p>
<pre><code>> ACL GETUSER alice
1# "flags" => 1~ "on"
2# "passwords" => 1) "2d9c75273d72b32df726fb545c8a4edc719f0a95a6fd993950b10c474ad9c927"
3# "commands" => "-@all +get"
4# "keys" => "~cached:*"
5# "channels" => ""
6# "selectors" => (empty array)
</code></pre>
<p>
<em>
Note: from now on, we'll continue using the Redis default protocol, version 2
</em>
</p>
<p>
Using another
<a href="/commands/acl-setuser">
<code>
ACL SETUSER
</code>
</a>
command (from a different user, because alice cannot run the
<a href="/commands/acl">
<code>
ACL
</code>
</a>
command), we can add multiple patterns to the user:
</p>
<pre><code>> ACL SETUSER alice ~objects:* ~items:* ~public:*
OK
> ACL LIST
1) "user alice on #2d9c75... ~cached:* ~objects:* ~items:* ~public:* resetchannels -@all +get"
2) "user default on nopass ~* &* +@all"
</code></pre>
<p>
The user representation in memory is now as we expect it to be.
</p>
<h2 id="multiple-calls-to-acl-setuser">
Multiple calls to ACL SETUSER
</h2>
<p>
It is very important to understand what happens when
<a href="/commands/acl-setuser">
<code>
ACL SETUSER
</code>
</a>
is called
multiple times. What is critical to know is that every
<a href="/commands/acl-setuser">
<code>
ACL SETUSER
</code>
</a>
call will
NOT reset the user, but will just apply the ACL rules to the existing user.
The user is reset only if it was not known before. In that case, a brand new
user is created with zeroed-ACLs. The user cannot do anything, is
disallowed, has no passwords, and so forth. This is the best default for safety.
</p>
<p>
However later calls will just modify the user incrementally. For instance,
the following sequence:
</p>
<pre><code>> ACL SETUSER myuser +set
OK
> ACL SETUSER myuser +get
OK
</code></pre>
<p>
Will result in myuser being able to call both
<a href="/commands/get">
<code>
GET
</code>
</a>
and
<a href="/commands/set">
<code>
SET
</code>
</a>
:
</p>
<pre><code>> ACL LIST
1) "user default on nopass ~* &* +@all"
2) "user myuser off resetchannels -@all +get +set"
</code></pre>
<h2 id="command-categories">
Command categories
</h2>
<p>
Setting user ACLs by specifying all the commands one after the other is
really annoying, so instead we do things like this:
</p>
<pre><code>> ACL SETUSER antirez on +@all -@dangerous >42a979... ~*
</code></pre>
<p>
By saying +@all and -@dangerous, we included all the commands and later removed
all the commands that are tagged as dangerous inside the Redis command table.
Note that command categories
<strong>
never include modules commands
</strong>
with
the exception of +@all. If you say +@all, all the commands can be executed by
the user, even future commands loaded via the modules system. However if you
use the ACL rule +@read or any other, the modules commands are always
excluded. This is very important because you should just trust the Redis
internal command table. Modules may expose dangerous things and in
the case of an ACL that is just additive, that is, in the form of
<code>
+@all -...
</code>
You should be absolutely sure that you'll never include what you did not mean
to.
</p>
<p>
The following is a list of command categories and their meanings:
</p>
<ul>
<li>
<strong>
admin
</strong>
- Administrative commands. Normal applications will never need to use
these. Includes
<a href="/commands/replicaof">
<code>
REPLICAOF
</code>
</a>
,
<a href="/commands/config">
<code>
CONFIG
</code>
</a>
,
<a href="/commands/debug">
<code>
DEBUG
</code>
</a>
,
<a href="/commands/save">
<code>
SAVE
</code>
</a>
,
<a href="/commands/monitor">
<code>
MONITOR
</code>
</a>
,
<a href="/commands/acl">
<code>
ACL
</code>
</a>
,
<a href="/commands/shutdown">
<code>
SHUTDOWN
</code>
</a>
, etc.
</li>
<li>
<strong>
bitmap
</strong>
- Data type: bitmaps related.
</li>
<li>
<strong>
blocking
</strong>
- Potentially blocking the connection until released by another
command.
</li>
<li>
<strong>
connection
</strong>
- Commands affecting the connection or other connections.
This includes
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
,
<a href="/commands/select">
<code>
SELECT
</code>
</a>
,
<a href="/commands/command">
<code>
COMMAND
</code>
</a>
,
<a href="/commands/client">
<code>
CLIENT
</code>
</a>
,
<a href="/commands/echo">
<code>
ECHO
</code>
</a>
,
<a href="/commands/ping">
<code>
PING
</code>
</a>
, etc.
</li>
<li>
<strong>
dangerous
</strong>
- Potentially dangerous commands (each should be considered with care for
various reasons). This includes
<a href="/commands/flushall">
<code>
FLUSHALL
</code>
</a>
,
<a href="/commands/migrate">
<code>
MIGRATE
</code>
</a>
,
<a href="/commands/restore">
<code>
RESTORE
</code>
</a>
,
<a href="/commands/sort">
<code>
SORT
</code>
</a>
,
<a href="/commands/keys">
<code>
KEYS
</code>
</a>
,
<a href="/commands/client">
<code>
CLIENT
</code>
</a>
,
<a href="/commands/debug">
<code>
DEBUG
</code>
</a>
,
<a href="/commands/info">
<code>
INFO
</code>
</a>
,
<a href="/commands/config">
<code>
CONFIG
</code>
</a>
,
<a href="/commands/save">
<code>
SAVE
</code>
</a>
,
<a href="/commands/replicaof">
<code>
REPLICAOF
</code>
</a>
, etc.
</li>
<li>
<strong>
geo
</strong>
- Data type: geospatial indexes related.
</li>
<li>
<strong>
hash
</strong>
- Data type: hashes related.
</li>
<li>
<strong>
hyperloglog
</strong>
- Data type: hyperloglog related.
</li>
<li>
<strong>
fast
</strong>
- Fast O(1) commands. May loop on the number of arguments, but not the
number of elements in the key.
</li>
<li>
<strong>
keyspace
</strong>
- Writing or reading from keys, databases, or their metadata
in a type agnostic way. Includes
<a href="/commands/del">
<code>
DEL
</code>
</a>
,
<a href="/commands/restore">
<code>
RESTORE
</code>
</a>
,
<a href="/commands/dump">
<code>
DUMP
</code>
</a>
,
<a href="/commands/rename">
<code>
RENAME
</code>
</a>
,
<a href="/commands/exists">
<code>
EXISTS
</code>
</a>
,
<a href="/commands/dbsize">
<code>
DBSIZE
</code>
</a>
,
<a href="/commands/keys">
<code>
KEYS
</code>
</a>
,
<a href="/commands/expire">
<code>
EXPIRE
</code>
</a>
,
<a href="/commands/ttl">
<code>
TTL
</code>
</a>
,
<a href="/commands/flushall">
<code>
FLUSHALL
</code>
</a>
, etc. Commands that may modify the keyspace,
key, or metadata will also have the
<code>
write
</code>
category. Commands that only read
the keyspace, key, or metadata will have the
<code>
read
</code>
category.
</li>
<li>
<strong>
list
</strong>
- Data type: lists related.
</li>
<li>
<strong>
pubsub
</strong>
- PubSub-related commands.
</li>
<li>
<strong>
read
</strong>
- Reading from keys (values or metadata). Note that commands that don't
interact with keys, will not have either
<code>
read
</code>
or
<code>
write
</code>
.
</li>
<li>
<strong>
scripting
</strong>
- Scripting related.
</li>
<li>
<strong>
set
</strong>
- Data type: sets related.
</li>
<li>
<strong>
sortedset
</strong>
- Data type: sorted sets related.
</li>
<li>
<strong>
slow
</strong>
- All commands that are not
<code>
fast
</code>
.
</li>
<li>
<strong>
stream
</strong>
- Data type: streams related.
</li>
<li>
<strong>
string
</strong>
- Data type: strings related.
</li>
<li>
<strong>
transaction
</strong>
-
<a href="/commands/watch">
<code>
WATCH
</code>
</a>
/
<a href="/commands/multi">
<code>
MULTI
</code>
</a>
/
<a href="/commands/exec">
<code>
EXEC
</code>
</a>
related commands.
</li>
<li>
<strong>
write
</strong>
- Writing to keys (values or metadata).
</li>
</ul>
<p>
Redis can also show you a list of all categories and the exact commands each category includes using the Redis
<a href="/commands/acl-cat">
<code>
ACL CAT
</code>
</a>
command. It can be used in two forms:
</p>
<pre><code>ACL CAT -- Will just list all the categories available
ACL CAT <category-name> -- Will list all the commands inside the category
</code></pre>
<p>
Examples:
</p>
<pre><code> > ACL CAT
1) "keyspace"
2) "read"
3) "write"
4) "set"
5) "sortedset"
6) "list"
7) "hash"
8) "string"
9) "bitmap"
10) "hyperloglog"
11) "geo"
12) "stream"
13) "pubsub"
14) "admin"
15) "fast"
16) "slow"
17) "blocking"
18) "dangerous"
19) "connection"
20) "transaction"
21) "scripting"
</code></pre>
<p>
As you can see, so far there are 21 distinct categories. Now let's check what
command is part of the
<em>
geo
</em>
category:
</p>
<pre><code> > ACL CAT geo
1) "geohash"
2) "georadius_ro"
3) "georadiusbymember"
4) "geopos"
5) "geoadd"
6) "georadiusbymember_ro"
7) "geodist"
8) "georadius"
9) "geosearch"
10) "geosearchstore"
</code></pre>
<p>
Note that commands may be part of multiple categories. For example, an
ACL rule like
<code>
+@geo -@read
</code>
will result in certain geo commands to be
excluded because they are read-only commands.
</p>
<h2 id="allowblock-subcommands">
Allow/block subcommands
</h2>
<p>
Starting from Redis 7.0, subcommands can be allowed/blocked just like other
commands (by using the separator
<code>
|
</code>
between the command and subcommand, for
example:
<code>
+config|get
</code>
or
<code>
-config|set
</code>
)
</p>
<p>
That is true for all commands except DEBUG. In order to allow/block specific
DEBUG subcommands, see the next section.
</p>
<h2 id="allow-the-first-arg-of-a-blocked-command">
Allow the first-arg of a blocked command
</h2>
<p>
<strong>
Note: This feature is deprecated since Redis 7.0 and may be removed in the future.
</strong>
</p>
<p>
Sometimes the ability to exclude or include a command or a subcommand as a whole is not enough.
Many deployments may not be happy providing the ability to execute a
<a href="/commands/select">
<code>
SELECT
</code>
</a>
for any DB, but may
still want to be able to run
<code>
SELECT 0
</code>
.
</p>
<p>
In such case we could alter the ACL of a user in the following way:
</p>
<pre><code>ACL SETUSER myuser -select +select|0
</code></pre>
<p>
First, remove the
<a href="/commands/select">
<code>
SELECT
</code>
</a>
command and then add the allowed
first-arg. Note that
<strong>
it is not possible to do the reverse
</strong>
since first-args
can be only added, not excluded. It is safer to specify all the first-args
that are valid for some user since it is possible that
new first-args may be added in the future.
</p>
<p>
Another example:
</p>
<pre><code>ACL SETUSER myuser -debug +debug|digest
</code></pre>
<p>
Note that first-arg matching may add some performance penalty; however, it is hard to measure even with synthetic benchmarks. The
additional CPU cost is only paid when such commands are called, and not when
other commands are called.
</p>
<p>
It is possible to use this mechanism in order to allow subcommands in Redis
versions prior to 7.0 (see above section).
</p>
<h2 id="all-vs--all">
+@all VS -@all
</h2>
<p>
In the previous section, it was observed how it is possible to define command
ACLs based on adding/removing single commands.
</p>
<h2 id="selectors">
Selectors
</h2>
<p>
Starting with Redis 7.0, Redis supports adding multiple sets of rules that are evaluated independently of each other.
These secondary sets of permissions are called selectors and added by wrapping a set of rules within parentheses.
In order to execute a command, either the root permissions (rules defined outside of parenthesis) or any of the selectors (rules defined inside parenthesis) must match the given command.
Internally, the root permissions are checked first followed by selectors in the order they were added.
</p>
<p>
For example, consider a user with the ACL rules
<code>
+GET ~key1 (+SET ~key2)
</code>
.
This user is able to execute
<code>
GET key1
</code>
and
<code>
SET key2 hello
</code>
, but not
<code>
GET key2
</code>
or
<code>
SET key1 world
</code>
.
</p>
<p>
Unlike the user's root permissions, selectors cannot be modified after they are added.
Instead, selectors can be removed with the
<code>
clearselectors
</code>
keyword, which removes all of the added selectors.
Note that
<code>
clearselectors
</code>
does not remove the root permissions.
</p>
<h2 id="key-permissions">
Key permissions
</h2>
<p>
Starting with Redis 7.0, key patterns can also be used to define how a command is able to touch a key.
This is achieved through rules that define key permissions.
The key permission rules take the form of
<code>
%(<permission>)~<pattern>
</code>
.
Permissions are defined as individual characters that map to the following key permissions:
</p>
<ul>
<li>
W (Write): The data stored within the key may be updated or deleted.
</li>
<li>
R (Read): User supplied data from the key is processed, copied or returned. Note that this does not include metadata such as size information (example
<a href="/commands/strlen">
<code>
STRLEN
</code>
</a>
), type information (example
<a href="/commands/type">
<code>
TYPE
</code>
</a>
) or information about whether a value exists within a collection (example
<a href="/commands/sismember">
<code>
SISMEMBER
</code>
</a>
).
</li>
</ul>
<p>
Permissions can be composed together by specifying multiple characters.
Specifying the permission as 'RW' is considered full access and is analogous to just passing in
<code>
~<pattern>
</code>
.
</p>
<p>
For a concrete example, consider a user with ACL rules
<code>
+@all ~app1:* (+@read ~app2:*)
</code>
.
This user has full access on
<code>
app1:*
</code>
and readonly access on
<code>
app2:*
</code>
.
However, some commands support reading data from one key, doing some transformation, and storing it into another key.
One such command is the
<a href="/commands/copy">
<code>
COPY
</code>
</a>
command, which copies the data from the source key into the destination key.
The example set of ACL rules is unable to handle a request copying data from
<code>
app2:user
</code>
into
<code>
app1:user
</code>
, since neither the root permission nor the selector fully matches the command.
However, using key selectors you can define a set of ACL rules that can handle this request
<code>
+@all ~app1:* %R~app2:*
</code>
.
The first pattern is able to match
<code>
app1:user
</code>
and the second pattern is able to match
<code>
app2:user
</code>
.
</p>
<p>
Which type of permission is required for a command is documented through
<a href="/docs/latest/develop/reference/key-specs#logical-operation-flags">
key specifications
</a>
.
The type of permission is based off the keys logical operation flags.
The insert, update, and delete flags map to the write key permission.
The access flag maps to the read key permission.
If the key has no logical operation flags, such as
<a href="/commands/exists">
<code>
EXISTS
</code>
</a>
, the user still needs either key read or key write permissions to execute the command.
</p>
<p>
Note: Side channels to accessing user data are ignored when it comes to evaluating whether read permissions are required to execute a command.
This means that some write commands that return metadata about the modified key only require write permission on the key to execute.
For example, consider the following two commands:
</p>
<ul>
<li>
<code>
LPUSH key1 data
</code>
: modifies "key1" but only returns metadata about it, the size of the list after the push, so the command only requires write permission on "key1" to execute.
</li>
<li>
<code>
LPOP key2
</code>
: modifies "key2" but also returns data from it, the left most item in the list, so the command requires both read and write permission on "key2" to execute.
</li>
</ul>
<p>
If an application needs to make sure no data is accessed from a key, including side channels, it's recommended to not provide any access to the key.
</p>
<h2 id="how-passwords-are-stored-internally">
How passwords are stored internally
</h2>
<p>
Redis internally stores passwords hashed with SHA256. If you set a password
and check the output of
<a href="/commands/acl-list">
<code>
ACL LIST
</code>
</a>
or
<a href="/commands/acl-getuser">
<code>
ACL GETUSER
</code>
</a>
, you'll see a long hex
string that looks pseudo random. Here is an example, because in the previous
examples, for the sake of brevity, the long hex string was trimmed:
</p>
<pre><code>> ACL GETUSER default
1) "flags"
2) 1) "on"
3) "passwords"
4) 1) "2d9c75273d72b32df726fb545c8a4edc719f0a95a6fd993950b10c474ad9c927"
5) "commands"
6) "+@all"
7) "keys"
8) "~*"
9) "channels"
10) "&*"
11) "selectors"
12) (empty array)
</code></pre>
<p>
Using SHA256 provides the ability to avoid storing the password in clear text
while still allowing for a very fast
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
command, which is a very important
feature of Redis and is coherent with what clients expect from Redis.
</p>
<p>
However ACL
<em>
passwords
</em>
are not really passwords. They are shared secrets
between the server and the client, because the password is
not an authentication token used by a human being. For instance:
</p>
<ul>
<li>
There are no length limits, the password will just be memorized in some client software. There is no human that needs to recall a password in this context.
</li>
<li>
The ACL password does not protect any other thing. For example, it will never be the password for some email account.
</li>
<li>
Often when you are able to access the hashed password itself, by having full access to the Redis commands of a given server, or corrupting the system itself, you already have access to what the password is protecting: the Redis instance stability and the data it contains.
</li>
</ul>
<p>
For this reason, slowing down the password authentication, in order to use an
algorithm that uses time and space to make password cracking hard,
is a very poor choice. What we suggest instead is to generate strong
passwords, so that nobody will be able to crack it using a
dictionary or a brute force attack even if they have the hash. To do so, there is a special ACL
command
<a href="/commands/acl-genpass">
<code>
ACL GENPASS
</code>
</a>
that generates passwords using the system cryptographic pseudorandom
generator:
</p>
<pre><code>> ACL GENPASS
"dd721260bfe1b3d9601e7fbab36de6d04e2e67b0ef1c53de59d45950db0dd3cc"
</code></pre>
<p>
The command outputs a 32-byte (256-bit) pseudorandom string converted to a
64-byte alphanumerical string. This is long enough to avoid attacks and short
enough to be easy to manage, cut & paste, store, and so forth. This is what
you should use in order to generate Redis passwords.
</p>
<h2 id="use-an-external-acl-file">
Use an external ACL file
</h2>
<p>
There are two ways to store users inside the Redis configuration:
</p>
<ol>
<li>
Users can be specified directly inside the
<code>
redis.conf
</code>
file.
</li>
<li>
It is possible to specify an external ACL file.
</li>
</ol>
<p>
The two methods are
<em>
mutually incompatible
</em>
, so Redis will ask you to use one
or the other. Specifying users inside
<code>
redis.conf
</code>
is
good for simple use cases. When there are multiple users to define, in a
complex environment, we recommend you use the ACL file instead.
</p>
<p>
The format used inside
<code>
redis.conf
</code>
and in the external ACL file is exactly
the same, so it is trivial to switch from one to the other, and is
the following:
</p>
<pre><code>user <username> ... acl rules ...
</code></pre>
<p>
For instance:
</p>
<pre><code>user worker +@list +@connection ~jobs:* on >ffa9203c493aa99
</code></pre>
<p>
When you want to use an external ACL file, you are required to specify
the configuration directive called
<code>
aclfile
</code>
, like this:
</p>
<pre><code>aclfile /etc/redis/users.acl
</code></pre>
<p>
When you are just specifying a few users directly inside the
<code>
redis.conf
</code>
file, you can use
<a href="/commands/config-rewrite">
<code>
CONFIG REWRITE
</code>
</a>
in order to store the new user configuration
inside the file by rewriting it.
</p>
<p>
The external ACL file however is more powerful. You can do the following:
</p>
<ul>
<li>
Use
<a href="/commands/acl-load">
<code>
ACL LOAD
</code>
</a>
if you modified the ACL file manually and you want Redis to reload the new configuration. Note that this command is able to load the file
<em>
only if all the users are correctly specified
</em>
. Otherwise, an error is reported to the user, and the old configuration will remain valid.
</li>
<li>
Use
<a href="/commands/acl-save">
<code>
ACL SAVE
</code>
</a>
to save the current ACL configuration to the ACL file.
</li>
</ul>
<p>
Note that
<a href="/commands/config-rewrite">
<code>
CONFIG REWRITE
</code>
</a>
does not also trigger
<a href="/commands/acl-save">
<code>
ACL SAVE
</code>
</a>
. When you use
an ACL file, the configuration and the ACLs are handled separately.
</p>
<h2 id="acl-rules-for-sentinel-and-replicas">
ACL rules for Sentinel and Replicas
</h2>
<p>
In case you don't want to provide Redis replicas and Redis Sentinel instances
full access to your Redis instances, the following is the set of commands
that must be allowed in order for everything to work correctly.
</p>
<p>
For Sentinel, allow the user to access the following commands both in the master and replica instances:
</p>
<ul>
<li>
AUTH, CLIENT, SUBSCRIBE, SCRIPT, PUBLISH, PING, INFO, MULTI, SLAVEOF, CONFIG, CLIENT, EXEC.
</li>
</ul>
<p>
Sentinel does not need to access any key in the database but does use Pub/Sub, so the ACL rule would be the following (note:
<a href="/commands/auth">
<code>
AUTH
</code>
</a>
is not needed since it is always allowed):
</p>
<pre><code>ACL SETUSER sentinel-user on >somepassword allchannels +multi +slaveof +ping +exec +subscribe +config|rewrite +role +publish +info +client|setname +client|kill +script|kill
</code></pre>
<p>
Redis replicas require the following commands to be allowed on the master instance:
</p>
<ul>
<li>
PSYNC, REPLCONF, PING
</li>
</ul>
<p>
No keys need to be accessed, so this translates to the following rules:
</p>
<pre><code>ACL setuser replica-user on >somepassword +psync +replconf +ping
</code></pre>
<p>
Note that you don't need to configure the replicas to allow the master to be able to execute any set of commands. The master is always authenticated as the root user from the point of view of replicas.
</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/management/security/acl/"/>
<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/lmpop/.html | <section class="prose w-full py-12">
<h1 class="command-name">
LMPOP
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">LMPOP numkeys key [key ...] <LEFT | RIGHT> [COUNT count]</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.0.0
</dd>
<dt class="font-semibold text-redis-ink-900 m-0">
Time complexity:
</dt>
<dd class="m-0">
O(N+M) where N is the number of provided keys and M is the number of elements returned.
</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>
@list
</code>
<span class="mr-1 last:hidden">
,
</span>
<code>
@slow
</code>
<span class="mr-1 last:hidden">
,
</span>
</dd>
</dl>
<p>
Pops one or more elements from the first non-empty list key from the list of provided key names.
</p>
<p>
<code>
LMPOP
</code>
and
<a href="/docs/latest/commands/blmpop/">
<code>
BLMPOP
</code>
</a>
are similar to the following, more limited, commands:
</p>
<ul>
<li>
<a href="/docs/latest/commands/lpop/">
<code>
LPOP
</code>
</a>
or
<a href="/docs/latest/commands/rpop/">
<code>
RPOP
</code>
</a>
which take only one key, and can return multiple elements.
</li>
<li>
<a href="/docs/latest/commands/blpop/">
<code>
BLPOP
</code>
</a>
or
<a href="/docs/latest/commands/brpop/">
<code>
BRPOP
</code>
</a>
which take multiple keys, but return only one element from just one key.
</li>
</ul>
<p>
See
<a href="/docs/latest/commands/blmpop/">
<code>
BLMPOP
</code>
</a>
for the blocking variant of this command.
</p>
<p>
Elements are popped from either the left or right of the first non-empty list based on the passed argument.
The number of returned elements is limited to the lower between the non-empty list's length, and the count argument (which defaults to 1).
</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> LMPOP 2 non1 non2 LEFT COUNT 10
(nil)
redis> LPUSH mylist "one" "two" "three" "four" "five"
(integer) 5
redis> LMPOP 1 mylist LEFT
1) "mylist"
2) 1) "five"
redis> LRANGE mylist 0 -1
1) "four"
2) "three"
3) "two"
4) "one"
redis> LMPOP 1 mylist RIGHT COUNT 10
1) "mylist"
2) 1) "one"
2) "two"
3) "three"
4) "four"
redis> LPUSH mylist "one" "two" "three" "four" "five"
(integer) 5
redis> LPUSH mylist2 "a" "b" "c" "d" "e"
(integer) 5
redis> LMPOP 2 mylist mylist2 right count 3
1) "mylist"
2) 1) "one"
2) "two"
3) "three"
redis> LRANGE mylist 0 -1
1) "five"
2) "four"
redis> LMPOP 2 mylist mylist2 right count 5
1) "mylist"
2) 1) "four"
2) "five"
redis> LMPOP 2 mylist mylist2 right count 10
1) "mylist2"
2) 1) "a"
2) "b"
3) "c"
4) "d"
5) "e"
redis> EXISTS mylist mylist2
(integer) 0
</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">
Nil reply
</a>
: if no element could be popped.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a two-element array with the first element being the name of the key from which elements were popped and the second element being an array of elements.
</li>
</ul>
<h2 id="resp3-reply">
RESP3 Reply
</h2>
<p>
One of the following:
</p>
<ul>
<li>
<a href="../../develop/reference/protocol-spec#nulls">
Null reply
</a>
: if no element could be popped.
</li>
<li>
<a href="../../develop/reference/protocol-spec#arrays">
Array reply
</a>
: a two-element array with the first element being the name of the key from which elements were popped and the second element being an array of elements.
</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/lmpop/"/>
<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/tdigest.reset.html | <section class="prose w-full py-12">
<h1 class="command-name">
TDIGEST.RESET
</h1>
<div class="font-semibold text-redis-ink-900">
Syntax
</div>
<pre class="command-syntax">TDIGEST.RESET 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 2.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>
Resets a t-digest sketch: empty the sketch and re-initializes it.
</p>
<h2 id="required-arguments">
Required arguments
</h2>
<details open="">
<summary>
<code>
key
</code>
</summary>
is key name for an existing t-digest sketch.
</details>
<h2 id="return-value">
Return value
</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>
<div class="highlight">
<pre class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">redis> TDIGEST.RESET t
</span></span><span class="line"><span class="cl">OK</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/tdigest.reset/"/>
<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/release-notes/legacy-release-notes/release-notes-redis-enterprise-software-v5-0-2/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis Enterprise Software 5.0.2 (2018 March)
</h1>
<p>
Redis Enterprise Software 5.0.2 is now available. Key features include
functional and performance updates for CRDB, changes to module
deployment, and general fixes.
</p>
<h2 id="overview">
Overview
</h2>
<p>
If you are upgrading from a previous version, make sure to review the
upgrade instructions before beginning the upgrade process.
</p>
<p>
You can upgrade to RS 5.0.2 from RS 4.4.2 and above. If you have a
version older than 4.4.2, you must first upgrade to at least 5.0.
</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>
Starting from RS 5.0.2, ports 3338 and 3339 should also be opened
on each node for the purpose of internal cluster communication.
For more information, check the
<a href="/docs/latest/operate/rs/networking/port-configurations/">
'network port
configurations'
</a>
page
</div>
</div>
<h2 id="new-features">
New features
</h2>
<h3 id="crdbs">
CRDBs
</h3>
<ul>
<li>
The ability to add and remove participating clusters from a CRDB
</li>
<li>
Communications between participating clusters can be encrypted using
SSL/TLS
</li>
<li>
Imports can be done to an existing database without flushing the
existing data beforehand.
</li>
</ul>
<h3 id="modules">
Modules
</h3>
<ul>
<li>
Redis Enterprise Modules are installed with Redis Enterprise
Software by default
</li>
<li>
RedisBloom and RediSearch Enterprise have been updated to newer
versions
</li>
</ul>
<h3 id="other">
Other
</h3>
<ul>
<li>
Discovery Service supports encryption using SSL/TLS
</li>
<li>
Starting from version 5.0.2 build #30, Redis Enterprise Software is
supported on RHEL 7.5
</li>
</ul>
<h2 id="important-fixes">
Important fixes
</h2>
<ul>
<li>
RS16153 -- Supervisord version update
</li>
<li>
RS16667 - Fixed issue with 'rladmin status' timeout
</li>
<li>
RS17746 - Fixed upgrade issue when -s option used
</li>
<li>
RS17997, RS18088 - Upgrade issues when using non-default socket
file path
</li>
<li>
RS8584 -- Endpoint migration provided misleading plan message
</li>
<li>
RS17696 - Fixed issues with Multi-proxy and intermittent network
issues
</li>
<li>
RS17362 - Upgrade fails under some circumstances
</li>
<li>
RS18351 - Listener active after node has been declared dead
</li>
<li>
RS18874 - Fixed OOM issue due to redis_mgr high memory consumption
</li>
<li>
RS19002 - Fixed wrong message when an upgrade of a quorum node with
all-nodes policy takes place
</li>
</ul>
<p>
<strong>
Important Fixes in Build #30:
</strong>
</p>
<ul>
<li>
RS19701 - Fixed high CPU usage on large scale clusters
</li>
<li>
RS19869- Added support for Redis
version 4.0.9
</li>
<li>
RS20153- Fixed Redis important security issues related to the Lua
scripting engine
</li>
<li>
RS19852- Fixed proxy crash which might happen for SSL-enabled
DBs
</li>
</ul>
<h2 id="known-limitations">
Known limitations
</h2>
<ul>
<li>
Since Redis Enterprise CRDBs have counters, unlike traditional Redis
databases, they must be handled differently when importing. There is
a special type of import because of importing counter data types.
When performing the import through the admin console, you will be prompted
to confirm you want to add the data to the CRDB or stop and go flush
the database.
</li>
<li>
This version of RS comes with a pre-bundled python which might
over-ride your default installed python version, this can be solved
by changing your PATH environment variable.
</li>
<li>
Uploading a Redis Module through the admin console, can be performed only
when the admin console is connected to the master node.
</li>
<li>
Write operations are not allowed for database which was created with
password of exactly 50-characters.
</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/release-notes/legacy-release-notes/release-notes-redis-enterprise-software-v5-0-2/"/>
<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/management/config/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Redis configuration
</h1>
<p class="text-lg -mt-5 mb-10">
Overview of redis.conf, the Redis configuration file
</p>
<p>
Redis is able to start without a configuration file using a built-in default
configuration, however this setup is only recommended for testing and
development purposes.
</p>
<p>
The proper way to configure Redis is by providing a Redis configuration file,
usually called
<code>
redis.conf
</code>
.
</p>
<p>
The
<code>
redis.conf
</code>
file contains a number of directives that have a very simple
format:
</p>
<pre><code>keyword argument1 argument2 ... argumentN
</code></pre>
<p>
This is an example of a configuration directive:
</p>
<pre><code>replicaof 127.0.0.1 6380
</code></pre>
<p>
It is possible to provide strings containing spaces as arguments using
(double or single) quotes, as in the following example:
</p>
<pre><code>requirepass "hello world"
</code></pre>
<p>
Single-quoted string can contain characters escaped by backslashes, and
double-quoted strings can additionally include any ASCII symbols encoded using
backslashed hexadecimal notation "\xff".
</p>
<p>
The list of configuration directives, and their meaning and intended usage
is available in the self documented example redis.conf shipped into the
Redis distribution.
</p>
<ul>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/unstable/redis.conf">
redis.conf for Redis 7.4
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/7.2/redis.conf">
redis.conf for Redis 7.2
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/7.0/redis.conf">
redis.conf for Redis 7.0
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/6.2/redis.conf">
redis.conf for Redis 6.2
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/6.0/redis.conf">
redis.conf for Redis 6.0
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/5.0/redis.conf">
redis.conf for Redis 5.0
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/4.0/redis.conf">
redis.conf for Redis 4.0
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/3.2/redis.conf">
redis.conf for Redis 3.2
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/3.0/redis.conf">
redis.conf for Redis 3.0
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/2.8/redis.conf">
redis.conf for Redis 2.8
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/2.6/redis.conf">
redis.conf for Redis 2.6
</a>
.
</li>
<li>
The self documented
<a href="https://raw.githubusercontent.com/redis/redis/2.4/redis.conf">
redis.conf for Redis 2.4
</a>
.
</li>
</ul>
<h2 id="passing-arguments-via-the-command-line">
Passing arguments via the command line
</h2>
<p>
You can also pass Redis configuration parameters
using the command line directly. This is very useful for testing purposes.
The following is an example that starts a new Redis instance using port 6380
as a replica of the instance running at 127.0.0.1 port 6379.
</p>
<pre><code>./redis-server --port 6380 --replicaof 127.0.0.1 6379
</code></pre>
<p>
The format of the arguments passed via the command line is exactly the same
as the one used in the redis.conf file, with the exception that the keyword
is prefixed with
<code>
--
</code>
.
</p>
<p>
Note that internally this generates an in-memory temporary config file
(possibly concatenating the config file passed by the user, if any) where
arguments are translated into the format of redis.conf.
</p>
<h2 id="changing-redis-configuration-while-the-server-is-running">
Changing Redis configuration while the server is running
</h2>
<p>
It is possible to reconfigure Redis on the fly without stopping and restarting
the service, or querying the current configuration programmatically using the
special commands
<a href="/commands/config-set">
<code>
CONFIG SET
</code>
</a>
and
<a href="/commands/config-get">
<code>
CONFIG GET
</code>
</a>
.
</p>
<p>
Not all of the configuration directives are supported in this way, but most
are supported as expected.
Please refer to the
<a href="/commands/config-set">
<code>
CONFIG SET
</code>
</a>
and
<a href="/commands/config-get">
<code>
CONFIG GET
</code>
</a>
pages for more information.
</p>
<p>
Note that modifying the configuration on the fly
<strong>
has no effects on the
redis.conf file
</strong>
so at the next restart of Redis the old configuration will
be used instead.
</p>
<p>
Make sure to also modify the
<code>
redis.conf
</code>
file accordingly to the configuration
you set using
<a href="/commands/config-set">
<code>
CONFIG SET
</code>
</a>
.
You can do it manually, or you can use
<a href="/commands/config-rewrite">
<code>
CONFIG REWRITE
</code>
</a>
, which will automatically scan your
<code>
redis.conf
</code>
file and update the fields which don't match the current configuration value.
Fields non existing but set to the default value are not added.
Comments inside your configuration file are retained.
</p>
<h2 id="configuring-redis-as-a-cache">
Configuring Redis as a cache
</h2>
<p>
If you plan to use Redis as a cache where every key will have an
expire set, you may consider using the following configuration instead
(assuming a max memory limit of 2 megabytes as an example):
</p>
<pre><code>maxmemory 2mb
maxmemory-policy allkeys-lru
</code></pre>
<p>
In this configuration there is no need for the application to set a
time to live for keys using the
<a href="/commands/expire">
<code>
EXPIRE
</code>
</a>
command (or equivalent) since
all the keys will be evicted using an approximated LRU algorithm as long
as we hit the 2 megabyte memory limit.
</p>
<p>
Basically, in this configuration Redis acts in a similar way to memcached.
We have more extensive documentation about using Redis as an LRU cache
<a href="/docs/latest/develop/reference/eviction/">
here
</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/oss_and_stack/management/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/develop/interact/search-and-query/query/combined/.html | <section class="prose w-full py-12">
<h1>
Combined queries
</h1>
<p class="text-lg -mt-5 mb-10">
Combine query expressions
</p>
<p>
A combined query is a combination of several query types, such as:
</p>
<ul>
<li>
<a href="/docs/latest/develop/interact/search-and-query/query/exact-match/">
Exact match
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/query/range/">
Range
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/query/full-text/">
Full-text
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/query/geo-spatial/">
Geospatial
</a>
</li>
<li>
<a href="/docs/latest/develop/interact/search-and-query/query/vector-search/">
Vector search
</a>
</li>
</ul>
<p>
You can use logical query operators to combine query expressions for numeric, tag, and text fields. For vector fields, you can combine a KNN query with a pre-filter.
</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 operators are interpreted slightly differently depending on the query dialect used. The default dialect is
<code>
DIALECT 1
</code>
; see
<a href="/docs/latest/develop/interact/search-and-query/basic-constructs/configuration-parameters#default_dialect">
this article
</a>
for information on how to change the dialect version. This article uses the second version of the query dialect,
<code>
DIALECT 2
</code>
, and uses additional brackets (
<code>
(...)
</code>
) to help clarify the examples. Further details can be found in the
<a href="/docs/latest/develop/interact/search-and-query/advanced-concepts/query_syntax/">
query syntax documentation
</a>
.
</div>
</div>
<p>
The examples in this article use the following schema:
</p>
<table>
<thead>
<tr>
<th>
Field name
</th>
<th>
Field type
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
description
</code>
</td>
<td>
<code>
TEXT
</code>
</td>
</tr>
<tr>
<td>
<code>
condition
</code>
</td>
<td>
<code>
TAG
</code>
</td>
</tr>
<tr>
<td>
<code>
price
</code>
</td>
<td>
<code>
NUMERIC
</code>
</td>
</tr>
<tr>
<td>
<code>
vector
</code>
</td>
<td>
<code>
VECTOR
</code>
</td>
</tr>
</tbody>
</table>
<h2 id="and">
AND
</h2>
<p>
The binary operator
<code>
</code>
(space) is used to intersect the results of two or more expressions.
</p>
<pre tabindex="0"><code>FT.SEARCH index "(expr1) (expr2)"
</code></pre>
<p>
If you want to perform an intersection based on multiple values within a specific text field, then you should use the following simplified notion:
</p>
<pre tabindex="0"><code>FT.SEARCH index "@text_field:( value1 value2 ... )"
</code></pre>
<p>
The following example shows you a query that finds bicycles in new condition and in a price range from 500 USD to 1000 USD:
</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="query_combined-stepcombined1">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined1" name="query_combined-stepcombined1" 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_query_combined-stepcombined1" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined1" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined1" 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 "@price:[500 1000] @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_query_combined-stepcombined1')" 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_query_combined-stepcombined1" name="query_combined-stepcombined1" 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_query_combined-stepcombined1" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined1" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined1" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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="c1"># put query string here</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">search</span><span class="p">(</span><span class="n">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined1')" 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_query_combined-stepcombined1" 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/query_combined.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_query_combined-stepcombined1" name="query_combined-stepcombined1" 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_query_combined-stepcombined1" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined1" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined1" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="kr">const</span> <span class="nx">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</span></span></span><span class="line hl"><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="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res7</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></span><span class="line"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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></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_query_combined-stepcombined1')" 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_query_combined-stepcombined1" 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/query-combined.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>
</div>
<p>
You might also be interested in bicycles for kids. The query below shows you how to combine a full-text search with the criteria from the previous query:
</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="query_combined-stepcombined2">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined2" name="query_combined-stepcombined2" 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_query_combined-stepcombined2" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined2" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined2" 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 "kids (@price:[500 1000] @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_query_combined-stepcombined2')" 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_query_combined-stepcombined2" name="query_combined-stepcombined2" 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_query_combined-stepcombined2" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined2" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined2" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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="c1"># put query string here</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">search</span><span class="p">(</span><span class="n">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined2')" 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_query_combined-stepcombined2" 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/query_combined.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_query_combined-stepcombined2" name="query_combined-stepcombined2" 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_query_combined-stepcombined2" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined2" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined2" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</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 hl"><span class="cl"><span class="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</span></span></span><span class="line hl"><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="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res7</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></span><span class="line"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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></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_query_combined-stepcombined2')" 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_query_combined-stepcombined2" 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/query-combined.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>
</div>
<h2 id="or">
OR
</h2>
<p>
You can use the binary operator
<code>
|
</code>
(vertical bar) to perform a union.
</p>
<pre tabindex="0"><code>FT.SEARCH index "(expr1) | (expr2)"
</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">
Note:
</div>
The logical
<code>
AND
</code>
takes precedence over
<code>
OR
</code>
when using dialect version two. The expression
<code>
expr1 expr2 | expr3 expr4
</code>
means
<code>
(expr1 expr2) | (expr3 expr4)
</code>
. Version one of the query dialect behaves differently. Using parentheses in query strings is advised to ensure the order is clear.
</div>
</div>
<p>
If you want to perform the union based on multiple values within a single tag or text field, then you should use the following simplified notion:
</p>
<pre tabindex="0"><code>FT.SEARCH index "@text_field:( value1 | value2 | ... )"
</code></pre>
<pre tabindex="0"><code>FT.SEARCH index "@tag_field:{ value1 | value2 | ... }"
</code></pre>
<p>
The following query shows you how to find used bicycles that contain either the word 'kids' or 'small':
</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="query_combined-stepcombined3">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined3" name="query_combined-stepcombined3" 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_query_combined-stepcombined3" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined3" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined3" 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 "(kids | small) @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_query_combined-stepcombined3')" 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_query_combined-stepcombined3" name="query_combined-stepcombined3" 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_query_combined-stepcombined3" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined3" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined3" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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="c1"># put query string here</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">search</span><span class="p">(</span><span class="n">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined3')" 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_query_combined-stepcombined3" 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/query_combined.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_query_combined-stepcombined3" name="query_combined-stepcombined3" 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_query_combined-stepcombined3" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined3" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined3" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</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 hl"><span class="cl"><span class="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res7</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></span><span class="line"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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></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_query_combined-stepcombined3')" 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_query_combined-stepcombined3" 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/query-combined.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>
</div>
<p>
The previous query searches across all text fields. The following example shows you how to limit the search to the description 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="query_combined-stepcombined4">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined4" name="query_combined-stepcombined4" 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_query_combined-stepcombined4" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined4" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined4" 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 "@description:(kids | small) @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_query_combined-stepcombined4')" 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_query_combined-stepcombined4" name="query_combined-stepcombined4" 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_query_combined-stepcombined4" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined4" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined4" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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="c1"># put query string here</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">search</span><span class="p">(</span><span class="n">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined4')" 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_query_combined-stepcombined4" 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/query_combined.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_query_combined-stepcombined4" name="query_combined-stepcombined4" 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_query_combined-stepcombined4" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined4" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined4" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 hl"><span class="cl"><span class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res7</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></span><span class="line"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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></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_query_combined-stepcombined4')" 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_query_combined-stepcombined4" 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/query-combined.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>
</div>
<p>
If you want to extend the search to new bicycles, then the below example shows you how to do that:
</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="query_combined-stepcombined5">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined5" name="query_combined-stepcombined5" 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_query_combined-stepcombined5" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined5" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined5" 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 "@description:(kids | small) @condition:{new | 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_query_combined-stepcombined5')" 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_query_combined-stepcombined5" name="query_combined-stepcombined5" 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_query_combined-stepcombined5" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined5" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined5" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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="c1"># put query string here</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">search</span><span class="p">(</span><span class="n">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined5')" 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_query_combined-stepcombined5" 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/query_combined.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_query_combined-stepcombined5" name="query_combined-stepcombined5" 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_query_combined-stepcombined5" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined5" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined5" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 hl"><span class="cl"><span class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res7</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></span><span class="line"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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></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_query_combined-stepcombined5')" 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_query_combined-stepcombined5" 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/query-combined.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>
</div>
<h2 id="not">
NOT
</h2>
<p>
A minus (
<code>
-
</code>
) in front of a query expression negates the expression.
</p>
<pre tabindex="0"><code>FT.SEARCH index "-(expr)"
</code></pre>
<p>
If you want to exclude new bicycles from the search within the previous price range, you can use this query:
</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="query_combined-stepcombined6">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined6" name="query_combined-stepcombined6" 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_query_combined-stepcombined6" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined6" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined6" 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 "@price:[500 1000] -@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_query_combined-stepcombined6')" 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_query_combined-stepcombined6" name="query_combined-stepcombined6" 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_query_combined-stepcombined6" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined6" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined6" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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="c1"># put query string here</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">search</span><span class="p">(</span><span class="n">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined6')" 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_query_combined-stepcombined6" 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/query_combined.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_query_combined-stepcombined6" name="query_combined-stepcombined6" 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_query_combined-stepcombined6" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined6" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined6" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 hl"><span class="cl"><span class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="c1"></span>
</span></span><span class="line"><span class="cl"><span class="kr">const</span> <span class="nx">res7</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></span><span class="line"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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></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_query_combined-stepcombined6')" 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_query_combined-stepcombined6" 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/query-combined.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>
</div>
<h2 id="numeric-filter">
Numeric filter
</h2>
<p>
The
<a href="/docs/latest/commands/ft.search">
FT.SEARCH
</a>
command allows you to combine any query expression with a numeric filter.
</p>
<pre tabindex="0"><code>FT.SEARCH index "expr" FILTER numeric_field start end
</code></pre>
<p>
Please see the
<a href="/docs/latest/develop/interact/search-and-query/query/range/">
range query article
</a>
to learn more about numeric range queries and such filters.
</p>
<h2 id="pre-filter-for-a-knn--vector-query">
Pre-filter for a KNN vector query
</h2>
<p>
You can use a simple or more complex query expression with logical operators as a pre-filter in a KNN vector query.
</p>
<pre tabindex="0"><code>FT.SEARCH index "(filter_expr)=>[KNN num_neighbours @field $vector]" PARAMS 2 vector "binary_data" DIALECT 2
</code></pre>
<p>
Here is an example:
</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="query_combined-stepcombined7">
<input checked="" class="radiotab w-0 h-0" data-lang="redis-cli" id="redis-cli_query_combined-stepcombined7" name="query_combined-stepcombined7" 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_query_combined-stepcombined7" title="Open example">
>_ Redis CLI
</label>
<div aria-labelledby="tab-query_combined-stepcombined7" class="panel order-last hidden w-full mt-0 relative" id="panel_redis-cli_query_combined-stepcombined7" 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:bikes_vss "(@price:[500 1000] @condition:{new})=>[KNN 3 @vector $query_vector]" PARAMS 2 "query_vector" "Z\xf8\x15:\xf23\xa1\xbfZ\x1dI>\r\xca9..." DIALECT 2</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_query_combined-stepcombined7')" 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_query_combined-stepcombined7" name="query_combined-stepcombined7" 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_query_combined-stepcombined7" title="Open example">
Python
</label>
<div aria-labelledby="tab-query_combined-stepcombined7" class="panel order-last hidden w-full mt-0 relative" id="panel_Python_query_combined-stepcombined7" 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="kn">import</span> <span class="nn">json</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 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">warnings</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 class="p">,</span> <span class="n">VectorField</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="k">def</span> <span class="nf">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">text</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">tobytes</span><span class="p">()</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">warnings</span><span class="o">.</span><span class="n">filterwarnings</span><span class="p">(</span><span class="s2">"ignore"</span><span class="p">,</span> <span class="n">category</span><span class="o">=</span><span class="ne">FutureWarning</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="sa">r</span><span class="s2">".*clean_up_tokenization_spaces.*"</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">model</span> <span class="o">=</span> <span class="n">SentenceTransformer</span><span class="p">(</span><span class="s1">'sentence-transformers/all-MiniLM-L6-v2'</span><span class="p">)</span>
</span></span><span class="line"><span class="cl"><span class="n">query</span> <span class="o">=</span> <span class="s2">"Bike for small kids"</span>
</span></span><span class="line"><span class="cl"><span class="n">query_vector</span> <span class="o">=</span> <span class="n">embed_text</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">query</span><span class="p">)</span>
</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">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="c1"># create index</span>
</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">"$.description"</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">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="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">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="mi">384</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></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></span><span class="line"><span class="cl"><span class="c1"># load data</span>
</span></span><span class="line"><span class="cl"><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"data/query_vector.json"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
</span></span><span class="line"><span class="cl"> <span class="n">bicycles</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">f</span><span class="p">)</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">r</span><span class="o">.</span><span class="n">pipeline</span><span class="p">(</span><span class="n">transaction</span><span class="o">=</span><span class="kc">False</span><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">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="sa">f</span><span class="s1">'bicycle:</span><span class="si">{</span><span class="n">bid</span><span class="si">}</span><span class="s1">'</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 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></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] @condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"kids @price:[500 1000] @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 1</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:</span><span class="si">{used}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@description:(kids | small) @condition:{new | used}"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 0</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">"</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">index</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">q</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">total</span><span class="p">)</span> <span class="c1"># >>> 2</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line hl"><span class="cl"><span class="n">q</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="s2">"(@price:[500 1000] -@condition:</span><span class="si">{new}</span><span class="s2">)=>[KNN 3 @vector $query_vector]"</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 hl"><span class="cl"><span class="c1"># put query string here</span>
</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">q</span><span class="p">,{</span> <span class="s1">'query_vector'</span><span class="p">:</span> <span class="n">query_vector</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="o">.</span><span class="n">total</span><span class="p">)</span> <span class="c1"># >>> 2</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_Python_query_combined-stepcombined7')" 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_query_combined-stepcombined7" 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/query_combined.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_query_combined-stepcombined7" name="query_combined-stepcombined7" 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_query_combined-stepcombined7" title="Open example">
Node.js
</label>
<div aria-labelledby="tab-query_combined-stepcombined7" class="panel order-last hidden w-full mt-0 relative" id="panel_Nodejs_query_combined-stepcombined7" 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="nx">assert</span> <span class="nx">from</span> <span class="s1">'node:assert'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="nx">fs</span> <span class="nx">from</span> <span class="s1">'node:fs'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">createClient</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">import</span> <span class="p">{</span> <span class="nx">SchemaFieldTypes</span><span class="p">,</span> <span class="nx">VectorAlgorithms</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@redis/search'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kr">import</span> <span class="p">{</span> <span class="nx">pipeline</span> <span class="p">}</span> <span class="nx">from</span> <span class="s1">'@xenova/transformers'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"><span class="kd">function</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="nx">arr</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">floatArray</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Float32Array</span><span class="p">(</span><span class="nx">arr</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="kr">const</span> <span class="nx">float32Buffer</span> <span class="o">=</span> <span class="nx">Buffer</span><span class="p">.</span><span class="nx">from</span><span class="p">(</span><span class="nx">floatArray</span><span class="p">.</span><span class="nx">buffer</span><span class="p">);</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">float32Buffer</span><span 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">async</span> <span class="kd">function</span> <span class="nx">embedText</span><span class="p">(</span><span class="nx">sentence</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">modelName</span> <span class="o">=</span> <span class="s1">'Xenova/all-MiniLM-L6-v2'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"> <span class="kd">let</span> <span class="nx">pipe</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipeline</span><span class="p">(</span><span class="s1">'feature-extraction'</span><span class="p">,</span> <span class="nx">modelName</span><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">vectorOutput</span> <span class="o">=</span> <span class="kr">await</span> <span class="nx">pipe</span><span class="p">(</span><span class="nx">sentence</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">pooling</span><span class="o">:</span> <span class="s1">'mean'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">normalize</span><span class="o">:</span> <span class="kc">true</span><span 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">if</span> <span class="p">(</span><span class="nx">vectorOutput</span> <span class="o">==</span> <span class="kc">null</span><span class="p">)</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'vectorOutput is undefined'</span><span 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">const</span> <span class="nx">embedding</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">values</span><span class="p">(</span><span class="nx">vectorOutput</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="k">return</span> <span class="nx">embedding</span><span 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">query</span> <span class="o">=</span> <span class="s1">'Bike for small kids'</span><span class="p">;</span>
</span></span><span class="line"><span class="cl"><span class="kd">let</span> <span class="nx">vector_query</span> <span class="o">=</span> <span class="nx">float32Buffer</span><span class="p">(</span><span class="kr">await</span> <span class="nx">embedText</span><span class="p">(</span><span class="s1">'That is a very happy person'</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">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="kr">await</span> <span class="nx">client</span><span class="p">.</span><span class="nx">connect</span><span class="p">().</span><span class="k">catch</span><span class="p">(</span><span class="nx">console</span><span class="p">.</span><span class="nx">error</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 index
</span></span></span><span class="line"><span class="cl"><span class="c1"></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">create</span><span class="p">(</span><span class="s1">'idx:bicycle'</span><span class="p">,</span> <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">'$.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="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">'$.description_embeddings'</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">VECTOR</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">TYPE</span><span class="o">:</span> <span class="s1">'FLOAT32'</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">ALGORITHM</span><span class="o">:</span> <span class="nx">VectorAlgorithms</span><span class="p">.</span><span class="nx">FLAT</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DIM</span><span class="o">:</span> <span class="mi">384</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nx">DISTANCE_METRIC</span><span class="o">:</span> <span class="s1">'COSINE'</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">'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 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></span><span class="line"><span class="cl"><span class="c1">// load data
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="kr">const</span> <span class="nx">bicycles</span> <span class="o">=</span> <span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">readFileSync</span><span class="p">(</span><span class="s1">'data/query_vector.json'</span><span class="p">,</span> <span class="s1">'utf8'</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="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">bid</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="k">return</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">bid</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 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">res1</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">'@price:[500 1000] @condition:{new}'</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="nx">res1</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res1</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res2</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">'kids @price:[500 1000] @condition:{used}'</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="nx">res2</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 1
</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">log</span><span class="p">(</span><span class="nx">res2</span><span class="p">);</span> <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">// total: 1,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
</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="kr">const</span> <span class="nx">res3</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">'(kids | small) @condition:{used}'</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="nx">res3</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res3</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res4</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">'@description:(kids | small) @condition:{used}'</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="nx">res4</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res4</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res5</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">'@description:(kids | small) @condition:{new | used}'</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="nx">res5</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 3
</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">log</span><span class="p">(</span><span class="nx">res5</span><span class="p">);</span> <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">// total: 3,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:1', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:0', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] }
</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 class="kr">const</span> <span class="nx">res6</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">'@price:[500 1000] -@condition:{new}'</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="nx">res6</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res6</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 hl"><span class="cl"><span class="kr">const</span> <span class="nx">res7</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></span><span class="line hl"><span class="cl"> <span class="s1">'(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]'</span><span class="p">,</span> <span class="p">{</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">PARAMS</span><span class="o">:</span> <span class="p">{</span> <span class="nx">query_vector</span><span class="o">:</span> <span class="nx">vector_query</span> <span class="p">},</span>
</span></span><span class="line hl"><span class="cl"> <span class="nx">DIALECT</span><span class="o">:</span> <span class="mi">2</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="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">.</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// >>> 2
</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">log</span><span class="p">(</span><span class="nx">res7</span><span class="p">);</span> <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">// total: 2,
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// documents: [
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:2', value: [Object: null prototype] },
</span></span></span><span class="line hl"><span class="cl"><span class="c1">// { id: 'bicycle:9', value: [Object: null prototype] }
</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 class="c1"></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_Nodejs_query_combined-stepcombined7')" 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_query_combined-stepcombined7" 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/query-combined.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>
</div>
<p>
The
<a href="/docs/latest/develop/interact/search-and-query/query/vector-search/">
vector search article
</a>
provides further details about vector queries in general.
</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/query/combined/"/>
<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/re-clusters/connect-prometheus-operator/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Connect the Prometheus operator to Redis Enterprise for Kubernetes
</h1>
<p class="text-lg -mt-5 mb-10">
This article describes how to configure a Prometheus operator custom resource to allow it to export metrics from Redis Enterprise for Kubernetes.
</p>
<p>
To collect metrics data from your databases and Redis Enterprise cluster (REC), you can connect your
<a href="https://prometheus.io/">
Prometheus
</a>
server to an endpoint exposed on your REC. Redis Enterprise for Kubernetes creates a dedicated service to expose the
<code>
prometheus
</code>
port (8070) for data collection. A custom resource called
<code>
ServiceMonitor
</code>
allows the
<a href="https://github.com/prometheus-operator/prometheus-operator/tree/main/Documentation">
Prometheus operator
</a>
to connect to this port and collect data from Redis Enterprise.
</p>
<h2 id="prerequisites">
Prerequisites
</h2>
<p>
Before connecting Redis Enterprise to Prometheus on your Kubernetes cluster, make sure you've done the following:
</p>
<ul>
<li>
<a href="/docs/latest/operate/kubernetes/deployment/quick-start/">
Deploy Redis Enterprise for Kubernetes
</a>
(version 6.2.10-4 or newer)
</li>
<li>
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md">
Deploy the Prometheus operator
</a>
(version 0.19.0 or newer)
</li>
<li>
<a href="/docs/latest/operate/kubernetes/deployment/quick-start/#create-a-redis-enterprise-cluster-rec">
Create a Redis Enterprise cluster
</a>
</li>
</ul>
<h2 id="create-a-servicemonitor-custom-resource">
Create a
<code>
ServiceMonitor
</code>
custom resource
</h2>
<p>
Below is an example
<code>
ServiceMonitor
</code>
custom resource file. By specifying the service label (
<code>
app: redis.io/service=prom-metrics
</code>
) in the
<code>
selector.matchLabels
</code>
section, you can point the Prometheus operator to the correct Redis Enterprise service (
<code>
<rec_name>-prom
</code>
).
</p>
<p>
You'll need to configure the following fields to connect Prometheus to Redis Enterprise:
</p>
<table>
<thead>
<tr>
<th>
Section
</th>
<th>
Field
</th>
<th>
Value
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>
spec.endpoints
</code>
</td>
<td>
<code>
port
</code>
</td>
<td>
Name of exposed port (
<code>
prometheus
</code>
)
</td>
</tr>
<tr>
<td>
<code>
spec.namespaceSelector
</code>
</td>
<td>
<code>
matchNames
</code>
</td>
<td>
Namespace for your REC
</td>
</tr>
<tr>
<td>
<code>
spec.selector
</code>
</td>
<td>
<code>
matchLabels
</code>
</td>
<td>
REC service label (
<code>
app: redis.io/service=prom-metrics
</code>
)
</td>
</tr>
</tbody>
</table>
<p>
Apply the file in the same namespace as your Redis Enterprise cluster (REC).
</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>
If Redis Enterprise and Prometheus are deployed in different namespaces, you'll also need to add the
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#namespaceselector">
<code>
serviceMonitorNamespaceSelector
</code>
</a>
field to your Prometheus resource. See the
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#related-resources">
Prometheus operator documentation
</a>
for more details on cross-namespace
<code>
ServiceMonitor
</code>
configuration.
</div>
</div>
<p>
</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">monitoring.coreos.com/v1</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">ServiceMonitor</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">redis-enterprise</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"></span><span class="nt">spec</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">endpoints</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="nt">interval</span><span class="p">:</span><span class="w"> </span><span class="l">15s</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l">prometheus</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">scheme</span><span class="p">:</span><span class="w"> </span><span class="l">https</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">tlsConfig</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">insecureSkipVerify</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">namespaceSelector</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">matchNames</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span>- <span class="l"><your_REC_namespace></span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">selector</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">matchLabels</span><span class="p">:</span><span class="w">
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">redis.io/service</span><span class="p">:</span><span class="w"> </span><span class="l">prom-metrics</span><span class="w">
</span></span></span></code></pre>
</div>
<p>
For more info about configuring the
<code>
ServiceMonitor
</code>
resource, see the
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec">
<code>
ServiceMonitorSpec
</code>
API documentation
</a>
.
</p>
<h2 id="more-info">
More info
</h2>
<ul>
<li>
github.com/prometheus-operator
<ul>
<li>
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md">
Getting started
</a>
</li>
<li>
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/running-exporters.md">
Running exporters
</a>
</li>
<li>
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/getting-started.md#related-resources">
Related resources
</a>
</li>
<li>
<a href="https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/troubleshooting.md">
Troubleshooting ServiceMonitor changes
</a>
</li>
</ul>
</li>
<li>
redis.io/docs
<ul>
<li>
<a href="/docs/latest/integrate/prometheus-with-redis-enterprise/prometheus-metrics-definitions/">
Metrics in Prometheus
</a>
</li>
<li>
<a href="/docs/latest/operate/rs/clusters/monitoring/">
Monitoring and metrics
</a>
</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/kubernetes/re-clusters/connect-prometheus-operator/"/>
<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/encryption/tls/.html | <section class="prose w-full py-12 max-w-none">
<h1>
Transport Layer Security (TLS)
</h1>
<p class="text-lg -mt-5 mb-10">
An overview of Transport Layer Security (TLS).
</p>
<p>
<a href="https://en.wikipedia.org/wiki/Transport_Layer_Security">
Transport Layer Security (TLS)
</a>
, a successor to SSL, ensures the privacy of data sent between applications and Redis databases. TLS also secures connections between Redis Enterprise Software nodes.
</p>
<p>
You can
<a href="/docs/latest/operate/rs/7.4/security/encryption/tls/enable-tls/">
use TLS authentication
</a>
for the following types of communication:
</p>
<ul>
<li>
Communication from clients (applications) to your database
</li>
<li>
Communication from your database to other clusters for replication using
<a href="/docs/latest/operate/rs/7.4/databases/import-export/replica-of/">
Replica Of
</a>
</li>
<li>
Communication to and from your database to other clusters for synchronization using
<a href="/docs/latest/operate/rs/7.4/databases/active-active/">
Active-Active
</a>
</li>
</ul>
<h2 id="protocols-and-ciphers">
Protocols and ciphers
</h2>
<p>
TLS protocols and ciphers define the overall suite of algorithms that clients are able to connect to the servers with.
</p>
<p>
You can change the
<a href="/docs/latest/operate/rs/7.4/security/encryption/tls/tls-protocols/">
TLS protocols
</a>
and
<a href="/docs/latest/operate/rs/7.4/security/encryption/tls/ciphers/">
ciphers
</a>
to improve the security of your Redis Enterprise cluster and databases. The default settings are in line with industry best practices, but you can customize them to match the security policy of your organization.
</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/security/encryption/tls/"/>
<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
No community queries yet
The top public SQL queries from the community will appear here once available.