From 517a81388d4f81c777f22c82ada2a8f66e05306f Mon Sep 17 00:00:00 2001 From: Bharath Rupireddy Date: Wed, 3 Feb 2021 18:26:47 +0530 Subject: [PATCH v21] postgres_fdw add keep_connections GUC to not cache connections This patch adds a new GUC postgres_fdw.keep_connections, default being on, when set to off no remote connections are cached by the local session. --- contrib/postgres_fdw/connection.c | 12 +++-- .../postgres_fdw/expected/postgres_fdw.out | 28 ++++++++++++ contrib/postgres_fdw/postgres_fdw.c | 16 +++++++ contrib/postgres_fdw/postgres_fdw.h | 3 ++ contrib/postgres_fdw/sql/postgres_fdw.sql | 15 +++++++ doc/src/sgml/postgres-fdw.sgml | 45 +++++++++++++++++++ 6 files changed, 116 insertions(+), 3 deletions(-) diff --git a/contrib/postgres_fdw/connection.c b/contrib/postgres_fdw/connection.c index ee0b4acf0b..3325ce00f2 100644 --- a/contrib/postgres_fdw/connection.c +++ b/contrib/postgres_fdw/connection.c @@ -809,6 +809,7 @@ pgfdw_xact_callback(XactEvent event, void *arg) while ((entry = (ConnCacheEntry *) hash_seq_search(&scan))) { PGresult *res; + bool used_in_current_xact = false; /* Ignore cache entry if no open connection right now */ if (entry->conn == NULL) @@ -819,6 +820,8 @@ pgfdw_xact_callback(XactEvent event, void *arg) { bool abort_cleanup_failure = false; + used_in_current_xact = true; + elog(DEBUG3, "closing remote transaction on connection %p", entry->conn); @@ -953,16 +956,19 @@ pgfdw_xact_callback(XactEvent event, void *arg) /* * If the connection isn't in a good idle state or it is marked as - * invalid, then discard it to recover. Next GetConnection will open a - * new connection. + * invalid or keep_connections GUC is false and this connection is used + * in current xact, then discard it to recover. Next GetConnection will + * open a new connection. */ if (PQstatus(entry->conn) != CONNECTION_OK || PQtransactionStatus(entry->conn) != PQTRANS_IDLE || entry->changing_xact_state || - entry->invalidated) + entry->invalidated || + (used_in_current_xact && !keep_connections)) { elog(DEBUG3, "discarding connection %p", entry->conn); disconnect_pg_server(entry); + used_in_current_xact = false; } } diff --git a/contrib/postgres_fdw/expected/postgres_fdw.out b/contrib/postgres_fdw/expected/postgres_fdw.out index b09dce63f5..f89c189a48 100644 --- a/contrib/postgres_fdw/expected/postgres_fdw.out +++ b/contrib/postgres_fdw/expected/postgres_fdw.out @@ -9263,6 +9263,34 @@ DROP USER MAPPING FOR regress_multi_conn_user1 SERVER loopback; DROP USER MAPPING FOR regress_multi_conn_user2 SERVER loopback; DROP ROLE regress_multi_conn_user1; DROP ROLE regress_multi_conn_user2; +-- =================================================================== +-- Test postgres_fdw.keep_connections GUC +-- =================================================================== +-- By default, keep_connections GUC is on i.e. local session caches all the +-- foreign server connections. +SHOW postgres_fdw.keep_connections; + postgres_fdw.keep_connections +------------------------------- + on +(1 row) + +-- Set it off i.e. the cached connections which are used after this setting are +-- disconnected at the end of respective xacts. +SET postgres_fdw.keep_connections TO off; +-- Make connection using loopback server, connection should not be cached as +-- the GUC is off. +SELECT 1 FROM ft1 LIMIT 1; + ?column? +---------- + 1 +(1 row) + +-- No cached connections, so no records should be output. +SELECT server_name FROM postgres_fdw_get_connections() ORDER BY 1; + server_name +------------- +(0 rows) + -- =================================================================== -- batch insert -- =================================================================== diff --git a/contrib/postgres_fdw/postgres_fdw.c b/contrib/postgres_fdw/postgres_fdw.c index 2ce42ce3f1..c5a76b7ad0 100644 --- a/contrib/postgres_fdw/postgres_fdw.c +++ b/contrib/postgres_fdw/postgres_fdw.c @@ -312,6 +312,8 @@ typedef struct List *already_used; /* expressions already dealt with */ } ec_member_foreign_arg; +bool keep_connections = true; + /* * SQL functions */ @@ -527,6 +529,20 @@ static void merge_fdw_options(PgFdwRelationInfo *fpinfo, const PgFdwRelationInfo *fpinfo_i); static int get_batch_size_option(Relation rel); +void +_PG_init(void) +{ + DefineCustomBoolVariable("postgres_fdw.keep_connections", + "Enables postgres_fdw connection caching.", + "When off postgres_fdw will close connections at the end of transaction.", + &keep_connections, + true, + PGC_USERSET, + 0, + NULL, + NULL, + NULL); +} /* * Foreign-data wrapper handler function: return a struct with pointers diff --git a/contrib/postgres_fdw/postgres_fdw.h b/contrib/postgres_fdw/postgres_fdw.h index 1f67b4d9fd..ceea46b304 100644 --- a/contrib/postgres_fdw/postgres_fdw.h +++ b/contrib/postgres_fdw/postgres_fdw.h @@ -124,9 +124,12 @@ typedef struct PgFdwRelationInfo int relation_index; } PgFdwRelationInfo; +extern bool keep_connections; + /* in postgres_fdw.c */ extern int set_transmission_modes(void); extern void reset_transmission_modes(int nestlevel); +extern void _PG_init(void); /* in connection.c */ extern PGconn *GetConnection(UserMapping *user, bool will_prep_stmt); diff --git a/contrib/postgres_fdw/sql/postgres_fdw.sql b/contrib/postgres_fdw/sql/postgres_fdw.sql index 319c15d635..b4234e19cf 100644 --- a/contrib/postgres_fdw/sql/postgres_fdw.sql +++ b/contrib/postgres_fdw/sql/postgres_fdw.sql @@ -2807,6 +2807,21 @@ DROP USER MAPPING FOR regress_multi_conn_user2 SERVER loopback; DROP ROLE regress_multi_conn_user1; DROP ROLE regress_multi_conn_user2; +-- =================================================================== +-- Test postgres_fdw.keep_connections GUC +-- =================================================================== +-- By default, keep_connections GUC is on i.e. local session caches all the +-- foreign server connections. +SHOW postgres_fdw.keep_connections; +-- Set it off i.e. the cached connections which are used after this setting are +-- disconnected at the end of respective xacts. +SET postgres_fdw.keep_connections TO off; +-- Make connection using loopback server, connection should not be cached as +-- the GUC is off. +SELECT 1 FROM ft1 LIMIT 1; +-- No cached connections, so no records should be output. +SELECT server_name FROM postgres_fdw_get_connections() ORDER BY 1; + -- =================================================================== -- batch insert -- =================================================================== diff --git a/doc/src/sgml/postgres-fdw.sgml b/doc/src/sgml/postgres-fdw.sgml index 8d6abd4c54..838b9a0084 100644 --- a/doc/src/sgml/postgres-fdw.sgml +++ b/doc/src/sgml/postgres-fdw.sgml @@ -571,6 +571,43 @@ postgres=# SELECT postgres_fdw_disconnect_all(); + + Configuration Parameters + + + + + + postgres_fdw.keep_connections (boolean) + + postgres_fdw.keep_connections configuration parameter + + + + + + + Allows postgres_fdw to keep or discard the + connection made to the foreign server by the local session. Default is + on. When set to off the local + session doesn't keep the connections made to the foreign servers. Each + connection is discarded at the end of transaction in which it is used. + + + + Note that setting postgres_fdw.keep_connections to + off does not discard any previously made and still open + connections immediately. They will be closed only at the end of future + transactions, which operated on them. Use postgres_fdw_disconnect_all + function or postgres_fdw_disconnect function to + close all or specific foreign server connections respectively. + + + + + + + Connection Management @@ -602,6 +639,14 @@ postgres=# SELECT postgres_fdw_disconnect_all(); the connections that are no longer necessary and then preventing them from consuming the foreign server connections capacity too much. + + + Use configuration parameter postgres_fdw.keep_connections, + so that the local session doesn't keep any remote connections that are made + to the foreign servers within it. Default being on, when + set to off, each connection is discarded at the end of + local transaction in which it is used. + -- 2.25.1