Scroll to navigation

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

NAME

DBIx::Class::Migration::Script::Help::diagram - create a PNG of you database structure

SYNOPSIS

    dbic-migration diagram -Ilib --schema_class MyApp::Schema

DESCRIPTION

Experimental feature. This command will place a file in your "target_dir" called "db-diagram-vXXX.png" where "XXX" is he current "schema" version.

This feature is experimental and currently does not offer any options.

OPTIONS

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

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 String.

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.

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.40.0