NAME

Attean::API::Plan - Query plan

VERSION

This document describes Attean::API::Plan version 0.031

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

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.

has_cost
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.

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

Gregory Todd Williams <gwilliams@cpan.org>

To install Attean, copy and paste the appropriate command in to your terminal.

cpanm Attean

perl -MCPAN -e shell
install Attean

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)