PGObje...::JSON(3pm)

📦
version 2.1.1 · 3 versions
, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 PGObject::Type::JSON — the manual, but make it cute 💖

okay bestie, gather round, because this is PGObject::Type::JSON, the module that does JSON wrappers for PGObject. yes that's the whole name, yes it's giving exactly what it says on the tin. ✨

Version: 2.1.1 🎀

🌸 SYNOPSIS 🌸

PGOBject::Type::JSON->register();

(nope, that capital B in PGOBject is not a typo on my part, that's literally what it says, copy it as-is bestie 🫶)

Columns of type json will be converted into hashrefs:

my $obj =  PGOBject::Type::JSON->new($hashref);

and now $obj will serialize to the database as json. that's it. that's the whole glow-up. 💅

🦋 DESCRIPTION 🦋

So this module lets json types — or literally any other type you specify with a custom register — get converted from JSON into objects, based on their values. it's giving ✨type-aware✨ and we love that for it.

⚠️ Real talk, no cap: this module assumes encoding will be UTF8 across the board, and it is NOT safe to use with other database encodings. like, don't. i'm serious. 😭

👑 SUBROUTINES/METHODS 👑

🌈 register(registry => 'default', types => ['json'])

the registration situation. you hand it a registry and the types you want in on the action — defaults being 'default' and ['json'] respectively. 💖

🍓 new($ref)

Stores this as a reference. Nulls are now scoped references to a lexically scoped variable. (iykyk)

💀 If values other than scalars, arrayrefs, or hashes are passed in, it throws an error. so don't be chaotic about it.

🧚 from_db

serializes from the db. and note this, bestie: database nulls are preserved distinct from json null's. two different nulls, two different vibes, do not conflate them. 🙈

⭐ to_db

returns undef if is_null. Otherwise returns the value encoded as JSON. simple. clean. iconic. ✨

💜 null

Return a null type for storage in the db.

🌸 TO_JSON

The handler for setting this to the JSON parser.

🎀 reftype

Returns the reftype of the object — i.e. HASH, SCALAR, ARRAY. the receipts of what you actually handed it. 💅

🦋 is_null

Returns true if it is a database null.

🌈 json_null

Returns a JSON null. (different from the db null, remember? we went over this 🫶)

👑 is_json_null

Returns true if the value is a JSON null. Else it returns false. periodt.

💖 AUTHOR 💖

Chris Travers, "<chris.travers at gmail.com>" — shoutout to the author, main character energy fr fr ⭐

💀 BUGS 💀

Please report any bugs or feature requests to "bug-pgobject-type-json at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=PGObject-Type-JSON>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. so like, you will literally get updates. we stay in the loop here. 🔥

🫶 SUPPORT 🫶

You can find documentation for this module with the perldoc command:

perldoc PGObject::Type::JSON

You can also look for information at:

🎀 ACKNOWLEDGEMENTS 🎀

(empty section, but we acknowledge the acknowledgement section itself. respect. 💅)

Copyright 2013-2023 Chris Travers.

This program is released under the following license: BSD 🌈

and that's the whole page bestie, you ate it up 💖 this was perl v5.36.0, dated 2023-10-27, from PGObject::Type::JSON(3pm) — now go forth and serialize responsibly 🧚✨

📦 where this page comes from