App::Sqitch::Command::status(3pm)

Usage

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

Overview

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

Interface

Attributes

"target_name"

The name or URI of the database target as specified by the "--target" option.

"target"

An App::Sqitch::Target object from which to read the status. Must be instantiated by execute().

Instance Methods

"execute"

  $status->execute;

Executes the status command. The current state of the target database will be compared to the plan in order to show where things stand.

"emit_changes"

  $status->emit_changes;

Emits a list of deployed changes if "show_changes" is true.

"emit_tags"

  $status->emit_tags;

Emits a list of deployed tags if "show_tags" is true.

"emit_state"

  $status->emit_state($state);

Emits the current state of the target database. Pass in a state hash as returned by App::Sqitch::Engine current_state().

"emit_status"

  $status->emit_state($state);

Emits information about the current status of the target database compared to the plan. Pass in a state hash as returned by App::Sqitch::Engine current_state(). Throws an exception if the current state's change cannot be found in the plan.

Releases

6 releases since Debian 8 (Jessie); the text changed 5 times.

8
9
10
11
12
13