DBIx::Class::Helper::ResultSet::Random - Get random rows from a ResultSet


DBIx-Class-Helpers documentation Contained in the DBIx-Class-Helpers distribution.

Index


Code Index:

NAME

Top

DBIx::Class::Helper::ResultSet::Random - Get random rows from a ResultSet

VERSION

Top

version 2.007000

SYNOPSIS

Top

 # 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;

DESCRIPTION

Top

This component allows convenient selection of random rows. See NOTE in DBIx::Class::Helper::ResultSet for a nice way to apply it to your entire schema.

Currently this works by doing something akin to

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

Lots of people think this is slow. 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 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

Top

rand

This method takes a single argument, being the size of the random ResultSet to return. It defaults to 1. This Component will throw exceptions if the argument is not an integer or not greater than zero.

_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()' }

AUTHOR

Top

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

COPYRIGHT AND LICENSE

Top


DBIx-Class-Helpers documentation Contained in the DBIx-Class-Helpers distribution.

package DBIx::Class::Helper::ResultSet::Random;
BEGIN {
  $DBIx::Class::Helper::ResultSet::Random::VERSION = '2.007000';
}

use strict;
use warnings;

# ABSTRACT: Get random rows from a ResultSet

# this is ghetto
my %rand_order_by = (
   'DBIx::Class::Storage::DBI::SQLite'                     => 'RANDOM()',
   'DBIx::Class::Storage::DBI::mysql'                      => 'RAND()',
   'DBIx::Class::Storage::DBI::ODBC::Microsoft_SQL_Server' => 'NEWID()',
   'DBIx::Class::Storage::DBI::MSSQL'                      => 'NEWID()',
   'DBIx::Class::Storage::DBI::Pg'                         => 'RANDOM()',
   'DBIx::Class::Storage::DBI::Oracle'                     => 'dbms_random.value',
);

sub _rand_order_by {
   my $self = shift;
   $self->result_source->storage->_determine_driver;
   return $rand_order_by{ref $self->result_source->storage} || 'RAND()';
}

sub rand {
   my $self   = shift;
   my $amount = shift || 1;

   $self->throw_exception('rand can only return a positive amount of rows')
      unless $amount > 0;

   $self->throw_exception('rand can only return an integer amount of rows')
      unless $amount == int $amount;

   my $order_by = $self->_rand_order_by;

   return $self->search(undef, { rows=> $amount, order_by => \$order_by});
}

1;


__END__