https://github.com/thebenforce/dynamo-tools

CLI utilities for dynamodb
https://github.com/thebenforce/dynamo-tools

Last synced: 16 days ago
JSON representation

CLI utilities for dynamodb

• Host: GitHub
• URL: https://github.com/thebenforce/dynamo-tools
• Owner: theBenForce
• Created: 2020-02-27T14:12:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T19:44:03.000Z (about 2 years ago)
• Last Synced: 2025-02-05T02:58:14.325Z (16 days ago)
• Language: TypeScript
• Size: 529 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dynamo-tools

CLI tools for dynamodb

[![Build Status](https://travis-ci.org/theBenForce/dynamo-tools.svg?branch=master)](https://travis-ci.org/theBenForce/dynamo-tools)

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/dynamo-tools.svg)](https://npmjs.org/package/dynamo-tools)

[![Downloads/week](https://img.shields.io/npm/dw/dynamo-tools.svg)](https://npmjs.org/package/dynamo-tools)

[![Maintainability](https://api.codeclimate.com/v1/badges/94c18ce4c845c77847bb/maintainability)](https://codeclimate.com/github/theBenForce/dynamo-tools/maintainability)

[![License](https://img.shields.io/npm/l/dynamo-tools.svg)](https://github.com/theBenForce/dynamo-tools/blob/master/package.json)

* [dynamo-tools](#dynamo-tools)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g dynamo-tools

$ ddb COMMAND

running command...

$ ddb (-v|--version|version)

dynamo-tools/0.0.0 darwin-x64 node-v12.13.1

$ ddb --help [COMMAND]

USAGE

  $ ddb COMMAND

...

```

# Commands

* [`ddb backup [FILE]`](#ddb-backup-file)

* [`ddb copy`](#ddb-copy)

* [`ddb delete [FILE]`](#ddb-delete-file)

* [`ddb help [COMMAND]`](#ddb-help-command)

## `ddb backup [FILE]`

Backup all entries in a dynamodb table to a file

```

USAGE

  $ ddb backup [FILE]

ARGUMENTS

  FILE  Path to write the backup to.

OPTIONS

  -h, --help             show CLI help

  --batchSize=batchSize  [default: 100] The number of items to copy at a time

  --region=region        (required) AWS region that the DynamoDB is hosted in

  --source=source        (required) Name of the DynamoDB to copy entries from

```

_See code: [src/commands/backup.ts](https://github.com/theBenForce/dynamo-tools/blob/v0.0.0/src/commands/backup.ts)_

## `ddb copy`

Copy the contents of one dynamodb table to another

```

USAGE

  $ ddb copy

OPTIONS

  -h, --help                               show CLI help

  --batchSize=batchSize                    [default: 25] The number of items to copy at a time

  --destination=destination                (required) Destination table name

  --destinationProfile=destinationProfile  AWS Credentials profile to copy to

  --destinationRegion=destinationRegion    Region of destination table

  --region=region                          Region for both source and destination tables

  --source=source                          (required) Source table name

  --sourceProfile=sourceProfile            AWS Credentials profile to copy from

  --sourceRegion=sourceRegion              Region of source table

```

_See code: [src/commands/copy.ts](https://github.com/theBenForce/dynamo-tools/blob/v0.0.0/src/commands/copy.ts)_

## `ddb delete [FILE]`

describe the command here

```

USAGE

  $ ddb delete [FILE]

OPTIONS

  -h, --help       show CLI help

  --region=region  (required) AWS region that the DynamoDB is hosted in

  --target=target  (required) Name of the DynamoDB table to delete records from

```

_See code: [src/commands/delete.ts](https://github.com/theBenForce/dynamo-tools/blob/v0.0.0/src/commands/delete.ts)_

## `ddb help [COMMAND]`

display help for ddb

```

USAGE

  $ ddb help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_