# pg-history

> PostgreSQL audit trails with automated S3 archival.

## Docs

- [Quick Start](https://github.com/TimMikeladze/pg-history/blob/main/README.md#quick-start)
- [Installation](https://github.com/TimMikeladze/pg-history/blob/main/README.md#installation): pg, hono, and the S3/Parquet libraries ship as regular dependencies — nothing else to install.
- [Examples](https://github.com/TimMikeladze/pg-history/blob/main/README.md#examples): Working examples in examples/. Each creates a temporary database, runs against real PostgreSQL, and cleans up after itself.
- [How It Works](https://github.com/TimMikeladze/pg-history/blob/main/README.md#how-it-works): pg-history uses PostgreSQL's own trigger system to capture every change.
- [Architecture](https://github.com/TimMikeladze/pg-history/blob/main/README.md#architecture)
- [API Reference](https://github.com/TimMikeladze/pg-history/blob/main/README.md#api-reference)
- [Server & REST API](https://github.com/TimMikeladze/pg-history/blob/main/README.md#server--rest-api): A ready-made Hono server exposing the audit trail over HTTP, with JWT or cron-secret auth on every endpoint that reads data.
- [Dashboard](https://github.com/TimMikeladze/pg-history/blob/main/README.md#dashboard): A ready-to-deploy Next.js UI for browsing, searching and reverting the audit trail.
- [Deployment](https://github.com/TimMikeladze/pg-history/blob/main/README.md#deployment)
- [Archiver](https://github.com/TimMikeladze/pg-history/blob/main/README.md#archiver): Move old audit rows to S3 as compressed Parquet files. Hands off to Orchestrator for scheduling and PgHistoryArchiver for the upload + delete lifecycle.
- [Environment Variables](https://github.com/TimMikeladze/pg-history/blob/main/README.md#environment-variables)
- [Production Caveats](https://github.com/TimMikeladze/pg-history/blob/main/README.md#production-caveats): Knobs and trade-offs, not bugs.
- [Error Handling](https://github.com/TimMikeladze/pg-history/blob/main/README.md#error-handling): Typed error classes, all extending PgHistoryError.
- [Limitations](https://github.com/TimMikeladze/pg-history/blob/main/README.md#limitations)

## Links

- [Full README](https://github.com/TimMikeladze/pg-history/blob/main/README.md)
- [GitHub](https://github.com/TimMikeladze/pg-history)
- [npm](https://www.npmjs.com/package/pg-history)