Fix review comments.

khushboovashi · khushboovashi · commit 5bd6bcef0879 · 2025-06-12T16:32:16.000+05:30
diff --git a/docs/en_US/images/query_tool_server_cursor_preference.png b/docs/en_US/images/query_tool_server_cursor_preference.png
diff --git a/docs/en_US/preferences.rst b/docs/en_US/preferences.rst
@@ -535,6 +535,10 @@ Use the fields on the *Options* panel to manage editor preferences.
   will warn upon clicking the *Execute Query* button in the query tool.  The warning
   will appear only if *Underline query at cursor?* is set to *False*.
 
+* When the *Use server cursor?* switch is set to *True*, the dataset will be fetched
+  using a server-side cursor after the query is executed.
+
+
 .. image:: images/preferences_sql_results_grid.png
     :alt: Preferences dialog sql results grid section
     :align: center
diff --git a/docs/en_US/query_tool.rst b/docs/en_US/query_tool.rst
@@ -568,16 +568,11 @@ very large result sets. However, they may offer lower performance in typical, ev
 
 To enable server-side cursors:
 
-* Go to Preferences > Query Tool > Options and set "Execute with server-side cursor?" to True.
-
-.. image:: images/query_tool_server_cursor_preference.png
-   :alt: Query Tool Manage Macros Clear row confirmation
-   :align: center
-
+* Go to Preferences > Query Tool > Options and set "Use server cursor?" to True.
 * Alternatively, you can enable it on a per-session basis via the Query Tool’s Execute menu.
 
 .. image:: images/query_tool_server_cursor_execute_menu.png
-   :alt: Query Tool Manage Macros Clear row confirmation
+   :alt: Query Tool Server Cursor
    :align: center
 
 
diff --git a/web/pgadmin/static/js/components/PgTree/FileTreeItem/index.tsx b/web/pgadmin/static/js/components/PgTree/FileTreeItem/index.tsx
@@ -134,6 +134,7 @@ export class FileTreeItem extends React.Component<IItemRendererXProps & IItemRen
   }
 
   private readonly setActiveFile = async (FileOrDir): Promise<void> => {
+
     this.props.changeDirectoryCount(FileOrDir.parent);
     if(FileOrDir._loaded !== true) {
       this.events.dispatch(FileTreeXEvent.onTreeEvents, window.event, 'added', FileOrDir);
diff --git a/web/pgadmin/static/js/tree/pgadmin_tree_save_state.js b/web/pgadmin/static/js/tree/pgadmin_tree_save_state.js
@@ -1,4 +1,4 @@
-/////////////////////////////////////////////////////////////
+l/////////////////////////////////////////////////////////////
 //
 // pgAdmin 4 - PostgreSQL Tools
 //
diff --git a/web/pgadmin/tools/sqleditor/__init__.py b/web/pgadmin/tools/sqleditor/__init__.py
@@ -930,6 +930,7 @@ def start_view_data(trans_id):
         status, result = conn.execute_async(
             sql,
             server_cursor=trans_obj.server_cursor)
+
     else:
         status = False
         result = error_msg
@@ -1894,11 +1895,11 @@ def set_pref_options(trans_id, operation):
 
         if operation == 'auto_commit':
             # Call the set_auto_commit method of transaction object
-            trans_obj.set_auto_commit(_data)
+            trans_obj.set_auto_commit(_data['auto_commit'])
         elif operation == 'auto_rollback':
-            trans_obj.set_auto_rollback(_data)
+            trans_obj.set_auto_rollback(_data['auto_rollback'])
         elif operation == 'server_cursor':
-            trans_obj.set_server_cursor(_data)
+            trans_obj.set_server_cursor(_data['server_cursor'])
 
         # As we changed the transaction object we need to
         # restore it and update the session variable.
@@ -1933,7 +1934,7 @@ def set_auto_commit(trans_id):
 @pga_login_required
 def set_auto_rollback(trans_id):
     """
-    This method is used to set the value for auto commit .
+    This method is used to set the value for auto rollback .
 
     Args:
         trans_id: unique transaction id
@@ -1948,7 +1949,7 @@ def set_auto_rollback(trans_id):
 @pga_login_required
 def set_server_cursor(trans_id):
     """
-    This method is used to set the value for server_cursor.
+    This method is used to set the value for server cursor.
 
     Args:
         trans_id: unique transaction id
diff --git a/web/pgadmin/tools/sqleditor/static/js/components/sections/MainToolBar.jsx b/web/pgadmin/tools/sqleditor/static/js/components/sections/MainToolBar.jsx
@@ -46,7 +46,7 @@ const StyledBox = styled(Box)(({theme}) => ({
   ...theme.mixins.panelBorder.bottom,
 }));
 
-function autoCommitRollback(type, api, transId, value) {
+function autoCommitRollbackServerCur(type, api, transId, value) {
   let url = url_for(`sqleditor.${type}`, {
     'trans_id': transId,
   });
@@ -127,7 +127,7 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
         queryToolCtx.updateServerCursor({server_cursor: newVal});
       }
       if(e.value === 'auto_commit' || e.value === 'auto_rollback' || e.value === 'server_cursor') {
-        autoCommitRollback(e.value, queryToolCtx.api, queryToolCtx.params.trans_id, newVal)
+        autoCommitRollbackServerCur(e.value, queryToolCtx.api, queryToolCtx.params.trans_id, newVal)
           .catch ((error)=>{
             newVal = prev[e.value];
             eventBus.fireEvent(QUERY_TOOL_EVENTS.HANDLE_API_ERROR, error, {
@@ -267,8 +267,8 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
   };
   useEffect(()=>{
     if(isInTxn()) {
-      setDisableButton('commit', false);
-      setDisableButton('rollback', false);
+      setDisableButton('commit', queryToolCtx.params.server_cursor && !queryToolCtx.params.is_query_tool ?true:false);
+      setDisableButton('rollback', queryToolCtx.params.server_cursor && !queryToolCtx.params.is_query_tool ?true:false);
       setDisableButton('execute-options', true);
     } else {
       setDisableButton('commit', true);
@@ -639,7 +639,7 @@ export function MainToolBar({containerRef, onFilterClick, onManageMacros, onAddT
         <PgMenuItem hasCheck value="auto_rollback" checked={checkedMenuItems['auto_rollback']}
           onClick={checkMenuClick}>{gettext('Auto rollback on error?')}</PgMenuItem>
         <PgMenuItem hasCheck value="server_cursor" checked={checkedMenuItems['server_cursor']}
-          onClick={checkMenuClick}>{gettext('Use server cursor')}</PgMenuItem>
+          onClick={checkMenuClick}>{gettext('Use server cursor?')}</PgMenuItem>
       </PgMenu>
       <PgMenu
         anchorRef={explainMenuRef}
diff --git a/web/pgadmin/tools/sqleditor/static/js/components/sections/ResultSetToolbar.jsx b/web/pgadmin/tools/sqleditor/static/js/components/sections/ResultSetToolbar.jsx
@@ -205,16 +205,16 @@ function PaginationInputs({pagination, totalRowCount, clearSelection, serverCurs
           />
         </Box> : <span>{gettext('Showing rows: %s to %s', inputs.from, inputs.to)}</span>}
       <PgButtonGroup>
-        {editPageRange && <PgIconButton size="xs"
+        {!serverCursor && editPageRange && <PgIconButton size="xs"
           title={editPageRange ? gettext('Apply (or press Enter on input)') : gettext('Edit range')}
           onClick={()=>eventBus.fireEvent(QUERY_TOOL_EVENTS.FETCH_WINDOW, inputs.from, inputs.to)}
           disabled={errorInputs.from || errorInputs.to} icon={<CheckRoundedIcon />}
         />}
-        <PgIconButton size="xs"
+        {!serverCursor && <PgIconButton size="xs"
           title={editPageRange ? gettext('Cancel edit') : gettext('Edit range')}
           onClick={()=>setEditPageRange((prev)=>!prev)}
           icon={editPageRange ? <EditOffRoundedIcon /> : <EditRoundedIcon />}
-        />
+        />}
       </PgButtonGroup>
       <div className='PaginationInputs-divider'>&nbsp;</div>
       <span>{gettext('Page No:')}</span>
@@ -228,13 +228,14 @@ function PaginationInputs({pagination, totalRowCount, clearSelection, serverCurs
         value={inputs.pageNo}
         onChange={(value)=>onInputChange('pageNo', value)}
         onKeyDown={onInputKeydownPageNo}
+        disabled={serverCursor}
         error={errorInputs['pageNo']}
       />
       <span> {gettext('of')} {pagination.page_count}</span>
       <div className='PaginationInputs-divider'>&nbsp;</div>
       <PgButtonGroup size="small">
         <PgIconButton title={gettext('First Page')} disabled={pagination.page_no <= 1 || serverCursor} onClick={()=>goToPage(1)} icon={<SkipPreviousRoundedIcon />}/>
-        <PgIconButton title={gettext('Previous Page')} disabled={pagination.page_no <= 1 && !serverCursor} onClick={()=>goToPage(pagination.page_no-1)} icon={<FastRewindRoundedIcon />}/>
+        <PgIconButton title={gettext('Previous Page')} disabled={pagination.page_no <= 1} onClick={()=>goToPage(pagination.page_no-1)} icon={<FastRewindRoundedIcon />}/>
         <PgIconButton title={gettext('Next Page')} disabled={pagination.page_no == pagination.page_count && !serverCursor} onClick={()=>goToPage(pagination.page_no+1)} icon={<FastForwardRoundedIcon />}/>
         <PgIconButton title={gettext('Last Page')} disabled={pagination.page_no == pagination.page_count || serverCursor} onClick={()=>goToPage(pagination.page_count)} icon={<SkipNextRoundedIcon />} />
       </PgButtonGroup>
diff --git a/web/pgadmin/tools/sqleditor/tests/test_server_cursor.py b/web/pgadmin/tools/sqleditor/tests/test_server_cursor.py
@@ -40,7 +40,7 @@ def setUp(self):
             secrets.choice(range(10000, 65535)))
         self._sid = self.server_information['server_id']
 
-        server_con = server_utils.connect_server(self, self._sid)
+        server_utils.connect_server(self, self._sid)
 
         self._did = test_utils.create_database(
             self.server, self._db_name
@@ -64,12 +64,10 @@ def initiate_sql_query_tool(self, trans_id, sql_query):
 
     def set_server_cursor(self, server_cursor):
         _url = '/sqleditor/server_cursor/{0}'.format(self.trans_id)
-        print(_url)
         res = self.tester.post(_url, data=json.dumps({
             "server_cursor": server_cursor
         }))
 
-        print(res)
         self.assertEqual(res.status_code, 200)
 
     def runTest(self):
@@ -78,7 +76,7 @@ def runTest(self):
                                                  test_utils.SERVER_GROUP,
                                                  self._sid,
                                                  self._did)
-        if not db_con["info"] == "Database connected.":
+        if db_con["info"] != "Database connected.":
             raise Exception("Could not connect to the database.")
 
         # Initialize query tool
@@ -95,7 +93,8 @@ def runTest(self):
         response = self.initiate_sql_query_tool(self.trans_id, self.sql)
 
         self.assertEqual(response.status_code, 200)
-        csv_data = response.data.decode()
+        _resp = response.data.decode()
+        self.assertTrue(_resp.server_cursor)
 
         self.set_server_cursor(False)
 
diff --git a/web/pgadmin/tools/sqleditor/utils/query_tool_preferences.py b/web/pgadmin/tools/sqleditor/utils/query_tool_preferences.py
@@ -82,13 +82,13 @@ def register_query_tool_preferences(self):
 
     self.server_cursor = self.preference.register(
         'Options', 'server_cursor',
-        gettext("Execute with server side cursor?"), 'boolean', False,
+        gettext("Use server cursor?"), 'boolean', False,
         category_label=PREF_LABEL_OPTIONS,
-        help_str=gettext('If set to True, the dataset will be fetched from the'
-                         ' server-side cursor after query execution.'
-                         ' This will be helpful to transfer to the client only'
-                         ' a controlled amount of data, so a large dataset can'
-                         ' be examined without being kept entirely in memory.')
+        help_str=gettext('If set to True, the dataset will be fetched using a'
+                         ' server-side cursor after the query is executed.'
+                         ' This allows controlled data transfer to the client,'
+                         ' enabling examination of large datasets without'
+                         ' loading them entirely into memory.')
     )
 
     self.show_prompt_save_query_changes = self.preference.register(
diff --git a/web/pgadmin/tools/sqleditor/utils/start_running_query.py b/web/pgadmin/tools/sqleditor/utils/start_running_query.py
@@ -137,10 +137,12 @@ def __execute_query(self, conn, session_obj, sql, trans_id, trans_obj):
         StartRunningQuery.save_transaction_in_session(session_obj,
                                                       trans_id, trans_obj)
 
+        if trans_obj.server_cursor and sql != 'COMMIT;' and sql != 'ROLLBACK;':
+            conn.release_async_cursor()
+
         if StartRunningQuery.is_begin_required_for_sql_query(trans_obj,
                                                              conn, sql
                                                              ):
-            conn.release_async_cursor()
             conn.execute_void("BEGIN;")
 
         is_rollback_req = StartRunningQuery.is_rollback_statement_required(
@@ -185,7 +187,7 @@ def asyn_exec_query(conn, sql, trans_obj, is_rollback_req,
     @staticmethod
     def is_begin_required_for_sql_query(trans_obj, conn, sql):
 
-        return ((trans_obj.server_cursor) or (
+        return ((trans_obj.server_cursor and trans_obj.auto_commit) or (
             not trans_obj.auto_commit and
             conn.transaction_status() == TX_STATUS_IDLE and
             is_begin_required(sql)
diff --git a/web/pgadmin/utils/driver/psycopg3/connection.py b/web/pgadmin/utils/driver/psycopg3/connection.py
@@ -686,12 +686,6 @@ def execute_post_connection_sql(self, cur, manager):
                 current_app.logger.error(errmsg)
         return errmsg
 
-    def __reset_auto_commit(self, autocommit):
-        asyncio.run(self.__reset_auto_commit_for(autocommit))
-
-    async def __reset_auto_commit_for(self, autocommit):
-        await self.conn.set_autocommit(autocommit)
-
     def __cursor(self, server_cursor=False, scrollable=False):
 
         if not get_crypt_key()[0] and config.SERVER_MODE:
@@ -743,13 +737,11 @@ def __cursor(self, server_cursor=False, scrollable=False):
                 # Providing name to cursor will create server side cursor.
                 cursor_name = "CURSOR:{0}".format(self.conn_id)
                 self.conn.server_cursor_factory = AsyncDictServerCursor
-                # self.__reset_auto_commit(False)
                 cur = self.conn.cursor(
                     name=cursor_name,
                     scrollable=scrollable
                 )
             else:
-                # self.__reset_auto_commit(auto_commit)
                 cur = self.conn.cursor(scrollable=scrollable)
         except psycopg.Error as pe:
             current_app.logger.exception(pe)
@@ -1527,7 +1519,7 @@ def poll(self, formatted_exception_msg=False, no_result=False):
         else:
             status = 1
 
-        if not cur:
+        if not cur or cur.closed:
             return False, self.CURSOR_NOT_FOUND
 
         result = None
diff --git a/web/pgadmin/utils/driver/psycopg3/cursor.py b/web/pgadmin/utils/driver/psycopg3/cursor.py
@@ -15,11 +15,9 @@
 
 import asyncio
 from collections import OrderedDict
-import psycopg
 from flask import g, current_app
 from psycopg import (Cursor as _cursor, AsyncCursor as _async_cursor,
                      AsyncServerCursor as _async_server_cursor)
-from typing import Any, Sequence
 from psycopg.rows import dict_row, tuple_row
 from psycopg._encodings import py_codecs as encodings
 from .encoding import configure_driver_encodings

Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,7 @@ export class FileTreeItem extends React.Component<IItemRendererXProps & IItemRen`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`private readonly setActiveFile = async (FileOrDir): Promise<void> => {`
	`137`	`+`
`137`	`138`	`this.props.changeDirectoryCount(FileOrDir.parent);`
`138`	`139`	`if(FileOrDir._loaded !== true) {`
`139`	`140`	`this.events.dispatch(FileTreeXEvent.onTreeEvents, window.event, 'added', FileOrDir);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/////////////////////////////////////////////////////////////`
	`1`	`+l/////////////////////////////////////////////////////////////`
`2`	`2`	`//`
`3`	`3`	`// pgAdmin 4 - PostgreSQL Tools`
`4`	`4`	`//`