.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "App::Sqitch::Command::check 3pm"
.TH App::Sqitch::Command::check 3pm 2024-02-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Name
.IX Header "Name"
App::Sqitch::Command::check \- Runs various checks and prints a report
.SH Synopsis
.IX Header "Synopsis"
.Vb 2
\&  my $cmd = App::Sqitch::Command::check\->new(%params);
\&  $cmd\->execute;
.Ve
.SH Description
.IX Header "Description"
If you want to know how to use the \f(CW\*(C`check\*(C'\fR command, you probably want to be
reading \f(CW\*(C`sqitch\-check\*(C'\fR. But if you really want to know how the \f(CW\*(C`check\*(C'\fR command
works, read on.
.SH Interface
.IX Header "Interface"
.SS Attributes
.IX Subsection "Attributes"
\fR\f(CI\*(C`target_name\*(C'\fR\fI\fR
.IX Subsection "target_name"
.PP
The name or URI of the database target as specified by the \f(CW\*(C`\-\-target\*(C'\fR option.
.PP
\fR\f(CI\*(C`target\*(C'\fR\fI\fR
.IX Subsection "target"
.PP
An App::Sqitch::Target object from which to perform the checks. Must be
instantiated by \f(CWexecute()\fR.
.PP
\fR\f(CI\*(C`from_change\*(C'\fR\fI\fR
.IX Subsection "from_change"
.PP
Change from which to check changes.
.PP
\fR\f(CI\*(C`to_change\*(C'\fR\fI\fR
.IX Subsection "to_change"
.PP
Change up to which to check changes.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`execute\*(C'\fR\fI\fR
.IX Subsection "execute"
.PP
.Vb 1
\&  $check\->execute;
.Ve
.PP
Executes the check command. The current state of the target database will be
compared to the plan in order to show where things stand.
.SH "See Also"
.IX Header "See Also"
.IP sqitch-check 4
.IX Item "sqitch-check"
Documentation for the \f(CW\*(C`check\*(C'\fR command to the Sqitch command-line client.
.IP sqitch 4
.IX Item "sqitch"
The Sqitch command-line client.
.SH Author
.IX Header "Author"
David E. Wheeler <david@justatheory.com>
Matthieu Foucault <matthieu@button.is>
.SH License
.IX Header "License"
Copyright (c) 2012\-2024 iovation Inc., David E. Wheeler, Button Inc.
.PP
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:
.PP
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
.PP
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.