Sync Background Task Builders

Synchronous background dataset task builders (delegate to aio.background).

class aerospike_sdk.sync.background.BackgroundOperationBuilder

Bases: object

Configure a background update/delete/touch job (sync).

See also

BackgroundOperationBuilder

__init__(inner)

default_with_durable_delete()

Prefer durable deletes when resolving policy defaults (SC namespaces).

Return type:

BackgroundOperationBuilder

default_without_durable_delete()

Prefer non-durable deletes when resolving policy defaults.

Return type:

BackgroundOperationBuilder

with_durable_delete()

Force durable delete on this background job.

Return type:

BackgroundOperationBuilder

without_durable_delete()

Force non-durable deletes (may be rejected on SC).

Return type:

BackgroundOperationBuilder

where(expression, *params)

Restrict the job with an AEL or filter predicate.

Overloads:

• self, expression (str), params (Any) → BackgroundOperationBuilder

• self, expression (FilterExpression) → BackgroundOperationBuilder

Combines with filter(); see aerospike_sdk.aio.background.BackgroundOperationBuilder.where() for the full contract.

filter(filter_obj)

Restrict the job with a secondary-index Filter (sync).

Combines with where(); see aerospike_sdk.aio.background.BackgroundOperationBuilder.filter() for the full contract.

Raises:

• TypeError – If filter_obj is None.

• ValueError – If filter has already been called on this builder.

Return type:

BackgroundOperationBuilder

bin(name)

Start a write on bin name (update jobs only).

Example:

builder.bin("prefs").on_map_key("tags").list_append_items(["sports"])

See also

aerospike_sdk.aio.background.BackgroundOperationBuilder.bin()

Return type:

BackgroundWriteBinBuilder[BackgroundOperationBuilder]

add_operation(op)

Append a prebuilt write operation to apply to each matching record.

See also

aerospike_sdk.aio.background.BackgroundOperationBuilder.add_operation()

Return type:

BackgroundOperationBuilder

expire_record_after_seconds(seconds)

Set record TTL for the background job.

Return type:

BackgroundOperationBuilder

expire_record_after(duration)

Set record TTL using a datetime.timedelta (-1/-2/0 select sentinels).

Return type:

BackgroundOperationBuilder

expire_record_at(when)

Set record TTL so records expire at an absolute point in time.

A naive when is interpreted in local time; pass a timezone-aware datetime for explicit UTC or other zones. Raises ValueError if when is not strictly in the future.

Return type:

BackgroundOperationBuilder

never_expire()

Make every record the job writes never expire (TTL = -1).

Return type:

BackgroundOperationBuilder

with_no_change_in_expiration()

Keep each record’s existing TTL (TTL = -2).

Return type:

BackgroundOperationBuilder

expiry_from_server_default()

Give each record the namespace’s default TTL (TTL = 0).

Return type:

BackgroundOperationBuilder

records_per_second(rps)

Throttle the background job to rps records per second.

Parameters:

rps (int) – Records per second. 0 means unthrottled.

Return type:

BackgroundOperationBuilder

Returns:

This builder, for chaining.

Example:

session.update(users).bin("tier").set_to("gold") \
    .records_per_second(500).execute()

fail_on_filtered_out()

Return type:

BackgroundOperationBuilder

include_missing_keys()

Unsupported for background tasks (raises TypeError).

Return type:

BackgroundOperationBuilder

execute()

Submit the job and return a task handle (blocks until accepted).

See also

execute()

Return type:

ExecuteTask

class aerospike_sdk.sync.background.BackgroundUdfFunctionBuilder

Bases: object

Select UDF package/function for a background dataset run (sync).

See also

BackgroundUdfFunctionBuilder

__init__(inner)

function(package_name, function_name)

Select the UDF package and Lua function.

Return type:

BackgroundUdfBuilder

class aerospike_sdk.sync.background.BackgroundUdfBuilder

Bases: object

Arguments, filters, and throttle for background UDF execution (sync).

See also

BackgroundUdfBuilder

__init__(inner)

default_with_durable_delete()

Prefer durable deletes when resolving policy defaults (SC namespaces).

Return type:

BackgroundUdfBuilder

default_without_durable_delete()

Prefer non-durable deletes when resolving policy defaults.

Return type:

BackgroundUdfBuilder

with_durable_delete()

Force durable delete on this background job.

Return type:

BackgroundUdfBuilder

without_durable_delete()

Force non-durable deletes (may be rejected on SC).

Return type:

BackgroundUdfBuilder

passing(*args)

Return type:

BackgroundUdfBuilder

where(expression, *params)

Optional predicate limiting which records invoke the UDF.

Overloads:

• self, expression (str), params (Any) → BackgroundUdfBuilder

• self, expression (FilterExpression) → BackgroundUdfBuilder

filter(filter_obj)

Restrict the UDF job with a secondary-index Filter (sync).

Combines with where(); see aerospike_sdk.aio.background.BackgroundUdfBuilder.filter() for the full contract.

Raises:

• TypeError – If filter_obj is None.

• ValueError – If filter has already been called on this builder.

Return type:

BackgroundUdfBuilder

records_per_second(rps)

Return type:

BackgroundUdfBuilder

fail_on_filtered_out()

Unsupported for background tasks.

Return type:

BackgroundUdfBuilder

include_missing_keys()

Unsupported for background tasks (raises TypeError).

Return type:

BackgroundUdfBuilder

execute()

Submit the background UDF job (blocks until accepted).

See also

execute()

Return type:

ExecuteTask

class aerospike_sdk.sync.background.BackgroundTaskSession

Bases: object

Sync entry for server-side dataset background operations.

Obtained from background_task(). Each method returns a sync builder that mirrors BackgroundTaskSession.

See also

BackgroundTaskSession

Examples

session.background_task().update(dataset).bin(“x”).set_to(1).execute() session.background_task().execute_udf(dataset).function(“pkg”, “fn”).execute()

__init__(inner)

update(dataset)

Return type:

BackgroundOperationBuilder

delete(dataset)

Start a background delete over dataset.

Return type:

BackgroundOperationBuilder

touch(dataset)

Start a background touch (TTL refresh) over dataset.

Return type:

BackgroundOperationBuilder

execute_udf(dataset)

Start a background UDF over dataset.

Return type:

BackgroundUdfFunctionBuilder