Skip to content

Commit ed1a0fd

Browse files
Documented PGSpecial meta-commands
1 parent 18fc86f commit ed1a0fd

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

README.rst

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -234,19 +234,6 @@ If you have installed ``matplotlib``, you can use a result set's
234234
.. image:: https://raw.github.com/catherinedevlin/ipython-sql/master/examples/wordcount.png
235235
:alt: pie chart of word count of Shakespeare's comedies
236236

237-
238-
Installing
239-
----------
240-
241-
Install the lastest release with::
242-
243-
pip install ipython-sql
244-
245-
or download from https://github.com/catherinedevlin/ipython-sql and::
246-
247-
cd ipython-sql
248-
sudo python setup.py install
249-
250237
Dumping
251238
-------
252239

@@ -260,6 +247,28 @@ specified) or in a file of the given name.
260247
261248
In[9]: result.csv(filename='work.csv')
262249
250+
PostgreSQL features
251+
-------------------
252+
253+
``psql``-style "backslash" `meta-commands`_ commands (``\d``, ``\dt``, etc.)
254+
are provided by `PGSpecial`_.
255+
256+
.. _PGSpecial: https://pypi.python.org/pypi/pgspecial
257+
258+
.. _meta-commands: https://www.postgresql.org/docs/9.6/static/app-psql.html#APP-PSQL-META-COMMANDS
259+
260+
Installing
261+
----------
262+
263+
Install the lastest release with::
264+
265+
pip install ipython-sql
266+
267+
or download from https://github.com/catherinedevlin/ipython-sql and::
268+
269+
cd ipython-sql
270+
sudo python setup.py install
271+
263272
Development
264273
-----------
265274

@@ -280,6 +289,7 @@ Credits
280289
- Michael Erasmus for DataFrame truth bugfix
281290
- Noam Finkelstein for README clarification
282291
- Xiaochuan Yu for `<<` operator, syntax colorization
292+
- Amjith Ramanujam for PGSpecial and incorporating it here
283293

284294
.. _Distribute: http://pypi.python.org/pypi/distribute
285295
.. _Buildout: http://www.buildout.org/

0 commit comments

Comments
 (0)