DB_UPGRADE(1)

💖 db_upgrade — bestie edition 💖

okay so. this is db_upgrade, a BerkeleyDB utility, and it's literally here to upgrade your files and databases to the current release version. group chat for that: 👑

---

✨ SYNOPSIS ✨

db_upgrade [-NsVv] [-h home] [-P password] file ...

---

🦋 DESCRIPTION 🦋

The db_upgrade utility upgrades the Berkeley DB version of one or more files — and every database chillin' inside them — to the current release version. that's the whole job. no cap. it takes your old-format files and brings them into the present, main character energy only 💅

---

🌸 OPTIONS 🌸

• -h home — pick a home directory for the database environment. if you don't say anything, it just uses the current working directory, lowkey default behavior 🏠
• -N — do NOT acquire shared region mutexes while running. and like, other problems too — including potentially fatal errors in Berkeley DB — get ignored as well. > ⚠️ this option is intended only for debugging errors, and should not be used under any other circumstances. fr fr, do not be casual about this one. 🙈
• -P password — specify an environment password. now, Berkeley DB utilities overwrite password strings as soon as possible, which is good, but bestie be aware: there may be a window of vulnerability on systems where unprivileged users can see command-line arguments, or where the utilities aren't able to overwrite the memory containing those command-line arguments. it's giving briefly exposed 😭
• -s — okay so this flag is only meaningful when upgrading databases from releases before the Berkeley DB 3.1 release. periodt.

As part of the upgrade from the Berkeley DB 3.0 release to the 3.1 release, the on-disk format of duplicate data items changed. To correctly upgrade the format, applications need to specify whether duplicate data items in the database are sorted or not. Specifying the -s flag means the duplicates are sorted; otherwise, they are assumed to be unsorted.

💀 Incorrectly specifying the value of this flag may lead to database corruption. like, actual corruption. not the vibe.

And because db_upgrade upgrades a physical file (including all the databases it contains), it is not possible to use db_upgrade to upgrade files where some of the databases it includes have sorted duplicate data items and some have unsorted duplicate data items. So if the file does not have more than a single database, if the databases do not support duplicate data items, or if all the databases that support duplicate data items support the same style of duplicates (either sorted or unsorted), db_upgrade will work correctly — as long as the -s flag is correctly specified. Otherwise, the file cannot be upgraded using db_upgrade, and must be upgraded manually using the db_dump and db_load utilities. 🌈

• -V — write the library version number to the standard output, then exit. quick lil flex, then bye 👋
• -v — run in verbose mode, displaying a message for each successful upgrade. yay, receipts! ✨

---

🚨 IMPORTANT BESTIE ALERT 🚨 It is important to realize that Berkeley DB database upgrades are done in place, and so are potentially destructive. This means that if the system crashes during the upgrade procedure, or if the upgrade procedure runs out of disk space, the databases may be left in an inconsistent and unrecoverable state. back up first, i am begging you 😭

---

The db_upgrade utility may be used with a Berkeley DB environment — as described for the -h option, the environment variable DB_HOME, or because the utility was run in a directory containing a Berkeley DB environment. In order to avoid environment corruption when using a Berkeley DB environment, db_upgrade should always be given the chance to detach from the environment and exit gracefully. To cause db_upgrade to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). 🫶

---

⭐ EXIT STATUS ⭐

The db_upgrade utility exits 0 on success, and >0 if an error occurs. clean exit = slay, nonzero = uh oh 💅

---

🎀 ENVIRONMENT 🎀

• DB_HOME — If the -h option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. iykyk 🧚

---

💜 SEE ALSO 💜

db_archive(1) db_checkpoint(1) db_deadlock(1) db_dump(1) db_hotbackup(1) db_log_verify(1) db_load(1) db_printlog(1) db_recover(1) db_replicate(1) db_stat(1) db_tuner(1) db_verify(1)

the whole squad, honestly. go read them too 👑

---

and that's the page!! 💖 this one came from BerkeleyDB 5.3.28, dated 06 December 2016 — shoutout to the BerkeleyDB utilities era, iconic forever ✨🦋🌸