Catch errors when trying to EXPLAIN an invalid query. Fixes #3257

docs/en_US/release_notes.rst

@@ -9,6 +9,7 @@ for it.
 
 .. toctree::
 
+   release_notes_3_1
    release_notes_3_0
    release_notes_2_1
    release_notes_2_0

docs/en_US/release_notes_3_1.rst

@@ -0,0 +1,17 @@
+***********
+Version 3.1
+***********
+
+Release date: 2018-??-??
+
+This release contains a number of features and fixes reported since the release of pgAdmin4 3.0
+
+
+Features
+********
+
+
+Bug fixes
+*********
+
+| `Bug #3257 <https://redmine.postgresql.org/issues/3257>`_ - Catch errors when trying to EXPLAIN an invalid query

web/pgadmin/tools/sqleditor/templates/sqleditor/sql/10_plus/explain_plan.sql

@@ -1,23 +1,15 @@
-EXPLAIN (
+EXPLAIN ({% if format -%}
-{% if format %}
   FORMAT {{ format.upper() }},
-{% endif %}
+{%- endif %}{% if analyze is defined -%}
-{% if analyze is defined %}
   ANALYZE {{ analyze }},
-{% endif %}
+{%- endif %}{% if verbose is defined -%}
-{% if verbose is defined %}
   VERBOSE {{ verbose }},
-{% endif %}
+{%- endif %}{% if costs is defined -%}
-{% if costs is defined %}
   COSTS {{ costs }},
-{% endif %}
+{%- endif %}{% if timing is defined -%}
-{% if timing is defined %}
   TIMING {{ timing }},
-{% endif %}
+{%- endif %}{% if summary is defined -%}
-{% if summary is defined %}
   SUMMARY {{ summary }},
-{% endif %}
+{%- endif %}{% if buffers is defined -%}
-{% if buffers is defined %}
   BUFFERS {{ buffers }}
-{% endif %}
+{%- endif %}) {{ sql }}
-) {{ sql }}

web/pgadmin/tools/sqleditor/templates/sqleditor/sql/9.2_plus/explain_plan.sql

@@ -1,20 +1,13 @@
-EXPLAIN (
+EXPLAIN ({% if format -%}
-{% if format %}
   FORMAT {{ format.upper() }},
-{% endif %}
+{%- endif %}{% if analyze is defined -%}
-{% if analyze is defined %}
   ANALYZE {{ analyze }},
-{% endif %}
+{%- endif %}{% if verbose is defined -%}
-{% if verbose is defined %}
   VERBOSE {{ verbose }},
-{% endif %}
+{%- endif %}{% if costs is defined -%}
-{% if costs is defined %}
   COSTS {{ costs }},
-{% endif %}
+{%- endif %}{% if timing is defined -%}
-{% if timing is defined %}
   TIMING {{ timing }},
-{% endif %}
+{%- endif %}{% if buffers is defined -%}
-{% if buffers is defined %}
   BUFFERS {{ buffers }}
-{% endif %}
+{%- endif %}) {{ sql }}
-) {{ sql }}

web/pgadmin/tools/sqleditor/templates/sqleditor/sql/default/explain_plan.sql

@@ -1,17 +1,10 @@
-EXPLAIN (
+EXPLAIN ({% if format -%}
-{% if format %}
   FORMAT {{ format.upper() }},
-{% endif %}
+{%- endif %}{% if analyze is defined -%}
-{% if analyze is defined %}
+  ANALYZE {{ analyze }},{%- endif %}{% if verbose is defined -%}
-  ANALYZE {{ analyze }},
-{% endif %}
-{% if verbose is defined %}
   VERBOSE {{ verbose }},
-{% endif %}
+{%- endif %}{% if costs is defined -%}
-{% if costs is defined %}
   COSTS {{ costs }},
-{% endif %}
+{%- endif %}{% if buffers is defined -%}
-{% if buffers is defined %}
   BUFFERS {{ buffers }}
-{% endif %}
+{%- endif %}) {{ sql }}
-) {{ sql }}

web/pgadmin/tools/sqleditor/templates/sqleditor/sql/gpdb_5.0_plus/explain_plan.sql

@@ -1,5 +1 @@
-EXPLAIN
+EXPLAIN {% if analyze %}ANALYZE {% endif %}{{ sql }}
-{% if analyze %}
- ANALYZE
-{% endif %}
- {{ sql }}

web/pgadmin/tools/sqleditor/tests/test_explain_plan_templates.py

@@ -35,8 +35,8 @@ class TestExplainPlanTemplates(BaseTestGenerator):
                 ),
                 sql_statement='SELECT * FROM places',
                 expected_return_value='EXPLAIN '
-                                      '(  FORMAT XML,  ANALYZE True,  '
+                                      '(FORMAT XML,ANALYZE True,'
-                                      'VERBOSE True,  COSTS False,  '
+                                      'VERBOSE True,COSTS False,'
                                       'BUFFERS True) SELECT * FROM places'
             )
         ),
@@ -54,7 +54,7 @@ class TestExplainPlanTemplates(BaseTestGenerator):
                 ),
                 sql_statement='SELECT * FROM places',
                 expected_return_value='EXPLAIN '
-                                      '(  FORMAT JSON,  BUFFERS True) '
+                                      '(FORMAT JSON,BUFFERS True) '
                                       'SELECT * FROM places'
             )
         ),
@@ -73,7 +73,7 @@ class TestExplainPlanTemplates(BaseTestGenerator):
                 ),
                 sql_statement='SELECT * FROM places',
                 expected_return_value='EXPLAIN '
-                                      '(  FORMAT JSON,  TIMING False,  '
+                                      '(FORMAT JSON,TIMING False,'
                                       'BUFFERS True) SELECT * FROM places'
             )
         ),
@@ -93,8 +93,8 @@ class TestExplainPlanTemplates(BaseTestGenerator):
                 ),
                 sql_statement='SELECT * FROM places',
                 expected_return_value='EXPLAIN '
-                                      '(  FORMAT YAML,  TIMING False,  '
+                                      '(FORMAT YAML,TIMING False,'
-                                      'SUMMARY True,  BUFFERS True) '
+                                      'SUMMARY True,BUFFERS True) '
                                       'SELECT * FROM places'
             )
         ),