bingoohuang/pgweb
Cross-platform client for PostgreSQL databases
pgweb
Simple web-based and cross platform PostgreSQL database explorer.
Overview
Pgweb is a web-based database explorer for PostgreSQL, written in Go, and works
on Mac, Linux and Windows machines. Distributed as a simple binary with zero dependencies.
Very easy to use and packs just the right amount of features.
Features
- Cross-platform: Mac/Linux/Windows (64bit).
- Simple installation (distributed as a single binary).
- Zero dependencies.
- Works with PostgreSQL 9.1+.
- Supports native SSH tunnels.
- Multiple database sessions.
- Execute and analyze custom SQL queries.
- Table and query data export to CSV/JSON/XML.
- Query history.
- Server bookmarks.
Visit WIKI for more details.
Demo
Visit https://pgweb-demo.fly.dev/ to see Pgweb in action.
Installation
- Precompiled binaries for supported operating systems are available.
- More installation options
Usage
Start server:
pgweb
You can also provide connection flags:
pgweb --host localhost --user myuser --db mydb
Connection URL scheme is also supported:
pgweb --url postgres://user:password@host:port/database?sslmode=[mode]
pgweb --url "postgres:///database?host=/absolute/path/to/unix/socket/dir"
Multiple database sessions
To enable multiple database sessions in pgweb, start the server with:
pgweb --sessions
Or set environment variable:
PGWEB_SESSIONS=1 pgweb
Testing
Before running tests, make sure you have PostgreSQL server running on localhost:5432
interface. Also, you must have postgres user that could create new databases
in your local environment. Pgweb server should not be running at the same time.
Execute test suite:
make test
If you're using Docker locally, you might also run pgweb test suite against
all supported PostgreSQL version with a single command:
make test-all
Contribute
- Fork this repository
- Create a new feature branch for a new functionality or bugfix
- Commit your changes
- Execute test suite
- Push your code and open a new pull request
- Use issues for any questions
- Check wiki for extra documentation
License
The MIT License (MIT). See LICENSE file for more details.