Search by

tenma / postgres

Lento Leisenfeld

A Postgres server of the app's own on Tenma: started next to the app through a native plugin, stopped with it.

Package info

github.com/tenma-runtime/postgres

pkg:composer/tenma/postgres

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 6

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

v0.1.2 2026-10-26 09:58 UTC

Requires

  • php: >=8.5

Requires (Dev)

Suggests

None

Provides

None

Conflicts

None

Replaces

None

MIT, Apache-2.0 13bd3e2068ef20d2331ca047d0cca5c805207f57

Published on Packagist.org on 2026-10-26 09:58 UTC

This package is auto-updated.

Last update: 2026-10-26 10:01:40 UTC

README

A Postgres server of the app's own on Tenma. The app starts it next to itself, with its data in a directory the app chooses, and Tenma stops it when the app ends. Meant for apps that ship as one download and need a database without asking the user to set one up.

use Tenma\Postgres\Server;

$server = Server::start(__DIR__ . '/data');
$pdo = new PDO($server->dsn());
  • The first start creates the cluster (UTF-8, builtin locale) with a user tenma and a random password, kept in data/tenma-password (mode 0600).
  • The server listens on 127.0.0.1 only, on a free port. Unix sockets stay off.
  • It runs once per process: every worker gets the same server. A server that an earlier process left running on the same directory (a restart in watch mode, a crash) is found and used.
  • It stops when tenma ends: after Ctrl+C or SIGTERM, and when a script that serves nothing finishes.
  • $server->url() gives postgresql://tenma:...@127.0.0.1:PORT/postgres, the form of DATABASE_URL.

Optional by design

The package is meant to be easy to add and to drop. An app asks for its own server only when no database is configured, so the same code runs with an external Postgres and without:

$url = getenv('DATABASE_URL') ?: Server::start($home . '/data')->url();

Without the package, that line becomes the plain DATABASE_URL, and nothing else changes.

Install

composer require tenma/postgres
vendor/bin/tenma-postgres install

The install downloads the plugin of this version for the machine and Postgres 18 from theseus-rs/postgresql-binaries, checks both against their SHA-256, keeps only the server, initdb, pg_ctl and the libraries they load (about 70 MB, 16 MB compressed) in vendor/tenma/postgres/postgres/, and adds the plugin to tenma.json.

Platforms: macOS arm64, Linux x64 and arm64.

Develop

cd plugin && cargo build --release && mkdir -p ../lib
cp target/release/libtenma_postgres.dylib ../lib/tenma_postgres.plugin   # .so on Linux
cd .. && bin/tenma-postgres install
composer test

The tests run the plugin under a real tenma and skip when tenma, the plugin or Postgres is missing.

License

The package: MIT or Apache-2.0, at your option. Postgres itself: the PostgreSQL License; the install copies it to postgres/LICENSE and the notices of the bundled libraries to postgres/dependency-notices/.