lsdy

README

Overview

lsdy is a tool for querying DynamoDB tables. It will attempt to display the values in a tabular form using all available attributes (by default, alphabetical order, left to right), unless specified. If --pk is specified, it will query the table with that specific primary key. For tables with sort keys, only string-based sort keys are supported at the moment. When the --sk flag is supplied, it will query all sort keys that begins with the flag value. An empty primary key implies a table scan.

Installation

Using Homebrew:

$ brew tap flowerinthenight/tap
$ brew install lsdy

If you have a Go environment:

$ go get -u -v github.com/flowerinthenight/lsdy

Usage

# Minimal usage:
$ lsdy TABLE_NAME

# For a more updated help information:
$ lsdy -h

To authenticate to AWS, this tool looks for the following environment variables (can be set by cmdline args as well):

AWS_REGION
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY

# Optional:
ROLE_ARN

# When ROLE_ARN is set, it will assume this role using the provided key/secret pair.

To query a table using a primary key:

# Query table with primary key 'id' value of 'ID0001':
$ lsdy TABLE_NAME --pk "id:ID0001"

To query a table using both a primary key and a sort key:

# Query table with primary key 'id' value of 'ID0001' and sort key 'sortkey' of SK002:
$ lsdy TABLE_NAME --pk "id:ID0001" --sk "sortkey:SK002"

To query a table using multiple primary keys and optional sort key pair(s):

# Multiple primary keys only:
$ lsdy TABLE_NAME --pk "id:ID0001,id:ID0002,id:ID9999"

# Multiple primary keys with corresponding sort keys:
$ lsdy TABLE_NAME --pk "id:ID0001,id:ID0002,id:ID9999" --sk "sortkey:AAA,sortkey:BBB,sortkey:CCC"

# Multiple primary keys with only the first pk having a sortkey pair:
$ lsdy TABLE_NAME --pk "id:ID0001,id:ID0002,id:ID9999" --sk "sortkey:AAA"

To scan a table:

# All attributes (columns) will be queried:
$ lsdy TABLE_NAME

# If you want specific attributes (unsorted columns):
$ lsdy TABLE_NAME --attr "col1,col2,col3" --nosort

# or you can write it this way (sorted columns):
$ lsdy TABLE_NAME --attr col1 --attr col2 --attr col3

If you want to describe a table:

# Will output the table details and all its attributes/columns:
$ lsdy TABLE_NAME --describe

By default, the length of all cell items in the output table are concatenated up to --maxlen.