The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-Sqitch-0.997
River stage one • 2 direct dependents • 2 total dependents
43 ++

Changes for version 0.997 - 2014-11-04

  • New Features
    • Added support for new target properties. In addition to the existing `uri`, `client`, and `registry` properties, targets may also configure these properties via the new `--set` option to and `set-*` actions on the `target` command:
      • `top_dir`
      • `plan_file`
      • `extension`
      • `deploy_dir`
      • `revert_dir`
      • `verify_dir`
    • Added support for new engine configuration variables. In addition to the existing `target`, `client`, and `registry` variables, engine configuration may also include these variables:
      • `top_dir`
      • `plan_file`
      • `extension`
      • `deploy_dir`
      • `revert_dir`
      • `verify_dir`
    • Rationalized the hierarchical configuration of deployment targets. The properties of any given target will now be determined by examining values in the following order:
      • Command-line options
      • Target configuration
      • Engine configuration
      • Core configuration
      • Reasonable engine-specific defaults
    • Added the `engine` command to simplify engine configuration. This complements the newly-improved `target` command. Run `sqitch engine update-config` to update deprecated engine configurations and start using it.
    • Added the sqitch-configuration guide to provide an overview of core, engine, and target configuration. Includes some use-case examples and best suggested practices.
  • Improvements
    • Simplified the output of `sqitch help`, and added the more important options to it.
    • Added the `--guide` option to `sqitch help` to list Sqitch guides.
    • Renamed the `--db-client` option to `--client`. `--db-client` still works, but is deprecated.
    • Added the `--registry` core option for parity with `--client`, `--top-dir`, `--plan-file`, and the rest of the hierarchical configuration properties.
    • Updated the `init` documentation to better cover all the options processed.
    • Incremented the version plan file format version to v1.0.0. No changes; it has been stable for at least a year, so it's time.
  • Bug Fixes
    • At runtime, the Vertica engine now properly requires DBD::ODBC instead of DBD::Pg.
    • The Vertica engine now supports Vertica 6, as documented.
    • Fixed a warning from Type::Utils, thanks to a report from Géraud CONTINSOUZAS.
    • The `status` command once again notices if the specified database is uninitialized and says as much, rather than dying with an SQL error.
    • The `--etc-path` option works again.
  • Deprecations
    • Deprecated `core.$engine` configuration in favor of `engine.$engine`. A warning will be emitted if Sqitch sees the former. Run `sqitch engine update-config` to update your configurations. Existing `core.$engine` configurations will be left in place for compatibility with older versions of Sqitch, but the `sqitch engine` command will not modify them, so they can get out-of-sync. Run `sqitch config --remove-section core.$engine` to remove them.
    • Formally deprecated the database connection options in favor of target URIs. If any of these options is used, a warning will be issued. They will be dropped in v1.0:
      • `--db-host`
      • `--db-port`
      • `--db-username`
      • `--db-password`
      • `--db-name`
    • Formally deprecated the database connection configuration variables in favor of target URIs. If any of these variables is used, a warning will be issued. Run `sqitch engine update-config` to update your configurations. Existing `core.$engine` configurations will be left in place for compatibility with older versions of Sqitch, but the `sqitch engine` command will not modify them, so they can get out-of-sync. Run `sqitch config --remove-section core.$engine` to remove them. Sqitch will cease to support them in v1.0:
      • `core.$engine.host`
      • `core.$engine.port`
      • `core.$engine.username`
      • `core.$engine.password`
      • `core.$engine.db_name`
    • Deprecated the `--registry` and `--client` options of the `target` command. All target properties should now be set via the new `--set` option, such as `--set registry=reg`.
    • Formally deprecated the following options of the `add` command. They have been replaced with the `--with`, `--without`, and `--use` options since v0.991. Their use will emit a warning, and they will be removed in v1.0:
      • `--deploy-template`
      • `--revert-template`
      • `--verify-template`
      • `--deploy`
      • `--no-deploy`
      • `--revert`
      • `--no-revert`
      • `--verify`
      • `--no-verify`
    • Dropped support for the long-deprecated (and likely never used outside ancient tests long deleted) engine configuration variables `core.sqlite.sqitch_db` and `core.pg.sqitch_schema`. Both have been replaced with `engine.$engine.registry`, which applies to all engines.
    • Formally deprecated the `@FIRST` and `@LAST` symbolic tags. Their use will trigger a warning to use `@ROOT` and `@HEAD`, instead. They will be removed in v1.0.
  • Internals
    • Moved target and engine configuration from App::Sqitch and App::Sqitch::Engine to a new class, App::Sqitch::Target. This class is solely responsible for finding the appropriate values for attributes on every run. The target knows what plan and engine to use, based on those properties. App::Sqitch is now responsible solely for encapsulating command-line options, configuration, and utilities. Classes are now responsible for instantiating both an App::Sqitch and App::Sqitch::Target options as appropriate.
    • Updated all classes to create both Sqitch and Target objects as appropriate. This change touched almost every class.
    • Replaced attributes in App::Sqitch that were previously set from command-line options or configuration with a single attribute, `options`, which is a hash only of the command-line options. Classes are now responsible for finding the proper values in config or options. Mostly this requirement is encapsulated by the new App::Sqitch::Target class.
    • Updated the command classes to use either a "default target" derived from command-line options, engine configuration, and core configuration, or a target looked up by name in the configuration maintained by the `target` command.

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-configuration
Hierarchical engine and target configuration
sqitch-deploy-usage
Sqitch deploy usage statement
sqitch-deploy
Deploy changes to a database
sqitch-engine-usage
Sqitch engine usage statement
sqitch-engine
Manage database engine configuration
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
Manage target database configuration
sqitch-verify-usage
Sqitch verify usage statement
sqitch-verify
Verify deployed database changes
sqitch
Sane database change management
sqitchchanges
Specifying changes for Sqitch
sqitchcommands
List of common sqitch commands
sqitchguides
List of common Sqitch guides
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 Vertica
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::engine
Add, modify, or list Sqitch database engines
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::Engine::vertica
Sqitch Vertica 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::Target
Sqitch deployment target
App::Sqitch::Types
Definition of attribute data types
App::Sqitch::X
Sqitch Exception class

Other files