2014-10-09 06:29:43 +04:00
|
|
|
# pgweb
|
|
|
|
|
|
2014-10-11 06:06:08 +04:00
|
|
|
Web-based PostgreSQL database browser written in Go.
|
2014-10-09 06:29:43 +04:00
|
|
|
|
2014-12-10 04:49:29 +03:00
|
|
|
[](https://github.com/sosedoff/pgweb/releases)
|
2015-05-10 06:12:38 +03:00
|
|
|
[](https://travis-ci.org/sosedoff/pgweb)
|
|
|
|
|
[](https://ci.appveyor.com/project/sosedoff/pgweb)
|
2014-10-28 06:12:56 +03:00
|
|
|
|
2014-10-14 06:02:04 +04:00
|
|
|
## Overview
|
|
|
|
|
|
2014-12-30 05:03:35 +03:00
|
|
|
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.
|
2014-10-14 06:02:04 +04:00
|
|
|
|
2014-10-14 20:34:22 +04:00
|
|
|
<img src="screenshots/browse.png" width="345px" />
|
|
|
|
|
<img src="screenshots/query.png" width="345px" />
|
|
|
|
|
|
2014-12-30 05:03:35 +03:00
|
|
|
## Features
|
2014-10-23 19:11:40 +04:00
|
|
|
|
2014-12-30 05:03:35 +03:00
|
|
|
- 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 data
|
|
|
|
|
- Get table details: structure, size, indeces, row count
|
|
|
|
|
- Run / analyze custom queries
|
2014-10-23 19:11:40 +04:00
|
|
|
- Export query results to CSV
|
2014-12-30 05:03:35 +03:00
|
|
|
- Query history
|
|
|
|
|
- Server bookmarks
|
2014-10-23 19:11:40 +04:00
|
|
|
|
2014-12-30 05:03:35 +03:00
|
|
|
Visit [WIKI](https://github.com/sosedoff/pgweb/wiki) for more details
|
2014-10-17 02:42:40 +04:00
|
|
|
|
2014-12-11 08:41:45 +03:00
|
|
|
## Installation
|
2014-10-29 21:58:32 +03:00
|
|
|
|
2014-12-11 08:42:24 +03:00
|
|
|
[Precompiled binaries](https://github.com/sosedoff/pgweb/releases) for supported
|
2014-12-11 08:41:45 +03:00
|
|
|
operating systems are available.
|
2014-10-29 21:58:32 +03:00
|
|
|
|
2014-12-30 05:03:35 +03:00
|
|
|
[More installation options](https://github.com/sosedoff/pgweb/wiki/Installation)
|
2014-12-11 08:43:17 +03:00
|
|
|
|
2014-10-09 06:29:43 +04:00
|
|
|
## Usage
|
|
|
|
|
|
2014-10-14 06:03:42 +04:00
|
|
|
Start server:
|
|
|
|
|
|
2014-11-08 03:12:08 +03:00
|
|
|
```
|
|
|
|
|
pgweb
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You can also provide connection flags:
|
|
|
|
|
|
2014-10-14 06:03:42 +04:00
|
|
|
```
|
2014-10-14 19:52:40 +04:00
|
|
|
pgweb --host localhost --user myuser --db mydb
|
2014-10-14 06:03:42 +04:00
|
|
|
```
|
|
|
|
|
|
2014-11-08 03:12:08 +03:00
|
|
|
Connection URL scheme is also supported:
|
2014-10-14 06:02:04 +04:00
|
|
|
|
|
|
|
|
```
|
2014-11-08 03:12:08 +03:00
|
|
|
pgweb --url postgres://user:password@host:port/database?sslmode=[mode]
|
2014-10-14 06:02:04 +04:00
|
|
|
```
|
|
|
|
|
|
2014-12-11 08:41:45 +03:00
|
|
|
## Deploy on Heroku
|
2014-12-05 08:35:25 +03:00
|
|
|
|
2014-12-11 08:41:45 +03:00
|
|
|
[](https://heroku.com/deploy?template=https://github.com/sosedoff/pgweb)
|
2014-11-08 03:12:08 +03:00
|
|
|
|
2015-01-02 23:27:51 +03:00
|
|
|
## Testing
|
|
|
|
|
|
|
|
|
|
Run tests:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
make test
|
|
|
|
|
```
|
|
|
|
|
|
2014-12-30 05:03:35 +03:00
|
|
|
## Contribute
|
2014-11-08 03:12:08 +03:00
|
|
|
|
|
|
|
|
- Fork repository
|
|
|
|
|
- Create a feature or bugfix branch
|
|
|
|
|
- Open a new pull request
|
2014-12-30 05:03:35 +03:00
|
|
|
- Use [github issues](https://github.com/sosedoff/pgweb/issues) for any questions
|
2014-11-03 09:35:56 +03:00
|
|
|
|
2014-11-08 03:12:08 +03:00
|
|
|
## Contact
|
2014-10-14 06:02:04 +04:00
|
|
|
|
2014-11-08 03:12:08 +03:00
|
|
|
- Dan Sosedoff
|
|
|
|
|
- [dan.sosedoff@gmail.com](mailto:dan.sosedoff@gmail.com)
|
|
|
|
|
- [http://twitter.com/sosedoff](http://twitter.com/sosedoff)
|
2014-10-14 06:02:04 +04:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
The MIT License (MIT)
|
|
|
|
|
|
2015-01-03 18:48:30 +03:00
|
|
|
Copyright (c) 2014-2015 Dan Sosedoff, <dan.sosedoff@gmail.com>
|
