Skip to content
DuckDB Extensions All extensions Redis

Expiry functions in the Redis DuckDB extension

Function category

Expiry

3 functions

3 expiry functions provided by the Redis DuckDB extension.

redis_expire

Scalar function Expiry
Signature
redis_expire( key: VARCHAR, seconds: BIGINT, secret_name: VARCHAR ) → BOOLEAN
Arguments (Positional)
Argument key Type VARCHAR Mode Positional Description
Argument seconds Type BIGINT Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Set a key's time-to-live in seconds. Returns TRUE if the TTL was set, FALSE if the key does not exist.

1 Example 1 
SELECT redis_expire('mykey', 3600, 'my_redis_secret');
2 Example 2 
SELECT redis_expire('session:' || id, 300, 'my_redis_secret') FROM users;
Related functions

redis_expireat

Scalar function Expiry
Signature
redis_expireat( key: VARCHAR, timestamp: BIGINT, secret_name: VARCHAR ) → BOOLEAN
Arguments (Positional)
Argument key Type VARCHAR Mode Positional Description
Argument timestamp Type BIGINT Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Expire a key at an absolute Unix timestamp (seconds). Returns TRUE if the expiry was set, FALSE if the key does not exist.

1 Example 1 
SELECT redis_expireat('mykey', 1736918400, 'my_redis_secret');
2 Example 2 
SELECT redis_expireat('event:' || id, EXTRACT(EPOCH FROM (event_time + INTERVAL '1 day'))::BIGINT, 'my_redis_secret') FROM events;
Related functions

redis_ttl

Scalar function Expiry
Signature
redis_ttl(key: VARCHAR, secret_name: VARCHAR) → BIGINT
Arguments (Positional)
Argument key Type VARCHAR Mode Positional Description
Argument secret_name Type VARCHAR Mode Positional Description
Description

Remaining time-to-live in seconds. Returns -1 if the key has no expiry and -2 if the key does not exist.

1 Example 1 
SELECT redis_ttl('mykey', 'my_redis_secret');
2 Example 2 
SELECT key, redis_ttl(key, 'my_redis_secret') FROM redis_keys('session:*', 'my_redis_secret');
Related functions