benizar/pg_adm repository overview

⁠pg_adm

• Introduction⁠
  • Postgres xtensions⁠
  • Contributing⁠
• Getting started⁠
  • Using Dockers⁠
  • Install the extension⁠
  • Dependencies⁠
• Acknowledgements⁠
• TODOs⁠

⁠Introduction

A PostgreSQL extension compiling different administration tools.

⁠Postgres Extensions

PostgreSQL is an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance [source⁠].

Apart from the PostgreSQL official documentation you can check the PostgreSQL Extension Network⁠ for additional information about extensions.

⁠Contributing

• Send a pull request with your awesome features and bug fixes
• Help users resolve their issues⁠.

⁠Getting started

⁠Using dockers

Automated builds of the image are available on Dockerhub⁠. This is the recommended method of installation.

docker pull benizar/pg_adm

Start this image using:

docker run --name pg_adm -itd --restart always \
  --publish 5432:5432
  --volume /srv/docker/postgresql:/var/lib/postgresql \
  benizar/pg_adm

For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version 1.3.0 or higher you can access a running containers shell by starting bash using docker exec:

docker exec -it pg_adm bash

Alternatively, you can use the sample docker-compose.yml⁠ file to start the container using Docker Compose⁠

⁠Install the extension

To build pg_adm:

make
make install
make installcheck

If you encounter an error such as:

ERROR:  must be owner of database regression

You need to run the test suite using a super user, such as the default "postgres" super user:

make installcheck PGUSER=postgres

If that doesn't work, for testing purposes you also can do:

sudo -u postgres createuser -s $USER

Once the extension is installed, you can add it to a database. If you're running PostgreSQL 9.1.0 or greater, it's a simple as connecting to a database as a super user and running:

CREATE EXTENSION pg_adm;

⁠Dependencies

The pg_adm extension depends on other postgres extensions. See the pg_adm.control file.

⁠Acknowledgements

Most of the provided tools are available from different projects:

• postgresql wiki⁠
• pgx_scripts⁠
• postgres_useful⁠
• pgpermisions⁠

⁠TODOs:

Check the following resources:

• pg_cheat_funcs⁠ for PGLZ data compresion.
• plpgsql-tools⁠