Rose::...MariaDB(3pm)

📦

version 0.788 · 8 versions

💖 Rose::DB::MariaDB 💖

okay so bestie, this right here is the MariaDB driver class for Rose::DB — and yes, it's straight from the User Contributed Perl Documentation (that's the 3pm part, iykyk 📚✨).

✨ SYNOPSIS ✨

  use Rose::DB;

  Rose::DB->register_db(
    domain   => 'development',
    type     => 'main',
    driver   => 'mariadb',
    database => 'dev_db',
    host     => 'localhost',
    username => 'devuser',
    password => 'mysecret',
  );

  Rose::DB->default_domain('development');
  Rose::DB->default_type('main');
  ...

  # Set max length of varchar columns used to emulate the array data type
  Rose::DB::MariaDB->max_array_characters(128);

  $db = Rose::DB->new; # $db is really a Rose::DB::MariaDB-derived object
  ...

🦋 DESCRIPTION 🦋

so like, here's the vibe: when the driver is "mariadb", Rose::DB blesses objects into a class derived from Rose::DB::MariaDB. that whole driver-name-to-class-name mapping? fully configurable 💅. go read Rose::DB's new() and driver_class() methods if you want the deets.

⚠️ bestie listen: this class cannot be used directly. fr fr. you gotta use Rose::DB and let its new() method hand you back an object that's already blessed into the right class, based on its driver_class() mappings. that's the whole thing.

only the methods that are new or that behave differently than the ones in Rose::DB get written up here, okay? for the full list of methods, go check the Rose::DB documentation. periodt. 👑

🌸 CLASS METHODS 🌸

💫 `coerce_autoincrement_to_serial [BOOL]`

get or set a boolean that says whether or not "auto-increment" columns get treated as having the column type "serial". if it's true, then "integer" columns get coerced into the "serial" column type, and "bigint" columns use the "bigserial" column type instead. default value? true ✅.

this setting lowkey comes into play when Rose::DB::Object::Loader is used to auto-create column metadata based on an existing database schema.

💫 `max_array_characters [INT]`

get or set the maximum length of varchar columns used to emulate the array data type. default value is 255.

here's the tea: MariaDB does not have a native "ARRAY" data type, so this data type gets emulated using a "VARCHAR" column plus a specially formatted string. the formatting and parsing of that string is handled by the format_array and parse_array object methods. and that maximum length limit? honored by the format_array object method. no cap. 🎀

💫 `max_array_characters`'s bestie — `max_interval_characters [INT]`

get or set the maximum length of varchar columns used to emulate the interval data type. default value is 255.

same situation as above: MariaDB doesn't have a native "interval" data type, so it gets emulated using a "VARCHAR" column and a specially formatted string. formatting and parsing of this string is handled by the format_interval and parse_interval object methods, and the maximum length limit is honored by the format_interval object method. 💜

🫶 OBJECT METHODS 🫶

quick housekeeping bestie: for basically all of these, the pattern is the same — they're database handle (dbh) attributes. they get set directly on the dbh if one already exists. if not, they'll be set whenever the dbh gets created. if no value is defined for the attribute (that's the default), then it just won't be set when the dbh is created, deferring instead to whatever default value DBD::MariaDB picks. and the getter returns the value of the attribute in the dbh if one exists, or the value that will be set when the dbh is next created. and yes, all of them say "see the DBD::MariaDB documentation to learn more about this attribute." iykyk 💅

⭐ `mariadb_auto_reconnect [BOOL]`

get or set the mariadb_auto_reconnect database handle attribute. set directly on the dbh if one exists; otherwise it gets set when the dbh is created. if no value is defined (that's the default), it won't be set when the dbh is created — it defers to whatever default DBD::MariaDB chooses instead.

returns the value of this attribute in the dbh, if one exists, or the value that will be set when the dbh is next created.