Meta-commands for Postgres
This package provides an API to execute meta-commands (AKA "special", or "backslash commands") on PostgreSQL.
This is a python package. It can be installed with:
$ pip install pgspecial
Once this library is included into your project, you will most likely use the following imports:
from pgspecial.main import PGSpecial from pgspecial.namedqueries import NamedQueries
Then you will create and use an instance of PGSpecial:
pgspecial = PGSpecial() for result in pgspecial.execute(cur, sql): # Do something
If you want to import named queries from an existing config file, it is
convenient to initialize and keep around the class variable in
from configobj import ConfigObj NamedQueries.instance = NamedQueries.from_config( ConfigObj('~/.config_file_name'))
If you're interested in contributing to this project, first of all I would like to extend my heartfelt gratitude. I've written a small doc to describe how to get this running in a development setup.
Please feel free to reach out if you need help.
mailing list: https://groups.google.com/forum/#!forum/pgcli
Projects using it:
This library is used by the following projects:
pgcli: A REPL for Postgres.
ipython-sql: %%sql magic for IPython
OmniDB: An web tool for database management
If you find this module useful and include it in your project, I'll be happy to know about it and list it here.