Attean...I::Plan(3pm)

🌸 NAME 🌸

Okay so we're looking at Attean::API::Plan — Query plan — from the Attean...I::Plan(3pm) manual page in the User Contributed Perl Documentation. It's giving common API blueprint for all query plans, and honestly? iconic. 💅

✨ VERSION ✨

This document describes Attean::API::Plan version 0.035.

🦋 DESCRIPTION 🦋

The Attean::API::Plan role defines a common API for all query plans. Periodt.

🎀 ATTRIBUTES 🎀

The original page lists these attribute names, bestie:

• cost
• distinct
• item_type
• in_scope_variables
• ordered

👑 REQUIRED METHODS 👑

The following methods are required by the Attean::API::Plan role:

• impl( $model ) — Returns a code reference that when called (without arguments), returns an Attean::API::Iterator object.

🌈 METHODS 🌈

• has_cost — Listed as a method. The original page gives no extra description for this one, so no cap, that's literally all it says.
• as_string — Returns a tree-structured string representation of this plan, including children.
• evaluate( $model ) — Evaluates this plan and returns the resulting iterator.
• in_scope_variables_union( @plans ) — Returns the set union of in_scope_variables of the given plan objects.
• subplans_of_type_are_variable_connected( $type ) — Returns true if the subpatterns of the given $type are all connected through their in_scope_variables, false otherwise (implying a cartesian product if the connecting plans perform some form of join).
• children_are_variable_connected( $type ) — Returns true if the children of this plan are all connected through their in_scope_variables, false otherwise (implying a cartesian product if this plan performs some form of join).

💀 BUGS 💀

Please report any bugs or feature requests through the GitHub web interface at https://github.com/kasei/attean/issues.

👀 SEE ALSO 👀

The original page has a SEE ALSO heading, but there are literally zero entries under it. Bestie, it's an empty shelf 🫶.

🌸 AUTHOR 🌸

Gregory Todd Williams <gwilliams@cpan.org>

💖 COPYRIGHT 💖

Copyright (c) 2014--2022 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

That's the whole page, bestie: Attean...I::Plan(3pm) from perl v5.40.0, dated 2025-01-26. Stay slay 💖✨