Skip to content

Commit 7f4dc4f

Browse files
authored
docs: adds sentinel instructions, no_index and unf attributes documented (#397)
1 parent 156e429 commit 7f4dc4f

File tree

2 files changed

+42
-8
lines changed

2 files changed

+42
-8
lines changed

docs/api/schema.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,27 @@ Each field type supports specific attributes that customize its behavior. Below
7272
- `withsuffixtrie`: Optimizes queries by maintaining a suffix trie.
7373
- `phonetic_matcher`: Enables phonetic matching.
7474
- `sortable`: Allows sorting on this field.
75+
- `no_index`: When True, field is not indexed but can be returned in results (requires `sortable=True`).
76+
- `unf`: Un-normalized form. When True, preserves original case for sorting (requires `sortable=True`).
7577

7678
**Tag Field Attributes**:
7779

7880
- `separator`: Character for splitting text into individual tags.
7981
- `case_sensitive`: Case sensitivity in tag matching.
8082
- `withsuffixtrie`: Suffix trie optimization for queries.
8183
- `sortable`: Enables sorting based on the tag field.
84+
- `no_index`: When True, field is not indexed but can be returned in results (requires `sortable=True`).
8285

83-
**Numeric and Geo Field Attributes**:
86+
**Numeric Field Attributes**:
8487

85-
- Both numeric and geo fields support the `sortable` attribute, enabling sorting on these fields.
88+
- `sortable`: Enables sorting on the numeric field.
89+
- `no_index`: When True, field is not indexed but can be returned in results (requires `sortable=True`).
90+
- `unf`: Un-normalized form. When True, maintains original numeric representation for sorting (requires `sortable=True`).
91+
92+
**Geo Field Attributes**:
93+
94+
- `sortable`: Enables sorting based on the geo field.
95+
- `no_index`: When True, field is not indexed but can be returned in results (requires `sortable=True`).
8696

8797
**Common Vector Field Attributes**:
8898

docs/overview/installation.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,21 @@ $ pip install .
4949
$ pip install -e .
5050
```
5151

52-
5352
## Installing Redis
5453

5554
RedisVL requires a distribution of Redis that supports the [Search and Query](https://redis.com/modules/redis-search/) capability of which there are 3:
5655

5756
offering
57+
5858
1. [Redis Cloud](https://redis.io/cloud), a fully managed cloud offering
5959
2. [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/), a local docker image for testing and development
6060
3. [Redis Enterprise](https://redis.com/redis-enterprise/), a commercial self-hosted
6161

62-
63-
6462
### Redis Cloud
6563

6664
Redis Cloud is the easiest way to get started with RedisVL. You can sign up for a free account [here](https://redis.io/cloud). Make sure to have the `Search and Query`
6765
capability enabled when creating your database.
6866

69-
7067
### Redis Stack (local development)
7168

7269
For local development and testing, Redis-Stack can be used. We recommend running Redis
@@ -78,9 +75,36 @@ docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:lat
7875

7976
This will also spin up the [Redis Insight GUI](https://redis.io/insight/) at `http://localhost:8001`.
8077

81-
8278
### Redis Enterprise (self-hosted)
8379

8480
Redis Enterprise is a commercial offering that can be self-hosted. You can download the latest version [here](https://redis.io/downloads/).
8581

86-
If you are considering a self-hosted Redis Enterprise deployment on Kubernetes, there is the [Redis Enterprise Operator](https://docs.redis.com/latest/kubernetes/) for Kubernetes. This will allow you to easily deploy and manage a Redis Enterprise cluster on Kubernetes.
82+
If you are considering a self-hosted Redis Enterprise deployment on Kubernetes, there is the [Redis Enterprise Operator](https://docs.redis.com/latest/kubernetes/) for Kubernetes. This will allow you to easily deploy and manage a Redis Enterprise cluster on Kubernetes.
83+
84+
### Redis Sentinel
85+
86+
For high availability deployments, RedisVL supports connecting to Redis through Sentinel. Use the `redis+sentinel://` URL scheme to connect:
87+
88+
```python
89+
from redisvl.index import SearchIndex
90+
91+
# Connect via Sentinel
92+
# Format: redis+sentinel://[username:password@]host1:port1,host2:port2/service_name[/db]
93+
index = SearchIndex.from_yaml(
94+
"schema.yaml",
95+
redis_url="redis+sentinel://sentinel1:26379,sentinel2:26379/mymaster"
96+
)
97+
98+
# With authentication
99+
index = SearchIndex.from_yaml(
100+
"schema.yaml",
101+
redis_url="redis+sentinel://user:pass@sentinel1:26379,sentinel2:26379/mymaster/0"
102+
)
103+
```
104+
105+
The Sentinel URL format supports:
106+
107+
- Multiple sentinel hosts (comma-separated)
108+
- Optional authentication (username:password)
109+
- Service name (required - the name of the Redis master)
110+
- Optional database number (defaults to 0)

0 commit comments

Comments
 (0)