Redis 中文文档

Upstash Redis


@upstash/redis is an HTTP/REST based Redis client for typescript, built on top of Upstash REST API.

Tests

It is the only connectionless (HTTP based) Redis client and designed for:

Serverless functions (AWS Lambda ...)
Cloudflare Workers (see the example )
Fastly Compute@Edge (see the example )
Next.js, Jamstack ...
Client side web/mobile applications
WebAssembly
and other environments where HTTP is preferred over TCP.

See the list of APIs supported.

Quick Start


Install


Node.js


  1. ``` shell
  2. npm install @upstash/redis
  3. ```

Deno


  1. ``` ts
  2. import { Redis } from "https://deno.land/x/upstash_redis/mod.ts";
  3. ```

Create database


Create a new redis database on upstash

Basic Usage:


  1. ``` ts
  2. import { Redis } from "@upstash/redis"

  4. const redis = new Redis({
  5.   url: <UPSTASH_REDIS_REST_URL>,
  6.   token: <UPSTASH_REDIS_REST_TOKEN>,
  7. })

  9. // string
  10. await redis.set('key', 'value');
  11. let data = await redis.get('key');
  12. console.log(data)

  14. await redis.set('key2', 'value2', {ex: 1});

  16. // sorted set
  17. await redis.zadd('scores', { score: 1, member: 'team1' })
  18. data = await redis.zrange('scores', 0, 100 )
  19. console.log(data)

  21. // list
  22. await redis.lpush('elements', 'magnesium')
  23. data = await redis.lrange('elements', 0, 100 )
  24. console.log(data)

  26. // hash
  27. await redis.hset('people', {name: 'joe'})
  28. data = await redis.hget('people', 'name' )
  29. console.log(data)

  31. // sets
  32. await redis.sadd('animals', 'cat')
  33. data  = await redis.spop('animals', 1)
  34. console.log(data)
  35. ```

Troubleshooting


We have a dedicated page for common problems. If you can't find a solution, please open an issue.

Docs


See the documentation for details.

Contributing


Install Deno


Database


Create a new redis database on upstash and copy the url and token

Running tests


  1. ``` shell
  2. UPSTASH_REDIS_REST_URL=".." UPSTASH_REDIS_REST_TOKEN=".." deno test -A
  3. ```

Telemetry


This library sends anonymous telemetry data to help us improve your experience. We collect the following:

SDK version
Platform (Deno, Cloudflare, Vercel)
Runtime version (node@18.x )

You can opt out by setting the UPSTASH_DISABLE_TELEMETRY environment variable to any truthy value.

  1. ``` shell
  2. UPSTASH_DISABLE_TELEMETRY=1
  3. ```