Upstash

https://upstash.com
Admin
Upstash is a serverless platform providing Redis databases, vector databases for AI/LLMs, message...
Tokens:3,210,095
Snippets:25,848
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install dependencies and start dev server

Source: https://upstash.com/blog/sveltekit-rate-limiting

Commands to install dependencies, initialize git, and start the SvelteKit dev server.

```bash
cd sveltekit-rate-limit
npm install
git init && git add -A && git commit -m "Initial commit"
npm run dev -- --open
```

--------------------------------

### Setup .env file

Source: https://upstash.com/examples/rate-limitingafeedbackform

Environment variables required for the example: UPSTASH_REDIS_REST_URL, UPSTASH_REDIS_REST_TOKEN, and RESEND_API_KEY. Fill in the values before starting the app.

```plaintext
UPSTASH_REDIS_REST_URL=
UPSTASH_REDIS_REST_TOKEN=
RESEND_API_KEY=
```

--------------------------------

### Install Hermes

Source: https://upstash.com/blog/personal-assistant-in-messaging-apps-hermes-upstash-box

Install Hermes on the box using the official install script. At the end, a setup wizard starts.

```bash
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
```

--------------------------------

### Set up the starter project with degit

Source: https://upstash.com/blog/sveltekit-edge-redis

Commands to download the initial state of the SvelteKit Edge Guestbook repo using degit, install dependencies, and start the dev server.

```bash
npx degit geoffrich/sveltekit-edge-guestbook#initial sveltekit-edge-guestbook
cd sveltekit-edge-guestbook
npm i
npm run dev
```

--------------------------------

### Complete Setup

Source: https://upstash.com/docs/redis/sdks/py/commands/connection/client_setinfo

Sets both library name and version, and notes that this information will appear in CLIENT LIST output.

```python
# Set both library name and version
redis.client_setinfo("LIB-NAME", "my-redis-wrapper")
redis.client_setinfo("LIB-VER", "3.2.1")
# Now this information will appear in CLIENT LIST output
```

--------------------------------

### History options: limit and start

Source: https://upstash.com/docs/realtime/features/server-side

Fetches messages with a limit of 100 and only those after a Unix timestamp (start). The example uses start: Date.now() - 86400000 to get messages from the last 24 hours.

```typescript
const messages = await realtime.channel("room-123").history({
  limit: 100,
  start: Date.now() - 86400000,
})
```

--------------------------------

### Build and start the application

Source: https://upstash.com/blog/article-recommendation-system

Command to build and start the application, then visit localhost:3000.

```bash
pnpm run build && pnpm run start
```

--------------------------------

### Initialize Fastly Compute project with JavaScript empty starter

Source: https://upstash.com/docs/redis/quickstarts/fastlycompute

Run `fastly compute init` and select JavaScript and the empty starter kit. The output shows the interactive prompts and selections.

```text
> fastly compute initCreating a new Compute project.Press ^C at any time to quit.Name: [fastly-upstash]Description:Author: [enes@upstash.com]Language:[1] Rust[2] JavaScript[3] Go[4] Other ('bring your own' Wasm binary)Choose option: [1] 2Starter kit:[1] Default starter for JavaScript    A basic starter kit that demonstrates routing, simple synthetic responses and    overriding caching rules.    https://github.com/fastly/compute-starter-kit-javascript-default[2] Empty starter for JavaScript    An empty application template for the Fastly Compute environment which simply    returns a 200 OK response.    https://github.com/fastly/compute-starter-kit-javascript-emptyChoose option or paste git URL: [1] 2
```

--------------------------------

### CONFIG GET example with redis-rs

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the redis-rs client in Rust.

```rust
fn main() -> redis::RedisResult<()> {
    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");
    let client = redis::Client::open(url)?;
    let mut connection = client.get_connection()?;
    let mut command = redis::cmd("CONFIG");
    command.arg("GET");
    command.arg("notify-keyspace-events");
    let result: redis::Value = command.query(&mut connection)?;
    println!("{result:?}");
    Ok(())
}
```

--------------------------------

### CONFIG GET example with jedis

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the jedis client in Java.

```java
import java.net.URI;
import redis.clients.jedis.Jedis;

try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.configGet("notify-keyspace-events");
  System.out.println(result);
}
```

--------------------------------

### CONFIG GET example with go-redis

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the go-redis client in Go.

```go
package main

import (
    "context"
    "fmt"
    "os"
    "github.com/redis/go-redis/v9"
)

func main() {
    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))
    if err != nil {
        panic(err)
    }
    client := redis.NewClient(opts)
    result, err := client.ConfigGet(context.Background(), "notify-keyspace-events").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}
```

--------------------------------

### Set up Node project and install Ollama client

Source: https://upstash.com/blog/ollama-deepseek

Initializes a new Node project, installs the ollama library, and creates an index.js file for the application.

```bash
npm init -y
npm install ollama
touch index.js
```

--------------------------------

### Run setup.py

Source: https://upstash.com/docs/box/guides/browser-use

Command to execute the setup script that creates the box and schedules the agent.

```bash
python setup.py
```

--------------------------------

### CONFIG GET example with redis-py

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the redis-py client in Python.

```python
import os
import redis
client = redis.from_url(os.environ["REDIS_URL"])
result = client.config_get("notify-keyspace-events")
print(result)
```

--------------------------------

### Initialize project and install dependencies

Source: https://upstash.com/blog/chat-langchain

Commands to create a project directory, initialize a package.json, install TypeScript, ts-node, Upstash Redis, LangChain, and dotenv, and set up git.

```bash
mkdir langchain_upstash_redis # Create a project directory
 
cd langchain_upstash_redis # Navigate into the project directory
 
yarn init -y # Initializes a new project with a package.json file
 
yarn add typescript ts-node --dev # Installs TypeScript and TS-Node for running TypeScript files
 
npx tsc --init # Initializes a TypeScript project
 
yarn add @upstash/redis langchain dotenv # Installs Upstash Redis, LangChain and dotenv for our environment variables
 
git init # Initializes a git repository
 
touch .gitignore # Creates a .gitignore file
```

--------------------------------

### CONFIG GET example with node-redis

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the node-redis client in Node.js.

```javascript
import { createClient } from "redis";
const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.configGet("notify-keyspace-events");
console.log(result);
```

--------------------------------

### CONFIG GET example with ioredis

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the ioredis client in Node.js.

```javascript
import Redis from "ioredis";
const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.config("GET", "notify-keyspace-events");
console.log(result);
```

--------------------------------

### Interactive setup answers and install dependencies

Source: https://upstash.com/blog/openai-hackernews-summarizer

These are the answers to the create-next-app prompts, followed by the command to install required packages: node-html-parser, ky, @upstash/redis, @upstash/ratelimit, @upstash/qstash, and openai. The cd command changes into the project directory before installing.

```bash
✔ What is your project named? … hackernews-summarizer
✔ Would you like to use TypeScript? … No / Yes
✔ Would you like to use ESLint? … No / Yes
✔ Would you like to use Tailwind CSS? … No / Yes
✔ Would you like to use `src/` directory? … No / Yes
✔ Would you like to use App Router? (recommended) … No / Yes
✔ Would you like to customize the default import alias (@/*)? … No / Yes
✔ What import alias would you like configured? … @/*
 
cd hackernews-summarizer && npm i node-html-parser ky @upstash/redis @upstash/ratelimit @upstash/qstash openai
```

--------------------------------

### Complete Setup

Source: https://upstash.com/docs/redis/sdks/ts/commands/connection/client_setinfo

Sets both library name and version, and notes that this information will appear in CLIENT LIST output.

```typescript
// Set both library name and version
await redis.clientSetInfo("LIB-NAME", "my-redis-wrapper");
await redis.clientSetInfo("LIB-VER", "3.2.1");
// Now this information will appear in CLIENT LIST output
```

--------------------------------

### Install with go get

Source: https://upstash.com/docs/devops/pulumi/overview

Install the Go SDK for the Upstash Pulumi provider using go get.

```bash
go get github.com/upstash/pulumi-upstash/sdk/go/...
```

--------------------------------

### SETRANGE example with Upstash Redis Python SDK

Source: https://upstash.com/docs/redis/sdks/py/commands/string/setrange

Shows how to use setrange to replace a substring starting at offset 6, then verifies the result with get. The command returns the new length of the string (11).

```python
redis.set("key", "Hello World")
assert redis.setrange("key", 6, "Redis") == 11
assert redis.get("key") == "Hello Redis"
```

--------------------------------

### Create a new project and initialize Go module

Source: https://upstash.com/docs/qstash/quickstarts/fly-io/go

Commands to create a new folder 'flyio-go', navigate into it, and initialize a Go module. This is the first step in setting up the project.

```bash
mkdir flyio-gocd flyio-gogo mod init flyio-go
```

--------------------------------

### Create public URLs for multiple services (Python)

Source: https://upstash.com/docs/box/overall/preview

Python equivalent of the multi-port example: creates a Box, writes server files, installs Express, starts both servers, and creates public URLs using get_public_url.

```python
from upstash_box import Box
box = Box.create(runtime="node")
# Start frontend on port 3000
box.files.write(
    path="/work/frontend.js",
    content="""const express = require('express')
const app = express()
app.get('/', (req, res) => res.send('Frontend'))
app.listen(3000)
  """,
)
# Start API on port 8080
box.files.write(
    path="/work/api.js",
    content="""const express = require('express')
const app = express()
app.get('/api/status', (req, res) => res.json({ status: 'ok' }))
app.listen(8080)
  """,
)
box.exec.command("npm install express")
box.exec.command("node /work/frontend.js & node /work/api.js &")
# Create a public URL for each service
frontend_public_url = box.get_public_url(3000)
api_public_url = box.get_public_url(8080)
print(f"Frontend: {frontend_public_url.url}")
print(f"API: {api_public_url.url}")
```

--------------------------------

### Start the development server

Source: https://upstash.com/blog/authenticate-users-nextjs-authjs

Move into the project directory and start the app in development mode. The app should run on localhost:3000.

```bash
cd my-app
npm run dev
```

--------------------------------

### Run the blog locally

Source: https://upstash.com/blog/react-server-components

Navigate into the blog directory and start the development server.

```bash
cd blog
pnpm dev
```

--------------------------------

### CONFIG GET example with Redis CLI

Source: https://upstash.com/docs/redis/commands/server/config-get

Example of using CONFIG GET with the Redis CLI to fetch the notify-keyspace-events parameter.

```redis
CONFIG GET notify-keyspace-events
```

--------------------------------

### Create directory and navigate

Source: https://upstash.com/docs/redis/quickstarts/koyeb

Creates a new directory for the demo application and navigates into it.

```bash
mkdir example-koyeb-upstashcd example-koyeb-upstash
```

--------------------------------

### Start DeepSeek harness

Source: https://upstash.com/docs/agent-resources/clients

Boots the DeepSeek harness with the 'web' profile.

```bash
dsh web
```

--------------------------------

### Create Cloudflare Worker with npm create cloudflare@latest

Source: https://upstash.com/blog/rag-chatbot-for-instagram-with-upstash-workflow-and-hono

Command to initialize a new Cloudflare Worker project. This installs the Cloudflare packages and guides through setup. Note that a CF worker endpoint is not required for QStash; any endpoint can be used.

```bash
# You don’t need CF worker endpoint to implement QStash feature.
# You can build on any endpoint.
# this will install the CF packages and lead you through setup.
 
npm create cloudflare@latest
```

--------------------------------

### JavaScript fetch example to get a URL Group

Source: https://upstash.com/docs/qstash/api-reference/url-groups/get-a-url-group

JavaScript example using fetch to GET a URL Group. Replace {urlGroupName} and <token> with your values.

```javascript
const response = await fetch('https://qstash-eu-central-1.upstash.io/v2/topics/{urlGroupName}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Install dependencies and run development server

Source: https://upstash.com/blog/build-article-research-agent

Commands to install npm dependencies and start the development server for both forked repositories.

```bash
npm install
npm run dev
```

--------------------------------

### JavaScript Fetch Example for Get Index

Source: https://upstash.com/docs/devops/developer-api/vector/get_index

JavaScript example using fetch to call the Get Index endpoint. Replace {id} and <encoded-value> as needed.

```javascript
const response = await fetch('https://api.upstash.com/v2/vector/index/{id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Python requests example to get a URL Group

Source: https://upstash.com/docs/qstash/api-reference/url-groups/get-a-url-group

Python example using the requests library to GET a URL Group. Replace {urlGroupName} and <token> with your values.

```python
import requests

url = "https://qstash-eu-central-1.upstash.io/v2/topics/{urlGroupName}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### Initialize Bun project and install ioredis

Source: https://upstash.com/blog/redis-message-queue

Shell commands to create a project directory, initialize a Bun project, and add the ioredis dependency.

```bash
mkdir upstash-mq
cd upstash-mq
 
bun init
> package name (upstash-mq-tutorial): upstash-mq
> entry point (index.ts):
> Done!
 
bun add ioredis
```

--------------------------------

### Install dependencies and run unit tests with NPM

Source: https://upstash.com/examples/usingawssamwithredis

Navigate to the `hello-world` directory, install dependencies with `npm install`, and run unit tests with `npm run test`. Tests are defined in the `hello-world/tests` folder using the Mocha test framework.

```bash
using-aws-sam$ cd hello-world
hello-world$ npm install
hello-world$ npm run test
```

--------------------------------

### Python Requests Example for Get Index

Source: https://upstash.com/docs/devops/developer-api/vector/get_index

Python example using the requests library to call the Get Index endpoint. Replace {id} and <encoded-value> as needed.

```python
import requests

url = "https://api.upstash.com/v2/vector/index/{id}"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### JavaScript fetch example to get database details

Source: https://upstash.com/docs/devops/developer-api/redis/get_database

JavaScript example using fetch to call the Get Database endpoint. Replace {id} and the Authorization header value with your credentials.

```javascript
const response = await fetch('https://api.upstash.com/v2/redis/database/{id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Create project directory and navigate

Source: https://upstash.com/blog/langchain-caching

Creates a new empty directory for the project and navigates into it, as required by create-hono.

```bash
mkdir langchain-qstash
cd langchain-qstash
```

--------------------------------

### Start the development server

Source: https://upstash.com/blog/nextjs-kafka-upstash-cqrs

Install dependencies and start the Next.js development server. If running on GitHub Codespaces, make the server's port public so Apollo GraphQL UI can read the schema.

```bash
$ npm i
$ npm run dev
```

--------------------------------

### JavaScript fetch example to get failed workflow run

Source: https://upstash.com/docs/workflow/api-reference/dlq/get-failed-workflow-run

JavaScript example using fetch to call the GET endpoint for a failed workflow run. Replace {dlqId} and <token> as needed.

```javascript
const response = await fetch('https://qstash-eu-central-1.upstash.io/v2/workflows/dlq/{dlqId}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);
```

--------------------------------

### Answer a prompt from an installer (TypeScript)

Source: https://upstash.com/docs/box/overall/live-sessions

Starts an interactive npm create session with a TTY, collects output, waits for the prompt 'Select a framework', then sends a newline to accept the default. Includes a 30-second deadline.

```typescript
let out = ""
const session = await box.exec.session({
  cmd: "npm create vite@latest my-app",
  tty: true,
  onStdout: (data) => (out += Buffer.from(data).toString()),
})
const deadline = Date.now() + 30000
while (!out.includes("Select a framework") && Date.now() < deadline) {
  await new Promise((r) => setTimeout(r, 100))
}
session.write("\n") // accept the default
await session.wait()
```

--------------------------------

### Python requests example to get database details

Source: https://upstash.com/docs/devops/developer-api/redis/get_database

Python example using the requests library to call the Get Database endpoint. Replace {id} and the Authorization header value with your credentials.

```python
import requests

url = "https://api.upstash.com/v2/redis/database/{id}"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### Python requests example to get failed workflow run

Source: https://upstash.com/docs/workflow/api-reference/dlq/get-failed-workflow-run

Python example using the requests library to call the GET endpoint for a failed workflow run. Replace {dlqId} and <token> as needed.

```python
import requests

url = "https://qstash-eu-central-1.upstash.io/v2/workflows/dlq/{dlqId}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)
```

--------------------------------

### Create project directory and initialize npm

Source: https://upstash.com/blog/api-key-generator-upstash-redis

Commands to create a new directory, navigate into it, and initialize a Node.js project.

```bash
mkdir keyflow
cd keyflow
npm init -y
```

--------------------------------

### Create server folder and navigate into it

Source: https://upstash.com/blog/next-chatapp-with-kafka

Commands to create and enter the 'server' directory for the chat app.

```bash
mkdir server
cd server
```

--------------------------------

### Clone the repository

Source: https://upstash.com/examples/rate-limitingafeedbackform

Clones the Upstash examples repository to get the feedback form rate-limiting example.

```shell
git clone https://github.com/upstash/examples.git
```

--------------------------------

### jedis: DISCARD Example

Source: https://upstash.com/docs/redis/commands/transactions/discard

Example using jedis to start a transaction, set a value, and discard it.

```java
import java.net.URI;import redis.clients.jedis.Jedis;import redis.clients.jedis.Transaction;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")));     Transaction transaction = jedis.multi()) {  transaction.set("balance", "100");  transaction.discard();}
```

--------------------------------

### Run the application

Source: https://upstash.com/blog/groq-llama3-vercel-ai

Starts the Next.js development server.

```bash
pnpm run dev
```

--------------------------------

### Create project and initialize lambda_function.py

Source: https://upstash.com/docs/qstash/quickstarts/aws-lambda/python

Commands to create a new folder 'aws-lambda', navigate into it, and create the 'lambda_function.py' file. This is the first step of the tutorial.

```bash
mkdir aws-lambda
cd aws-lambda
touch lambda_function.py
```

--------------------------------

### ioredis: DISCARD Example

Source: https://upstash.com/docs/redis/commands/transactions/discard

Example using ioredis to start a transaction, set a value, and discard it.

```typescript
import Redis from "ioredis";const client = new Redis(process.env.REDIS_URL!);await client.multi({ pipeline: false });await client.set("balance", "100");await client.discard();
```

--------------------------------

### Redis CLI ZRANGEBYLEX Example

Source: https://upstash.com/docs/redis/commands/sorted-set/zrangebylex

Example using the Redis CLI to get all members from 'my-key'.

```bash
ZRANGEBYLEX my-key - +
```

--------------------------------

### Create project directory and main.py

Source: https://upstash.com/blog/integrating-vector-search-in-e-commerce-platforms-with-upstash-vector

Commands to create a new directory named 'ecommerce-vector-search-server' and an empty main.py file.

```bash
# Create and move to the new directory
mkdir ecommerce-vector-search-server
cd ecommerce-vector-search-server
 
# Create a main.py file
touch main.py
```
Tokens:
Raw