@elastictable/dynamodb-api
v1.5.0
Published
DynamoDB API generator
Downloads
7
Readme
DynamoDB API generator
DynamoDB-API, an open-source NodeJS CLI-tool for developing GraphQL APIs instantly on top of AWS's DynamoDB and AppSync.
It aims to simplify the effort required to model GraphQL APIs with a single-table design.
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 API] from npm (requires Node.js ≥ 10.13.0). Only Active LTS Node versions are supported.
$ npm i -g @elastictable/dynamodb-api
Usage
$ npm install -g @elastictable/dynamodb-api
$ dynamodb-api COMMAND
running command...
$ dynamodb-api (-v|--version|version)
@elastictable/dynamodb-api/1.5.0 linux-x64 node-v12.18.4
$ dynamodb-api --help [COMMAND]
USAGE
$ dynamodb-api COMMAND
...
Commands
dynamodb-api autocomplete [SHELL]
dynamodb-api generate FILE
dynamodb-api help [COMMAND]
dynamodb-api update [CHANNEL]
dynamodb-api autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ dynamodb-api autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ dynamodb-api autocomplete
$ dynamodb-api autocomplete bash
$ dynamodb-api autocomplete zsh
$ dynamodb-api autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
dynamodb-api generate FILE
Generate a DynamoDB API
USAGE
$ dynamodb-api generate FILE
ARGUMENTS
FILE The input definition file, that is used to generate a DynamoDB API definition.
OPTIONS
-a, --appsync Generate AppSync schema and resolvers.
-h, --help show CLI help
See code: src/src/commands/generate.ts
dynamodb-api help [COMMAND]
display help for dynamodb-api
USAGE
$ dynamodb-api help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
dynamodb-api update [CHANNEL]
update the dynamodb-api CLI
USAGE
$ dynamodb-api update [CHANNEL]
See code: @oclif/plugin-update