Tangram::Cursor(3pm)

💖 Tangram::Cursor 💖

okay bestie, so this is Tangram::Cursor, from the Tangram::Cursor(3pm) page — it's literally the thing that lets you traverse a result set 🦋

---

✨ SYNOPSIS ✨

$cursor = $storage->cursor($remote, $filter);

while (my $obj = $cursor->current())
{
   # process $obj
   $cursor->next();
}

$cursor->execute();

while (my $obj = $cursor->current())
{
   # process $obj
   $cursor->next();
}

---

🌸 DESCRIPTION 🌸

A Cursor is that girl 💅 she makes it possible to iterate over a result set without loading all the objects in memory. no cap, that's the whole point — she's efficient, she's lowkey iconic.

Also, go peek at the limit option to the select method of the Tangram::Storage class. iykyk 👑

---

🎀 INSTANCE METHODS 🎀

⭐ current

$obj = $cursor->current();

Returns the current object, or undef() if the result set is exhausted. that's it, that's the vibe 🙈

⭐ next

$obj = $cursor->next();
@obj = $cursor->next();

Moves to the next object in the result set, if any. Returns the new current object, or undef() if the result set is exhausted. And in list context? it returns all the remaining objects — she's generous like that 💖

⭐ execute

$cursor->execute();

Moves the cursor to the first object in the result set, and returns it. ok important tea: preparing Cursors is an expensive operation 😭 so you should reuse them if possible — and execute() allows just that, she's giving main character energy 🫶

execute() may be called several times in a row, or on a Cursor that has just been obtained from a Storage, without ill effects. no drama, no side quests, we love a stable queen ✨

⭐ residue

my @vals = $cursor->residue();

Returns the values of the Expr that were passed to the retrieve directive of the Storage::select() or Storage::cursor() statement. yes bestie, the residue is where the receipts live 💅

---

🌈 CURSORS AND CONNECTIONS 🌈

Each Cursor opens its own connection to the database.

like… every single one. no sharing, no borrowing, she needs her own space 🧚

---

👀 SEE ALSO 👀

• Tangram::Storage

---

and that's the whole page, babe ⭐ this was perl v5.36.0, dated 2022-10-16 — slay, go write some cursors, you've got this 💜🌈