Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/agroal/pgagroal

High-performance connection pool for PostgreSQL
https://github.com/agroal/pgagroal

connection high-performance pool postgresql

Last synced: about 1 month ago
JSON representation

High-performance connection pool for PostgreSQL

Awesome Lists containing this project

README 

        
# pgagroal



[**pgagroal**](https://github.com/agroal/pgagroal) is a high-performance protocol-native connection pool for [PostgreSQL](https://www.postgresql.org).



Pronounced: p-g-a-gro-al, named after [A](https://www.visitportugal.com/en/content/praia-fluvial-do-agroal)[gro](https://www.google.com/maps/place/Agroal,+Portugal/@39.6775431,-8.4486056,14z/)[al](https://www.infatima.pt/en/nearby/sun-sea/fluvial-beaches/agroal/) in Portugal.



## Features



* High performance

* Connection pool

* Limit connections for users and databases

* Prefill support

* Remove idle connections

* Perform connection validation

* Enable / disable database access

* Graceful / fast shutdown

* Prometheus support

* Grafana 8 dashboard

* Remote management

* Authentication query support

* Failover support

* Transport Layer Security (TLS) v1.2+ support

* Daemon mode

* User vault



See [Getting Started](./doc/GETTING_STARTED.md) on how to get started with [**pgagroal**](https://github.com/agroal/pgagroal).



See [Configuration](./doc/CONFIGURATION.md) on how to configure [**pgagroal**](https://github.com/agroal/pgagroal).



See [Performance](./doc/PERFORMANCE.md) for a performance run.



## Overview



[**pgagroal**](https://github.com/agroal/pgagroal) makes use of



* Process model

* Shared memory model across processes

* [libev](http://software.schmorp.de/pkg/libev.html) for fast network interactions

* [Atomic operations](https://en.cppreference.com/w/c/atomic) are used to keep track of state

* The [PostgreSQL](https://www.postgresql.org) native protocol

  [v3](https://www.postgresql.org/docs/11/protocol-message-formats.html) for its communication



[**pgagroal**](https://github.com/agroal/pgagroal) will work with any [PostgreSQL](https://www.postgresql.org) compliant driver, for example

[pgjdbc](https://jdbc.postgresql.org/), [Npgsql](https://www.npgsql.org/) and [pq](https://github.com/lib/pq).



See [Architecture](./doc/ARCHITECTURE.md) for the architecture of [**pgagroal**](https://github.com/agroal/pgagroal).



## Tested platforms



* [Fedora](https://getfedora.org/) 38+

* [RHEL 9.x](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9)

* [Rocky Linux 9.x](https://rockylinux.org/)



* [FreeBSD](https://www.freebsd.org/)

* [OpenBSD](http://www.openbsd.org/)



## Compiling the source



[**pgagroal**](https://github.com/agroal/pgagroal) requires



* [gcc 8+](https://gcc.gnu.org) (C17)

* [cmake](https://cmake.org)

* [make](https://www.gnu.org/software/make/)

* [libev](http://software.schmorp.de/pkg/libev.html)

* [OpenSSL](http://www.openssl.org/)

* [systemd](https://www.freedesktop.org/wiki/Software/systemd/)

* [rst2man](https://docutils.sourceforge.io/)

* [libatomic](https://gcc.gnu.org/wiki/Atomic)

* [cJSON](https://github.com/DaveGamble/cJSON)



On Rocky Linux (and similar) operating systems, the dependencies

can be installed via `dnf(8)` as follows:



```sh

dnf install git gcc cmake make    \

            libev libev-devel     \

            openssl openssl-devel \

            systemd systemd-devel \

            python3-docutils      \

            libatomic             \

            cjson cjson-devel

```



Please note that, on Rocky Linux, in order to install the `python3-docutils`

package (that provides `rst2man` executable), you need to enable the `crb` repository:



```sh

dnf config-manager --set-enabled crb

```



Alternatively to GCC, [clang 8+](https://clang.llvm.org/) can be used.



### Release build



The following commands will install [**pgagroal**](https://github.com/agroal/pgagroal) in the `/usr/local` hierarchy

and run the default configuration.



```sh

git clone https://github.com/agroal/pgagroal.git

cd pgagroal

mkdir build

cd build

cmake -DCMAKE_INSTALL_PREFIX=/usr/local ..

make

sudo make install

/usr/local/bin/pgagroal -c /usr/local/etc/pgagroal/pgagroal.conf -a /usr/local/etc/pgagroal/pgagroal_hba.conf

```



See [RPM](./doc/RPM.md) for how to build a RPM of [**pgagroal**](https://github.com/agroal/pgagroal).



### Debug build



The following commands will create a `DEBUG` version of [**pgagroal**](https://github.com/agroal/pgagroal).



```sh

git clone https://github.com/agroal/pgagroal.git

cd pgagroal

mkdir build

cd build

cmake -DCMAKE_BUILD_TYPE=Debug ..

make

cd src

cp ../../doc/etc/*.conf .

./pgagroal -c pgagroal.conf -a pgagroal_hba.conf

```



Remember to set the `log_level` configuration option to `debug5`.



## Contributing



Contributions to [**pgagroal**](https://github.com/agroal/pgagroal) are managed on [GitHub.com](https://github.com/agroal/pgagroal/)



* [Ask a question](https://github.com/agroal/pgagroal/discussions)

* [Raise an issue](https://github.com/agroal/pgagroal/issues)

* [Feature request](https://github.com/agroal/pgagroal/issues)

* [Code submission](https://github.com/agroal/pgagroal/pulls)



Contributions are most welcome !



Please, consult our [Code of Conduct](./CODE_OF_CONDUCT.md) policies for interacting in our

community.



Consider giving the project a [star](https://github.com/agroal/pgagroal/stargazers) on

[GitHub](https://github.com/agroal/pgagroal/) if you find it useful. And, feel free to follow

the project on [Twitter](https://twitter.com/pgagroal/) as well.



## License



[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)