David E. Wheeler > App-Sqitch-0.953 > App::Sqitch::Engine::pg

Download:
App-Sqitch-0.953.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.953   Source   Latest Release: App-Sqitch-0.992

Name ^

App::Sqitch::Engine::pg - Sqitch PostgreSQL Engine

Synopsis ^

  my $pg = App::Sqitch::Engine->load( engine => 'pg' );

Description ^

App::Sqitch::Engine::pg provides the PostgreSQL storage engine for Sqitch.

Interface ^

Class Methods

config_vars

  my %vars = App::Sqitch::Engine::pg->config_vars;

Returns a hash of names and types to use for variables in the core.pg section of the a Sqitch configuration file. The variables and their types are:

  client        => 'any'
  username      => 'any'
  password      => 'any'
  db_name       => 'any'
  host          => 'any'
  port          => 'int'
  sqitch_schema => 'any'

Instance Methods

initialized

  $pg->initialize unless $pg->initialized;

Returns true if the database has been initialized for Sqitch, and false if it has not.

initialize

  $pg->initialize;

Initializes a database for Sqitch by installing the Sqitch metadata schema.

Author ^

David E. Wheeler <david@justatheory.com>

License ^

Copyright (c) 2012-2013 iovation Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

syntax highlighting: