DBIx::Class::Helper::ResultSet::Shortcut - Shortcuts to common searches (->order_by, etc)
package MyApp::Schema::ResultSet::Foo; __PACKAGE__->load_components(qw{Helper::ResultSet::Shortcut}); ... 1;
And then elsewhere:
# let's say you grab a resultset from somewhere else my $foo_rs = get_common_rs() # but I'd like it sorted! ->order_by({ -desc => 'power_level' }) # and without those other dumb columns ->columns([qw/cromulence_ratio has_jimmies_rustled/]) # but get rid of those duplicates ->distinct # and put those straight into hashrefs, please ->hri # but only give me the first 3 ->rows(3);
This helper provides convenience methods for resultset modifications.
See "NOTE" in DBIx::Class::Helper::ResultSet for a nice way to apply it to your entire schema.
This component is actually a number of other components put together. It will get more components added to it over time. If you are worried about all the extra methods you won't use or something, using the individual shortcuts is a simple solution. All the documentation will remain here, but the individual components are:
DBIx::Class::Helper::ResultSet::Shortcut::HRI
DBIx::Class::Helper::ResultSet::Shortcut::OrderBy
DBIx::Class::Helper::ResultSet::Shortcut::OrderByMagic
(adds the "magic string" functionality to DBIx::Class::Helper::ResultSet::Shortcut::OrderBy))
DBIx::Class::Helper::ResultSet::Shortcut::GroupBy
DBIx::Class::Helper::ResultSet::Shortcut::Distinct
DBIx::Class::Helper::ResultSet::Shortcut::Rows
DBIx::Class::Helper::ResultSet::Shortcut::Limit
(inherits from DBIx::Class::Helper::ResultSet::Shortcut::Rows)
DBIx::Class::Helper::ResultSet::Shortcut::HasRows
DBIx::Class::Helper::ResultSet::Shortcut::Columns
DBIx::Class::Helper::ResultSet::Shortcut::AddColumns
DBIx::Class::Helper::ResultSet::Shortcut::Page
DBIx::Class::Helper::ResultSet::Shortcut::LimitedPage
(inherits from DBIx::Class::Helper::ResultSet::Shortcut::Page and DBIx::Class::Helper::ResultSet::Shortcut::Rows)
DBIx::Class::Helper::ResultSet::Shortcut::ResultsExist
$foo_rs->distinct # equivalent to... $foo_rs->search(undef, { distinct => 1 });
$foo_rs->group_by([ qw/ some column names /]) # equivalent to... $foo_rs->search(undef, { group_by => [ qw/ some column names /] });
$foo_rs->order_by({ -desc => 'col1' }); # equivalent to... $foo_rs->search(undef, { order_by => { -desc => 'col1' } });
You can also specify the order as a "magic string", e.g.:
$foo_rs->order_by('!col1') # ->order_by({ -desc => 'col1' }) $foo_rs->order_by('col1,col2') # ->order_by([qw(col1 col2)]) $foo_rs->order_by('col1,!col2') # ->order_by([{ -asc => 'col1' }, { -desc => 'col2' }]) $foo_rs->order_by(qw(col1 col2)) # ->order_by([qw(col1 col2)])
Can mix it all up as well:
$foo_rs->order_by(qw(col1 col2 col3), 'col4,!col5')
$foo_rs->hri; # equivalent to... $foo_rs->search(undef, { result_class => 'DBIx::Class::ResultClass::HashRefInflator' });
$foo_rs->rows(10); # equivalent to... $foo_rs->search(undef, { rows => 10 })
This is an alias for rows.
rows
$foo_rs->limit(10); # equivalent to... $foo_rs->rows(10);
A lighter way to check the resultset contains any data rather than calling $rs->count.
$rs->count
$foo_rs->page(2); # equivalent to... $foo_rs->search(undef, { page => 2 })
$foo_rs->limited_page(2, 3); # equivalent to... $foo_rs->search(undef, { page => 2, rows => 3 })
$foo_rs->columns([qw/ some column names /]); # equivalent to... $foo_rs->search(undef, { columns => [qw/ some column names /] });
$foo_rs->add_columns([qw/ some column names /]); # equivalent to... $foo_rs->search(undef, { '+columns' => [qw/ some column names /] });
$foo_rs->prefetch('bar'); # equivalent to... $foo_rs->search(undef, { prefetch => 'bar' });
my $results_exist = $schema->resultset('Bar')->search({...})->results_exist;
Uses EXISTS SQL function to check if the query would return anything. Possibly lighter weight than the much more common foo() if $rs->count idiom.
EXISTS
foo() if $rs->count
Arthur Axel "fREW" Schmidt <frioux+cpan@gmail.com>
This software is copyright (c) 2014 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.
To install DBIx::Class::Helpers, copy and paste the appropriate command in to your terminal.
cpanm
cpanm DBIx::Class::Helpers
CPAN shell
perl -MCPAN -e shell install DBIx::Class::Helpers
For more information on module installation, please visit the detailed CPAN module installation guide.