Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages
Mojo::Pg::Migrations(3) User Contributed Perl Documentation Mojo::Pg::Migrations(3)

Mojo::Pg::Migrations - Migrations

  use Mojo::Pg::Migrations;
  my $migrations = Mojo::Pg::Migrations->new(pg => $pg);

Mojo::Pg::Migrations is used by Mojo::Pg to allow database schemas to evolve easily over time. A migration file is just a collection of sql blocks, with one or more statements, separated by comments of the form "-- VERSION UP/DOWN".
  -- 1 up
  create table messages (message text);
  insert into messages values ('I ♥ Mojolicious!');
  -- 1 down
  drop table messages;
  -- 2 up ( can comment freely here...)
  create table stuff (whatever int);
  -- 2 down
  drop table stuff;
The idea is to let you migrate from any version, to any version, up and down. Migrations are very safe, because they are performed in transactions and only one can be performed at a time. If a single statement fails, the whole migration will fail and get rolled back. Every set of migrations has a "name", which is stored together with the currently active version in an automatically created table named "mojo_migrations".

Mojo::Pg::Migrations implements the following attributes.

  my $name    = $migrations->name;
  $migrations = $migrations->name('foo');
Name for this set of migrations, defaults to "migrations".

  my $pg      = $migrations->pg;
  $migrations = $migrations->pg(Mojo::Pg->new);
Mojo::Pg object these migrations belong to. Note that this attribute is weakened.

Mojo::Pg::Migrations inherits all methods from Mojo::Base and implements the following new ones.

  my $version = $migrations->active;
Currently active version.

  $migrations = $migrations->from_data;
  $migrations = $migrations->from_data('main');
  $migrations = $migrations->from_data('main', 'file_name');
Extract migrations from a file in the DATA section of a class with "data_section" in Mojo::Loader, defaults to using the caller class and "name".
  @@ migrations
  -- 1 up
  create table messages (message text);
  insert into messages values ('I ♥ Mojolicious!');
  -- 1 down
  drop table messages;

  $migrations = $migrations->from_file('/home/sri/migrations.sql');
Extract migrations from a file.

  $migrations = $migrations->from_string(
    '-- 1 up
     create table foo (bar int);
     -- 1 down
     drop table foo;'
Extract migrations from string.

  my $version = $migrations->latest;
Latest version available.

  $migrations = $migrations->migrate;
  $migrations = $migrations->migrate(3);
Migrate from "active" to a different version, up or down, defaults to using "latest". All version numbers need to be positive, with version 0 representing an empty database.
  # Reset database

  my $sql = $migrations->sql_for(5, 10);
Get SQL to migrate from one version to another, up or down.

You can set the "MOJO_MIGRATIONS_DEBUG" environment variable to get some advanced diagnostics information printed to "STDERR".

Mojo::Pg, Mojolicious::Guides, <>.
2018-11-22 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.