SPI_CURSOR_FETCH(3)

✨ NAME ✨

Okay bestie, this is the SPI_CURSOR_FETCH(3) manual page from the PostgreSQL 13.23 docs, and it's all about SPI_cursor_fetch — the function that fetches some rows from a cursor. Cursor-fetch core, no cap. 🎀

🦋 SYNOPSIS 🦋

void SPI_cursor_fetch(Portal portal, bool forward, long count)

💖 DESCRIPTION 💖

So SPI_cursor_fetch fetches some rows from a cursor. It's equivalent to a subset of the SQL command FETCH — and for more functionality, see SPI_scroll_cursor_fetch. That's the vibe: this one is the focused subset, and the other one has extra moves. ✨

🌸 ARGUMENTS 🌸

These are the three things you pass in, bestie:

• Portal portal — the portal containing the cursor. That's your cursor-holding bestie. 🫶
• bool forward — true for fetch forward, false for fetch backward. Binary queen behavior. 💅
• long count — the maximum number of rows to fetch. Maximum, not a promise, okay? 😌

👑 RETURN VALUE 👑

If it's successful, SPI_processed and SPI_tuptable are set as in SPI_execute. That's the whole return-value situation. ☕

⚠️ NOTES ⚠️

Bestie, heads up: fetching backward may fail if the cursor's plan was not created with the CURSOR_OPT_SCROLL option. That's a real caveat, not a drill. 😭

💖 That's the page, bestie! Source/version: PostgreSQL 13.23; date: 2025. SPI_CURSOR_FETCH(3) said what it said, and it ate. Periodt. 🎀✨