Redis Cloud Quick Start
If you’re new to Redis Enterprise Cloud, this quick start helps you get up and running.
You’ll learn how to:
Create a free subscription
Create a database
Connect to your database
Create a subscription
To create a new free subscription:
Sign in to the Redis Cloud admin portal. (Create an acoount if you don’t already have one.)
From the admin console menu, choose Subscriptions.
Select the Add Subscription button ().
Choose a Cloud Provider and a Region.
(You can ignore the High-Availability options for now; these are available in paid tiers only.)
In the Fixed Size panel, locate the Dataset Size list and then choose 30MB.
Free plans are a tier of Fixed plans; this provides an easy upgrade path when you need it.
Enter a descriptive Subscription Name and then select Create.
If this is your first subscription, you’ll be taken directly to the Create Database screen.
Create a database
Next, we create a database.
If you aren’t already at the Databases screen, sign into the Redis Cloud admin console, select Databases from the menu, and then select the button.
Enter a descriptive Database Name.
- You have 40 characters
- You can use letters, numbers, or a hyphen
- The name must start with a letter and end with either a letter or a number
- Spaces are not allowed
For this exercise, leave the remaining options at their default values. (To learn about them, see Create a fixed subscription.)
Locate the Activate button near the bottom of the page and then select it.
You’re taken to the Configuration tab of the View Database screen. In the upper corner, you’ll see an orange box containing a rotating circle. This is the Pending status indicator and it means your database is still being created.
When the database has been created, the status indicator switches to a green box containing a checkmark; this is the Active status indicator. When your database becomes active, it’s ready for use.
Admin console operations are asychronous; they operate in the background. You can continue to use the admin console for other tasks, but pending resources aren’t avilable until they’re active.
To use a database, you need to connect to it.
Connect to a database
At this point, you’re at the View Database screen for your new database.
To connect to your database, you need the following info:
- The public endpoint for your database
- The port number
- The database password
These are available in the Configuration details of the View Database screen:
The Endpoint setting shows the URI for your database and the port number
The Access Control & Security setting shows a masked Default Password. Use Password button to show or hide the password.
Once you have the connection details, you can connect in a variety of ways, including:
Using a connection client for your preferred programming language
Here’s an example of each.
Use redis-cli (via Docker)
redis-cli utility is installed when you install Redis. It provides a command-line interface that lets you work with your database using core Redis commands.
Docker provides a covenient way to run
redis-cli without the full installation experience.
When you run the
redis Docker image, you can open a bash shell instance and run
redis-cli from the container.
To begin, pull the
redisdocker image and run it with default options:
% docker pull redis % docker run -d --name redis1 redis % docker exec -it redis1 bash
This gives you a bash prompt running within your Docker image. From here, you can connect to your database:
# redis-cli -h <endpoint> -p <port> -a <password> xxx:yyy>
<password>with the details copied earlier from the View Database screen.
You should now be connectded to your database and can perform basic Redis commands:
xxx:yyy> ping PONG xxx:yyy> set hello world OK xxx:yyy> get hello "world"
Use code (Python)
Different programming languages use different clients to interact with Redis databases.
Here’s how to connect to your database using the
redis-py library for Python.
If you don’t already have the client installed:
sudo pip install redis-py
The specific syntax vries according to the client:
import redis r = redis.Redis(host='<endpoint>', port=<port>, password='<password>') r.set('hello', 'world') print(r.get('hello'))
Now, run the code:
$ python example_redis.py bar