API versioning

Mon, 01 Jan 0001 00:00:00 +0000

Change Request: API Versioning for pgmi Session Interface#

Status: IMPLEMENTED This design document describes changes that have been completed. The “Current State” section reflects the pre-implementation state for historical context. The “Target State” is now the actual implementation. See Session API for current API documentation.

Overview#

Introduce versioned API contracts for pgmi’s session-scoped interface (temp tables, views, functions). This enables:

Stable deploy.sql scripts that don’t break on pgmi upgrades
DevOps pipelines pinned to specific API versions
Internal refactoring freedom for pgmi maintainers

Motivation#

Currently, deploy.sql scripts directly reference internal tables like pg_temp.pgmi_source. If pgmi changes the table structure, all user deploy.sql scripts break. By introducing versioned views as the public API, pgmi can evolve internally while maintaining backward compatibility.

Design on pgmi

API versioning

Change Request: API Versioning for pgmi Session Interface#

Overview#

Motivation#