Sync UDF Builders

Synchronous foreground UDF builders delegating to aio.operations.udf.

class aerospike_sdk.sync.operations.udf.SyncUdfFunctionBuilder

Bases: object

First step after execute_udf: select package and function name.

See also

UdfFunctionBuilder

Examples

session.execute_udf(key).function(“pkg”, “fn”)

__init__(inner, loop_manager, sdk_client)

function(package, function_name)

Select the UDF package and Lua function.

Return type:

SyncUdfBuilder

class aerospike_sdk.sync.operations.udf.SyncUdfBuilder

Bases: object

Chain UDF arguments, optional filter, and execution (sync).

See also

UdfBuilder

Examples

session.execute_udf(key).function(“pkg”, “fn”).passing(1, 2).execute() session.execute_udf(key).function(“pkg”, “fn”).query(key).where(“true”).execute()

__init__(inner, loop_manager, sdk_client)

passing(*args)

Forward arguments to the server UDF (chainable).

Return type:

SyncUdfBuilder

where(expression)

Overloads:

• self, expression (str) → SyncUdfBuilder

• self, expression (FilterExpression) → SyncUdfBuilder

Restrict rows with an AEL string or FilterExpression.

respond_all_keys()

Include results for missing keys in the stream.

Return type:

SyncUdfBuilder

Returns:

self for method chaining.

execute_udf(*keys)

Finalize this UDF spec and start another on keys.

Return type:

SyncUdfFunctionBuilder

query(arg1, *more_keys)

Return type:

SyncQueryBuilder

upsert(arg1, *more_keys)

Finalize the UDF spec and start an upsert write segment.

Return type:

SyncWriteSegmentBuilder

insert(arg1, *more_keys)

Finalize the UDF spec and start an insert-only write segment.

Return type:

SyncWriteSegmentBuilder

update(arg1, *more_keys)

Return type:

SyncWriteSegmentBuilder

replace(arg1, *more_keys)

Finalize the UDF spec and start a replace write segment.

Return type:

SyncWriteSegmentBuilder

replace_if_exists(arg1, *more_keys)

Return type:

SyncWriteSegmentBuilder

delete(arg1, *more_keys)

Finalize the UDF spec and start a delete segment.

Return type:

SyncWriteSegmentBuilder

touch(arg1, *more_keys)

Finalize the UDF spec and start a touch segment.

Return type:

SyncWriteSegmentBuilder

exists(arg1, *more_keys)

Finalize the UDF spec and start an exists-check segment.

Return type:

SyncWriteSegmentBuilder

execute(on_error=None)

Run the UDF and return a SyncRecordStream.

Parameters:

on_error (Union[ErrorStrategy, Callable[[Key, int, AerospikeError], None], None]) – Same semantics as query/write execute().

See also

execute()

Return type:

SyncRecordStream