Skip to main content

Meta-commands handler for Postgres Database.

Project description

Meta-commands for Postgres

Build Status Latest Version

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

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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pgspecial-2.1.2.tar.gz (51.1 kB view details)

Uploaded Source

Built Distribution

pgspecial-2.1.2-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file pgspecial-2.1.2.tar.gz.

File metadata

  • Download URL: pgspecial-2.1.2.tar.gz
  • Upload date:
  • Size: 51.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.10.0 requests/2.31.0 setuptools/69.5.1 requests-toolbelt/1.0.0 tqdm/4.66.4 CPython/3.11.9

File hashes

Hashes for pgspecial-2.1.2.tar.gz
Algorithm Hash digest
SHA256 f0419e1b3b78fb3a72fe3b546f6788a712091532d599fe7593b5f6ee55a88f87
MD5 aa1be38113dd9eb72f7c2709b956840c
BLAKE2b-256 3b4c5eece5ad87915a24e59c1f8adca6e2ae44368e5f7fdfcf9143a741a92161

See more details on using hashes here.

File details

Details for the file pgspecial-2.1.2-py3-none-any.whl.

File metadata

  • Download URL: pgspecial-2.1.2-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.10.0 requests/2.31.0 setuptools/69.5.1 requests-toolbelt/1.0.0 tqdm/4.66.4 CPython/3.11.9

File hashes

Hashes for pgspecial-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a0d2f9cd85d94c11453a99b5c14e64136fde800f4a6c8f180500d3fc23789e7e
MD5 94972f9b0da40297d0f7c2e5415c7410
BLAKE2b-256 da87a83fedbe102ba1f7ee9a40559a406e6359d57ab0e8b06acf444c6c30cb15

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page