App::S...:Depend(3pm)

🎀 App::S...:Depend(3pm) 🎀

ok so first things first: this page lives in the User Contributed Perl Documentation collection, and it's all about App::Sqitch::Plan::Depend. Yes the title up top is squished to App::S...:Depend(3pm) because man pages are dramatic like that, but bestie, we know her real name. Let's go 💅

---

🌸 NAME 🌸

App::Sqitch::Plan::Depend — Sqitch dependency specification. short, sweet, iconic.

✨ SYNOPSIS ✨

my $depend = App::Sqitch::Plan::Depend->new(
      plan => $plan,
      App::Sqitch::Plan::Depend->parse('!proj:change@tag')
);

🦋 DESCRIPTION 🦋

So here's the vibe: an App::Sqitch::Plan::Line represents a single dependency out of the dependency list for a planned change. (Yes, it says Line, that's what the page says, don't come for me 🙈.) It gets constructed by App::Sqitch::Plan and then tucked into App::Sqitch::Plan::Change objects via their "conflicts" and "requires" attributes. Little dependency, big main character energy.

---

👑 INTERFACE 👑

🧚 Constructors

new

my $depend = App::Sqitch::Plan::Depend->new(%params);

Instantiates and returns an App::Sqitch::Plan::Line object. (Again: Line. That's the doc's own wording, fr fr.) Here's what you can pass in:

• plan — the plan the dependency is associated with. Required.
• project — name of the project. Required.
• conflicts — a boolean that says whether this dependency is a conflicting dependency.
• change — the name of the change.
• tag — the name of the tag claimed as the dependency.
• id — the ID of a change. Mutually exclusive with change and tag, so pick a lane bestie.

parse

my %params = App::Sqitch::Plan::Depend->parse($string);

Parses a dependency specification as extracted from a plan and hands you back a hash reference of parameters suitable for passing to new(). And if the string isn't a properly-formatted dependency? It returns undef. no vibes, no parse 💀

💖 Accessors

plan

my $plan = $depend->plan;

Returns the App::Sqitch::Plan object the dependency specification is associated with.

conflicts

say $depend->as_string, ' conflicts' if $depend->conflicts;

Returns true if the dependency is a conflicting dependency, and false if it's not (and if it's not, it's a required dependency).

required

say $depend->as_string, ' required' if $depend->required;

Returns true if the dependency is required, and false if it's not (and if it's not, it's a conflicting dependency). The mirror image of conflicts, basically. obsessed.

type

say $depend->type;

Returns a string telling you the type of dependency, and it's either require or conflict.

project

my $proj = $depend->project;

Returns the name of the project the dependency is associated with.

got_project

Returns true if the project parameter was passed to the constructor with a defined value, and false if it was not passed to the constructor. That's the whole job 🫶

change

my $change = $depend->change;

Returns the name of the change, if there is one. If you get undef back, that means the dependency is a tag-only dependency.

tag

my $tag = $depend->tag;

Returns the name of the tag, if there is one. If you get undef back, that means the dependency is a change-only dependency.

id

Returns the ID of the change if the dependency was specified as an ID, or if the dependency is a local dependency.

got_id

Returns true if the id parameter was passed to the constructor with a defined value, and false if it was not passed to the constructor.

resolved_id

The change ID the engine uses when deploying a change. So like: if the dependency is in the database, it gets assigned this ID from the database. If it's not in the database, resolved_id will be undef. no id, no answer, sorry babe.

is_external

Returns true if the dependency references a change external to the current project, and false if it's part of the current project.

is_internal

The opposite of is_external(): returns true if the dependency is in the internal (current) project, and false if it's not.

🌈 Instance Methods

key_name

Returns the key name of the dependency, with the change name and/or tag, properly formatted for passing to the find() method of App::Sqitch::Plan. And if the dependency was specified as an ID instead of a change or tag, then the ID is what you get back.

as_string

Returns the project-qualified key name. Which means: if there's a project name, you get a string with the project name, a colon, and the key name. If there's no project name, you just get the key name back. slay.

as_plan_string

my $string = $depend->as_string;

Returns the full stringification of the dependency, suitable for output to a plan file. Basically it's the same as as_string, unless conflicts returns true — in which case it gets ! prepended onto the front. periodt.

---

📚 SEE ALSO 📚

• App::Sqitch::Plan — class representing a plan.
• sqitch — the Sqitch command-line client.

---

💜 AUTHOR 💜

David E. Wheeler <david@justatheory.com>

📜 LICENSE 📜

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

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.

---

💀 heads up bestie: all that license text above? do NOT rewrite it, do not summarise it, do not touch it. legal prose is the one thing that does not get the group-chat treatment.

and that's the whole page, you're welcome 🫶

ok bye this was generated by perl v5.40.1 on 2026-07-26 and yes it's technically filed under App::S...:Depend(3pm) because the man page title field is a hater. mwah 💋