John Napiorkowski > DBIx-Class-Migration-0.042 > DBIx::Class::Migration::Script::Help::install

Download:
DBIx-Class-Migration-0.042.tar.gz

Annotate this POD

Website

View/Report Bugs
Source   Latest Release: DBIx-Class-Migration-0.044

NAME ^

DBIx::Class::Migration::Script::Help::install - Install a migration version

SYNOPSIS ^

    dbic-migration install --schema_class MyApp::Schema --to_version 2

DESCRIPTION ^

Installs a prepared migration to either the current schema version or the target version specified via "to_version" to the database connected via the "dsn", "username" and "password" (or to a developer level sandbox as defined by the "sandbox_type").

You can't install to a database if the tables already exist. See drop_tables.

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

syntax highlighting: