Add support for restoring plain SQL database dumps. #5871

Author: adityatoshniwal

docs/en_US/restore_dialog.rst

@@ -27,6 +27,8 @@ restore process:
 
    * Select *Custom or tar* to restore from a custom archive file to create a
      copy of the backed-up object.
+   * Select *Plain* to restore a plain SQL backup. When selecting this option
+     all the other options will not be applicable.
    * Select *Directory* to restore from a compressed directory-format archive.
 
 * Enter the complete path to the backup file in the *Filename* field.

web/pgadmin/static/js/SchemaView/FormView.jsx

@@ -32,6 +32,7 @@ import {
 } from './hooks';
 import { registerView, View } from './registry';
 import { createFieldControls, listenDepChanges } from './utils';
+import FormViewTab from './FormViewTab';
 
 const ErrorMessageBox = () => {
   const [key, setKey] = useState(0);
@@ -181,14 +182,8 @@ export default function FormView({
               action={(ref) => ref?.updateIndicator()}
             >{
                 finalGroups.map((tabGroup, idx) =>
-                  <Tab
-                    key={tabGroup.id}
-                    label={tabGroup.label}
-                    data-test={tabGroup.id}
-                    className={
-                      tabGroup.hasError &&
-                      tabValue != idx ? 'tab-with-error' : ''
-                    }
+                  <FormViewTab
+                    key={tabGroup.id} tabGroup={tabGroup} idx={idx} tabValue={tabValue}
                   />
                 )
               }{hasSQLTab &&

web/pgadmin/static/js/SchemaView/FormViewTab.jsx

@@ -0,0 +1,45 @@
+/////////////////////////////////////////////////////////////
+//
+// pgAdmin 4 - PostgreSQL Tools
+//
+// Copyright (C) 2013 - 2025, The pgAdmin Development Team
+// This software is released under the PostgreSQL Licence
+//
+//////////////////////////////////////////////////////////////
+
+import { Tab } from '@mui/material';
+import React, { useContext, useState } from 'react';
+import { useFieldOptions, useSchemaStateSubscriber } from './hooks';
+import { SchemaStateContext } from './SchemaState';
+import PropTypes from 'prop-types';
+
+export default function FormViewTab({tabGroup, idx, tabValue, ...props}) {
+  const accessPath = [tabGroup.id];
+  const [refreshKey, setRefreshKey] = useState(0);
+  const subscriberManager = useSchemaStateSubscriber(setRefreshKey);
+  const schemaState = useContext(SchemaStateContext);
+  const options = useFieldOptions(accessPath, schemaState, subscriberManager);
+
+  return (
+    <Tab
+      key={refreshKey}
+      label={tabGroup.label}
+      data-test={tabGroup.id}
+      iconPosition='start'
+      disabled={options.disabled}
+      className={
+        tabGroup.hasError &&
+        tabValue != idx ? 'tab-with-error' : ''
+      }
+      {...props}
+    />
+  );
+};
+
+FormViewTab.muiName = Tab.muiName;
+
+FormViewTab.propTypes = {
+  tabGroup: PropTypes.object,
+  idx: PropTypes.number,
+  tabValue: PropTypes.number,
+};

web/pgadmin/static/js/Theme/index.jsx

@@ -788,13 +788,17 @@ function getFinalTheme(baseTheme) {
       MuiTab: {
         styleOverrides: {
           root: {
-            '&.MuiTab-textColorPrimary':{
+            '&:not(.Mui-disabled).MuiTab-textColorPrimary':{
               color: baseTheme.palette.text.primary,
             },
             '&.Mui-selected': {
               color: baseTheme.otherVars.activeColor,
             },
-          }
+          },
+          icon: {
+            fontSize: '1rem',
+            marginRight: '2px',
+          },
         }
       },
       MuiBackdrop: {

web/pgadmin/tools/restore/__init__.py

@@ -141,18 +141,18 @@ def _get_create_req_data():
         data = json.loads(request.data)
 
     try:
-        _file = filename_with_file_manager_path(data['file'])
+        filepath = filename_with_file_manager_path(data['file'])
     except Exception as e:
         return True, internal_server_error(errormsg=str(e)), data, None
 
-    if _file is None:
+    if filepath is None:
         return True, make_json_response(
             status=410,
             success=0,
             errormsg=_("File could not be found.")
-        ), data, _file
+        ), data, filepath
 
-    return False, '', data, _file
+    return False, '', data, filepath
 
 
 def _connect_server(sid):
@@ -263,15 +263,15 @@ def set_multiple(key, param, data, args, driver, conn, with_schema=True):
     return False
 
 
-def _set_args_param_values(data, manager, server, driver, conn, _file):
+def get_restore_util_args(data, manager, server, driver, conn, filepath):
     """
-    add args to the list.
+    return the args for the command
     :param data: Data.
     :param manager: Manager.
     :param server: Server.
     :param driver: Driver.
     :param conn: Connection.
-    :param _file: File.
+    :param filepath: File.
     :return: args list.
     """
     args = []
@@ -347,11 +347,56 @@ def _set_args_param_values(data, manager, server, driver, conn, _file):
                      False)
         set_multiple('indexes', '--index', data, args, driver, conn, False)
 
-    args.append(fs_short_path(_file))
+    args.append(fs_short_path(filepath))
 
     return args
 
 
+def get_sql_util_args(data, manager, server, filepath):
+    """
+    return the args for the command
+    :param data: Data.
+    :param manager: Manager.
+    :param server: Server.
+    :param filepath: File.
+    :return: args list.
+    """
+    args = [
+        '--host',
+        manager.local_bind_host if manager.use_ssh_tunnel else server.host,
+        '--port',
+        str(manager.local_bind_port) if manager.use_ssh_tunnel
+        else str(server.port),
+        '--username', server.username, '--dbname',
+        data['database'],
+        '--file', fs_short_path(filepath)
+    ]
+
+    return args
+
+
+def use_restore_utility(data, manager, server, driver, conn, filepath):
+    utility = manager.utility('restore')
+    ret_val = does_utility_exist(utility)
+    if ret_val:
+        return ret_val, None, None
+
+    args = get_restore_util_args(data, manager, server, driver, conn, filepath)
+
+    return None, utility, args
+
+
+def use_sql_utility(data, manager, server, filepath):
+    utility = manager.utility('sql')
+    ret_val = does_utility_exist(utility)
+    if ret_val:
+        return ret_val, None, None
+
+    args = get_sql_util_args(data, manager, server, filepath)
+
+    return None, utility, args
+
+
 @blueprint.route('/job/<int:sid>', methods=['POST'], endpoint='create_job')
 @pga_login_required
 def create_restore_job(sid):
@@ -364,24 +409,27 @@ def create_restore_job(sid):
     Returns:
         None
     """
-    is_error, errmsg, data, _file = _get_create_req_data()
+    is_error, errmsg, data, filepath = _get_create_req_data()
     if is_error:
         return errmsg
 
     is_error, errmsg, driver, manager, conn, _, server = _connect_server(sid)
     if is_error:
         return errmsg
 
-    utility = manager.utility('restore')
-    ret_val = does_utility_exist(utility)
-    if ret_val:
+    if data['format'] == 'plain':
+        error_msg, utility, args = use_sql_utility(
+            data, manager, server, filepath)
+    else:
+        error_msg, utility, args = use_restore_utility(
+            data, manager, server, driver, conn, filepath)
+
+    if error_msg is not None:
         return make_json_response(
             success=0,
-            errormsg=ret_val
+            errormsg=error_msg
         )
 
-    args = _set_args_param_values(data, manager, server, driver, conn, _file)
-
     try:
         p = BatchProcess(
             desc=RestoreMessage(

web/pgadmin/tools/restore/static/js/restore.js

@@ -81,7 +81,8 @@ define('tools.restore', [
         ()=>getRestoreDisableOptionSchema({nodeInfo: treeNodeInfo}),
         ()=>getRestoreMiscellaneousSchema({nodeInfo: treeNodeInfo}),
         {
-          role: ()=>getNodeListByName('role', treeNodeInfo, itemNodeData)
+          role: ()=>getNodeListByName('role', treeNodeInfo, itemNodeData),
+          nodeType: itemNodeData._type,
         },
         treeNodeInfo,
         pgBrowser