Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DBIx::Class::MigratiDBUserCContributedtPerl:Dccupentation:install_if_needed(3)

NAME
       DBIx::Class::Migration::Script::Help::install_if_needed - Install a
       migration only if needed

SYNOPSIS
	   dbic-migration install_if_needed --schema_class MyApp::Schema

DESCRIPTION
       Install the database to the current $schema version if it is not
       currently installed.  Otherwise this is a nop (even if the database is
       behind the schema).

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.

   to_version
       aliases:V, Optional

       This is the target version of the database we are installing.  The
       version named must be have been previously prepared.  If	not specified,
       we will use the current "Schema"	class version.

   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.

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

   sandbox_class
       Aliases:	T, sb

       Accepts:	String (default: SqliteSandbox)

       The class we use	to create a developer level database sandbox.

       You can change this to either 'PostgresqlSandbox' or 'MySQLSandbox',
       which will create a sandbox using either
       DBIx::Class::Migration::MySQLSandbox or
       DBIx::Class::Migration::PostgresqlSandbox.

   user
       Aliases:	U

   password
       Aliases:	P

   dsn
       Connection information to an already created and	running	instance of a
       database.  If you don't specify this, we	will assume you	want a
       developer level sandbox ( See "sandbox").

   dbic_fixture_class
       Accepts:	String to a Perl Class.	 Defaults to DBIx::Class::Fixtures

       Lets you	specify	a fixture class.

   dbic_fixtures_extra_args
       Accepts:	HashRef.  Optional

       Allows you to pass custom arguments to DBIx::Class::Fixtures.

   dbic_connect_attrs
   dbi_connect_attrs
       Accepts:	HashRef, Optional

       Lets you	send custom attributes at "connect" time to either DBIx::Class
       or the underlying DBI and your storage "DBD".

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

perl v5.24.1	    DBIx::Class::Migration::Script::Help::install_if_needed(3)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | SEE ALSO | AUTHOR | COPYRIGHT & LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=DBIx::Class::Migration::Script::Help::install_if_needed&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help