Struct mz_adapter::subscribe::ActiveSubscribe

pub struct ActiveSubscribe {
    pub user: User,
    pub conn_id: ConnectionId,
    pub channel: Option<UnboundedSender<PeekResponseUnary>>,
    pub emit_progress: bool,
    pub as_of: Timestamp,
    pub arity: usize,
    pub cluster_id: ClusterId,
    pub depends_on: BTreeSet<GlobalId>,
    pub start_time: EpochMillis,
    pub output: SubscribeOutput,
}

A description of an active subscribe from coord’s perspective

Fields

user: User

The user of the session that created the subscribe.

conn_id: ConnectionId

The connection id of the session that created the subscribe.

channel: Option<UnboundedSender<PeekResponseUnary>>

Channel to send responses to the client.

The responses have the form PeekResponseUnary but should perhaps become TailResponse.

emit_progress: bool

Whether progress information should be emitted.

as_of: Timestamp

As of of subscribe

arity: usize

Number of columns in the output.

cluster_id: ClusterId

The cluster that the subscribe is running on.

depends_on: BTreeSet<GlobalId>

All GlobalIds that the subscribe’s expression depends on.

start_time: EpochMillis

The time when the subscribe was started.

output: SubscribeOutput

How to modify output

Implementations

impl ActiveSubscribe

pub(crate) fn initialize(&self)

fn send_progress_message(&self, upper: &Antichain<Timestamp>)

pub(crate) fn process_response(&mut self, batch: SubscribeBatch)

Process a subscribe response.

Returns true if the subscribe is finished.

pub fn send(&self, response: PeekResponseUnary)

Sends a message to the client if the subscribe has not already completed and if the client has not already gone away.

Trait Implementations

impl Debug for ActiveSubscribe

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

Formats the value using the given formatter.