Backport to 2.18.x: #7637: Allow EXPLAIN in read-only mode

.unreleased/pr_7637

@@ -0,0 +1,2 @@
+Fixes: #7637 Allow EXPLAIN in read-only mode
+Thanks: @ikalafat for reporting the error

src/process_utility.c

@@ -4859,6 +4859,7 @@ process_ddl_command_start(ProcessUtilityArgs *args)
 			handler = preprocess_execute;
 			break;
 		case T_ExplainStmt:
+			check_read_only = false;
 			handler = process_explain_start;
 			break;
 

tsl/test/expected/read_only.out

@@ -8,7 +8,84 @@
 -- create_hypertable()
 --
 CREATE TABLE test_table(time bigint NOT NULL, device int);
+-- EXPLAIN should work in read-only mode, when enabling in transaction.
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (COSTS OFF) SELECT * FROM test_table;
+       QUERY PLAN       
+------------------------
+ Seq Scan on test_table
+(1 row)
+
+ROLLBACK;
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) SELECT * FROM test_table;
+                   QUERY PLAN                   
+------------------------------------------------
+ Seq Scan on test_table (actual rows=0 loops=1)
+(1 row)
+
+ROLLBACK;
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (COSTS OFF) INSERT INTO test_table VALUES (1, 1);
+      QUERY PLAN      
+----------------------
+ Insert on test_table
+   ->  Result
+(2 rows)
+
+ROLLBACK;
+-- This should give an error since we are using ANALYZE and a DML. The
+-- read-only is checked when executing the actual INSERT statement,
+-- not inside our code.
+\set ON_ERROR_STOP 0
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) INSERT INTO test_table VALUES (1, 1);
+ERROR:  cannot execute INSERT in a read-only transaction
+ROLLBACK;
+\set ON_ERROR_STOP 1
 SET default_transaction_read_only TO on;
+-- EXPLAIN should work in read-only mode, even when using the default.
+START TRANSACTION;
+EXPLAIN (COSTS OFF) SELECT * FROM test_table;
+       QUERY PLAN       
+------------------------
+ Seq Scan on test_table
+(1 row)
+
+ROLLBACK;
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) SELECT * FROM test_table;
+                   QUERY PLAN                   
+------------------------------------------------
+ Seq Scan on test_table (actual rows=0 loops=1)
+(1 row)
+
+ROLLBACK;
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (COSTS OFF) INSERT INTO test_table VALUES (1, 1);
+      QUERY PLAN      
+----------------------
+ Insert on test_table
+   ->  Result
+(2 rows)
+
+ROLLBACK;
+-- This should give an error since we are using ANALYZE and a DML. The
+-- read-only is checked when executing the actual INSERT statement,
+-- not inside our code.
+\set ON_ERROR_STOP 0
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) INSERT INTO test_table VALUES (1, 1);
+ERROR:  cannot execute INSERT in a read-only transaction
+ROLLBACK;
+\set ON_ERROR_STOP 1
 \set ON_ERROR_STOP 0
 SELECT * FROM create_hypertable('test_table', 'time');
 ERROR:  cannot execute create_hypertable() in a read-only transaction

tsl/test/shared/expected/extension.out

@@ -208,6 +208,8 @@ ORDER BY pronamespace::regnamespace::text COLLATE "C", p.oid::regprocedure::text
  debug_waitpoint_enable(text)
  debug_waitpoint_id(text)
  debug_waitpoint_release(text)
+ ts_hypercore_handler(internal)
+ ts_hypercore_proxy_handler(internal)
  ts_now_mock()
  add_columnstore_policy(regclass,"any",boolean,interval,timestamp with time zone,text,interval,boolean)
  add_compression_policy(regclass,"any",boolean,interval,timestamp with time zone,text,interval,boolean)
@@ -298,8 +300,6 @@ ORDER BY pronamespace::regnamespace::text COLLATE "C", p.oid::regprocedure::text
  time_bucket_gapfill(smallint,smallint,smallint,smallint)
  timescaledb_post_restore()
  timescaledb_pre_restore()
- ts_hypercore_handler(internal)
- ts_hypercore_proxy_handler(internal)
  timescaledb_experimental.add_policies(regclass,boolean,"any","any","any","any",boolean)
  timescaledb_experimental.alter_policies(regclass,boolean,"any","any","any","any")
  timescaledb_experimental.remove_all_policies(regclass,boolean)

tsl/test/sql/read_only.sql

@@ -12,8 +12,59 @@
 --
 CREATE TABLE test_table(time bigint NOT NULL, device int);
 
+-- EXPLAIN should work in read-only mode, when enabling in transaction.
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (COSTS OFF) SELECT * FROM test_table;
+ROLLBACK;
+
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) SELECT * FROM test_table;
+ROLLBACK;
+
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (COSTS OFF) INSERT INTO test_table VALUES (1, 1);
+ROLLBACK;
+
+-- This should give an error since we are using ANALYZE and a DML. The
+-- read-only is checked when executing the actual INSERT statement,
+-- not inside our code.
+\set ON_ERROR_STOP 0
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) INSERT INTO test_table VALUES (1, 1);
+ROLLBACK;
+\set ON_ERROR_STOP 1
+
 SET default_transaction_read_only TO on;
 
+-- EXPLAIN should work in read-only mode, even when using the default.
+START TRANSACTION;
+EXPLAIN (COSTS OFF) SELECT * FROM test_table;
+ROLLBACK;
+
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) SELECT * FROM test_table;
+ROLLBACK;
+
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (COSTS OFF) INSERT INTO test_table VALUES (1, 1);
+ROLLBACK;
+
+-- This should give an error since we are using ANALYZE and a DML. The
+-- read-only is checked when executing the actual INSERT statement,
+-- not inside our code.
+\set ON_ERROR_STOP 0
+START TRANSACTION;
+SET transaction_read_only TO on;
+EXPLAIN (ANALYZE ON, COSTS OFF, TIMING OFF, SUMMARY OFF) INSERT INTO test_table VALUES (1, 1);
+ROLLBACK;
+\set ON_ERROR_STOP 1
+
 \set ON_ERROR_STOP 0
 SELECT * FROM create_hypertable('test_table', 'time');
 \set ON_ERROR_STOP 1
@@ -213,3 +264,4 @@ SELECT remove_retention_policy('test_table');
 SELECT add_job('now','12h');
 SELECT alter_job(1,scheduled:=false);
 SELECT delete_job(1);
+