database-gateway

module
v0.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2024 License: GPL-3.0

README

Database Gateway

This service provides a unified web interface for secure, controlled access to company databases. It enables employees to run queries on production databases while enforcing access control (ACL) policies. For example, team leads may have permissions to execute both SELECT and INSERT queries on certain tables, while other team members are restricted to read-only (SELECT) access. This approach ensures that database interactions are managed safely and that each user’s access is tailored to their role and responsibilities.

Quickstart with example setup

Run commands to get a local dbgw instance with 3 postgres.

git clone https://github.com/kazhuravlev/database-gateway.git
cd database-gateway/example
docker compose up --pull always --force-recreate -d
open 'http://127.0.0.1:8080'
# Username: test@example.com
# Password: password

You will see a 3 postgres instances (local-1, local-2, local-3): pic1_instances.png

Choose local-1, put this query select id, name from clients and click Run pic2_run.png

Features

  • Supports any PostgreSQL wire-protocol database, including PostgreSQL and CockroachDB
  • Allows hardcoded user configuration via config file
  • Integrates with OpenID Connect for user authentication
  • Enforces access filtering through ACLs
  • Provides query result output in HTML format
  • Provides query result output in JSON format
  • Output query results in CSV format
  • MySQL support
  • Query history tracking
  • Unique links for query results (useful for debugging)
  • API for test automation

Interesting projects

Directories

Path Synopsis
cmd
internal
app
Code generated by options-gen.
Code generated by options-gen.
facade
Code generated by options-gen.
Code generated by options-gen.
facade/templates
templ: version: v0.2.793
templ: version: v0.2.793

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL