David E. Wheeler > App-Sqitch > sqitch-rework

Download:
App-Sqitch-0.996.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

Name ^

sqitch-rework - Rework a database change

Synopsis ^

  sqitch [options] rework [<dependency-options>] name

Description ^

This command allows for the reworking of an existing database change. It is best used only under the following circumstances:

If all of these hold, then feel free to rework an existing change.

In effect, reworking a change is similar to adding one. However, rather than writing new files for the change, the rework command copies the files for the existing change. The new files are named with the tag that comes between the changes, and serves as the file for the original change. This leaves you free to edit the existing files.

Options ^

-r
--requires

Name of a change that is required by the new change. May be specified multiple times. See sqitchchanges for the various ways in which changes can be specified.

-c
--conflicts

Name of a change that conflicts with the new change. May be specified multiple times. See sqitchchanges for the various ways in which changes can be specified.

-n
--note

A brief note describing the purpose of the reworking. The note will be attached to the change as a comment. Multiple invocations will be concatenated together as separate paragraphs.

For you Git folks out there, -m also works.

-e
--edit
--open-editor

Open the generated change scripts in an editor.

--no-edit
--no-open-editor

Do not open the change scripts in an editor. Useful when rework.open_editor is true.

Configuration Variables ^

rework.open_editor

Boolean indicating if the rework command should spawn an editor after generating change scripts. When true, equivalent to passing --edit. Defaults off.

Sqitch ^

Part of the sqitch suite.

syntax highlighting: