prefect_redis.lease_storage

Classes

ConcurrencyLeaseStorage ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L25" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A Redis-based concurrency lease storage implementation.

Methods:

create_lease ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L151" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

create_lease(self, resource_ids: list[UUID], ttl: timedelta, metadata: ConcurrencyLimitLeaseMetadata | None = None) -> ResourceLease[ConcurrencyLimitLeaseMetadata]

list_holders_for_limit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L330" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

list_holders_for_limit(self, limit_id: UUID) -> list[tuple[UUID, ConcurrencyLeaseHolder]]

read_active_lease_ids ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L299" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_active_lease_ids(self, limit: int = 100, offset: int = 0) -> list[UUID]

read_expired_lease_ids ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L316" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_expired_lease_ids(self, limit: int = 100) -> list[UUID]

read_lease ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L203" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_lease(self, lease_id: UUID) -> ResourceLease[ConcurrencyLimitLeaseMetadata] | None

renew_lease ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L218" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

renew_lease(self, lease_id: UUID, ttl: timedelta) -> bool

Atomically renew a concurrency lease by updating its expiration.

Uses a Lua script to atomically check if the lease exists, update its expiration in the lease data, and update the index - all in a single atomic operation, preventing race conditions from creating orphaned index entries.

Args:

• lease_id: The ID of the lease to renew
• ttl: The new time-to-live duration

Returns:

• True if the lease was renewed, False if it didn't exist

revoke_lease ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-redis/prefect_redis/lease_storage.py#L282" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

revoke_lease(self, lease_id: UUID) -> None