DuckDB Extensions
Hashes functions in the Redis DuckDB extension
Function category
Hashes
5 functionsHGET / HSET / HGETALL / HSCAN — for field-keyed records stored under one Redis key. The `_over_scan` variant pairs SCAN with HSCAN for high-throughput bulk reads.
Signature
redis_hget(
key: VARCHAR,
field: VARCHAR,
secret_name: VARCHAR
) → VARCHAR
Arguments (Positional)
| Argument | Type | Mode | Description |
|---|---|---|---|
Argument
key
|
Type
VARCHAR
|
Mode Positional | Description |
Argument
field
|
Type
VARCHAR
|
Mode Positional | Description |
Argument
secret_name
|
Type
VARCHAR
|
Mode Positional | Description |
Description
Get the value of a hash field.
1
Example 1
SELECT redis_hget('myhash', 'field1', 'my_redis_secret');Signature
redis_hgetall(key := VARCHAR, secret_name := VARCHAR) → None
Arguments (Named)
| Argument | Type | Mode | Description |
|---|---|---|---|
Argument
key
|
Type
VARCHAR
|
Mode Named | Description |
Argument
secret_name
|
Type
VARCHAR
|
Mode Named | Description |
Description
List all (field, value) pairs of a hash as a table.
1
Example 1
SELECT * FROM redis_hgetall('myhash', 'my_redis_secret');Signature
redis_hscan(
key: VARCHAR,
cursor: VARCHAR,
pattern: VARCHAR,
count: BIGINT,
secret_name: VARCHAR
) → VARCHAR
Arguments (Positional)
| Argument | Type | Mode | Description |
|---|---|---|---|
Argument
key
|
Type
VARCHAR
|
Mode Positional | Description |
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 a hash's fields.
1
Example 1
SELECT redis_hscan('myhash', '0', '*', 100, 'my_redis_secret');Signature
redis_hscan_over_scan(
count := BIGINT,
hscan_pattern := VARCHAR,
scan_pattern := VARCHAR,
secret_name := VARCHAR
) → None
Arguments (Named)
| Argument | Type | Mode | Description |
|---|---|---|---|
Argument
scan_pattern
|
Type
VARCHAR
|
Mode Named | Description |
Argument
hscan_pattern
|
Type
VARCHAR
|
Mode Named | Description |
Argument
count
|
Type
BIGINT
|
Mode Named | Description |
Argument
secret_name
|
Type
VARCHAR
|
Mode Named | Description |
Description
For every key matching a SCAN pattern, run HSCAN and emit (key, field, value) rows. The high-throughput discovery primitive for migration / analysis.
1
Example 1
SELECT * FROM redis_hscan_over_scan('user:*', '*', 100, 'my_redis_secret');Signature
redis_hset(
key: VARCHAR,
field: VARCHAR,
value: VARCHAR,
secret_name: VARCHAR
) → VARCHAR
Arguments (Positional)
| Argument | Type | Mode | Description |
|---|---|---|---|
Argument
key
|
Type
VARCHAR
|
Mode Positional | Description |
Argument
field
|
Type
VARCHAR
|
Mode Positional | Description |
Argument
value
|
Type
VARCHAR
|
Mode Positional | Description |
Argument
secret_name
|
Type
VARCHAR
|
Mode Positional | Description |
Description
Set the value of a hash field.
1
Example 1
SELECT redis_hset('myhash', 'field1', 'value1', 'my_redis_secret');