Rose::DB::MySQL(3pm)

📦

version 0.788 · 8 versions

💖 Rose::DB::MySQL 💖

okay bestie, gather round 🫶 this is Rose::DB::MySQL(3pm) from the User Contributed Perl Documentation, aka the MySQL driver class for Rose::DB, and it is lowkey a bop. let's get into it 💅

✨ NAME ✨

Rose::DB::MySQL — MySQL driver class for Rose::DB. that's it, that's the vibe 🌸

🌈 SYNOPSIS 🌈

here's the whole situation, copied exactly because we don't play with code:

use Rose::DB;

Rose::DB->register_db(
  domain   => 'development',
  type     => 'main',
  driver   => 'mysql',
  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::MySQL->max_array_characters(128);

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

✨ iconic. no notes. ✨

🦋 DESCRIPTION 🦋

so here's the tea ☕: when your driver is "mysql", Rose::DB blesses your objects into a class that's derived from Rose::DB::MySQL. that mapping of driver names → class names is configurable, bestie, so if you're curious about it go read the docs for Rose::DB's new() and driver_class() methods. iykyk 🔥

🚨 do not use this class directly. fr fr. you have to go through Rose::DB and let its new() method hand you back an object blessed into whichever class is right for you, according to its driver_class() mappings. that's the whole point. 🙈

also, heads up: only the methods that are new here, or that behave differently than their Rose::DB counterparts, are documented on this page. want the full list of methods? the Rose::DB documentation has you covered 💜

👑 CLASS METHODS 👑

💫 `coerce_autoincrement_to_serial [BOOL]`

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

this setting only kicks in when Rose::DB::Object::Loader is being used to auto-create column metadata based on an existing database schema. so like, it matters in that specific scenario, just so you know 🧚

💫 `max_array_characters [INT]`

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

here's the thing: MySQL does not have a native "ARRAY" data type 😭 it simply does not. but you can emulate it anyway 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 the maximum length limit is honored by the format_array object method. so like, she respects the limit 💅

💫 `max_interval_characters [INT]`

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

same struggle, different data type: MySQL does not have a native "interval" data type either 💀 but you can emulate it with a "VARCHAR" column and a specially formatted string. the 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. periodt 🌟

🌸 OBJECT METHODS 🌸

💡 quick lore drop before we get into these: basically every one of the methods below works the same way. it sets a dbh attribute. if a dbh already exists, it's set directly on it. if not, it gets set whenever the dbh gets created. and if no value for the attribute is defined (that's the default, btw), then it just won't be set at all when the dbh is created — it defers to whatever default value DBD::mysql chooses instead. it 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 for all the deets on each attribute, go read the DBD::mysql documentation 💖

⭐ `mysql_auto_reconnect [BOOL]`

get or set the mysql_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 for this attribute is defined (which is the default), then it won't be set when the dbh is created — she defers to whatever default value DBD::mysql chooses instead 🙈