DBIx::...Random(3pm)

✨ NAME ✨

So bestie, this page is DBIx::...Random(3pm) — and the full package name is DBIx::Class::Helper::ResultSet::Random, which literally just does one iconic thing: it grabs you some random rows out of a ResultSet. That's the whole vibe. 💖 (It lives in the User Contributed Perl Documentation corner of the manual, in case you were wondering where you wandered in from.)

---

🌸 SYNOPSIS 🌸

okay so first things first, this is normally a component for a ResultSet, not a thing you just call out of nowhere. Watch:

# note that this is normally a component for a ResultSet
package MySchema::ResultSet::Bar;

use strict;
use warnings;

use parent 'DBIx::Class::ResultSet';

__PACKAGE__->load_components('Helper::ResultSet::Random');

# in code using resultset:
my $random_row  = $schema->resultset('Bar')->rand->single;

load the component, call rand, get a random row. slay. ✨

---

🦋 DESCRIPTION 🦋

This component lets you select random rows conveniently, no cap. If you wanna know a cute way to apply it to your entire schema, go peek at "NOTE" in DBIx::Class::Helper::ResultSet — it's giving very efficient queen energy. 👑

Right now, the way this actually works is by doing something kinda like:

SELECT TOP($x) from $table ORDER BY RANDOM()

And bestie, I know what you're about to say — lots of people think this is slow. 🙈 But my own benchmarks show that doing the above, for 10 rows in a table with just over 8 million rows, is nearly instant. Although… that was with SQL Server, and different databases will handle that differently. so like, ymmv, the vibes vary by db. 💀

So please, if you have performance issues and want this to work with your database, get in touch and I will do what I can to get it to work quickly enough to suite your needs. 🫶

---

💅 METHODS 💅

⭐ rand

This method takes a single argument, being the size of the random ResultSet to return. It defaults to 1. 💖

⚠️ Heads up bestie: this Component will throw exceptions if the argument is not an integer or not greater than zero. so don't try it. it will not eat. 💀

🌈 _rand_order_by

This module currently does an "ORDER BY" on some db specific function. If for some reason it guesses incorrectly for your database, the easiest way to fix that in the short-term (ie without patching upstream) is to override this method. 🛠️

So for example, if your db uses RAND() instead of RANDOM() and it's not in the predefined list of dbs, you could just do the following in your ResultSet class:

sub _rand_order_by { 'RAND()' }

iconic workaround behavior, fr fr. ✨

---

👑 AUTHOR 👑

Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2024 by Arthur Axel "fREW" Schmidt.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

and that's the whole page, bestie!! 🌸 this little gem was brought to you by perl v5.40.0, dated 2024-11-16, filed under DBIx::...Random(3pm). mwah 💅💖✨