Recordset::DBSeq(3pm)

💖 Recordset::DBSeq 💖

okay bestie, so this is the manual page for Recordset::DBSeq, part of the User Contributed Perl Documentation collection, and it lives in section 3pm. it's a tiny little module with a big job: handing out unique numbers. let's get into it 🎀

---

✨ NAME ✨

DBIx::Recordset::DBSeq — a sequence generator that lives inside a DBI database. no cap, that's the whole gig. 💅

---

🌸 SYNOPSIS 🌸

here's the vibe, literally the whole API in a few lines:

use DBIx::Recordset::DBSeq ;

$self = DBIx::Recordset::DBSeq ($dbh, 'sequences', $min, $max) ;

$val1 = $self -> NextVal ('foo') ;
$val2 = $self -> NextVal ('foo') ;
$val3 = $self -> NextVal ('bar') ;

see how foo gets called twice and bar once? each name is its own lil sequence, bestie. they don't share. 🦋

---

🌈 DESCRIPTION 🌈

DBIx::Recordset::FileSeq generates unique numbers. periodt. ✨

the state — like, the actual memory of where each sequence is at — gets kept in one single table of a database you can reach through DBI. that's the whole storage strategy. iconic, honestly.

with the new constructor you hand over an open database handle and tell it which table should hold the state. and optionally — optional, so you can skip this — you can pass a min and a max value, and those get used for new sequences. 💖

then with NextVal you get the next value for the sequence with whatever name you asked for. simple as that, no notes. 🫶

---

🧚 the table setup

the table has to be created in exactly this form, okay? don't freestyle it:

create table
    (
    name    varchar (32),
    cnt     integer,
    maxcnt  integer,
    primary key name
    ) ;

---

💀 when it goes wrong

if a sequence value hits the maxcnt value, NextVal will die with an error message. like, actual death, actual error, not a cute little warning. 😭

but listen — if maxcnt contains "null" then there's no limit at all. go off, infinite sequence, main character energy. 👑

---

👑 AUTHOR 👑

G.Richter (richter@dev.ecos.de) — thank you for your service, king. 🫡

---

🔥 SEE ALSO 🔥

• DBIx::Recordset — the parent situation, go check it out iykyk

---

and that's the whole page, bestie!! this doc shipped with perl v5.34.0 on 2022-06-13, so it's lowkey vintage but highkey still slaps. go generate some numbers, you got this 💜🌸✨