Skip to content

chore: standardize pg client naming on Pg casing with deprecated aliase - #691

Merged
karenc-bq merged 1 commit into
chore/rename-gdbfrom
chore/pg-naming-consistency
Aug 20, 2026
Merged

chore: standardize pg client naming on Pg casing with deprecated aliase#691
karenc-bq merged 1 commit into
chore/rename-gdbfrom
chore/pg-naming-consistency

Conversation

@karenc-bq

Copy link
Copy Markdown
Contributor

Summary

Standardizes the PostgreSQL module on the dominant Pg casing.
This is a non-breaking change. The old PG-cased names are marked as deprecated and we export backwards-compatible aliases.

Description

Changes

Public API:

  • AwsPGClient → AwsPgClient
  • AwsPGPooledConnection → AwsPgPooledConnection
  • The former names remain exported as @deprecated aliases that resolve to the new names (both value and type), so new AwsPGClient(...), extends AwsPGClient, instanceof AwsPGClient, and AwsPGClient-typed annotations all keep working.

Internal:

  • PGClient → PgClient, PGPoolClient → PgPoolClient interfaces
  • Local variables (awsPGPooledConnection → awsPgPooledConnection)

Docs, examples, and benchmarks:

  • Migrated all customer-facing docs (docs/using-the-nodejs-wrapper/**), example projects, and benchmark scripts to the new names.
  • Added a deprecation callout in the client usage guide and a CHANGELOG entry announcing the rename + deprecation.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@karenc-bq
karenc-bq requested a review from a team as a code owner August 19, 2026 21:32
@karenc-bq
karenc-bq force-pushed the chore/pg-naming-consistency branch from 4071f77 to 7dae6fb Compare August 19, 2026 21:56
@karenc-bq
karenc-bq force-pushed the chore/pg-naming-consistency branch from 7dae6fb to 0409191 Compare August 19, 2026 23:01
@karenc-bq
karenc-bq force-pushed the chore/pg-naming-consistency branch from 0409191 to a633300 Compare August 20, 2026 01:56
@karenc-bq
karenc-bq merged commit be8762e into main Aug 20, 2026
4 checks passed
@karenc-bq
karenc-bq deleted the chore/pg-naming-consistency branch August 20, 2026 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants