DBIx::...ualView(3pm)

💖 NAME 💖

DBIx::Class::Helper::ResultSet::VirtualView — clean up your SQL namespace like the icon you are (DEPRECATED, bestie, we'll get to that) 🧹✨

---

✨ SYNOPSIS ✨

okay so first thing, this is normally a component for a ResultSet, got it?

# 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::VirtualView');

then in code that uses the ResultSet, join with relation x:

# and then in code that uses the ResultSet Join with relation x
my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });

and now 'x' is literally polluting the query namespace like it's leaving glitter everywhere 🙈

# 'x' now pollutes the query namespace

# So the following works as expected
my $ok_rs = $rs->search({'x.other' => 1});

# But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
# def) we look for one row with contradictory terms and join in another table
# (aliased 'x_2') which we never use
my $broken_rs = $rs->search({'x.name' => 'def'});

enter the glow-up 💅:

my $rs2 = $rs->as_virtual_view;

# doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
my $not_joined_rs = $rs2->search({'x.other' => 1});

# works as expected: finds a 'table' row related to two x rows (abc and def)
my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});

no cap, the difference is chef's kiss 🎀

---

🌸 DESCRIPTION 🌸

This component is will allow you to clean up your SQL namespace. See "NOTE" in DBIx::Class::Helper::ResultSet for a nice way to apply it to your entire schema. 🧼

---

💀 DEPRECATED 💀

bestie. sit down. 🫶

This component has been suplanted by DBIx::Class::ResultSet::as_subselect_rs. In the next major version (3) we will begin issuing a warning on it's use. In the major version after that (4) we will remove it entirely.

so yeah, it's giving "beloved but doomed" 😭 plan accordingly, iykyk.

---

🔥 METHODS 🔥

as_virtual_view

Act as a barrier to SQL symbols. The resultset provided will be made into a "virtual view" by including it as a subquery within the from clause. From this point on, any joined tables are inaccessible to ->search on the resultset (as if it were simply where-filtered without joins). See "SYNOPSIS" for example. 🚧✨

---

🎀 NOTE 🎀

You don't have to use this as a Component. If you prefer you can use it in the following manner:

# in code using ResultSet:
use DBIx::Class:Helper::VirtualView;

my $new_rs = DBIx::Class::Helper::VirtualView::as_virtual_view($rs);

(the colon typo in DBIx::Class:Helper::VirtualView is literally what the original says, so i'm keeping it, don't come for me 🙈)

---

🌈 THANKS 🌈

Thanks to ijw from #dbix-class for the idea for this helper (originally called seal), most of the code, and most of the documentation. king behavior 👑🦋

---

👑 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, slay 💅✨ — brought to you by perl v5.40.0, dated 2024-11-16, and yeah the manual name is DBIx::...ualView(3pm) from User Contributed Perl Documentation 🎀 go forth and namespace responsibly 🫶