Bun Redis with Upstash

Create a new project

Create a new project by running bun init:

$ bun init bun-upstash-redis
$ cd bun-upstash-redis

Create an Upstash Redis database

Go to the Upstash dashboard and create a new Redis database. After completing the getting started guide, you'll see your database page with connection information.

The database page displays two connection methods; HTTP and TLS. For Bun's Redis client, you need the TLS connection details. This URL starts with rediss://.

Connect using Bun's Redis client

You can connect to Upstash by setting environment variables with Bun's default redis client.

Set the REDIS_URL environment variable in your .env file using the Redis endpoint (not the REST URL):

REDIS_URL=rediss://********@********.upstash.io:6379

Bun's Redis client reads connection information from REDIS_URL by default:

import { redis } from "bun";

// Reads from process.env.REDIS_URL automatically
await redis.set("counter", "0"); 

Alternatively, you can create a custom client using RedisClient:

import { RedisClient } from "bun";

const redis = new RedisClient(process.env.REDIS_URL); 

Use the Redis client

You can now use the Redis client to interact with your Upstash Redis database:

import { redis } from "bun";

// Get a value
let counter = await redis.get("counter");

// Set a value if it doesn't exist
if (!counter) {
	await redis.set("counter", "0");
}

// Increment the counter
await redis.incr("counter");

// Get the updated value
counter = await redis.get("counter");
console.log(counter);
// => 1

The Redis client automatically handles connections in the background. No need to manually connect or disconnect for basic operations.