mirror of https://github.com/sosedoff/pgweb.git synced 2024-12-14 19:21:46 +03:00

Cross-platform client for PostgreSQL databases

cross-platform golang pgweb postgresql starred-repo starred-sosedoff-repo

Go to file

Dan Sosedoff 3b9be5d69b Add URL format hint to connection form		2014-11-01 17:50:14 -05:00
screenshots	Update screenshots take 2	2014-10-26 18:28:51 -05:00
static	Add URL format hint to connection form	2014-11-01 17:50:14 -05:00
.gitignore	Serve assets with bindata	2014-10-13 14:40:56 -05:00
.travis.yml	Test on go tip	2014-10-30 16:46:14 -05:00
api.go	Initial interface to connect to server using gui	2014-11-01 15:44:24 -05:00
CHANGELOG.md	Modify markdown format in changelog file	2014-10-29 19:55:32 -05:00
client.go	Add API method to connect to server with given url	2014-10-31 22:37:58 -05:00
Dockerfile	Use entrypoint, remove env vars	2014-10-29 19:21:03 -07:00
LICENSE	License, readme	2014-10-13 21:02:04 -05:00
main.go	Initial interface to connect to server using gui	2014-11-01 15:44:24 -05:00
Makefile	Have only one target that specifies the asset bindata	2014-10-31 11:31:59 +00:00
README.md	Add --bind flag to specify http server host	2014-10-30 18:51:49 -05:00
statements.go	Move all SQL statements into a separate file	2014-10-29 22:53:29 -05:00

README.md

pgweb

Web-based PostgreSQL database browser written in Go.

Overview

This is a web-based browser for PostgreSQL database server. Its written in Go and works on Mac OSX, Linux and Windows machines. Main idea behind using Go for the backend is to utilize language's ability for cross-compile source code for multiple platforms. This project is an attempt to create a very simple and portable application to work with PostgreSQL databases.

Features:

Connect to local or remote server
Browse tables and table rows
Get table details: structure, size, indices, row count
Execute SQL query and run analyze on it
Export query results to CSV
View query history

Installation

Please visit Github Releases to download a precompiled binary for your operating system.

Currently supported:

Mac OSX 64bit
Linux 32/64bit
Windows 32/64bit

Supported PostgreSQL versions:

Older versions of PostgreSQL might also work but this project is not tested on 8.x branches.

Usage

Start server:

pgweb --host localhost --user myuser --db mydb

You can also specify a connection URI instead of individual flags:

pgweb --url postgres://user:password@host:port/database

It works great with Heroku Postgres if you need to troubleshoot production database or simply run a few queries.

Full CLI options:

Usage:
  pgweb [OPTIONS]

Application Options:
  -v, --version    Print version
  -d, --debug      Enable debugging mode (false)
      --url=       Database connection string
      --host=      Server hostname or IP (localhost)
      --port=      Server port (5432)
      --user=      Database user (postgres)
      --pass=      Password for user
      --db=        Database name (postgres)
      --ssl=       SSL option (disable)
      --bind=      HTTP server host (localhost)
      --listen=    HTTP server listen port (8080)
      --auth-user= HTTP basic auth user
      --auth-pass= HTTP basic auth password
  -s, --skip-open  Skip browser open on start

Compile from source

Go 1.3+ is required. You can install Go with homebrew:

brew install go

To compile source code run the following command:

make setup
make dev

This will produce pgweb binary in the current directory.

There's also a task to compile binaries for other operating systems:

make build

Under the hood it uses gox. Compiled binaries will be stored into ./bin directory.

Contributors

Dan Sosedoff - https://twitter.com/sosedoff
Masha Safina - https://twitter.com/mashasafina

License

The MIT License (MIT)