Skip to main content

TransactUpdateRequest

Struct TransactUpdateRequest 

Source
pub struct TransactUpdateRequest<TD: TableDefinition, T = (), C: ConditionState = NoCondition> { /* private fields */ }
Expand description

Builder for an Update operation inside a DynamoDB transaction.

Constructed via DynamoDBItemTransactOp::transact_update or DynamoDBItemTransactOp::transact_update_by_id. Optionally add a condition that must hold for the update to succeed, via .condition(), .exists(), or .not_exists(). DynamoDB accepts a single condition expression per operation, so this can only be called once.

Call .build() to produce a TransactWriteItem that can be passed to the SDK’s transact_write_items() builder.

§Examples

Atomically promote a user to instructor and create their first enrollment:

use dynamodb_facade::{Condition, DynamoDBItemTransactOp, KeyId, Update};

let enrollment = sample_enrollment();

client
    .transact_write_items()
    .transact_items(
        User::transact_update_by_id(
            KeyId::pk("user-1"),
            Update::set("role", "instructor"),
        )
        .condition(Condition::not_exists("role"))
        .build(),
    )
    .transact_items(enrollment.transact_put().not_exists().build())
    .send()
    .await?;

Implementations§

Source§

impl<TD: TableDefinition, T, C: ConditionState> TransactUpdateRequest<TD, T, C>

Source

pub fn new(key: Key<TD>, update: Update<'_>) -> Self

Creates a new TransactUpdateRequest from a raw Key and an Update expression.

Prefer DynamoDBItemTransactOp::transact_update or DynamoDBItemTransactOp::transact_update_by_id for typed construction.

Source

pub fn into_inner(self) -> UpdateBuilder

Consumes the builder and returns the underlying SDK UpdateBuilder.

Use this escape hatch when you need to set options not exposed by this facade.

Source

pub fn build(self) -> TransactWriteItem

Finalizes the builder and returns a TransactWriteItem.

The returned value can be passed directly to the SDK’s transact_write_items().transact_items(...) call.

§Examples
use dynamodb_facade::{Condition, DynamoDBItemTransactOp, KeyId, Update};

let enrollment = sample_enrollment();

// Atomically promote a user and create an enrollment
client
    .transact_write_items()
    .transact_items(
        User::transact_update_by_id(
            KeyId::pk("user-1"),
            Update::set("role", "instructor"),
        )
        .condition(Condition::not_exists("role"))
        .build(),
    )
    .transact_items(enrollment.transact_put().not_exists().build())
    .send()
    .await?;
Source§

impl<TD: TableDefinition, T> TransactUpdateRequest<TD, T, NoCondition>

Source

pub fn condition( self, condition: Condition<'_>, ) -> TransactUpdateRequest<TD, T, AlreadyHasCondition>

Adds a condition expression that must be satisfied for the update to succeed.

DynamoDB accepts a single condition expression per operation, so this method can only be called once. If the condition fails, the entire transaction is cancelled.

§Examples
use dynamodb_facade::{DynamoDBItemTransactOp, KeyId, Update, Condition};

let transact_item = User::transact_update_by_id(
    KeyId::pk("user-1"),
    Update::set("role", "instructor"),
)
.condition(Condition::not_exists("role"))
.build();
Source§

impl<TD: TableDefinition, T: DynamoDBItem<TD>> TransactUpdateRequest<TD, T, NoCondition>

Source

pub fn exists(self) -> TransactUpdateRequest<TD, T, AlreadyHasCondition>

Adds an attribute_exists(<PK>) condition.

§Examples
use dynamodb_facade::{DynamoDBItemTransactOp, KeyId, Update};

let transact_item = User::transact_update_by_id(
    KeyId::pk("user-1"),
    Update::increment("enrollment_count", 1),
)
.exists()
.build();
Source

pub fn not_exists(self) -> TransactUpdateRequest<TD, T, AlreadyHasCondition>

Adds an attribute_not_exists(<PK>) condition.

Useful for upsert-style updates that must only apply when the item does not yet exist.

§Examples
use dynamodb_facade::{DynamoDBItemTransactOp, KeyId, Update};

// Initialize enrollment progress only if the enrollment doesn't exist yet
let transact_item = Enrollment::transact_update_by_id(
    KeyId::pk("user-1").sk("course-42"),
    Update::set("progress", 0.0),
)
.not_exists()
.build();

Auto Trait Implementations§

§

impl<TD, T, C> Freeze for TransactUpdateRequest<TD, T, C>

§

impl<TD, T, C> RefUnwindSafe for TransactUpdateRequest<TD, T, C>

§

impl<TD, T, C> Send for TransactUpdateRequest<TD, T, C>
where TD: Send, T: Send, C: Send,

§

impl<TD, T, C> Sync for TransactUpdateRequest<TD, T, C>
where TD: Sync, T: Sync, C: Sync,

§

impl<TD, T, C> Unpin for TransactUpdateRequest<TD, T, C>
where TD: Unpin, T: Unpin, C: Unpin,

§

impl<TD, T, C> UnsafeUnpin for TransactUpdateRequest<TD, T, C>

§

impl<TD, T, C> UnwindSafe for TransactUpdateRequest<TD, T, C>
where TD: UnwindSafe, T: UnwindSafe, C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more