UDF Builders

Foreground UDF execution builders (single-key, batch, and chained operations).

class aerospike_sdk.aio.operations.udf.UdfFunctionBuilder

Bases: object

First step of foreground UDF chaining: choose package and Lua function name.

Produced by execute_udf() or UdfBuilder.execute_udf(). Call function() before UdfBuilder.passing() or execute().

Example:

stream = await (
    session.execute_udf(key)
        .function("my_module", "my_func")
        .execute()
)

__init__(qb)

function(package, function_name)

Select the registered module and function to invoke.

Parameters:

• package (str) – Server-side module name (no .lua suffix).

• function_name (str) – Lua function symbol exported by the module.

Return type:

UdfBuilder

Returns:

UdfBuilder for arguments and execution.

Raises:

ValueError – If package or function_name is empty.

class aerospike_sdk.aio.operations.udf.UdfBuilder

Bases: _UdfBuilderBase

Supply UDF arguments, optional filter, then execute or chain another operation.

After UdfFunctionBuilder.function(), call passing() with values passed to Lua (after the implicit record argument). Use execute_udf() to append another UDF segment, or query() / write verbs to switch operation type. Await execute() to run the accumulated chain.

Example:

stream = await (
    session.execute_udf(key)
        .function("my_pkg", "my_func")
        .passing(1, "x")
        .execute()
)

See also

execute_udf(): Entry point.

async execute(on_error=None)

Run the current builder state and return a RecordStream.

Requires function() to have been called for the pending UDF operation.

Parameters:

on_error (Union[ErrorStrategy, Callable[[Key, int, AerospikeError], None], None]) – Same as QueryBuilder.execute().

Return type:

RecordStream

Returns:

Stream of per-key results and optional udf_result fields.

Example:

stream = await (
    session.execute_udf(k1, k2)
        .function("pkg", "fn")
        .execute()
)

Raises:

ValueError – If no UDF function was selected before execute.