Skip to main content

Project Setup#

To get started, let’s create a new Laravel application. If you don’t have the Laravel CLI installed globally, install it first using Composer:

After installation, create your Laravel project:

Alternatively, if you don’t want to install the Laravel CLI, you can create a project using Composer:

Redis Client Setup#

Laravel needs a Redis client to talk to your database. The easiest option is Predis, a pure-PHP client that requires no extension:

Info

If you have the PhpRedis PECL extension installed, you can skip this step, since Laravel uses it by default.

Database Setup#

Create a Redis database using Upstash Console. Go to the Connect to your database section and click on PHP and then Laravel. Copy those values into your .env file. REDIS_PASSWORD takes the Token shown in the console, which is also your database’s password. Note the tls:// prefix on the endpoint, Upstash requires TLS connections:

.env

Framework Integration#

Upstash Redis integrates seamlessly with Laravel, allowing it to be used as a driver for multiple framework components.

Interact with Redis#

The Redis Facade in Laravel provides a convenient way to interact with your Redis database. For example:

This can be particularly useful for simple caching or temporary data storage.

Cache#

To use Upstash Redis as your caching driver, update the CACHE_STORE in your .env file:

.env

With this configuration, you can use Laravel’s caching functions, such as:

For more advanced cache configurations, see the Laravel Cache Documentation.

Session#

Laravel can store session data in Upstash Redis. To enable this, set the SESSION_DRIVER in your .env file:

.env

This ensures that session data is stored in your Upstash Redis database, providing fast and reliable session management.

Queue#

Upstash Redis can also serve as a driver for Laravel’s queue system, enabling job processing. To configure this, update the QUEUE_CONNECTION in your .env file:

.env

For detailed queue configurations and usage, refer to the Laravel Queues Documentation.