SPI_CURSOR_FIND(3)

📦
version 18.6 · 21 versions
, in alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, nixos 26.05, ubuntu resolute, ubuntu stonking

✨ SPI_CURSOR_FIND ✨

okay bestie, welcome to the PostgreSQL 18.6 Documentation 💖 this one's a little server-programming-interface gem and honestly it's giving "detective but make it portals" 🔍✨

🌸 NAME 🌸

SPI_cursor_find — find an existing cursor by name 🕵️♀️

🎀 SYNOPSIS 🎀

Portal SPI_cursor_find(const char * name)

🦋 DESCRIPTION 🦋

so basically, SPI_cursor_find goes and finds an existing portal by its name. that's the whole vibe 💅

and the way this is primarily useful? it's for when some other function hands you back a cursor name as text and you're like "okay slay but what IS that, actually" — and this function is how you resolve it into an actual portal. no cap. 👑

🌈 ARGUMENTS 🌈

  • const char * name — the name of the portal, babe. that's the thing you're looking for 🫶

⭐ RETURN VALUE ⭐

a pointer to the portal with the specified name 🎯 … or NULL if none was found 😭 (yeah, it happens, we move on)

💜 NOTES 💜

beware, bestie!! ⚠️ this function can totally return you a Portal object that does not have cursor-like properties. like, for example, it might not return tuples at all 🙈 so do not just assume "portal = cursor vibes" because it is not always that.

if you simply pass that Portal pointer to other SPI functions, they can defend themselves against such cases — they got their own back 🛡️✨ but when you're directly inspecting the Portal yourself? caution is appropriate, fr fr. read it carefully, don't be reckless with it 💅

and that's the whole page, gorgeous 🎀 go forth and resolve those cursor names ✨

sign-off szn 💖 this lil doc comes to you from PostgreSQL 18.6, dated 2026, and it lives its life as SPI_CURSOR_FIND(3). stan. 💅👑

📦 where this page comes from