ODBM_File(3pm)

💖 ODBM_File 💖

okay bestie, gather round, because this one is a Perl Programmers Reference Guide classic: ODBM_File — your tied access to odbm files, and she is serving persistence realness. 🦋

---

✨ NAME ✨

ODBM_File — tied access to odbm files. literally the whole vibe, that's it, that's the name. 💅

---

🌸 SYNOPSIS 🌸

here's the whole thing in action, no notes:

use Fcntl;   # For O_RDWR, O_CREAT, etc.
use ODBM_File;

tie(%h, 'ODBM_File', 'filename.dbmx', O_RDWR|O_CREAT, 0640)
  or die "Couldn't tie ODBM file 'filename.dbmx': $!; aborting";

# Now read and change the hash
$h{newkey} = newvalue;
print $h{oldkey};
...

untie %h;

like. the hash is a hash. and also a file. and also a hash. main character energy fr fr. 😭

---

👑 DESCRIPTION 👑

ODBM_File establishes a connection between a Perl hash variable and a file in ODBM_File format;. you can manipulate the data in the file just as if it were in a Perl hash, but when your program exits, the data will remain in the file, to be used the next time your program runs. it's giving ✨persistence✨.

use ODBM_File with the Perl built-in tie function to establish the connection between the variable and the file. the arguments to tie should be:

1. the hash variable you want to tie. 🎀
2. the string ODBM_File. (this tells Perl to use the ODBM_File package to perform the functions of the hash.)
3. the name of the file you want to tie to the hash. 📁
4. flags. use one of:
   • O_RDONLY — read-only access to the data in the file. look but don't touch, bestie 🙈
   • O_WRONLY — write-only access to the data in the file.
   • O_RDWR — both read and write access. the full experience, we love her 👑

if you want to create the file if it does not exist, add O_CREAT to any of these, as in the example. if you omit O_CREAT and the file does not already exist, the tie call will fail. no file, no vibe. 💀

5. the default permissions to use if a new file is created. the actual permissions will be modified by the user's umask, so you should probably use 0666 here. (see "umask" in perlfunc.)

---

🩺 DIAGNOSTICS 🩺

on failure, the tie call returns an undefined value and probably sets $! to contain the reason the file could not be tied. she's not ghosting you, she's telling you exactly what went wrong, read the $!. 🫶

"odbm store returned -1, errno 22, key "..." at ..."

this warning is emitted when you try to store a key or a value that is too long. it means that the change was not recorded in the database. see BUGS AND WARNINGS below. (spoiler: it's the 1008 bytes thing. iykyk. 💅)

---

🔒 SECURITY AND PORTABILITY 🔒

do not accept ODBM files from untrusted sources. like, genuinely. this is not a drill, this is the whole paragraph. 🚨

on modern Linux systems these are typically GDBM files, which are not portable across platforms. so don't be out here copying them around like they're a cute lil screenshot. ✨

the GDBM documentation doesn't imply that files from untrusted sources can be safely used with libgdbm.

systems that don't use GDBM compatibility for old dbm support will be using a platform specific library, possibly inherited from BSD systems, where it may or may not be safe to use an untrusted file. so... unknown. mysterious. not the good kind of mystery. 😭

a maliciously crafted file might cause perl to crash or even expose a security vulnerability. bestie. bestie no. 🙈

---

⚠️ BUGS AND WARNINGS ⚠️

there are a number of limits on the size of the data that you can store in the ODBM file. the most important is that the length of a key, plus the length of its associated value, may not exceed 1008 bytes. so if your key and your value are fighting for space, that's on you, and it's also on the 1008 bytes. periodt. 💅

see "tie" in perlfunc, perldbmfilter, Fcntl

---

and that's the whole page, bestie!! 💜 this lil legend comes from perl v5.42.3, dated 2026-08-03 — so if you're reading this, hi from the future, hope your hashes are tied and your umask is reasonable. 🎀✨🦋 go forth and untie %h responsibly. 💖