Meta-commands handler for Postgres Database.
Project description
Meta-commands for Postgres
This package provides an API to execute meta-commands (AKA “special”, or “backslash commands”) on PostgreSQL.
Quick Start
This is a python package. It can be installed with:
$ pip install pgspecial
Usage
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
from psycopg2.extensions import cursorThen you will create and use an instance of PGSpecial:
pgspecial = PGSpecial()
for result in pgspecial.execute(cur: cursor, sql):
# Do somethingIf you want to import named queries from an existing config file, it is convenient to initialize and keep around the class variable in NamedQueries:
from configobj import ConfigObj
NamedQueries.instance = NamedQueries.from_config(
ConfigObj('~/.config_file_name'))Contributions:
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.
https://github.com/dbcli/pgspecial/blob/master/DEVELOP.rst
Please feel free to file an issue if you need help.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pgspecial-1.13.1.tar.gz.
File metadata
- Download URL: pgspecial-1.13.1.tar.gz
- Upload date:
- Size: 49.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.8.2 requests/2.27.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d5dab96690908275916dc2c622efae217f142e08165fa366949d41cbc5658701 |
|
| MD5 | 61703abf2ac8b2b108bdd11fb808eeda |
|
| BLAKE2b-256 | 5eeba5fe6dd01ededd9eb9a6400fd9a2bfa1e67a6c3f1f8cdb974d5a933d55c1 |
File details
Details for the file pgspecial-1.13.1-py3-none-any.whl.
File metadata
- Download URL: pgspecial-1.13.1-py3-none-any.whl
- Upload date:
- Size: 35.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.8.2 requests/2.27.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5716c470f358cf74914b8155bf48d6a8deb8f70aa6eccf8bddaacc44dfee46e4 |
|
| MD5 | b39782672741ed6ff65e8369412ae52d |
|
| BLAKE2b-256 | 6f7aef03095ebe066e6f6969d35e38428e8ec6fd81a1e5a82cf29ff757d6b56e |
