{"id":20533193,"url":"https://github.com/kishaningithub/rdapp","last_synced_at":"2025-04-14T06:32:56.784Z","repository":{"id":53697837,"uuid":"521535964","full_name":"kishaningithub/rdapp","owner":"kishaningithub","description":"rdapp - Redshift Data API Postgres Proxy","archived":false,"fork":false,"pushed_at":"2023-06-05T15:39:39.000Z","size":513,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-27T20:14:35.823Z","etag":null,"topics":["aws","aws-redshift","go","golang","hacktoberfest","redshift"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kishaningithub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"kishaningithub","custom":"https://www.paypal.me/kishansh"}},"created_at":"2022-08-05T06:55:22.000Z","updated_at":"2025-03-17T19:22:53.000Z","dependencies_parsed_at":"2024-06-21T08:45:17.520Z","dependency_job_id":"6f032f51-93a0-471c-b8b5-a967f7d0d7eb","html_url":"https://github.com/kishaningithub/rdapp","commit_stats":{"total_commits":87,"total_committers":1,"mean_commits":87.0,"dds":0.0,"last_synced_commit":"aaa2a67cce9c9340514e63685e6429333724c4f3"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kishaningithub%2Frdapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kishaningithub%2Frdapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kishaningithub%2Frdapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kishaningithub%2Frdapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kishaningithub","download_url":"https://codeload.github.com/kishaningithub/rdapp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248834290,"owners_count":21169000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-redshift","go","golang","hacktoberfest","redshift"],"created_at":"2024-11-16T00:19:19.225Z","updated_at":"2025-04-14T06:32:56.727Z","avatar_url":"https://github.com/kishaningithub.png","language":"Go","funding_links":["https://github.com/sponsors/kishaningithub","https://www.paypal.me/kishansh","https://www.paypal.me/kishansh/15"],"categories":[],"sub_categories":[],"readme":"# rdapp - Redshift Data API Postgres Proxy\n\n[![Build Status](https://github.com/kishaningithub/rdapp/actions/workflows/build.yml/badge.svg)](https://github.com/kishaningithub/rdapp/actions/workflows/build.yml)\n[![Go Reference](https://pkg.go.dev/badge/github.com/kishaningithub/rdapp.svg)](https://pkg.go.dev/github.com/kishaningithub/rdapp)\n[![Go Report Card](https://goreportcard.com/badge/github.com/kishaningithub/rdapp)](https://goreportcard.com/report/github.com/kishaningithub/rdapp)\n[![Latest release](https://img.shields.io/github/release/kishaningithub/rdapp.svg)](https://github.com/kishaningithub/rdapp/releases)\n[![Buy me a lunch](https://img.shields.io/badge/🍱-Buy%20me%20a%20lunch-blue.svg)](https://www.paypal.me/kishansh/15)\n\nUse your favourite postgres tools to query redshift via the redshift data api.\n\n## Table of contents\n\n- [rdapp - Redshift Data API Postgres Proxy](#rdapp---redshift-data-api-postgres-proxy)\n  - [Table of contents](#table-of-contents)\n  - [Architecture](#architecture)\n  - [Installation](#installation)\n    - [Using Homebrew](#using-homebrew)\n    - [Using docker](#using-docker)\n    - [Others](#others)\n  - [Examples](#examples)\n  - [Usage](#usage)\n  - [Contributing](#contributing)\n  - [Thanks](#thanks)\n\n## Architecture\n\n![Architecture](./diagrams/architecture.png)\n\n## Installation\n\n### Using Homebrew\n\n```bash\nbrew install kishaningithub/tap/rdapp\n```\n\n### Using docker\n\npulling the image\n```bash\ndocker pull ghcr.io/kishaningithub/rdapp:0.5.6\n```\n\nrunning the image in interactive mode (volume mounted aws folder for config)\n```bash\ndocker run -it -v \"${HOME}/.aws:/root/.aws\" ghcr.io/kishaningithub/rdapp:0.5.6\n```\n\n### Others\n\nHead over to the [releases page](https://github.com/kishaningithub/rdapp/releases) and download a binary for your platform\n\n## Examples\n\n- 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)\n  for more info.\n- **Interactive mode** - This loads an interactive view where you can pick and choose clusters to connect to\n  - 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).\n```bash\nrdapp --listen \":15432\"\n```\n- **Normal Mode** - Here you specify redshift connection config as cli args\n  - For proxying redshift serverless run command\n```bash\nrdapp --listen \":15432\" --database \"\u003c\u003cdb name\u003e\u003e\" --workgroup-name \"\u003c\u003cwork group name\u003e\u003e\" --secret-arn \"\u003c\u003csecret arn\u003e\u003e\"\n```\n  - For proxying redshift provisioned run command\n```bash\nrdapp --listen \":15432\" --db-user \u003c\u003cdb user\u003e\u003e --cluster-identifier \"\u003c\u003ccluster identifier\u003e\u003e\" --database \"\u003c\u003cdb name\u003e\u003e\"\n```\n- If you notice above other than `--listen` which is the address rdapp listens to all other parameters are exactly the same\n  as [aws cli's execute statement command](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift-data/execute-statement.html)\n  this is intentional and will be maintained that way in the future. This also helps people who are currently using the cli\n  to migrate to rdapp\n- Once the proxy is up, use your favorite postgres tool to interact with your redshift database, the tool will connect to\n  the address specified in the `--listen` and connects to it. If the parameter is not given it defaults to `:25432`\n  - My favourite pg tool being [pgcli](https://github.com/dbcli/pgcli) below is an example of using the same\n\n```bash\npgcli -h localhost -p 15432\n\n\u003e select * from employee limit 1;\n+-------+-----------+\n| id    | name      |\n|-------+-----------|\n| 1     | john doe  |\n+-------+-----------+\nOK 1\n```\n\n## Usage\n\n```bash\n$ rdapp -h\nUse your favourite postgres tools to query redshift via redshift data api\n\nUsage:\n  rdapp [flags]\n\nFlags:\n      --cluster-identifier string\n      --database string\n      --db-user string\n  -h, --help                        help for rdapp\n      --listen string                (default \":25432\")\n      --secret-arn string\n      --verbose                     verbose output\n      --workgroup-name string\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n## Thanks\n\nSpecial thanks to [@jeroenrinzema](https://github.com/jeroenrinzema) for creating [psql-wire](https://github.com/jeroenrinzema/psql-wire)\nwithout which this project might not have been possible.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkishaningithub%2Frdapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkishaningithub%2Frdapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkishaningithub%2Frdapp/lists"}