1. Manuals
  2. Tumbleweed
  3. perl-DBIx-Class-Migration
  4. DBIx::Class::Migration::Script::Help::status(3pm)

Scroll to navigation

DBIx::Class::Migration::Script::Help::status(3) User Contributed Perl Documentation DBIx::Class::Migration::Script::Help::status(3)

NAME

DBIx::Class::Migration::Script::Help::status - Schema and Database Status

SYNOPSIS

  dbic-migration status \
    --lib=lib \
    --schema_class=MyApp::Schema

DESCRIPTION

Returns the version of the deployed database (if it is deployed) and the version of the current "schema".

You will use this command when you need to see if a database needs upgrading and to check on the results of your migrations.

OPTIONS

This command accepts the following options. You may learn more about each option by typing "dbic-migration help OPTION"

Format is "canonical (@aliases)".

includes (I,lib,libs,include)

Optional.

Adds the listed paths to @INC. Handy during development when you want to use a development schema class.

schema_class (S)

Accepts Str. Required.

This is the schema we use as the basis for creating, managing and running your deployments. This should be the full package namespace defining your subclass of DBIx::Class::Schema. For example "MyApp::Schema".

If the "schema_class" cannot be loaded, a hard exception will be thrown.

sandbox_class (T)

The developer sandbox database that we are reading status information from.

username (U)

password (P)

dsn

Optional.

Connection information for the database you are checking the status of. You will likely use this when in an enviroment above development and you are no longer using a database sandbox. "dsn" is as defined in DBI.

target_dir (D)

Optional.

When using a "sandbox_class" for generating developer level database sandboxes, you may wish to place the sandbox in a directory other than the default (which is under the "share" directory off the project root).

SEE ALSO

DBIx::Class::Migration, DBIx::Class::Migration::Script, DBIx::Class::Migration::Features, DBIx::Class::Migration::Tutorial

AUTHOR

See DBIx::Class::Migration for author information

COPYRIGHT & LICENSE

See DBIx::Class::Migration for copyright and license information

2020-06-03 perl v5.38.2