Skip to main content

ChangeEvent

Enum ChangeEvent 

Source
pub enum ChangeEvent {
    Insert {
        data: Arc<RecordBatch>,
        timestamp: i64,
        sequence: u64,
    },
    Delete {
        data: Arc<RecordBatch>,
        timestamp: i64,
        sequence: u64,
    },
    Update {
        old: Arc<RecordBatch>,
        new: Arc<RecordBatch>,
        timestamp: i64,
        sequence: u64,
    },
    Watermark {
        timestamp: i64,
    },
    Snapshot {
        data: Arc<RecordBatch>,
        timestamp: i64,
        sequence: u64,
    },
}
Expand description

A change event carrying Arrow data for subscriber delivery.

Each variant includes the minimal data needed for that event type. Data is shared via Arc<RecordBatch> for zero-copy fan-out to multiple subscribers.

Variants§

§

Insert

A new row batch was inserted.

Fields

§data: Arc<RecordBatch>

The inserted rows.

§timestamp: i64

Event timestamp.

§sequence: u64

Sequence number from the notification.

§

Delete

A row batch was deleted.

Fields

§data: Arc<RecordBatch>

The deleted rows.

§timestamp: i64

Event timestamp.

§sequence: u64

Sequence number from the notification.

§

Update

A row batch was updated (before + after).

Fields

§old: Arc<RecordBatch>

The old row values.

§new: Arc<RecordBatch>

The new row values.

§timestamp: i64

Event timestamp.

§sequence: u64

Sequence number from the notification.

§

Watermark

Watermark progress (no data).

Fields

§timestamp: i64

The new watermark timestamp.

§

Snapshot

Initial snapshot delivery.

Fields

§data: Arc<RecordBatch>

The snapshot rows.

§timestamp: i64

Event timestamp.

§sequence: u64

Sequence number from the notification.

Implementations§

Source§

impl ChangeEvent

Source

pub fn insert(data: Arc<RecordBatch>, timestamp: i64, sequence: u64) -> Self

Creates an insert change event.

Source

pub fn delete(data: Arc<RecordBatch>, timestamp: i64, sequence: u64) -> Self

Creates a delete change event.

Source

pub fn update( old: Arc<RecordBatch>, new: Arc<RecordBatch>, timestamp: i64, sequence: u64, ) -> Self

Creates an update change event with old and new values.

Source

pub fn watermark(timestamp: i64) -> Self

Creates a watermark change event.

Source

pub fn snapshot(data: Arc<RecordBatch>, timestamp: i64, sequence: u64) -> Self

Creates a snapshot change event.

Source

pub fn event_type(&self) -> EventType

Returns the EventType for this change event.

Source

pub fn timestamp(&self) -> i64

Returns the event timestamp.

Source

pub fn sequence(&self) -> Option<u64>

Returns the sequence number, or None for watermark events.

Source

pub fn row_count(&self) -> usize

Returns the total number of rows in this event.

For Update events, returns the row count of the new batch. For Watermark, returns 0.

Source

pub fn has_data(&self) -> bool

Returns true if this event carries data rows.

Source

pub fn from_changelog_record(record: &ChangelogRecord, sequence: u64) -> Self

Creates a ChangeEvent from a ChangelogRecord.

Maps CDC operations to subscription event types:

  • Insert / UpdateAfterChangeEvent::Insert
  • Delete / UpdateBeforeChangeEvent::Delete

Trait Implementations§

Source§

impl Clone for ChangeEvent

Source§

fn clone(&self) -> ChangeEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ChangeEvent

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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