Merge branch 'amjith-master'

Author: catherinedevlin

README.rst

@@ -234,19 +234,6 @@ If you have installed ``matplotlib``, you can use a result set's
 .. image:: https://raw.github.com/catherinedevlin/ipython-sql/master/examples/wordcount.png
    :alt: pie chart of word count of Shakespeare's comedies
 
-
-Installing
-----------
-
-Install the lastest release with::
-
-    pip install ipython-sql
-
-or download from https://github.com/catherinedevlin/ipython-sql and::
-
-    cd ipython-sql
-    sudo python setup.py install
-
 Dumping
 -------
 
@@ -260,6 +247,28 @@ specified) or in a file of the given name.
 
     In[9]: result.csv(filename='work.csv')
 
+PostgreSQL features
+-------------------
+
+``psql``-style "backslash" `meta-commands`_ commands (``\d``, ``\dt``, etc.) 
+are provided by `PGSpecial`_.
+
+.. _PGSpecial: https://pypi.python.org/pypi/pgspecial 
+
+.. _meta-commands: https://www.postgresql.org/docs/9.6/static/app-psql.html#APP-PSQL-META-COMMANDS
+
+Installing
+----------
+
+Install the lastest release with::
+
+    pip install ipython-sql
+
+or download from https://github.com/catherinedevlin/ipython-sql and::
+
+    cd ipython-sql
+    sudo python setup.py install
+
 Development
 -----------
 
@@ -280,6 +289,7 @@ Credits
 - Michael Erasmus for DataFrame truth bugfix
 - Noam Finkelstein for README clarification
 - Xiaochuan Yu for `<<` operator, syntax colorization
+- Amjith Ramanujam for PGSpecial and incorporating it here
 
 .. _Distribute: http://pypi.python.org/pypi/distribute
 .. _Buildout: http://www.buildout.org/

run_tests.sh

@@ -1,2 +1,3 @@
+#!/bin/bash
 ipython -c "import nose; nose.run()"
 # Insert breakpoints with `from nose.tools import set_trace; set_trace()`

setup.py

@@ -1,5 +1,5 @@
 from setuptools import setup, find_packages
-import sys, os
+import os
 
 here = os.path.abspath(os.path.dirname(__file__))
 README = open(os.path.join(here, 'README.rst')).read()
@@ -14,6 +14,7 @@
     'sqlalchemy>=0.6.7',
     'sqlparse',
     'six',
+    'pgspecial',
     'ipython-genutils>=0.1.0',
 ]
 

src/sql/run.py

@@ -1,6 +1,4 @@
-import functools
 import operator
-import types
 import csv
 import six
 import codecs
@@ -9,6 +7,7 @@
 import sqlalchemy
 import sqlparse
 import prettytable
+from pgspecial.main import PGSpecial
 from .column_guesser import ColumnGuesserMixin
 
 
@@ -141,7 +140,7 @@ def __getitem__(self, key):
             return result[0]
     def dict(self):
         """Returns a single dict built from the result set
- 
+
         Keys are column names; values are a tuple"""
         return dict(zip(self.keys, zip(*self)))
 
@@ -274,19 +273,38 @@ def interpret_rowcount(rowcount):
         result = '%d rows affected.' % rowcount
     return result
 
+class FakeResultProxy(object):
+    """A fake class that pretends to behave like the ResultProxy from
+    SqlAlchemy.
+    """
+    def __init__(self, cursor, headers):
+        self.fetchall = cursor.fetchall
+        self.fetchmany = cursor.fetchmany
+        self.rowcount = cursor.rowcount
+        self.keys = lambda: headers
+        self.returns_rows = True
+
 
 def run(conn, sql, config, user_namespace):
     if sql.strip():
         for statement in sqlparse.split(sql):
-            if sql.strip().split()[0].lower() == 'begin':
+            first_word = sql.strip().split()[0].lower()
+            if first_word == 'begin':
                 raise Exception("ipython_sql does not support transactions")
-            txt = sqlalchemy.sql.text(statement)
-            result = conn.session.execute(txt, user_namespace)
+            if first_word.startswith('\\') and 'postgres' in str(conn.dialect):
+                pgspecial = PGSpecial()
+                _, cur, headers, _ = pgspecial.execute(
+                                              conn.session.connection.cursor(),
+                                              statement)[0]
+                result = FakeResultProxy(cur, headers)
+            else:
+                txt = sqlalchemy.sql.text(statement)
+                result = conn.session.execute(txt, user_namespace)
             try:
                 # mssql has autocommit
                 if 'mssql' not in str(conn.dialect):
                     conn.session.execute('commit')
-            except sqlalchemy.exc.OperationalError: 
+            except sqlalchemy.exc.OperationalError:
                 pass # not all engines can commit
             if result and config.feedback:
                 print(interpret_rowcount(result.rowcount))