goety

README

goety

goety is a small cli to help with common actions when working with dynamodb.

Purge tables, dump data into a json file, seed tables from json file.

Install

Using golang

go install github.com/code-gorilla-au/goety@latest

Usage

goety 

Power tools to interact with dynamodb tables

Usage:
  goety [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  dump        dump the contents of a dynamodb to a file
  help        Help about any command
  purge       purge a dynamodb table of all items
  seed        seed a dynamodb table from file

Flags:
  -r, --aws-region string   aws region the table is located (default "ap-southeast-2")
  -d, --dry-run             dry run does not perform actions, only logs them
  -h, --help                help for goety
  -v, --verbose             add verbose logging

Use "goety [command] --help" for more information about a command.

Purge

goety purge -h

Usage:
  goety purge -t [TABLE_NAME] -p [PARTITION_KEY] -s [SORT_KEY] [flags]

Flags:
  -e, --endpoint string        DynamoDB endpoint to connect to, if none is provide it will use the default aws endpoint
  -h, --help                   help for purge
  -p, --partition-key string   The name of the partition key (default "pk")
  -s, --sort-key string        The name of the sort key (default "sk")
  -t, --table string           table name

Global Flags:
  -r, --aws-region string   aws region the table is located (default "ap-southeast-2")
  -d, --dry-run             dry run does not perform actions, only logs them
  -v, --verbose             add verbose logging

Dump

dump will scan all items within a dynamodb table and write the contents to a file

Usage:
  goety dump -t [TABLE_NAME] [flags]

Flags:
  -N, --attribute-name string    Filter expression attribute names
  -V, --attribute-value string   Filter expression attribute values
  -a, --attributes strings       Optionally specify a list of attributes to extract from the table
  -e, --endpoint string          DynamoDB endpoint to connect to, if none is provide it will use the default aws endpoint
  -f, --filter string            Filter expression to apply to the scan operation
  -h, --help                     help for dump
  -l, --limit int32              Limit the number of items returned per scan iteration
  -P, --path string              file path to save the json output
  -t, --table string             table name

Global Flags:
  -r, --aws-region string   aws region the table is located (default "ap-southeast-2")
  -d, --dry-run             dry run does not perform actions, only logs them
  -v, --verbose             add verbose logging

Seed

seed will read a json file and write the contents to a dynamodb table

Usage:
  goety seed -t [TABLE_NAME] -f [FILE_PATH] [flags]

Flags:
  -e, --endpoint string   DynamoDB endpoint to connect to, if none is provide it will use the default aws endpoint
  -f, --file string       File path
  -h, --help              help for seed
  -t, --table string      Table name

Global Flags:
  -r, --aws-region string   aws region the table is located (default "ap-southeast-2")
  -d, --dry-run             dry run does not perform actions, only logs them
  -v, --verbose             add verbose logging

Basic usage

getting started.

# short flags
goety purge -t <table-name> -p <partition-key> -s <sort-key>
# with long flags
goety purge --table <table-name> --partition-key <partition-key> --sort-key <sort-key>

Dry run

The dry run flag does not perform purge, it logs what items will be deleted to standard out.

# short flags
goety purge -t <table-name> -p <partition-key> -s <sort-key> -d
# with long flags
goety purge --table <table-name> --partition-key <partition-key> --sort-key <sort-key> --dry-run

Verbose

Add additional logs to the output.

# short flags
goety purge -t <table-name> -p <partition-key> -s <sort-key> -v
# with long flags
goety purge --table <table-name> --partition-key <partition-key> --sort-key <sort-key> --verbose