Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamilturek/ddx
DynamoDB Key Schema Viewer
https://github.com/kamilturek/ddx
aws aws-dynamodb database dynamodb go golang nosql
Last synced: 26 days ago
JSON representation
DynamoDB Key Schema Viewer
- Host: GitHub
- URL: https://github.com/kamilturek/ddx
- Owner: kamilturek
- License: mit
- Created: 2023-11-19T16:23:02.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-11-19T16:35:00.000Z (12 months ago)
- Last Synced: 2024-05-01T16:06:54.601Z (6 months ago)
- Topics: aws, aws-dynamodb, database, dynamodb, go, golang, nosql
- Language: Go
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ddx - DynamoDB Key Schema Viewer
`ddx` is a CLI tool designed to help you quickly and conveniently view the key
schemas of your DynamoDB tables and their indexes. With `ddx`, you can get a
summary of the partition keys and sort keys for your DynamoDB tables, with
support for various output formats.
## Features
- View key schema of DynamoDB tables and indexes.
- Output in human-readable text or machine-readable JSON format.
- Option to view key schema of a specific table.
- Ability to limit the number of tables listed.
## Installation
```sh
go install github.com/kamilturek/ddx
```
## Usage
```sh
$ ddx --help
A tool for quickly viewing your DynamoDB table and index key schemas
Usage:
ddx [flags]
Flags:
-a, --all list all tables
-f, --format string output format, available: "text", "json" (default "text")
-h, --help help for ddx
-l, --limit int maximum number of tables listed (default -1)
-t, --table-name string table name whose key schema should be shown
-v, --version version for ddx
```
## Examples
View key schema for a specific table:
```sh
$ ddx --table-name Users
Table Name: Users
Table Type: BASE
Parition Key: UserID
```
View key schemas for all tables in text format:
```sh
$ ddx --all
Table Name: Books
Table Type: BASE
Parition Key: AuthorID
Sort Key: BookID
Table Name: BooksLSI
Table Type: LSI
Partition Key: AuthorID
Sort Key: PublisherID
Table Name: BooksGSI
Table Type: GSI
Partition Key: BookID
Table Name: Users
Table Type: BASE
Parition Key: UserID
```
Output key schemas in JSON format:
```sh
$ ddx --all --format json
[
{
"TableName": "Books",
"TableType": "BASE",
"PartitionKey": "AuthorID",
"SortKey": "BookID"
},
{
"TableName": "BooksLSI",
"TableType": "BASE",
"PartitionKey": "AuthorID",
"SortKey": "PublisherID"
},
{
"TableName": "BooksGSI",
"TableType": "BASE",
"PartitionKey": "BookID"
},
{
"TableName": "Users",
"TableType": "BASE",
"PartitionKey": "UserID"
}
]
```
## License
`ddx` is open-sourced software licensed under the [MIT license](LICENSE).