Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kishaningithub/rdapp
rdapp - Redshift Data API Postgres Proxy
https://github.com/kishaningithub/rdapp
aws aws-redshift go golang hacktoberfest redshift
Last synced: 1 day ago
JSON representation
rdapp - Redshift Data API Postgres Proxy
- Host: GitHub
- URL: https://github.com/kishaningithub/rdapp
- Owner: kishaningithub
- License: mit
- Created: 2022-08-05T06:55:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-05T15:39:39.000Z (over 1 year ago)
- Last Synced: 2024-06-21T09:52:55.921Z (5 months ago)
- Topics: aws, aws-redshift, go, golang, hacktoberfest, redshift
- Language: Go
- Homepage:
- Size: 501 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# rdapp - Redshift Data API Postgres Proxy
[](https://github.com/kishaningithub/rdapp/actions/workflows/build.yml)
[](https://pkg.go.dev/github.com/kishaningithub/rdapp)
[](https://goreportcard.com/report/github.com/kishaningithub/rdapp)
[](https://github.com/kishaningithub/rdapp/releases)
[](https://www.paypal.me/kishansh/15)
Use your favourite postgres tools to query redshift via the redshift data api.
## Table of contents
- [rdapp - Redshift Data API Postgres Proxy](#rdapp---redshift-data-api-postgres-proxy)
- [Table of contents](#table-of-contents)
- [Architecture](#architecture)
- [Installation](#installation)
- [Using Homebrew](#using-homebrew)
- [Using docker](#using-docker)
- [Others](#others)
- [Examples](#examples)
- [Usage](#usage)
- [Contributing](#contributing)
- [Thanks](#thanks)
## Architecture
## Installation
### Using Homebrew
```bash
brew install kishaningithub/tap/rdapp
```
### Using docker
pulling the image
```bash
docker pull ghcr.io/kishaningithub/rdapp:0.5.6
```
running the image in interactive mode (volume mounted aws folder for config)
```bash
docker run -it -v "${HOME}/.aws:/root/.aws" ghcr.io/kishaningithub/rdapp:0.5.6
```
### Others
Head over to the [releases page](https://github.com/kishaningithub/rdapp/releases) and download a binary for your platform
## Examples
- Ensure aws credentials are setup in your env. Refer [aws cli configuration guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)
for more info.
- **Interactive mode** - This loads an interactive view where you can pick and choose clusters to connect to
- This mode requires permissions to list provisioned clusters, work groups, namespaces and secrets (we do not read secret values, only requires list permission to choose secret ARN).
```bash
rdapp --listen ":15432"
```
- **Normal Mode** - Here you specify redshift connection config as cli args
- For proxying redshift serverless run command
```bash
rdapp --listen ":15432" --database "<>" --workgroup-name "<>" --secret-arn "<>"
```
- For proxying redshift provisioned run command
```bash
rdapp --listen ":15432" --db-user <> --cluster-identifier "<>" --database "<>"
```
- If you notice above other than `--listen` which is the address rdapp listens to all other parameters are exactly the same
as [aws cli's execute statement command](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift-data/execute-statement.html)
this is intentional and will be maintained that way in the future. This also helps people who are currently using the cli
to migrate to rdapp
- Once the proxy is up, use your favorite postgres tool to interact with your redshift database, the tool will connect to
the address specified in the `--listen` and connects to it. If the parameter is not given it defaults to `:25432`
- My favourite pg tool being [pgcli](https://github.com/dbcli/pgcli) below is an example of using the same
```bash
pgcli -h localhost -p 15432
> select * from employee limit 1;
+-------+-----------+
| id | name |
|-------+-----------|
| 1 | john doe |
+-------+-----------+
OK 1
```
## Usage
```bash
$ rdapp -h
Use your favourite postgres tools to query redshift via redshift data api
Usage:
rdapp [flags]
Flags:
--cluster-identifier string
--database string
--db-user string
-h, --help help for rdapp
--listen string (default ":25432")
--secret-arn string
--verbose verbose output
--workgroup-name string
```
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md)
## Thanks
Special thanks to [@jeroenrinzema](https://github.com/jeroenrinzema) for creating [psql-wire](https://github.com/jeroenrinzema/psql-wire)
without which this project might not have been possible.