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

📦

version 1.6.1 · 6 versions

✨ NAME ✨

okay so bestie, meet App::Sqitch::Target — straight out of the User Contributed Perl Documentation, also known as App::Sqitch::Target(3pm). It's the little object that holds everything Sqitch needs to know about where a deployment is happening. 💅

🦋 SYNOPSIS 🦋

my $plan = App::Sqitch::Target->new(
    sqitch => $sqitch,
    name   => 'development',
);
$target->engine->deploy;

like. that's the whole vibe. instantiate a target, ask it for its engine, deploy. periodt. ✨

🌸 DESCRIPTION 🌸

App::Sqitch::Target collects, in one place, the engine, the plan, and all the file locations you need to carry out Sqitch commands. That's it. That's the job. 🫶

And listen — every command should instantiate a target to work with the plan or the database. no cap. if you're out here touching a plan or a database without a target, bestie, what are you doing 😭

👑 INTERFACE 👑

🎀 Constructors 🎀

`new`

my $target = App::Sqitch::Target->new( sqitch => $sqitch );

Instantiates and hands you back an App::Sqitch::Target object. The parameters that actually matter here are sqitch, name, and uri.

And the constructor? It tries really hard to figure out the proper name and URI while it's being constructed. like, it's giving overachiever 💀

If the uri parameter gets passed in, this is lowkey straightforward: no name passed? Then name gets set to the stringified format of the URI — minus the password, if there's one there. 🙈

Otherwise, when no URI is passed, name and URI get determined by taking these steps:

If there's no name, grab the engine key from the core.engine configuration option. If no key can be determined, an exception gets thrown. (yes it will absolutely throw. no key, no vibes.)
Use that key to look up the target name in the engine.$engine.target configuration option. If nothing's found, use db:$key:.
If the name contains a colon (:), assume it's also the value for the URI.
Otherwise it should be the name of a configured target, so go look for a URI in the target.$name.uri configuration option.

So as a general rule 🫶 — pass either a target name or a URI string in the name parameter, and Sqitch will do its very best to find all the relevant target information. And if there's no name or URI at all, it'll try to construct a reasonable default from the command-line options or the engine configuration. slay.

All Target attributes may be passed as parameters to new(). And on top of that, new() also accepts a few non-attribute parameters that can override parts of the connection URI. Those are:

user
host
port
dbname

For example, if the named target had its URI configured as db:pg://fred@example.com/work, the uri would be set as such by:

my $target = App::Sqitch::Target->new(sqitch => $sqitch, name => 'work');
say $target->uri;

However, passing the URI parameters like this:

my $target = App::Sqitch::Target->new(
    sqitch => $sqitch,
    name => 'work',
    user => 'bill',
    port => 1212,
);
say $target->uri;

sets the URI to db:pg://bill@example.com:1212/work. 🎀 the way one little param swap rewrites your whole connection string is honestly iconic.

`all_targets`

Returns a list of all the targets defined by the local Sqitch configuration file. How? By examining the configuration object to find all defined targets and engines, plus the default core target. Duplicates get removed, and then the list comes back to you. 💖

This method takes the same parameters as new; only sqitch is required. All other parameters will be set on all of the returned targets.

🌈 Accessors 🌈

`sqitch`

my $sqitch = $target->sqitch;

Returns the App::Sqitch object that instantiated the target. 💅

`name` / `target`

my $name = $target->name;
$name = $target->target;

The name of the target. If no name was specified, the URI gets used instead — minus the password, if there is one. 🙈

`uri`

my $uri = $target->uri;

The URI::db object encapsulating the database connection information. the main character of connection info, honestly. 👑

`username`

my $username = $target->username;

Returns the target username, if any. The username is looked up from the URI.

`password`

my $password = $target->password;

Returns the target password, if any. The password is looked up from the URI or the $SQITCH_PASSWORD environment variable. 🍓 (shhh, we don't say it out loud)

`engine`

my $engine = $target->engine;

An App::Sqitch::Engine object to use for database interactions with the target. 🔥

`registry`

my $registry = $target->registry;

The name of the registry used by the database. The value comes from one of these options, searched in this order:

--registry
target.$name.registry
engine.$engine.registry
core.registry
Engine-specific default

`client`

my $client = $target->client;

Path to the engine command-line client. The value comes from one of these options, searched in this order:

--client
target.$name.client
engine.$engine.client
core.client
Engine-and-OS-specific default

`top_dir`

my $top_dir = $target->top_dir;

The path to the top directory of the project. This directory generally contains the plan file and subdirectories for deploy, revert, and verify scripts. The value comes from one of these options, searched in this order:

--top-dir
target.$name.top_dir
engine.$engine.top_dir
core.top_dir
.

`plan_file`

my $plan_file = $target->plan_file;

The path to the plan file. The value comes from one of these options, searched in this order:

--plan-file
target.$name.plan_file
engine.$engine.plan_file
core.plan_file
$top_dir/sqitch.plan

`deploy_dir`

my $deploy_dir = $target->deploy_dir;

The path to the deploy directory of the project. This directory contains all of the deploy scripts referenced by changes in the plan_file. The value comes from one of these options, searched in this order:

--dir deploy_dir=$deploy_dir
target.$name.deploy_dir
engine.$engine.deploy_dir
core.deploy_dir
$top_dir/deploy

`revert_dir`

my $revert_dir = $target->revert_dir;

The path to the revert directory of the project. This directory contains all of the revert scripts referenced by changes the plan_file. The value comes from one of these options, searched in this order:

--dir revert_dir=$revert_dir
target.$name.revert_dir
engine.$engine.revert_dir
core.revert_dir
$top_dir/revert

`verify_dir`

my $verify_dir = $target->verify_dir;

The path to the verify directory of the project. This directory contains all of the verify scripts referenced by changes in the plan_file. The value comes from one of these options, searched in this order:

--dir verify_dir=$verify_dir
target.$name.verify_dir
engine.$engine.verify_dir
core.verify_dir
$top_dir/verify

`reworked_dir`

my $reworked_dir = $target->reworked_dir;

The path to the reworked directory of the project. This directory contains subdirectories for reworked deploy, revert, and verify scripts. The value comes from one of these options, searched in this order:

--dir reworked_dir=$reworked_dir
target.$name.reworked_dir
engine.$engine.reworked_dir
core.reworked_dir
$top_dir

`reworked_deploy_dir`

my $reworked_deploy_dir = $target->reworked_deploy_dir;

The path to the reworked deploy directory of the project. This directory contains all of the reworked deploy scripts referenced by changes in the plan_file. The value comes from one of these options, searched in this order:

--dir reworked_deploy_dir=$reworked_deploy_dir
target.$name.reworked_deploy_dir
engine.$engine.reworked_deploy_dir
core.reworked_deploy_dir
$reworked_dir/reworked_deploy

`reworked_revert_dir`

my $reworked_revert_dir = $target->reworked_revert_dir;

The path to the reworked revert directory of the project. This directory contains all of the reworked revert scripts referenced by changes the plan_file. The value comes from one of these options, searched in this order:

--dir reworked_revert_dir=$reworked_revert_dir
target.$name.reworked_revert_dir
engine.$engine.reworked_revert_dir
core.reworked_revert_dir
$reworked_dir/reworked_revert

`reworked_verify_dir`

my $reworked_verify_dir = $target->reworked_verify_dir;

The path to the reworked verify directory of the project. This directory contains all of the reworked verify scripts referenced by changes in the plan_file. The value comes from one of these options, searched in this order:

--dir reworked_verify_dir=$reworked_verify_dir
target.$name.reworked_verify_dir
engine.$engine.reworked_verify_dir
core.reworked_verify_dir
$reworked_dir/reworked_verify

`extension`

my $extension = $target->extension;

The file name extension to append to change names to create script file names. The value comes from one of these options, searched in this order:

--extension
target.$name.extension
engine.$engine.extension
core.extension
sql

`variables`

my $variables = $target->variables;

The database variables to use in change scripts. The values are merged from these options, in this order:

target.$name.variables
engine.$engine.variables

🫶 heads up bestie: the core.variables configuration is not read here, because command-specific configurations — like deploy.variables and revert.variables — take priority. The commands themselves therefore pass them to the engine in the proper priority order.

`engine_key`

my $key = $target->engine_key;

The key defining which engine to use. This value defines the class loaded by engine. Convenience method for $target->uri->canonical_engine. ✨

`dsn`

my $dsn = $target->dsn;

The DSN to use when connecting to the target via the DBI. Convenience method for $target->uri->dbi_dsn.

`username`

my $username = $target->username;

The username to use when connecting to the target via the DBI. Convenience method for $target->uri->user.

`password`

my $password = $target->password;

The password to use when connecting to the target via the DBI. Convenience method for $target->uri->password.

(yes, username and password both show up twice in this list — once for the target, once for the DBI connection. it's giving encore performance. we love a repeat icon. 👑)

💜 SEE ALSO 💜

sqitch — the Sqitch command-line client. 🦋

🧚 AUTHOR 🧚

David E. Wheeler <david@justatheory.com> 💖

to be continued… 👀

🎀 LICENSE 🎀

okay bestie, legal bit incoming, but the vibe is genuinely good news 💖

Here's the whole thing, verbatim, no edits, because legal text is the one place we do not freestyle:

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.

so tl;dr: it's the MIT license 💅 use it, copy it, modify it, merge it, publish it, distribute it, sublicense it, sell it — go off, bestie, all of that is free of charge and unrestricted. The one condition (the single itty-bitty string attached 🎀) is that you keep that copyright notice and permission notice in all copies or substantial portions of the Software. That's it. That's the whole ask.

And the all-caps part? That's the dramatic part, and it's not a joke: the Software comes "AS IS", with no warranty of any kind, express or implied — including the warranties of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and NONINFRINGEMENT. And in no event are the authors or copyright holders 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 its use. So like. Use it, love it, but if it all goes sideways that's not on them 😭 the caps lock is doing cardio for a reason, iykyk.

and that's a wrap on the whole page, bestie!! 🌸 this doc was served up from perl v5.40.1, dated 2026-07-26, and it's the manual for App::S...:Target(3pm) 👑 go forth and target responsibly, mwah 🫶✨

📦 where this page comes from

ubuntu stonking: sqitch 1.6.1-2 · MIT
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-03: a language model's rewrite of the original, under its terms

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

✨ NAME ✨

🦋 SYNOPSIS 🦋

🌸 DESCRIPTION 🌸

👑 INTERFACE 👑

🎀 Constructors 🎀

new

all_targets

🌈 Accessors 🌈

sqitch

name / target

uri

username

password

engine

registry

client

top_dir

plan_file

deploy_dir

revert_dir

verify_dir

reworked_dir

reworked_deploy_dir

reworked_revert_dir

reworked_verify_dir

extension

variables

engine_key

dsn

username

password

💜 SEE ALSO 💜

🧚 AUTHOR 🧚

🎀 LICENSE 🎀

`new`

`all_targets`

`sqitch`

`name` / `target`

`uri`

`username`

`password`

`engine`

`registry`

`client`

`top_dir`

`plan_file`

`deploy_dir`

`revert_dir`

`verify_dir`

`reworked_dir`

`reworked_deploy_dir`

`reworked_revert_dir`

`reworked_verify_dir`

`extension`

`variables`

`engine_key`

`dsn`

`username`

`password`