chore: refactoring pg sql queries to be fully qualified (#574)

faviansamatha · sophia-bq · web-flow · commit 661df53a58da · 2025-10-16T13:11:51.000-07:00
Co-authored-by: Sophia Chu &lt;chusophx@amazon.com&gt;
diff --git a/examples/aws_driver_example/aws_iam_authentication_postgresql_example.ts b/examples/aws_driver_example/aws_iam_authentication_postgresql_example.ts
@@ -38,7 +38,7 @@ const client = new AwsPGClient({
 // Attempt connection
 try {
   await client.connect();
-  const result = await client.query("select aurora_db_instance_identifier()");
+  const result = await client.query("select pg_catalog.aurora_db_instance_identifier()");
   console.log(result.rows[0]); // { aurora_db_instance_identifier: "instance-id" }
 } finally {
   await client.end();
diff --git a/examples/aws_driver_example/aws_limitless_postgresql_example.ts b/examples/aws_driver_example/aws_limitless_postgresql_example.ts
@@ -39,7 +39,7 @@ const client = new AwsPGClient({
 // Attempt connection
 try {
   await client.connect();
-  const result = await client.query("select aurora_db_instance_identifier()");
+  const result = await client.query("select pg_catalog.aurora_db_instance_identifier()");
   console.log(result);
 } finally {
   await client.end();
diff --git a/examples/aws_driver_example/aws_simple_connection_postgresql_example.ts b/examples/aws_driver_example/aws_simple_connection_postgresql_example.ts
@@ -34,7 +34,7 @@ const client = new AwsPGClient({
 // Attempt connection.
 try {
   await client.connect();
-  const result = await client.query("select aurora_db_instance_identifier()");
+  const result = await client.query("select pg_catalog.aurora_db_instance_identifier()");
   console.log(result.rows[0]); // { aurora_db_instance_identifier: "instance-id" }
 } finally {
   await client.end();
diff --git a/examples/aws_driver_example/telemetry_metrics_otlp_example.ts b/examples/aws_driver_example/telemetry_metrics_otlp_example.ts
@@ -83,7 +83,7 @@ const client = new AwsPGClient({
 
 try {
   await client.connect();
-  const result = (await client.query("select * from aurora_db_instance_identifier()")).rows[0];
+  const result = (await client.query("select * from pg_catalog.aurora_db_instance_identifier()")).rows[0];
   console.log(result);
 } finally {
   await client.end();
diff --git a/examples/aws_driver_example/telemetry_tracing_xray_example.ts b/examples/aws_driver_example/telemetry_tracing_xray_example.ts
@@ -80,7 +80,7 @@ const client = new AwsPGClient({
 
 try {
   await client.connect();
-  const result = (await client.query("select * from aurora_db_instance_identifier()")).rows[0];
+  const result = (await client.query("select * from pg_catalog.aurora_db_instance_identifier()")).rows[0];
   console.log(result);
 } finally {
   await client.end();
diff --git a/examples/javascript_example/index.js b/examples/javascript_example/index.js
@@ -1,12 +1,12 @@
 /*
   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
+ 
   Licensed under the Apache License, Version 2.0 (the "License").
   You may not use this file except in compliance with the License.
   You may obtain a copy of the License at
-
+ 
   http://www.apache.org/licenses/LICENSE-2.0
-
+ 
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -35,7 +35,7 @@ async function main() {
 
   try {
     await client.connect();
-    const result = await client.query("SELECT aurora_db_instance_identifier() as current_id");
+    const result = await client.query("SELECT pg_catalog.aurora_db_instance_identifier() as current_id");
     console.log(`Currently connected to ${result.rows[0].current_id}`);
   } finally {
     await client.end();
diff --git a/pg/lib/dialect/aurora_pg_database_dialect.ts b/pg/lib/dialect/aurora_pg_database_dialect.ts
@@ -24,31 +24,31 @@ import { ClientWrapper } from "../../../common/lib/client_wrapper";
 import { DatabaseDialectCodes } from "../../../common/lib/database_dialect/database_dialect_codes";
 import { LimitlessDatabaseDialect } from "../../../common/lib/database_dialect/limitless_database_dialect";
 import { WrapperProperties } from "../../../common/lib/wrapper_property";
-import {
-  MonitoringRdsHostListProvider
-} from "../../../common/lib/host_list_provider/monitoring/monitoring_host_list_provider";
+import { MonitoringRdsHostListProvider } from "../../../common/lib/host_list_provider/monitoring/monitoring_host_list_provider";
 import { PluginService } from "../../../common/lib/plugin_service";
 import { BlueGreenDialect, BlueGreenResult } from "../../../common/lib/database_dialect/blue_green_dialect";
 
 export class AuroraPgDatabaseDialect extends PgDatabaseDialect implements TopologyAwareDatabaseDialect, LimitlessDatabaseDialect, BlueGreenDialect {
   private static readonly VERSION = process.env.npm_package_version;
   private static readonly TOPOLOGY_QUERY: string =
-    "SELECT server_id, CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END AS is_writer, " +
+    "SELECT server_id, CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END AS is_writer, " +
     "CPU, COALESCE(REPLICA_LAG_IN_MSEC, 0) AS lag, LAST_UPDATE_TIMESTAMP " +
-    "FROM aurora_replica_status() " +
+    "FROM pg_catalog.aurora_replica_status() " +
     // filter out nodes that haven't been updated in the last 5 minutes
-    "WHERE EXTRACT(EPOCH FROM(NOW() - LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID' " +
+    "WHERE EXTRACT(EPOCH FROM(pg_catalog.NOW() OPERATOR(pg_catalog.-) LAST_UPDATE_TIMESTAMP)) OPERATOR(pg_catalog.<=) 300 OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' " +
     "OR LAST_UPDATE_TIMESTAMP IS NULL";
   private static readonly EXTENSIONS_SQL: string =
-    "SELECT (setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils FROM pg_settings WHERE name='rds.extensions'";
-  private static readonly HOST_ID_QUERY: string = "SELECT aurora_db_instance_identifier() as host";
-  private static readonly IS_READER_QUERY: string = "SELECT pg_is_in_recovery() as is_reader";
+    "SELECT (setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils FROM pg_catalog.pg_settings WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'";
+  private static readonly HOST_ID_QUERY: string = "SELECT pg_catalog.aurora_db_instance_identifier() as host";
+  private static readonly IS_READER_QUERY: string = "SELECT pg_catalog.pg_is_in_recovery() as is_reader";
   private static readonly IS_WRITER_QUERY: string =
-    "SELECT server_id " + "FROM aurora_replica_status() " + "WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = aurora_db_instance_identifier()";
+    "SELECT server_id " +
+    "FROM pg_catalog.aurora_replica_status() " +
+    "WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()";
 
-  private static readonly BG_STATUS_QUERY: string = `SELECT * FROM get_blue_green_fast_switchover_metadata('aws_advanced_nodejs_wrapper-${AuroraPgDatabaseDialect.VERSION}')`;
+  private static readonly BG_STATUS_QUERY: string = `SELECT * FROM pg_catalog.get_blue_green_fast_switchover_metadata('aws_advanced_nodejs_wrapper-${AuroraPgDatabaseDialect.VERSION}')`;
 
-  private static readonly TOPOLOGY_TABLE_EXIST_QUERY: string = "SELECT 'get_blue_green_fast_switchover_metadata'::regproc";
+  private static readonly TOPOLOGY_TABLE_EXIST_QUERY: string = "SELECT pg_catalog.'get_blue_green_fast_switchover_metadata'::regproc";
 
   getHostListProvider(props: Map<string, any>, originalUrl: string, hostListProviderService: HostListProviderService): HostListProvider {
     if (WrapperProperties.PLUGINS.get(props).includes("failover2")) {
diff --git a/pg/lib/dialect/pg_database_dialect.ts b/pg/lib/dialect/pg_database_dialect.ts
@@ -17,9 +17,7 @@
 import { DatabaseDialect, DatabaseType } from "../../../common/lib/database_dialect/database_dialect";
 import { HostListProviderService } from "../../../common/lib/host_list_provider_service";
 import { HostListProvider } from "../../../common/lib/host_list_provider/host_list_provider";
-import {
-  ConnectionStringHostListProvider
-} from "../../../common/lib/host_list_provider/connection_string_host_list_provider";
+import { ConnectionStringHostListProvider } from "../../../common/lib/host_list_provider/connection_string_host_list_provider";
 import { AwsWrapperError, HostRole, TransactionIsolationLevel, UnsupportedMethodError } from "../../../common/lib";
 import { DatabaseDialectCodes } from "../../../common/lib/database_dialect/database_dialect_codes";
 import { ClientWrapper } from "../../../common/lib/client_wrapper";
@@ -41,7 +39,7 @@ export class PgDatabaseDialect implements DatabaseDialect {
   }
 
   getHostAliasQuery(): string {
-    return "SELECT CONCAT(inet_server_addr(), ':', inet_server_port())";
+    return "SELECT pg_catalog.CONCAT(pg_catalog.inet_server_addr(), ':', pg_catalog.inet_server_port())";
   }
 
   async getHostAliasAndParseResults(targetClient: ClientWrapper): Promise<string> {
@@ -56,7 +54,7 @@ export class PgDatabaseDialect implements DatabaseDialect {
   }
 
   getServerVersionQuery(): string {
-    return "SELECT 'version', VERSION()";
+    return "SELECT 'version', pg_catalog.VERSION()";
   }
 
   getSetReadOnlyQuery(readOnly: boolean): string {
@@ -98,7 +96,7 @@ export class PgDatabaseDialect implements DatabaseDialect {
 
   async isDialect(targetClient: ClientWrapper): Promise<boolean> {
     return await targetClient
-      .query("SELECT 1 FROM pg_proc LIMIT 1")
+      .query("SELECT 1 FROM pg_catalog.pg_proc LIMIT 1")
       .then((result: { rows: any }) => {
         return !!result.rows[0];
       })
diff --git a/pg/lib/dialect/rds_multi_az_pg_database_dialect.ts b/pg/lib/dialect/rds_multi_az_pg_database_dialect.ts
@@ -27,9 +27,7 @@ import { ErrorHandler } from "../../../common/lib/error_handler";
 import { MultiAzPgErrorHandler } from "../multi_az_pg_error_handler";
 import { WrapperProperties } from "../../../common/lib/wrapper_property";
 import { PluginService } from "../../../common/lib/plugin_service";
-import {
-  MonitoringRdsHostListProvider
-} from "../../../common/lib/host_list_provider/monitoring/monitoring_host_list_provider";
+import { MonitoringRdsHostListProvider } from "../../../common/lib/host_list_provider/monitoring/monitoring_host_list_provider";
 
 export class RdsMultiAZClusterPgDatabaseDialect extends PgDatabaseDialect implements TopologyAwareDatabaseDialect {
   constructor() {
@@ -38,13 +36,13 @@ export class RdsMultiAZClusterPgDatabaseDialect extends PgDatabaseDialect implem
   private static readonly VERSION = process.env.npm_package_version;
   private static readonly TOPOLOGY_QUERY: string = `SELECT id, endpoint, port FROM rds_tools.show_topology('aws_advanced_nodejs_wrapper-"${RdsMultiAZClusterPgDatabaseDialect.VERSION}"')`;
   private static readonly WRITER_HOST_FUNC_EXIST_QUERY: string =
-    "SELECT 1 AS tmp FROM information_schema.routines WHERE routine_schema='rds_tools' AND routine_name='multi_az_db_cluster_source_dbi_resource_id'";
+    "SELECT 1 AS tmp FROM information_schema.routines WHERE routine_schema OPERATOR(pg_catalog.=) 'rds_tools' AND routine_name OPERATOR(pg_catalog.=) 'multi_az_db_cluster_source_dbi_resource_id'";
   private static readonly FETCH_WRITER_HOST_QUERY: string =
     "SELECT multi_az_db_cluster_source_dbi_resource_id FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()";
   private static readonly FETCH_WRITER_HOST_QUERY_COLUMN_NAME: string = "multi_az_db_cluster_source_dbi_resource_id";
   private static readonly HOST_ID_QUERY: string = "SELECT dbi_resource_id FROM rds_tools.dbi_resource_id()";
   private static readonly HOST_ID_QUERY_COLUMN_NAME: string = "dbi_resource_id";
-  private static readonly IS_READER_QUERY: string = "SELECT pg_is_in_recovery() AS is_reader";
+  private static readonly IS_READER_QUERY: string = "SELECT pg_catalog.pg_is_in_recovery() AS is_reader";
   private static readonly IS_READER_QUERY_COLUMN_NAME: string = "is_reader";
 
   async isDialect(targetClient: ClientWrapper): Promise<boolean> {
diff --git a/pg/lib/dialect/rds_pg_database_dialect.ts b/pg/lib/dialect/rds_pg_database_dialect.ts
@@ -24,7 +24,7 @@ export class RdsPgDatabaseDialect extends PgDatabaseDialect implements BlueGreen
 
   private static readonly EXTENSIONS_SQL: string =
     "SELECT (setting LIKE '%rds_tools%') AS rds_tools, (setting LIKE '%aurora_stat_utils%') AS aurora_stat_utils " +
-    "FROM pg_settings WHERE name='rds.extensions'";
+    "FROM pg_catalog.pg_settings WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'";
 
   private static readonly BG_STATUS_QUERY: string = `SELECT * FROM rds_tools.show_topology('aws_advanced_nodejs_wrapper-${RdsPgDatabaseDialect.VERSION}')`;
 
diff --git a/tests/integration/container/tests/blue_green_deployment.test.ts b/tests/integration/container/tests/blue_green_deployment.test.ts
@@ -668,7 +668,7 @@ async function getWrapperBlueExecutingConnectivityMonitoringPromise(
   let query;
   switch (env.info.request.engine) {
     case DatabaseEngine.PG:
-      query = "SELECT PG_SLEEP(5)";
+      query = "SELECT pg_catalog.PG_SLEEP(5)";
       break;
     case DatabaseEngine.MYSQL:
       query = "SELECT SLEEP(5)";
diff --git a/tests/integration/container/tests/pg_pool.test.ts b/tests/integration/container/tests/pg_pool.test.ts
@@ -1,17 +1,17 @@
 /*
- Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
- Licensed under the Apache License, Version 2.0 (the "License").
- You may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
+  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ 
+  Licensed under the Apache License, Version 2.0 (the "License").
+  You may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+ 
+  http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
 */
 
 import { features, instanceCount } from "./config";
@@ -120,7 +120,9 @@ describe("pg pool integration tests", () => {
     describe(`using ${name}`, () => {
       itIfPG("concurrent execution", async () => {
         client = await factory();
-        const queries = Array.from({ length: 10 }, (_, i) => client.query("SELECT $1::int as query_id, pg_backend_pid() as connection_id", [i + 1]));
+        const queries = Array.from({ length: 10 }, (_, i) =>
+          client.query("SELECT $1::int as query_id, pg_catalog.pg_backend_pid() as connection_id", [i + 1])
+        );
         const results = await Promise.all(queries);
         expect(results).toHaveLength(10);
         const connectionIds = new Set();
@@ -136,7 +138,7 @@ describe("pg pool integration tests", () => {
         const results = [];
         const connectionIds = new Set();
         for (let i = 0; i < 10; i++) {
-          const result = await client.query("SELECT $1::int as query_id, pg_backend_pid() as connection_id", [i + 1]);
+          const result = await client.query("SELECT $1::int as query_id, pg_catalog.pg_backend_pid() as connection_id", [i + 1]);
           results.push(result);
           connectionIds.add(result.rows[0].connection_id);
         }
diff --git a/tests/integration/container/tests/utils/aurora_test_utility.ts b/tests/integration/container/tests/utils/aurora_test_utility.ts
@@ -116,7 +116,7 @@ export class AuroraTestUtility {
             break;
           case DatabaseEngine.PG:
             retrieveTopologySql =
-              "SELECT SERVER_ID, SESSION_ID FROM aurora_replica_status() ORDER BY CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN 0 ELSE 1 END";
+              "SELECT SERVER_ID, SESSION_ID FROM pg_catalog.aurora_replica_status() ORDER BY CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN 0 ELSE 1 END";
             break;
           default:
             throw new Error(`Unsupported database engine: ${engine}`);
@@ -134,7 +134,7 @@ export class AuroraTestUtility {
           }
           case DatabaseEngine.PG:
             retrieveTopologySql =
-              "SELECT SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint)) as SERVER_ID FROM rds_tools.show_topology() ORDER BY CASE WHEN id = (SELECT MAX(multi_az_db_cluster_source_dbi_resource_id) FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()) THEN 0 ELSE 1 END, endpoint";
+              "SELECT SUBSTRING(endpoint FROM 0 FOR POSITION('.' IN endpoint)) as SERVER_ID FROM rds_tools.show_topology() ORDER BY CASE WHEN id OPERATOR(pg_catalog.=) (SELECT MAX(multi_az_db_cluster_source_dbi_resource_id) FROM rds_tools.multi_az_db_cluster_source_dbi_resource_id()) THEN 0 ELSE 1 END, endpoint";
 
             break;
           default:
diff --git a/tests/integration/container/tests/utils/driver_helper.ts b/tests/integration/container/tests/utils/driver_helper.ts
@@ -62,7 +62,7 @@ export class DriverHelper {
       case DatabaseEngineDeployment.AURORA:
         switch (engine) {
           case DatabaseEngine.PG:
-            return "SELECT pg_sleep(10)";
+            return "SELECT pg_catalog.pg_sleep(10)";
           case DatabaseEngine.MYSQL:
             return "SELECT sleep(10)";
           default:
@@ -76,7 +76,7 @@ export class DriverHelper {
       case DatabaseEngineDeployment.AURORA:
         switch (engine) {
           case DatabaseEngine.PG:
-            return "SELECT aurora_db_instance_identifier() as id";
+            return "SELECT pg_catalog.aurora_db_instance_identifier() as id";
           case DatabaseEngine.MYSQL:
             return "SELECT @@aurora_server_id as id";
           default:
@@ -137,7 +137,7 @@ export class DriverHelper {
   static getSleepQuery(engine: DatabaseEngine, seconds: number) {
     switch (engine) {
       case DatabaseEngine.PG:
-        return `select pg_sleep(${seconds})`;
+        return `select pg_catalog.pg_sleep(${seconds})`;
       case DatabaseEngine.MYSQL:
         return `select sleep(${seconds})`;
       default:
diff --git a/tests/integration/host/src/test/java/integration/host/util/ContainerHelper.java b/tests/integration/host/src/test/java/integration/host/util/ContainerHelper.java
@@ -58,8 +58,8 @@ public class ContainerHelper {
   private static final String OTLP_TELEMETRY_IMAGE_NAME = "amazon/aws-otel-collector";
 
   private static final String RETRIEVE_TOPOLOGY_SQL_POSTGRES =
-      "SELECT SERVER_ID, SESSION_ID FROM aurora_replica_status() "
-          + "ORDER BY CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN 0 ELSE 1 END";
+      "SELECT SERVER_ID, SESSION_ID FROM pg_catalog.aurora_replica_status() "
+          + "ORDER BY CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN 0 ELSE 1 END";
   private static final String RETRIEVE_TOPOLOGY_SQL_MYSQL =
       "SELECT SERVER_ID, SESSION_ID FROM information_schema.replica_host_status "
           + "ORDER BY IF(SESSION_ID = 'MASTER_SESSION_ID', 0, 1)";
diff --git a/tests/testplugin/benchmark_plugin.ts b/tests/testplugin/benchmark_plugin.ts
@@ -14,7 +14,14 @@
   limitations under the License.
 */
 
-import { ConnectionPlugin, HostInfo, HostListProviderService, HostChangeOptions, OldConnectionSuggestionAction, HostRole, HostInfoBuilder, SimpleHostAvailabilityStrategy, Messages } from "../../index";
+import { ConnectionPlugin, HostInfo, HostRole } from "../../index";
+import { HostListProviderService } from "../../common/lib/host_list_provider_service";
+import { HostChangeOptions } from "../../common/lib/host_change_options";
+import { OldConnectionSuggestionAction } from "../../common/lib/old_connection_suggestion_action";
+import { HostInfoBuilder } from "../../common/lib";
+import { SimpleHostAvailabilityStrategy } from "../../common/lib/host_availability/simple_host_availability_strategy";
+import { Messages } from "../../common/lib/utils/messages";
+
 import { logger } from "../../common/logutils";
 
 export class BenchmarkPlugin implements ConnectionPlugin {
diff --git a/tests/testplugin/benchmark_plugin_factory.ts b/tests/testplugin/benchmark_plugin_factory.ts
@@ -14,8 +14,10 @@
   limitations under the License.
 */
 
-import { ConnectionPluginFactory, PluginServiceImpl, ConnectionPlugin, AwsWrapperError, Messages } from "../../index";
+import { ConnectionPlugin, PluginService, AwsWrapperError } from "../../index";
+import { Messages } from "../../common/lib/utils/messages";
 import { BenchmarkPlugin } from "./benchmark_plugin";
+import { ConnectionPluginFactory } from "../../common/lib/plugin_factory";
 
 export class BenchmarkPluginFactory extends ConnectionPluginFactory {
   async getInstance(pluginService: PluginService, properties: object): Promise<ConnectionPlugin> {
diff --git a/tests/unit/database_dialect.test.ts b/tests/unit/database_dialect.test.ts
