mirror of https://github.com/dbcli/pgcli
Update Readme.
This commit is contained in:
parent
60585c8856
commit
38aa366c90
87
README.rst
87
README.rst
|
@ -1,17 +1,98 @@
|
||||||
A REPL for Postgres
|
A REPL for Postgres
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
** _WARNING_: This is a WIP. Please DO NOT use. **
|
|
||||||
|
|
||||||
This is a postgres client that does auto-completion and syntax highlighting.
|
This is a postgres client that does auto-completion and syntax highlighting.
|
||||||
|
|
||||||
|
.. image:: screenshots/image01.png
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
|
If you don't know how to install python pacakges, please check the `detailed instructions`__.
|
||||||
|
|
||||||
|
__ Detailed Installation Instructions
|
||||||
|
|
||||||
|
If you already know how to install python pacakges, then you can simply do:
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
pip install pgcli
|
$ pip install pgcli
|
||||||
|
|
||||||
|
|
||||||
|
Detailed Installation Instructions:
|
||||||
|
===================================
|
||||||
|
|
||||||
|
OS X:
|
||||||
|
-----
|
||||||
|
|
||||||
|
For installing Python pacakges it is recommended to use the package manager
|
||||||
|
called `pip`. Check if `pip` is installed on the system.
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ which pip
|
||||||
|
|
||||||
|
If it is installed then you can do:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ pip install pgcli
|
||||||
|
|
||||||
|
If that fails due to permission issues, you might need to run the command with
|
||||||
|
sudo permissions.
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ sudo pip install pgcli
|
||||||
|
|
||||||
|
If pip is not installed check if easy_install is available on the system.
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ which easy_install
|
||||||
|
|
||||||
|
$ sudo easy_install pgcli
|
||||||
|
|
||||||
|
Linux:
|
||||||
|
------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Usage
|
||||||
|
=====
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ pgcli [database_name]
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
$ pgcli postgresql://[user[:password]@][netloc][:port][/dbname]
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
$ pgcli local_database
|
||||||
|
|
||||||
|
$ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db
|
||||||
|
|
||||||
|
|
||||||
|
Features
|
||||||
|
========
|
||||||
|
|
||||||
|
The `pgcli` is written using prompt_toolkit_.
|
||||||
|
|
||||||
|
* Auto-completion as you type for SQL keywords as well as tables and
|
||||||
|
columns in the database.
|
||||||
|
* Syntax highlighting using Pygments.
|
||||||
|
* Smart-completion (enabled by default) will suggest context-sensitive completion.
|
||||||
|
|
||||||
|
- `SELECT * FROM <tab>` will only show table names.
|
||||||
|
- `SELECT * FROM users WHERE <tab>` will only show column names.
|
||||||
|
|
||||||
|
* Config file is automatically created at ~/.pglirc at first launch.
|
||||||
|
* Primitive support for `psql` back-slash commands.
|
||||||
|
|
||||||
|
.. _prompt_toolkit: https://github.com/jonathanslenders/python-prompt-toolkit
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 80 KiB |
Loading…
Reference in New Issue