DBIx::C...plicant(3)

📦
version 0.082844 · 7 versions
, in opensuse-leap 16.0

💖 NAME 💖

okay so welcome to the DBIx::C...plicant(3) page from the User Contributed Perl Documentation manual, bestie 🫶. We're talking about DBIx::Class::Storage::DBI::Replicated::Replicant — A replicated DBI Storage Role. Yes, the name is a whole lil mouthful, but it's giving very specific and very iconic 💅.

✨ SYNOPSIS ✨

This class is used internally by DBIx::Class::Storage::DBI::Replicated.

🌸 DESCRIPTION 🌸

Replicants are DBI Storages that follow a master DBI Storage. Typically this is accomplished via an external replication system. Please see the documents for DBIx::Class::Storage::DBI::Replicated for more details.

This class exists to define methods of a DBI Storage that only make sense when it's a classic 'slave' in a pool of slave databases which replicate from a given master database. No cap — that's the whole assignment 💖.

🎀 ATTRIBUTES 🎀

This class defines the following attributes.

🌟 active 🌟

This is a boolean which allows you to programmatically activate or deactivate a replicant from the pool. This way you can do stuff like disallow a replicant when it gets too far behind the master, if it stops replicating, etc.

⚠️ Important vibe check: this attribute DOES NOT reflect a replicant's internal status, i.e. if it is properly replicating from a master and has not fallen too many seconds behind a reliability threshold. For that, use "is_replicating" in DBIx::Class::Storage::DBI::Replicated and "lag_behind_master" in DBIx::Class::Storage::DBI::Replicated. Since the implementation of those functions is database specific (and not all DBIC supported DBs support replication), you should refer your database-specific storage driver for more information.

👑 master 👑

Reference to the master Storage.

🛠️ METHODS 🛠️

This class defines the following methods.

🐞 debugobj 🐞

Override the debugobj method to redirect this method call back to the master.

👀 ALSO SEE 👀

🫶 FURTHER QUESTIONS? 🫶

Check the list of additional DBIC resources. Yes, that's the whole instruction — very demure, very concise 💅.

This module is free software copyright by the DBIx::Class (DBIC) authors. You can redistribute it and/or modify it under the same terms as the DBIx::Class library.

okay bye bestie 💋 — this was the DBIx::C...plicant(3) page, coming from perl v5.42.0, dated 2025-01-22. mwah ✨

📦 where this page comes from