/ 
App-Sqitch-0.990
River stage one • 3 direct dependents • 3 total dependents

Changes for version 0.990 - 2014-01-04

  • New Features
    • Added new command and feature: `target`. Use it to manage multiple database targets, each with an associated URI and, optionally, a registry name and command-line client. Inspired by Git remotes.
    • Added Firebird engine. Three cheers to Ștefan Suciu for this contribution!
    • Added support for the generation of arbitrary scripts from templates to the `add` command. Just add template files to subdirectories of the `templates` directory, and scripts will be created in a directory of the same name based on those templates.
    • Added `--open-editor` option (and aliases) to the `add` and `rework` commands. This option will open the newly-added change scripts in the preferred editor. Thanks to Thomas Sibley for the patch!
  • Improvements
    • Improved database driver loading to ensure the proper version of the driver is required.
    • Non-fatal but possibly unexpected messages -- which correspond to exit value 1 -- now send their messages to STDOUT instead of STDERR, and respect the `--quiet` option. Thanks to @giorgio-v for the report!
    • Added or replaced the `--target` option to commands that connect to a database to specify the name of target managed by the new `target` command or a database URI.
    • `HEAD` and `ROOT` are now recognized as aliases for `@HEAD` and `@ROOT`, respectively, since they are disallowed as change names, anyway, and folks often use them out of habit from Git.
  • Internals
    • Replaced the engine-specific connection attributes with three attributes use by every engine:
      • `target`: The name of a target managed by the new `target` command. Defaults to a value stored for the `core.$engine.target` configuration variable. If that variable does not exist, the target falls back on the stringification of `uri`.
      • `uri`: a database URI with the format `db:{engine}:{dbname}` or `db:{engine}://{user}:{password}@{host}:{port}/{dbname}`. If its value is not passed to the constructor, a `uri` value is looked up for the associated `target`. If `target` is not passed or configured, or if it has no URI associated with it, the `config.$engine.uri` configuration variable is used. If that value does not exist, the URI defaults to `db:$engine:`. In any of these cases, if any of the `--db-*` options are passed, they will be merged into the URI.
      • `registry`: the name to use for the Sqitch registry schema or database, where Sqitch's own data will be stored, as appropriate to each engine. If its value is not passed to the constructor, a `registry` value is looked up for the associated `target`. If `target` is not passed or configured, or if it has no registry associated with it, the `config.$engine.registry` configuration variable is used. If no value is found there, it defaults to an engine-specific value, usually "sqitch".
  • Bug Fixes
    • Fixed a bug when installing under local::lib. Thanks to Thomas Sibley for the pull request!
    • Eliminated "Wide character in print" warnings when piping the `log` command.
    • Documented that reworked changes do not have their verify tests run by the `verify` command. They do run when using the `--verify` deploy option.
    • Removed the documentation for the `add.with_deploy`, `add.with_revert`, and `add.with_verify` configuration variables, which were never implemented.
  • Deprecations
    • Deprecated engine-specific connection attributes and configuration variables. See the "Internals" section for their replacements. The deprecated options are:
      • `core.$engine.username`
      • `core.$engine.password`
      • `core.$engine.db_name`
      • `core.$engine.host`
      • `core.$engine.port`
      • `core.$engine.sqitch_schema`
      • `core.$engine.sqitch_db`
    • Deprecated all command-specific options with the string "target" in them, such as `--to-target`, `--upto-target`, etc. They have been replaced with options containing the string "change", instead, such as `--to-change` and `--upto-change`. Few people used these options, preferring their shorter aliases (`--to`, `--upto`, etc.).
    • Deprecated the `--deploy-template`, `--revert-template`, and `--verify-template` options to the `add` command. They are replaced with a single option, `--use` which takes a key/value pair for the script name and template path. This makes it useful for arbitrary script generation, as well.
    • Deprecated the `--deploy`, `--revert`, and `--verify` options to the `add` command, as well as their `--no-*` variants. They are replaced with two new options, `--with` and `--without`, to which a script name is passed. These are useful for arbitrary script generation, as well.
    • Deprecated the `add.deploy_template`, `add.revert_template`, and `add.verify_template` configuration settings. They have been replaced with a section, `add.templates`, which is more general, and supports arbitrary script generation, as well.
  • Incompatibilities
    • Removed the undocumented `--test` option to the `add` command.
    • Changed the meaning of `--target` from specifying a change to specifying a deployment target. Use the new `--change` option to specify a change.

Documentation

sqitch-add-usage
Sqitch add usage statement
sqitch-add
Add a database change to the plan
sqitch-bundle-usage
Sqitch bundle usage statement
sqitch-bundle
Bundle a Sqitch project for distribution
sqitch-checkout-usage
Sqitch checkout usage statement
sqitch-checkout
Revert, checkout another VCS branch, and re-deploy changes
sqitch-config-usage
Sqitch config usage statement
sqitch-config
Get and set local, user, or system Sqitch options
sqitch-deploy-usage
Sqitch deploy usage statement
sqitch-deploy
Deploy changes to a database
sqitch-help-usage
Sqitch help usage statement
sqitch-help
Display help for Sqitch and Sqitch commands
sqitch-init-usage
Sqitch init usage statement
sqitch-init
Create a new Sqitch project
sqitch-log-usage
Sqitch log usage statement
sqitch-log
Show Sqitch change logs
sqitch-plan-usage
Sqitch plan usage statement
sqitch-plan
Show planned database changes
sqitch-rebase-usage
Sqitch rebase usage statement
sqitch-rebase
Revert and redeploy database changes
sqitch-revert-usage
Sqitch revert usage statement
sqitch-revert
Revert changes to a database
sqitch-rework-usage
Sqitch rework usage statement
sqitch-rework
Rework a database change
sqitch-show-usage
Sqitch show usage statement
sqitch-show
Show object information or change file contents
sqitch-status-usage
Sqitch status usage statement
sqitch-status
Show the current deployment status of a database
sqitch-tag-usage
Sqitch tag usage statement
sqitch-tag
Create or list tag objects
sqitch-target-usage
Sqitch target usage statement
sqitch-target
Mange set of target databases
sqitch-verify-usage
Sqitch verify usage statement
sqitch-verify
Verify deployed database changes
sqitch
Sane database change management
sqitchchanges
sqitchcommands
List of common sqitch commands
sqitchtutorial-firebird
A tutorial introduction to Sqitch change management on Firebird
sqitchtutorial-mysql
A tutorial introduction to Sqitch change management on MySQL
sqitchtutorial-oracle
A tutorial introduction to Sqitch change management on Oracle
sqitchtutorial-sqlite
A tutorial introduction to Sqitch change management on SQLite
sqitchtutorial
A tutorial introduction to Sqitch change management on PostgreSQL
sqitchusage
Sqitch usage statement

Modules

App::Sqitch
Sane database change management
App::Sqitch::Command
Sqitch Command support
App::Sqitch::Command::add
Add a new change to a Sqitch plan
App::Sqitch::Command::bundle
Bundle Sqitch changes for distribution
App::Sqitch::Command::checkout
Revert, change checkout a VCS branch, and redeploy
App::Sqitch::Command::config
Get and set local, user, or system Sqitch options
App::Sqitch::Command::deploy
Deploy Sqitch changes to a database
App::Sqitch::Command::help
Display help information about Sqitch
App::Sqitch::Command::init
Initialize a Sqitch project
App::Sqitch::Command::log
Show a database event log
App::Sqitch::Command::plan
List the changes in the plan
App::Sqitch::Command::rebase
Revert and redeploy Sqitch changes
App::Sqitch::Command::revert
Revert Sqitch changes from a database
App::Sqitch::Command::rework
Rework a Sqitch change
App::Sqitch::Command::show
Show Sqitch changes to a database
App::Sqitch::Command::status
Display status information about Sqitch
App::Sqitch::Command::tag
Add or list tags in a Sqitch plan
App::Sqitch::Command::target
Add, modify, or list Sqitch target databases
App::Sqitch::Command::verify
Verify deployed Sqitch changes
App::Sqitch::Config
Sqitch configuration management
App::Sqitch::DateTime
Sqitch DateTime object
App::Sqitch::Engine
Sqitch Deployment Engine
App::Sqitch::Engine::firebird
Sqitch Firebird Engine
App::Sqitch::Engine::mysql
Sqitch MySQL Engine
App::Sqitch::Engine::oracle
Sqitch Oracle Engine
App::Sqitch::Engine::pg
Sqitch PostgreSQL Engine
App::Sqitch::Engine::sqlite
Sqitch SQLite Engine
App::Sqitch::ItemFormatter
Format events and changes for command output
App::Sqitch::Plan
Sqitch Deployment Plan
App::Sqitch::Plan::Blank
Sqitch deployment plan blank line
App::Sqitch::Plan::Change
Sqitch deployment plan tag
App::Sqitch::Plan::ChangeList
Sqitch deployment plan change list
App::Sqitch::Plan::Depend
Sqitch dependency specification
App::Sqitch::Plan::Line
Sqitch deployment plan line
App::Sqitch::Plan::LineList
Sqitch deployment plan line list
App::Sqitch::Plan::Pragma
Sqitch deployment plan blank line
App::Sqitch::Plan::Tag
Sqitch deployment plan tag
App::Sqitch::Role::DBIEngine
An engine based on the DBI
App::Sqitch::Role::RevertDeployCommand
A command that reverts and deploys
App::Sqitch::X
Sqitch Exception class

Other files