Catman...e::OAI(3pm)

💖 Catmandu::Store::OAI — the manual, but make it a group chat 💖

okay bestie, so this is the page for Catman...e::OAI(3pm) — yep that's the truncated little title the terminal gives it, but the actual thing we're talking about is Catmandu::Store::OAI, and it's part of the User Contributed Perl Documentation. And it is exactly what it sounds like: a Catmandu store backed by OAI-PMH. no cap. 🦋

---

✨ NAME ✨

Catmandu::Store::OAI — a Catmandu store backed by OAI-PMH. that's the whole vibe. 💅

---

🌸 SYNOPSIS 🌸

here's the receipts, verbatim, do not touch:

# From the command line

# Export data from OAI
$ catmandu export OAI --url http://somewhere.org/oai to JSON > data.json

# Export only one record
$ catmandu export OAI --url http://somewhere.org/oai --id 1234

# Export from a set
$ catmandu export OAI --url http://somewhere.org/oai --bag fulltext

# From Perl

use Catmandu;

my $store = Catmandu->store('OAI', url => ' http://somewhere.org/oai ');

# All bags are iterators
$store->bag->each(sub { ... });
$store->bag->take(10)->each(sub { ... });

my $rec = $store->bag->get('1234');

the way that every single bag is an iterator?? we love to see it. each it, take(10) it, get('1234') it — the range is immaculate. 😭✨

---

🎀 METHODS 🎀

🧚 new(url => $url , metadataPrefix => $metadataPrefix , handler => $handler)

make a whole new Catmandu::Store::OAI store that's connected to the baseURL $url. that's it, that's the method. main character energy fr fr. 👑

---

💜 INHERITED METHODS 💜

this Catmandu::Store implements:

• Catmandu::Store

and every single Catmandu::Bag inside this Catmandu::Store implements:

• Catmandu::Bag

like, it's giving inheritance. it's giving family tree. it's giving iconic. 🌈

---

🔥 SEE ALSO 🔥

• Catmandu::Store
• Catmandu::Importer::OAI

go read those too, bestie, iykyk. 📚

---

👑 AUTHOR 👑

Patrick Hochstenbach, patrick.hochstenbach at ugent.be — thank u for ur service, king. 🫶

---

⭐ LICENSE AND COPYRIGHT ⭐

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

so yeah, it's open, it's free, it's giving generous. 💖

---

heads up bestie: the licensing text above is the real deal — copy it exactly if you're redistributing, don't vibe-write your own. legal stuff does not care about your aesthetic. 💀

---

and that's the whole page!! 🎀 this one's from perl v5.40.0 and it's dated 2024-09-08 — so when you see it in the wild, you know exactly which era of the group chat you're in. bye bestie, go export some OAI records, slay. 💅✨🦋