data-migration-cli

A migration utility for AWS resources

• data-migration-cli
• Usage
• Commands

Usage

$ npm install -g data-migration-cli
$ migrate COMMAND
running command...
$ migrate (-v|--version|version)
data-migration-cli/2.10.2 linux-x64 node-v12.19.0
$ migrate --help [COMMAND]
USAGE
  $ migrate COMMAND
...

Commands

• migrate down [NUMBERTORUN]
• migrate help [COMMAND]
• migrate init
• migrate list
• migrate new NAME
• migrate reset
• migrate up

migrate down [NUMBERTORUN]

run down migration scripts

USAGE
  $ migrate down [NUMBERTORUN]

ARGUMENTS
  NUMBERTORUN  [default: 1] number of down scripts to execute

OPTIONS
  -h, --help               show CLI help
  --awsProfile=awsProfile  AWS Profile to use
  --config=config          [default: ./.dm.config.ts] Path to the configuration file
  --scope=scope            Script scope to use
  --stage=stage            Stage name to use

See code: lib/commands/down.js

migrate help [COMMAND]

display help for migrate

USAGE
  $ migrate help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

migrate init

Creates a basic configuration in the current directory

USAGE
  $ migrate init

OPTIONS
  -d, --directory=directory  [default: migrations] Path to migration directory
  -h, --help                 show CLI help
  --awsProfile=awsProfile    AWS Profile to use
  --config=config            [default: ./.dm.config.ts] Path to the configuration file
  --scope=scope              Script scope to use
  --stage=stage              Stage name to use

See code: lib/commands/init.js

migrate list

list all migration scripts and their status

USAGE
  $ migrate list

OPTIONS
  -h, --help               show CLI help
  -x, --extended           show extra columns
  --awsProfile=awsProfile  AWS Profile to use
  --columns=columns        only show provided columns (comma-separated)
  --config=config          [default: ./.dm.config.ts] Path to the configuration file
  --csv                    output is csv format [alias: --output=csv]
  --filter=filter          filter property by partial string matching, ex: name=foo
  --no-header              hide table header from output
  --no-truncate            do not truncate output to fit screen
  --output=csv|json|yaml   output in a more machine friendly format
  --scope=scope            Script scope to use
  --sort=sort              property to sort by (prepend '-' for descending)
  --stage=stage            Stage name to use

See code: lib/commands/list.js

migrate new NAME

Create a new migration script

USAGE
  $ migrate new NAME

OPTIONS
  -h, --help       show CLI help
  --config=config  [default: ./.dm.config.ts] Path to the configuration file
  --scope=scope    Script scope to use

See code: lib/commands/new.js

migrate reset

run all down migration scripts

USAGE
  $ migrate reset

OPTIONS
  -h, --help               show CLI help
  --awsProfile=awsProfile  AWS Profile to use
  --config=config          [default: ./.dm.config.ts] Path to the configuration file
  --scope=scope            Script scope to use
  --stage=stage            Stage name to use

See code: lib/commands/reset.js

migrate up

run all migration scripts

USAGE
  $ migrate up

OPTIONS
  -h, --help               show CLI help
  --awsProfile=awsProfile  AWS Profile to use
  --config=config          [default: ./.dm.config.ts] Path to the configuration file
  --scope=scope            Script scope to use
  --stage=stage            Stage name to use

See code: lib/commands/up.js