Connect to an existing PostgreSQL cluster as the `postgres` superuser and execute SQL commands.
Project description
pgsu
Connect to an existing PostgreSQL cluster as a PostgreSQL SUPERUSER and execute SQL commands.
psycopg
has a great API for interacting with PostgreSQL, once you provide it with the connection parameters for a given database.
However, what if your desired database and database user do not yet exist?
In order to create them, you will need to connect to PostgreSQL as a SUPERUSER.
Features
- autodetects postgres setup, tested on
- Ubuntu 22.04 & PostgreSQL installed via
apt
- Ubuntu 20.04 & PostgreSQL installed via
apt
- Ubuntu 16.04 & PostgreSQL installed via
apt
- Ubuntu 18.04 & PostgreSQL docker container
- MacOS 12 and PostgreSQL installed via
conda
- Windows Server 2019 and PostgreSQL installed via
conda
- Ubuntu 22.04 & PostgreSQL installed via
- uses psycopg to connect if possible
- can use
sudo
to become thepostgres
UNIX user if necessary/possible (default Ubuntu PostgreSQL setups)
Usage
Python API
from pgsu import PGSU
pgsu = PGSU() # On Ubuntu, this may prompt for sudo password
pgsu.execute("CREATE USER newuser WITH PASSWORD 'newpassword'")
users = pgsu.execute("SELECT usename FROM pg_user WHERE usename='newuser'")
print(users)
While the main point of the package is to guess how to connect as a postgres superuser, you can also provide partial or all information abut the setup using the dsn
parameter.
These are the default settings:
from pgsu import PGSU
pgsu = PGSU(dsn={
'host': None,
'port': 5432,
'user': 'postgres',
'password': None,
'dbname': 'template1', # Note: you cannot drop databases you are connected to
})
Command line tool
The package also comes with a very basic pgsu
command line tool that allows users to execute PostgreSQL commands as the superuser:
$ pgsu "SELECT usename FROM pg_user"
Trying to connect to PostgreSQL...
Executing query: SELECT usename FROM pg_user
[('aiida_qs_leopold',),
('postgres',)]
Tests
Run the tests as follows:
pip install -e .[dev]
pytest
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
Built Distribution
File details
Details for the file pgsu-0.3.0.tar.gz
.
File metadata
- Download URL: pgsu-0.3.0.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.32.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51dbb8f2272deacc28f546af442a1411eb260b1da53e11d4f93ea90f2b1acf50 |
|
MD5 | 037d1c709d58db1529e3e0df98192d0a |
|
BLAKE2b-256 | 581d48f83c23a7be0d8bbbab80cb93010ffee0dad2a760d86de3b28470f0b6f9 |
File details
Details for the file pgsu-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: pgsu-0.3.0-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.32.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bb206d02ea6bd8388cb3998e12f1ca9e954a740053b76773a99dc6d55fa23f4 |
|
MD5 | 4078acfc4b2d402356871898ca76cf28 |
|
BLAKE2b-256 | fef03403fae3006cd6c1e64378b7df10d59c114b23a7a90a4b565d8389cb4cb5 |