@elastictable/dynamodb-schema
v1.2.0
Published
DynamoDB schema generator
Downloads
4
Readme
DynamoDB schema generator
About
This project combines the various articles, best practices and tutorials written about DynamoDB's single-table design and automates the modeling process in a user-friendly tool.
Installation
Install or update [DynamoDB Schema] from npm (requires Node.js ≥ 10.13.0). Only Active LTS Node versions are supported.
$ npm i -g @elastictable/dynamodb-schema
Usage
$ npm install -g @elastictable/dynamodb-schema
$ dynamodb-schema COMMAND
running command...
$ dynamodb-schema (-v|--version|version)
@elastictable/dynamodb-schema/1.2.0 linux-x64 node-v12.18.3
$ dynamodb-schema --help [COMMAND]
USAGE
$ dynamodb-schema COMMAND
...
Commands
dynamodb-schema autocomplete [SHELL]
dynamodb-schema generate
dynamodb-schema help [COMMAND]
dynamodb-schema update [CHANNEL]
dynamodb-schema autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ dynamodb-schema autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ dynamodb-schema autocomplete
$ dynamodb-schema autocomplete bash
$ dynamodb-schema autocomplete zsh
$ dynamodb-schema autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
dynamodb-schema generate
Generate a DynamoDB schema
USAGE
$ dynamodb-schema generate
OPTIONS
-f, --file=file (required) The input definition file, that is used to generate a DynamoDB schema definition.
-h, --help show CLI help
See code: src/src/commands/generate.ts
dynamodb-schema help [COMMAND]
display help for dynamodb-schema
USAGE
$ dynamodb-schema help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
dynamodb-schema update [CHANNEL]
update the dynamodb-schema CLI
USAGE
$ dynamodb-schema update [CHANNEL]
See code: @oclif/plugin-update