From b1da14bf9684620223dc129029efac8a4b291bb5 Mon Sep 17 00:00:00 2001 From: Simon Prickett Date: Thu, 7 Apr 2022 10:33:53 +0100 Subject: [PATCH] Updated documentation with note about indexing only being for database 0. --- README.md | 4 +++- docs/connections.md | 4 ++++ docs/getting_started.md | 2 ++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 32ca32c..0c5ca98 100644 --- a/README.md +++ b/README.md @@ -237,7 +237,9 @@ Customer.find((Customer.last_name == "Brookins") | ( These queries -- and more! -- are possible because **Redis OM manages indexes for you automatically**. -Querying with this index features a rich expression syntax inspired by the Django ORM, SQLAlchemy, and Peewee. We think you'll enjoy it! +Querying with this index features a rich expression syntax inspired by the Django ORM, SQLAlchemy, and Peewee. We think you'll enjoy it! + +**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator. ### Embedded Models diff --git a/docs/connections.md b/docs/connections.md index 076c31c..096d00a 100644 --- a/docs/connections.md +++ b/docs/connections.md @@ -18,6 +18,8 @@ The default connection is equivalent to the following `REDIS_OM_URL` environment redis://localhost:6379 +**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator. + ### Passwords and Usernames Redis can be configured with password protection and a "default" user, in which case you might connect using only the password. @@ -34,6 +36,8 @@ If your Redis instance requires both a username and a password, you would includ Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database, or specify it. +**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator. + ### SSL Connections Use the "rediss" prefix for SSL connections: diff --git a/docs/getting_started.md b/docs/getting_started.md index 715b0a6..009fd2f 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -124,6 +124,8 @@ The default connection is equivalent to the following `REDIS_OM_URL` environment **TIP:** Redis databases are numbered, and the default is 0. You can leave off the database number to use the default database. +**Note:** Indexing only works for data stored in Redis logical database 0. If you are using a different database number when connecting to Redis, you can expect the code to raise a `MigrationError` when you run the migrator. + Other supported prefixes include "rediss" for SSL connections and "unix" for Unix domain sockets: rediss://[[username]:[password]]@localhost:6379/0