Skip to content
DuckDB Extensions All extensions Redis

Keys functions in the Redis DuckDB extension

Function category

Keys

5 functions

DEL / EXISTS / TYPE / SCAN / KEYS — keyspace introspection and management. Use SCAN for production traffic; KEYS blocks the server on large keyspaces.

redis_del

Scalar function Keys
Signature
redis_del(key: VARCHAR, secret_name: VARCHAR) → BOOLEAN
Arguments (Positional)
Argument key Type VARCHAR Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Delete a key. Returns TRUE if the key existed and was removed.

1 Example 1 
SELECT redis_del('mykey', 'my_redis_secret');
Related functions

redis_exists

Scalar function Keys
Signature
redis_exists(key: VARCHAR, secret_name: VARCHAR) → BOOLEAN
Arguments (Positional)
Argument key Type VARCHAR Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Check whether a key exists.

1 Example 1 
SELECT redis_exists('mykey', 'my_redis_secret');
Related functions

redis_keys

Table function Keys
Signature
redis_keys(pattern := VARCHAR, secret_name := VARCHAR) → None
Arguments (Named)
Argument pattern Type VARCHAR Mode Named Description
Argument secret_name Type VARCHAR Mode Named Description
Description

List all keys matching a pattern as a table. Convenient but blocks the Redis server on large keyspaces — prefer redis_scan in production.

1 Example 1 
SELECT * FROM redis_keys('*', 'my_redis_secret');
2 Example 2 
SELECT * FROM redis_keys('user:*', 'my_redis_secret');
Related functions

redis_scan

Scalar function Keys
Signature
redis_scan( cursor: VARCHAR, pattern: VARCHAR, count: BIGINT, secret_name: VARCHAR ) → VARCHAR
Arguments (Positional)
Argument cursor Type VARCHAR Mode Positional Description
Argument pattern Type VARCHAR Mode Positional Description
Argument count Type BIGINT Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Cursor-paginated SCAN of the keyspace. Returns 'cursor:keys_csv'. Iterate by re-passing the returned cursor.

1 Example 1 
SELECT redis_scan('0', '*', 100, 'my_redis_secret');
2 Example 2 
SELECT redis_scan('0', 'user:*', 10, 'my_redis_secret');
Related functions

redis_type

Scalar function Keys
Signature
redis_type(key: VARCHAR, secret_name: VARCHAR) → VARCHAR
Arguments (Positional)
Argument key Type VARCHAR Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Get the Redis type of a key (string / list / hash / set / zset / stream / none).

1 Example 1 
SELECT redis_type('mykey', 'my_redis_secret');
Related functions