Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgbouncer/pg_pgbouncer
A companion extension to PgBouncer that can be used to manage and run PgBouncer from Postgres
https://github.com/pgbouncer/pg_pgbouncer
Last synced: about 2 months ago
JSON representation
A companion extension to PgBouncer that can be used to manage and run PgBouncer from Postgres
- Host: GitHub
- URL: https://github.com/pgbouncer/pg_pgbouncer
- Owner: pgbouncer
- License: mit
- Created: 2024-05-27T22:07:24.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-05-29T08:37:40.000Z (7 months ago)
- Last Synced: 2024-05-29T21:07:16.374Z (7 months ago)
- Language: Rust
- Size: 41 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# pg_pgbouncer
**DISCLAIMER: This is alpha quality software at the moment. It is not
recommended for production use (yet). Some API design decisions might
significantly change too.**
## How to compile and run
### Install the Rust toolchain
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Configure Rust for more speedy compilation (optional)
See [`CONTRIBUTING.md`][`https://github.com/pgbouncer/pg_pgbouncer/blob/main/README.md`] for details
### Install `cargo pgrx`
```
cargo install cargo-pgrx --locked --version '=0.11.4' --force
cargo pgrx init
```
### Add extension to shared_preload_libraries and build & install the extension
You can either choose to let pgrx to create a new database cluster for you and install pg_pgbouncer
extension there, or you can choose to install pg_pgbouncer extension to your existing database cluster.
1. Use pgrx-managed postgres server
Configure postgres:
```
echo "shared_preload_libraries = 'pg_pgbouncer'" >> ~/.pgrx/data-16/postgresql.conf
echo "pg_pgbouncer.database = 'pg_pgbouncer'" >> ~/.pgrx/data-16/postgresql.conf
```
Build & install pg_pgbouncer.so into the pgrx-managed postgres server:
```
# builds & installs pg_pgbouncer.so into ~/.pgrx/16.0 and opens psql automatically for pg_pgbouncer database
cargo pgrx run
```
Create the extension in the psql session opened automatically:
```
DROP EXTENSION IF EXISTS pg_pgbouncer; CREATE EXTENSION pg_pgbouncer;
```
2. Use pre-installed postgres server
Configure postgres:
```
echo "shared_preload_libraries = 'pg_pgbouncer'" >> /path/to/desired/postgresql.conf
```
Build & install pg_pgbouncer.so into the postgres your effective pg_config utility points to:
```
# builds & installs pg_pgbouncer.so using pg_config from PATH
cargo pgrx install
```
Configure the database name in which you will create the pg_pgbouncer extension:
```
ALTER SYSTEM SET pg_pgbouncer.database='';
```
Restart postgres and connect to it using a client utility such as psql.
Connect to the database pg_pgbouncer.database and create the extension there:
```
DROP EXTENSION IF EXISTS pg_pgbouncer; CREATE EXTENSION pg_pgbouncer;
```
Check the postgres server log (for pgrx-managed Postgres the log is at
`~/.pgrx/16.log`). If you see the below line, pg_pgbouncer is working.
```
LOG: Hello from inside the PgBouncer Manager BGWorker!
```