Skip to content

bruceadams/query-rds-data

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Query AWS RDS Data from the command line

Build Status Contributor Covenant Apache License Github Release Crates.io

Installing

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/bruceadams/query-rds-data/releases/latest/download/query-rds-data-installer.sh | sh

Install prebuilt binaries via powershell script

irm https://github.com/bruceadams/query-rds-data/releases/latest/download/query-rds-data-installer.ps1 | iex

Install prebuilt binaries into your npm project

npm install query-rds-data

or install and run the binary using npx

npx query-rds-data --help

Install prebuilt binaries via Homebrew

brew install bruceadams/homebrew-utilities/query-rds-data

Install prebuilt binaries via cargo binstall

cargo binstall query-rds-data

Download

File Platform Checksum
query-rds-data-aarch64-apple-darwin.tar.gz macOS Apple Silicon checksum
query-rds-data-x86_64-apple-darwin.tar.gz macOS Intel checksum
query-rds-data-x86_64-pc-windows-msvc.zip Windows x64 checksum
query-rds-data-x86_64-unknown-linux-gnu.tar.gz Linux x64 checksum
query-rds-data-x86_64-unknown-linux-musl.tar.gz musl Linux x64 checksum
query-rds-data-x86_64-pc-windows-msvc.msi Windows x64 checksum

Building

This is a straightforward Rust project using Cargo. After installing Rust (I highly recommend using Rustup), cargo build should just work.

Built-in help

$ cargo build  # The first build takes longer, with more output
    Finished dev [unoptimized + debuginfo] target(s) in 0.22s
$ target/debug/query-rds-data --help
Query AWS RDS Data from the command line

You can set the environment variable `RUST_LOG` to adjust
logging, for example `RUST_LOG=trace query-rds-data`.

Usage: query-rds-data [OPTIONS] <QUERY>

Arguments:
  <QUERY>
          SQL query

Options:
  -p, --profile <PROFILE>
          AWS source profile to use. This name references an
          entry in ~/.aws/config

          [env: AWS_PROFILE=]

  -r, --region <REGION>
          AWS region to target

          [env: AWS_REGION=]

  -c, --db-cluster-identifier <CLUSTER_ID>
          RDS cluster identifier

          [env: AWS_RDS_CLUSTER=]

  -u, --db-user-identifier <USER_ID>
          RDS user identifier (really the AWS secret identifier)

          [env: AWS_RDS_USER=]

  -f, --format <FORMAT>
          Output format

          [default: csv]

          Possible values:
          - csv:  CSV output, including a header line
          - json: A JSON Object. For example:
            {"numberOfRecordsUpdated": 0, "records": [{"id": 1,
            "name": "bruce", "amount": 0.05}]}

  -d, --database <DATABASE>
          Database name

          [env: AWS_RDS_DATABASE=]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Error messages

I hope that the error messages from query-rds-data are helpful for figuring out what went wrong and how to address the issue.

# No RDS instances exist
$ query-rds-data "select * from db1.names"
Error: No DBs found
$ query-rds-data "select * from db1.names" --db-cluster-identifier nope
Error: No DB matched "nope", available ids are []

# Single RDS instance exists
$ query-rds-data "select * from db1.names" --db-cluster-identifier nope
Error: No DB matched "nope", available ids are ["demo"]

# No credentials in AWS Secrets Manager
$ query-rds-data "select * from db1.names"
Error: No DB user secrets found
$ query-rds-data "select * from db1.names" --db-user-identifier fake
Error: No DB user matched "fake", available users are []

# Single secret exists for this database
$ query-rds-data "create database db1"
""
$ query-rds-data "create table db1.names (id int, name varchar(64))"
""
$ query-rds-data "insert into db1.names values (1,'Bruce')"
""
$ query-rds-data "select * from db1.names"
id,name
1,Bruce
$ query-rds-data "select * from information_schema.tables where table_schema='db1'"
TABLE_CATALOG,TABLE_SCHEMA,TABLE_NAME,TABLE_TYPE,ENGINE,VERSION,ROW_FORMAT,TABLE_ROWS,AVG_ROW_LENGTH,DATA_LENGTH,MAX_DATA_LENGTH,INDEX_LENGTH,DATA_FREE,AUTO_INCREMENT,CREATE_TIME,UPDATE_TIME,CHECK_TIME,TABLE_COLLATION,CHECKSUM,CREATE_OPTIONS,TABLE_COMMENT
def,db1,names,BASE TABLE,InnoDB,10,Compact,0,0,16384,0,0,0,NULL,NULL,NULL,NULL,latin1_swedish_ci,NULL,,

# Explicit cluster and user names can be used
$ query-rds-data "select * from db1.names" --db-cluster-identifier demo
id,name
1,Bruce
$ query-rds-data "select * from db1.names" --db-user-identifier admin
id,name
1,Bruce
$ query-rds-data "select * from db1.names" --db-cluster-identifier demo --db-user-identifier admin
id,name
1,Bruce

# Names that are not found list what is available to be selected
$ query-rds-data "select * from db1.names" --db-cluster-identifier nope
Error: No DB matched "nope", available ids are ["demo"]
$ query-rds-data "select * from db1.names" --db-user-identifier fake
Error: No DB user matched "fake", available users are ["admin"]

# If there are multiple clusters or users available, you must select one
$ query-rds-data "select * from db1.names"
Error: Multiple DBs found, please specify one of ["demo", "empty"]
$ query-rds-data "select * from db1.names" --db-cluster-identifier demo
Error: Multiple DB users found, please specify one of ["admin", "read_only"]
$ query-rds-data "select * from db1.names"  --db-cluster-identifier demo --db-user-identifier read_only
id,name
1,Bruce