/ 
App-Sqitch-0.11-TRIAL
River stage one • 3 direct dependents • 3 total dependents
/ App::Sqitch

Name

App::Sqitch - VCS-powered SQL change management

Synopsis

user App::Sqitch;
exit App::Sqitch->go;

Description

This module provides the implementation for sqitch. You probably want to read its documentation, or the tutorial. Unless you want to hack on Sqitch itself, or provide support for a new engine or command. In which case, you will find this API documentation useful.

Interface

Class Methods

go

App::Sqitch->go;

Called from sqitch, this class method parses command-line options and arguments in @ARGV, parses the configuration file, constructs an App::Sqitch object, constructs a command object, and runs it.

Constructor

new

my $sqitch = App::Sqitch->new(\%params);

Constructs and returns a new Sqitch object. The supported parameters include:

plan_file
engine
client
db_name
username
host
port
sql_dir
deploy_dir
revert_dir
test_dir
extension
dry_run
editor
verbosity

Accessors

plan_file

engine

client

db_name

username

host

port

sql_dir

deploy_dir

revert_dir

test_dir

extension

dry_run

editor

config

my $config = $sqitch->config;

Returns the full configuration, combined from the project, user, and system configuration files.

verbosity

Author

David E. Wheeler <david@justatheory.com>

License

Copyright (c) 2012 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.