Non-Potable Macchiato

    dynamoman

    0.2.12 • Public • Published

    dynamoman - The Perfect AWS DynamoDB Manager

    Version Downloads Node MIT License

    Dynamoman is the perfect cli too to export and import data from AWS DynamoDB tables.

    It stores the data in the native DynamoDB Json format, so nothing is lost while importing.

    
    ████████    █████    ██ █████ ███    ███ ██████ ███    ███ █████ ███    ██
    ██   ████  ██ ████   ████   ██████  ██████    ██████  ██████   ██████   ██
    ██   ██ ████  ██ ██  ███████████ ████ ████    ████ ████ ███████████ ██  ██
    ██   ██  ██   ██  ██ ████   ████  ██  ████    ████  ██  ████   ████  ██ ██
    ██████   ██   ██   ██████   ████      ██ ██████ ██      ████   ████   ████
    
    
    

    Features

    • Easily export the dynamoDB table as JSON
    • Imports the data into any dynamoDB table
    • Export from one region and import in to another
    • Supports batch import (chunks of 25 records)
    • Supports Windows / Linux / Mac

    Installation

    You can use npm / yarn to install the cli

      npm install -g  dynamoman

    To verify the Installation

      dynamoman --help

    Documentation

    Getting started

    To get all details of the CLI use the help option

    dynamoman --help
    

    This will show a help screen

    Usage: dynamoman [options] [command]
    
    CLI to manage AWS DynamoDB Import & Export
    
    Options:
      -V, --version             display version
      -h, --help                display help for command
    
    Commands:
      export [options]          export data from an AWS DynamoDB table as JSON file
      import [options]          import data into an AWS DynamoDB table from a JSON file
      help [options] [command]  display help for command
    

    To view the help of a particular command use

    dynamoman <command> --help

    eg:

    dynamoman export --help
    
    
    Usage: dynamoman export [options]
    
    export data from an AWS DynamoDB table as JSON file
    
    Options:
      --region <aws_region>    Provide the AWS region if you want to overwrite the default one
      --log <log_level>        Log Level to user (choices: "Info", "Debug", "Trace", default: "Info")
      --force                  Forces any confirmation to default yes and proceed
      --file <target_file>     target json file
      --table <table>          Table to export
      --comment <description>  Any comments to include in the export (default: "")
      -h, --help               display help for command

    Configure AWS

    It is a prerequisite that you should configure the aws using the aws cli configure command

    aws configure
    

    Using this command setup the access key id and secret access key.

    You can also setup the default region during this step.

    Export a table

    Inorder to export a table you can use the following command

    dynamoman export --file output.json --table <mytable>
    

    Export options are

    Option Description
    --region <aws_region> Provide the AWS region if you want to overwrite the default one
    --log <log_level> Log Level to user (choices: "Info", "Debug", "Trace", default: "Info")
    --force Forces any confirmation to default yes and proceed
    --file <target_file> Target json file
    --table <table_name> Table to export
    --comment Any comments to include in the export (default: "")

    Import a table

    Inorder to import a table you can use the following command

    dynamoman import --file table_dump.json --table <mytable>
    

    Import options are

    Option Description
    --region <aws_region> Provide the AWS region if you want to overwrite the default one
    --log <log_level> Log Level to user (choices: "Info", "Debug", "Trace", default: "Info")
    --file <target_file> Source json file
    --table <table_name> Table to import

    Verify the exported JSON file

    Inorder to verify an exported json file use the following command

    dynamoman verify --file table_dump.json
    

    Verify options are

    Option Description
    --log <log_level> Log Level to user (choices: "Info", "Debug", "Trace", default: "Info")
    --file <target_file> source json file

    Contributing

    Contributions are always welcome!

    See contributing.md for ways to get started.

    Please adhere to this project's code of conduct.

    Roadmap

    • Export all tables to a zip
    • Import all tables from a zip

    Feedback

    If you have any feedback, please reach out to us at contact@vinodsr.com

    Install

    npm i dynamoman

    DownloadsWeekly Downloads

    101

    Version

    0.2.12

    License

    MIT

    Unpacked Size

    17.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • vinodsr