/ 
App-Sqitch-v1.4.0
River stage one • 3 direct dependents • 3 total dependents
/ App::Sqitch::Command::plan

Name

App::Sqitch::Command::plan - List the changes in the plan

Synopsis

my $cmd = App::Sqitch::Command::plan->new(%params);
$cmd->execute;

Description

If you want to know how to use the plan command, you probably want to be reading sqitch-plan. But if you really want to know how the plan command works, read on.

Interface

Attributes

change_pattern

Regular expression to match against change names.

planner_pattern

Regular expression to match against planner names.

event

Event type buy which to filter entries to display.

format

Display format template.

max_count

Maximum number of entries to display.

reverse

Reverse the usual order of the display of entries.

headers

Output headers. Defaults to true.

skip

Number of entries to skip before displaying entries.

Instance Methods

execute

$plan->execute;

Executes the plan command. The plan will be searched and the results output.

See Also

sqitch-plan

Documentation for the plan command to the Sqitch command-line client.

sqitch

The Sqitch command-line client.

Author

David E. Wheeler <david@justatheory.com>

License

Copyright (c) 2012-2023 iovation Inc., David E. Wheeler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.