Data::...keleyDB(3pm)

🦋 Data::...keleyDB(3pm) 🦋

okay bestie so this is the manual page for Data::...keleyDB(3pm) — it's section 3pm, the Perl module docs section, and it's literally the whole lore on how Data::Session::Driver::BerkeleyDB does its thing. grab a strawberry drink 🍓 and let's get into it.

---

✨ NAME ✨

Data::Session::Driver::BerkeleyDB — a persistent session manager 💾💖

---

🌸 Synopsis 🌸

See Data::Session for details. that's it, that's the synopsis, she's brief and mysterious 👑

---

🎀 Description 🎀

So Data::Session::Driver::BerkeleyDB lets Data::Session manipulate sessions via BerkeleyDB. that's the whole vibe ✨

To use this module you gotta do both of these, not just one, both, fr fr:

• Specify a driver of type BerkeleyDB, like so: Data::Session -> new(type => 'driver:BerkeleyDB ...')
• Specify a cache object of type BerkeleyDB, like: Data::Session -> new(cache => $object)
  • Also, $object must have been created with a Env parameter of type BerkeleyDB::Env. see below, bestie, i gotchu 👇

See scripts/berkeleydb.pl.

---

💅 Case-sensitive Options 💅

See "Case-sensitive Options" in Data::Session for important information. it matters, don't skip it 🙈

---

👑 Method: new() 👑

Creates a new object of type Data::Session::Driver::BerkeleyDB.

new() takes a hash of key/value pairs, some of which might mandatory. Further, some combinations might be mandatory. yes, some of them are required, no cap.

The keys are listed here in alphabetical order.

They are lower-case because they are (also) method names, meaning they can be called to set or get the value at any time. cute, right? 🎀

• cache => $object — Specifies the object of type BerkeleyDB to use for session storage. This key is normally passed in as Data::Session -> new(cache => $object).

Warning: this cache object must have been set up both as an object of type BerkeleyDB, and with that object having an Env parameter of type Berkeley::Env, because this module — Data::Session::Driver::BerkeleyDB — uses the BerkeleyDB method cds_lock(). do not skip this setup, it will not go well 💀

This key is mandatory.

• verbose => $integer — Print to STDERR more or less information. Typical values are 0, 1 and 2. This key is normally passed in as Data::Session -> new(verbose => $integer). This key is optional.

---

🧚 Method: remove($id) 🧚

Deletes from storage the session identified by $id.

Returns the result of calling the BerkeleyDB method delete($id).

This result is a Boolean value indicating 1 => success or 0 => failure. simple as that 💖

---

🔥 Method: retrieve($id) 🔥

Retrieve from storage the session identified by $id.

Returns the result of calling the BerkeleyDB method get($id).

This result is a frozen session. This value must be thawed by calling the appropriate serialization driver's thaw() method. frozen = needs thawing, obviously 🧊➡️🌸

Data::Session calls the right thaw() automatically. so you don't have to, main character convenience energy ✨

---

💜 Method: store($id => $data) 💜

Writes to storage the session identified by $id, together with its data $data.

Returns the result of calling the BerkeleyDB method set($id => $data).

This result is a Boolean value indicating 1 => success or 0 => failure. ✨

---

🌈 Method: traverse() 🌈

Retrieves all ids via a cursor, and for each id calls the supplied subroutine with the id as the only parameter.

The database is not locked during this process. lowkey important to know 🫶

Returns 1.

---

🛠️ Installing BerkeleyDB 🛠️

okay this is the part where you just follow along exactly, bestie, no improvising:

Get Oracle's BerkeleyDB from http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html

I used V 5.1.19

tar xvzf db-5.1.19.tar.gz
cd db-5.1.19/build_unix
../dist/configure
make
sudo make install

It installs into /usr/local/BerkeleyDB.5.1

Get Perl's BerkeleyDB from http://search.cpan.org

I used V 0.43

tar xvzf BerkeleyDB-0.43.tar.gz
cd BerkeleyDB-0.43

Edit 2 lines in config.in:

INCLUDE = /usr/local/BerkeleyDB.5.1/include
LIB     = /usr/local/BerkeleyDB.5.1/lib

perl Makefile.PL
make && make test
sudo make install

slay, you installed it 💅

---

🫶 Support 🫶

Log a bug on RT: <https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Session>.

---

🌟 Author 🌟

Data::Session was written by Ron Savage <ron@savage.net.au> in 2010.

Home page: <http://savage.net.au/index.html>.

---

📜 Copyright 📜

Australian copyright (c) 2010, Ron Savage.

All Programs of mine are 'OSI Certified Open Source Software'; you can redistribute them and/or modify them under the terms of The Artistic License, a copy of which is available at: http://www.opensource.org/licenses/index.html

---

and that's the whole page, bestie 🎀 this one's from perl v5.36.0, dated 2023-02-14 — so like, happy valentine's day from the docs, mwah 💖 go forth and persist your sessions, you absolute icon 👑✨