pgweb/README.md
2015-06-03 20:43:22 -05:00

2.8 KiB

pgweb

Web-based PostgreSQL database browser written in Go.

Release Linux Build Windows Build

Overview

Pgweb is a web-based database browser for PostgreSQL, written in Go and works on OSX, Linux and Windows machines. Main idea behind using Go for backend development is to utilize ability of the compiler to produce zero-dependency binaries for multiple platforms. Pgweb was created as an attempt to build very simple and portable application to work with local or remote PostgreSQL databases.

See application screenshots

Features

  • Works on OSX, Linux and Windows
  • Zero dependencies
  • Simple installation (distributes as a single binary)
  • Connect to local or remote servers
  • Browse tables and table rows
  • Get table details: structure, size, indeces, row count
  • Run and analyze custom SQL queries
  • Export table rows and query results as CSV
  • Query history
  • Server bookmarks

Visit WIKI for more details

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]

Deploy on Heroku

Heroku Deploy

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

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

Contact

License

The MIT License (MIT)

Copyright (c) 2014-2015 Dan Sosedoff, dan.sosedoff@gmail.com