FUNCTION LIST

Syntax text Syntax diagram API methods

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

Client:

function_list(
    library: Optional[str],  // Library name pattern (default: '*')
    withcode: Optional[bool]  // Include library code in response
) → Union[Awaitable[List], List]  // List of library information

functionList(
    options: FunctionListOptions  // Options for listing functions
) → Promise<FunctionListReply>  // Array of libraries and their functions

functionList() → List<LibraryInfo>  // List of library information

functionList(
    libraryNamePattern: String  // Library name pattern
) → List<LibraryInfo>  // List of library information

functionListWithCode() → List<LibraryInfo>  // List of library information with code

functionListWithCode(
    libraryNamePattern: String  // Library name pattern
) → List<LibraryInfo>  // List of library information with code

functionList() → List<Map<String, Object>>  // List of library information

functionList(
    libraryName: String  // Library name to filter by
) → List<Map<String, Object>>  // List of library information

functionList() → RedisFuture<List<Map<String, Object>>>  // List of library information

functionList(
    libraryName: String  // Library name to filter by
) → RedisFuture<List<Map<String, Object>>>  // List of library information

functionList() → Flux<Map<String, Object>>  // List of library information

functionList(
    libraryName: String  // Library name to filter by
) → Flux<Map<String, Object>>  // List of library information

FunctionList(
    ctx: context.Context,  // Context for the operation
    q: FunctionListQuery  // Query parameters for listing functions
) → *FunctionListCmd  // List of library information

Available since:: Redis Open Source 7.0.0
Time complexity:: O(N) where N is the number of functions
ACL categories:: @slow, @scripting,
Compatibility:: Redis Software and Redis Cloud compatibility

Return information about loaded functions and libraries.

For more information see Introduction to Redis Functions.

Optional arguments

LIBRARYNAME library-name-pattern

List only libraries whose names match the given pattern.

WITHCODE

Include the source code of each library in the reply.

Details

The following information is provided for each of the libraries in the response:

library_name: the name of the library.
engine: the engine of the library.
functions: the list of functions in the library. Each function has the following fields:
- name: the name of the function.
- description: the function's description.
- flags: an array of function flags.
library_code: the library's source code (when given the WITHCODE modifier).

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Array reply: information about loaded functions and libraries.