aurora-migrate

Helper CLI to run db-migrate using cloudformation stacks

• Usage
• Commands

Usage

$ npm install -g aurora-migrate
$ aurora-migrate COMMAND
running command...
$ aurora-migrate (-v|--version|version)
aurora-migrate/0.1.11 linux-x64 node-v12.8.0
$ aurora-migrate --help [COMMAND]
USAGE
  $ aurora-migrate COMMAND
...

Commands

• aurora-migrate create-env [FILE]
• aurora-migrate enable-data-api
• aurora-migrate help [COMMAND]
• aurora-migrate run [COMMAND]
• aurora-migrate setup

aurora-migrate create-env [FILE]

Create a .env file in the current directory

USAGE
  $ aurora-migrate create-env [FILE]

OPTIONS
  -h, --help           show CLI help
  -s, --stack=stack    (required) Name of the CloudFormation stack to reference
  --database=database  Database in the cluster to connect to
  --region=region      (required) [default: us-east-1] The aws region to connect to
  --resource=resource  (required) Name of the stack output containing an ARN of the Aurora cluster
  --schema=schema      Schema in the database to run operations on
  --secret=secret      (required) Name of the stack output containing an ARN of the secret store with RDS information

See code: src/commands/create-env.ts

aurora-migrate enable-data-api

describe the command here

USAGE
  $ aurora-migrate enable-data-api

OPTIONS
  -h, --help           show CLI help
  -s, --stack=stack    (required) Name of the CloudFormation stack to reference
  --region=region      (required) [default: us-east-1] The aws region to connect to
  --resource=resource  (required) Name of the stack output containing an ARN of the Aurora cluster

See code: src/commands/enable-data-api.ts

aurora-migrate help [COMMAND]

display help for aurora-migrate

USAGE
  $ aurora-migrate help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

aurora-migrate run [COMMAND]

Executes a db-migrate command

USAGE
  $ aurora-migrate run [COMMAND]

ARGUMENTS
  COMMAND  The command that will be passed on to db-migrate

OPTIONS
  -h, --help           show CLI help
  -s, --stack=stack    (required) Name of the CloudFormation stack to reference
  --database=database  Database in the cluster to connect to
  --region=region      (required) [default: us-east-1] The aws region to connect to
  --resource=resource  (required) Name of the stack output containing an ARN of the Aurora cluster
  --schema=schema      Schema in the database to run operations on
  --secret=secret      (required) Name of the stack output containing an ARN of the secret store with RDS information

See code: src/commands/run.ts

aurora-migrate setup

Generate a basic database.json that will connect to aurora

USAGE
  $ aurora-migrate setup

OPTIONS
  -e, --environment=environment  [default: prod] The name of the environment to create.
  --file=file                    [default: database.json] Where the config will be saved.

See code: src/commands/setup.ts