FUNCTION LIST - Upstash Documentation

Use FUNCTION LIST to inspect the function libraries loaded in the database.

The reply describes each library with its name, the engine it runs on, and the functions it registers, including each function's description and flags such as no-writes and allow-key-locking, which is the way to check whether a deployed function locks only its keys or the whole database. LIBRARYNAME filters the reply to library names matching a pattern, and WITHCODE includes the full source of each library, which is how you recover the code of a library that is deployed but no longer at hand.

Syntax#

FUNCTION LIST [LIBRARYNAME <library-name-pattern>] [WITHCODE]

Arguments#

Argument	Required	Repeatable	Description
`LIBRARYNAME <library-name-pattern>`	No	No	Return only libraries whose name matches this pattern.
`WITHCODE`	No	No	Include each library's source code.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Array of flat arrays containing library metadata
RESP3	Array of maps containing library metadata

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

FUNCTION LIST

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const libs = await redis.functions.list({    libraryName: "mylib",    withCode: true})console.log(libs)// [//   {//     libraryName: "mylib",//     engine: "LUA",//     functions: [{//       name: "my_func",//       description: null,//       flags: [ "no-writes" ]//     }],//     libraryCode: "#!lua name=mylib ..."//   }// ]

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.function("LIST");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.functionList();console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.function_list()print(result)

go-redis

package mainimport (    "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.FunctionList(context.Background(), redis.FunctionListQuery{}).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.functionList();  System.out.println(result);}

redis-rs

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("FUNCTION");    command.arg("LIST");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}