6. amps_upgrade¶
New versions of AMPS periodically change the format of the data files
AMPS uses. The amps_upgrade utilty upgrades datafiles from previous
versions of AMPS to the current version. amps_upgrade supports
upgrades from version 3.0.3 or later instances to current instances of AMPS.
For upgrading from versions 5.0.0.0 or later to this release of AMPS,
amps_upgrade is not necessary.
Options and Parameters¶
| Option | Description |
|---|---|
--verbose
|
Print additional details on each operation to stdout |
--trace
|
Print the operations that amps_upgrade performs to
stdout. |
Table 6.1: Options for amps_upgrade
| Option | Description |
|---|---|
--from=BASE
|
The root directory of the AMPS installation being
migrated. This is the directory in which you usually
start the ampServer process. Any relative paths in
the config file will be evaluated relative to this
directory. |
--config=CONFIG
|
The xml configuration file for the AMPS server being migrated. |
--work-dir=WORK_DIR
|
The working directory from which the ampServer is
invoked. |
--tmp-dir=TMP_DIR
|
The temporary directory where upgrade files are written
while the upgrade process is underway. If this directory
does not exist, it will be created. amps_upgrade
will fail without changing any existing files if this
directory already exists and contains files from a
previous migration. |
Table 6.2: Instance parameters for amps_upgrade
| Option | Description |
|---|---|
--check-current
|
Returns true if the instance is the same version as the
amps_migrate utility, with no upgrade needed |
--dry-run
|
Step through the entire upgrade process, printing
activity, without making changes. Returns false if
errors are encountered or upgrade is impossible. |
--upgrade
|
Upgrade the instance, returning false if the upgrade is impossible or the upgrade process fails. |
-h, --help
|
Show usage information and exit. |
--version
|
Show the program’s version number and exit. |
Table 6.3: Actions for amps_upgrade
Usage¶
Simply upgrade an AMPS instance that’s executed in the /amps/server directory from another version to this version, storing temporary files in the /amps/tmp directory:
$ amps_upgrade --from=/amps --config=/amps/config.xml --work-dir=/amps/server --tmp-dir=/amps/tmp --upgrade
Try out a migration without actually committing the changes to your AMPS instance:
$ amps_upgrade --from=/amps --config=/amps/config.xml --work-dir=/amps/server --tmp-dir=/amps/tmp --dry-run
Check to see if your AMPS instance is current:
$ amps_upgrade --from=/amps --config=/amps/config.xml --work-dir=/amps/server --tmp-dir=/amps/tmp --check-current