Skip to content

Commit 3132321

Browse files
author
Andrew Brookins
committed
Remove links to MD files that do not exist yet
1 parent 5dee757 commit 3132321

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

docs/getting_started.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ You can also use the official Redis Docker image, which is hosted on [Docker Hub
4747

4848
## Recommended: RediSearch and RedisJSON
4949

50-
Redis OM relies on the [RediSearch][redisearch-url] and [RedisJSON][redis-json-url] Redis modules to support [rich queries](querying.md) and [embedded models](embedded_models.md).
50+
Redis OM relies on the [RediSearch][redisearch-url] and [RedisJSON][redis-json-url] Redis modules to support rich queries and embedded models.
5151

5252
You don't need these Redis modules to use Redis OM's data modeling, validation, and persistence features, but we recommend them to get the most out of Redis OM.
5353

@@ -129,16 +129,6 @@ Other supported prefixes include "rediss" for SSL connections and "unix" for Uni
129129
rediss://[[username]:[password]]@localhost:6379/0
130130
unix://[[username]:[password]]@/path/to/socket.sock?db=0
131131

132-
For more details about how to connect to Redis with Redis OM, see the [connections documentation](connections.md).
133-
134-
### Redis Cluster Support
135-
136-
Redis OM supports connecting to Redis Cluster, but this preview release does not support doing so with the `REDIS_OM_URL` environment variable. However, you can connect by manually creating a connection object.
137-
138-
See the [connections documentation](connections.md) for examples of connecting to Redis Cluster.
139-
140-
Support for connecting to Redis Cluster via `REDIS_OM_URL` will be added in a future release.
141-
142132
## Defining a Model
143133

144134
In this tutorial, we'll create a `Customer` model that validates and saves data. Let's start with a basic definition of the model. We'll add features as we go along.
@@ -163,7 +153,7 @@ There are a few details to note:
163153
1. Our `Customer` model extends the `HashModel` class. This means that it will be saved to Redis as a hash. The other model class that Redis OM provides is `JsonModel`, which we'll discuss later.
164154
2. We've specified the model's fields using Python type annotations.
165155

166-
Let's dig into these two details a bit more.
156+
Let's dig into the `HashModel` class and type annotations a bit more.
167157

168158
### The HashModel Class
169159

@@ -669,6 +659,7 @@ from pydantic import EmailStr
669659

670660
from redis_om import (
671661
Field,
662+
get_redis_connection,
672663
HashModel,
673664
Migrator
674665
)
@@ -689,7 +680,8 @@ class Customer(HashModel):
689680
# Before running queries, we need to run migrations to set up the
690681
# indexes that Redis OM will use. You can also use the `migrate`
691682
# CLI tool for this!
692-
Migrator().run()
683+
redis = get_redis_connection()
684+
Migrator(redis).run()
693685

694686
# Find all customers with the last name "Brookins"
695687
Customer.find(Customer.last_name == "Brookins").all()
@@ -704,13 +696,14 @@ Customer.find((Customer.last_name == "Brookins") | (
704696
) & (Customer.last_name == "Smith")).all()
705697
```
706698

707-
Many more types of queries are possible. learn more about querying with Redis OM, see the [documentation on querying](docs/querying.md).
708-
709699
## Next Steps
710700

711-
Now that you know the basics of working with Redis OM, continue on for all the nitty-gritty details about [models and fields](models_and_fields.md).
701+
Now that you know the basics of working with Redis OM, start playing around with it in your project!
702+
703+
If you're a FastAPI user, check out [how to integrate Redis OM with FastAPI](https://github.com/redis/redis-om-python/blob/main/docs/fastapi_integration.md).
712704

713705
<!-- Links -->
714706

715707
[redisearch-url]: https://oss.redis.com/redisearch/
716708
[redis-json-url]: https://oss.redis.com/redisjson/
709+
[pydantic-url]: https://github.com/samuelcolvin/pydantic

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "redis-om"
3-
version = "0.0.14"
3+
version = "0.0.15"
44
description = "Objecting mapping, and more, for Redis."
55
authors = ["Andrew Brookins <[email protected]>"]
66
maintainers = ["Andrew Brookins <[email protected]>"]

0 commit comments

Comments
 (0)