Struct NamedPortal 

pub struct NamedPortal<'tx> { /* private fields */ }

Handle to a named portal for async iterative row fetching.

Created by [Transaction::exec_portal_named()]. Use exec() to retrieve rows in batches. The lifetime parameter ties the portal to the transaction that created it, preventing the transaction from being committed/rolled back while the portal is alive.

Example

conn.transaction(|conn, tx| async move {
    let mut portal = tx.exec_portal_named(conn, &stmt, ()).await?;

    while !portal.is_complete() {
        let rows: Vec<(i32,)> = portal.exec_collect(conn, 100).await?;
        process(rows);
    }

    portal.close(conn).await?;
    tx.commit(conn).await
}).await?;

Implementations

impl<'tx> NamedPortal<'tx>

pub fn name(&self) -> &str

Get the portal name.

pub fn is_complete(&self) -> bool

Check if portal execution is complete (no more rows available).

pub async fn exec<H: ExtendedHandler>( &mut self, conn: &mut Conn, max_rows: u32, handler: &mut H, ) -> Result<()>

Execute the portal with a handler.

Fetches up to max_rows rows. Pass 0 to fetch all remaining rows. Updates internal completion status.

pub async fn exec_collect<T: for<'a> FromRow<'a>>( &mut self, conn: &mut Conn, max_rows: u32, ) -> Result<Vec<T>>

Execute the portal and collect typed rows.

Fetches up to max_rows rows. Pass 0 to fetch all remaining rows.

pub async fn exec_foreach<T: for<'a> FromRow<'a>, F: FnMut(T) -> Result<()>>( &mut self, conn: &mut Conn, max_rows: u32, f: F, ) -> Result<()>

Execute the portal and call a closure for each row.

Fetches up to max_rows rows. Pass 0 to fetch all remaining rows.

pub async fn close(self, conn: &mut Conn) -> Result<()>

Close the portal and sync.

This sends Close(Portal) followed by Sync to end the transaction.