Enhanced pgAdmin 4 with support for Workspace layouts. #7708
No files matched your search
@@ -53,11 +53,11 @@ The default binary paths set in the container are as follows:
|
||||
.. code-block:: bash
|
||||
|
||||
DEFAULT_BINARY_PATHS = {
|
||||
'pg-17': '/usr/local/pgsql-17',
|
||||
'pg-16': '/usr/local/pgsql-16',
|
||||
'pg-15': '/usr/local/pgsql-15',
|
||||
'pg-14': '/usr/local/pgsql-14',
|
||||
'pg-13': '/usr/local/pgsql-13',
|
||||
'pg-12': '/usr/local/pgsql-12'
|
||||
'pg-13': '/usr/local/pgsql-13'
|
||||
}
|
||||
|
||||
this may be changed in the :ref:`preferences`.
|
||||
|
||||
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 155 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 148 KiB |
|
After Width: | Height: | Size: 209 KiB |
|
Before Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 245 KiB After Width: | Height: | Size: 238 KiB |
|
After Width: | Height: | Size: 348 KiB |
|
After Width: | Height: | Size: 361 KiB |
|
Before Width: | Height: | Size: 107 KiB After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 98 KiB |
@@ -1,6 +1,6 @@
|
||||
****************************
|
||||
`Keyboard Shortcuts`:index::
|
||||
****************************
|
||||
***************************
|
||||
`Keyboard Shortcuts`:index:
|
||||
***************************
|
||||
|
||||
Keyboard shortcuts are provided in pgAdmin to allow easy access to specific
|
||||
functions. Alternate shortcuts can be configured through File > Preferences if
|
||||
|
||||
@@ -6,7 +6,14 @@
|
||||
***************************
|
||||
|
||||
Use options on the *Preferences* dialog to customize the behavior of the client.
|
||||
To open the *Preferences* dialog, select *Preferences* from the *File* menu.
|
||||
To open the *Preferences* dialog, select *Preferences* from the *File* menu or
|
||||
click on the *Settings* button at the bottom left corner in case of Workspace
|
||||
layout.
|
||||
|
||||
.. image:: images/preferences_menu.png
|
||||
:alt: Preferences menu
|
||||
:align: center
|
||||
|
||||
The left pane of the *Preferences* dialog displays a tree control; each node of
|
||||
the tree control provides access to options that are related to the node under
|
||||
which they are displayed.
|
||||
@@ -266,21 +273,23 @@ The Miscellaneous Node
|
||||
|
||||
Expand the *Miscellaneous* node to specify miscellaneous display preferences.
|
||||
|
||||
.. image:: images/preferences_misc_user_language.png
|
||||
:alt: Preferences dialog user language section
|
||||
.. image:: images/preferences_misc_user_interface.png
|
||||
:alt: Preferences dialog user interface section
|
||||
:align: center
|
||||
|
||||
* Use the *User language* drop-down listbox to select the display language for
|
||||
* Use the *Language* drop-down listbox to select the display language for
|
||||
the client.
|
||||
|
||||
.. image:: images/preferences_misc_themes.png
|
||||
:alt: Preferences dialog themes section
|
||||
:align: center
|
||||
* Use the *Layout* drop-down listbox to select the layout for the client.
|
||||
pgAdmin offers two options: the Classic layout, a longstanding and familiar
|
||||
design, and the Workspace layout, which provides distraction free dedicated
|
||||
areas for the Query Tool, PSQL, and Schema Diff tools. 'Workspace' layout is
|
||||
the default layout, but user can change it to 'Classic'.
|
||||
|
||||
* Use the *Themes* drop-down listbox to select the theme for pgAdmin. You'll also get a preview just below the
|
||||
drop down. You can also submit your own themes,
|
||||
check `here <https://github.com/pgadmin-org/pgadmin4/blob/master/README.md>`_ how.
|
||||
Currently we support Standard, Dark and High Contrast and System theme. Selecting System option will follow
|
||||
Currently we support Light, Dark, High Contrast and System theme. Selecting System option will follow
|
||||
your computer's settings.
|
||||
|
||||
The Paths Node
|
||||
|
||||
@@ -27,4 +27,44 @@ mode, but is disabled by default in Server mode. This is because users can run
|
||||
arbitrary shell commands through psql which may be considered a security risk in
|
||||
some deployments. System Administrators can enable the use of the PSQL tool in
|
||||
the pgAdmin configuration by setting the *ENABLE_PSQL* option to *True*; see
|
||||
:ref:`config_py` for more information.
|
||||
:ref:`config_py` for more information.
|
||||
|
||||
PSQL Tool in Workspace Layout
|
||||
******************************
|
||||
|
||||
The workspace layout offers a distraction-free, dedicated area for the PSQL Tool.
|
||||
When the PSQL Tool workspace is accessed, the Welcome page opens by default.
|
||||
|
||||
**Note**: In the Workspace layout, all PSQL tabs open within the PSQL Tool workspace.
|
||||
|
||||
In the classic UI, users must connect to a database server and navigate to the
|
||||
database node before using the PSQL Tool. However, with the introduction of the
|
||||
Workspace layout and Welcome page, users can seamlessly connect to any ad-hoc
|
||||
server, even if it is not registered in the Object Explorer.
|
||||
|
||||
.. image:: images/psql_workspace.png
|
||||
:alt: PSQL tool workspace
|
||||
:align: center
|
||||
|
||||
* Select *Existing Server* from the dropdown to connect to a server already
|
||||
listed in the Object Explorer. It is optional.
|
||||
* Provide the *Server Name* for ad-hoc servers.
|
||||
* Specify the IP address of the server host, or the fully qualified domain
|
||||
name in the *Host name/address* field.
|
||||
* Enter the listener port number of the server host in the *Port* field.
|
||||
* Use the *Database* field to specify the name of the database to which
|
||||
the client will connect.
|
||||
* Use the *User* field to specify the name of a user that will be used when
|
||||
authenticating with the server.
|
||||
* Use the *Password* field to provide a password that will be supplied when
|
||||
authenticating with the server.
|
||||
* Use the *Role* field to specify the name of a role that has privileges that
|
||||
will be conveyed to the client after authentication with the server.
|
||||
* Use the *Service* field to specify the service name. For more information,
|
||||
see
|
||||
`Section 33.16 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgservice.html>`_.
|
||||
* Use the fields in the *Connection Parameters* to configure the connection parameters.
|
||||
|
||||
After filling in all the required fields, click the Connect & Open PSQL Tool
|
||||
button to launch the PSQL Tool with the provided server details. If the password
|
||||
is not supplied, you will be prompted to enter it.
|
||||
@@ -41,6 +41,47 @@ The Query Tool features two panels:
|
||||
server messages related to the query's execution and any asynchronous
|
||||
notifications received from the server.
|
||||
|
||||
Query Tool in Workspace Layout
|
||||
******************************
|
||||
|
||||
The workspace layout offers a distraction-free, dedicated area for the Query Tool.
|
||||
When the Query Tool workspace is accessed, the Welcome page opens by default.
|
||||
|
||||
**Note**: In the Workspace layout, all Query Tool and View/Edit Data tabs open within the Query Tool workspace.
|
||||
|
||||
In the classic UI, users must connect to a database server and navigate to the
|
||||
database node before using the Query Tool. However, with the introduction of the
|
||||
Workspace layout and Welcome page, users can seamlessly connect to any ad-hoc
|
||||
server, even if it is not registered in the Object Explorer.
|
||||
|
||||
.. image:: images/query_tool_workspace.png
|
||||
:alt: Query tool workspace
|
||||
:align: center
|
||||
|
||||
* Select *Existing Server* from the dropdown to connect to a server already
|
||||
listed in the Object Explorer. It is optional.
|
||||
* Provide the *Server Name* for ad-hoc servers.
|
||||
* Specify the IP address of the server host, or the fully qualified domain
|
||||
name in the *Host name/address* field.
|
||||
* Enter the listener port number of the server host in the *Port* field.
|
||||
* Use the *Database* field to specify the name of the database to which
|
||||
the client will connect.
|
||||
* Use the *User* field to specify the name of a user that will be used when
|
||||
authenticating with the server.
|
||||
* Use the *Password* field to provide a password that will be supplied when
|
||||
authenticating with the server.
|
||||
* Use the *Role* field to specify the name of a role that has privileges that
|
||||
will be conveyed to the client after authentication with the server.
|
||||
* Use the *Service* field to specify the service name. For more information,
|
||||
see
|
||||
`Section 33.16 of the Postgres documentation <https://www.postgresql.org/docs/current/libpq-pgservice.html>`_.
|
||||
* Use the fields in the *Connection Parameters* to configure the connection parameters.
|
||||
|
||||
After filling in all the required fields, click the Connect & Open Query Tool
|
||||
button to launch the Query Tool with the provided server details. If the password
|
||||
is not supplied, you will be prompted to enter it.
|
||||
|
||||
|
||||
Toolbar
|
||||
*******
|
||||
|
||||
|
||||
@@ -12,6 +12,7 @@ notes for it.
|
||||
:maxdepth: 1
|
||||
|
||||
|
||||
release_notes_9_0
|
||||
release_notes_8_14
|
||||
release_notes_8_13
|
||||
release_notes_8_12
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
***********
|
||||
Version 9.0
|
||||
***********
|
||||
|
||||
Release date: 2025-01-09
|
||||
|
||||
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v8.14.
|
||||
|
||||
Supported Database Servers
|
||||
**************************
|
||||
**PostgreSQL**: 13, 14, 15, 16 and 17
|
||||
|
||||
**EDB Advanced Server**: 13, 14, 15, 16 and 17
|
||||
|
||||
Bundled PostgreSQL Utilities
|
||||
****************************
|
||||
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 17.0
|
||||
|
||||
|
||||
New features
|
||||
************
|
||||
|
||||
| `Issue #7708 <https://github.com/pgadmin-org/pgadmin4/issues/7708>`_ - Enhanced pgAdmin 4 with support for Workspace layouts.
|
||||
|
||||
Housekeeping
|
||||
************
|
||||
|
||||
|
||||
Bug fixes
|
||||
*********
|
||||
|
||||
@@ -44,6 +44,18 @@ Use the :ref:`Preferences <preferences>` dialog to specify following:
|
||||
* *Schema Diff* should ignore the whitespaces while comparing string objects. Set *Ignore whitespaces* option to true.
|
||||
* *Schema Diff* should ignore the owner while comparing objects. Set *Ignore owner* option to true.
|
||||
|
||||
Schema Diff in Workspace Layout
|
||||
*******************************
|
||||
|
||||
The workspace layout offers a distraction-free, dedicated area for the Schema Diff.
|
||||
By default, the Schema Diff workspace button remains disabled until at least one Schema Diff tab is opened.
|
||||
|
||||
**Note**: In the Workspace layout, all Schema Diff tabs open within the Schema Diff workspace.
|
||||
|
||||
.. image:: images/schema_diff_workspace.png
|
||||
:alt: schema diff workspace
|
||||
:align: center
|
||||
|
||||
|
||||
The *Schema Diff* panel is divided into two panels; an Object Comparison panel
|
||||
and a DDL Comparison panel.
|
||||
|
||||
@@ -32,7 +32,7 @@ the right pane.
|
||||
Select an icon from the *Quick Links* panel on the *Dashboard* tab to:
|
||||
|
||||
* Click the *Add New Server* button to open the
|
||||
:ref:`Create - Server dialog <server_dialog>` to add a new server definition.
|
||||
:ref:`Register - Server dialog <server_dialog>` to add a new server definition.
|
||||
* Click the *Configure pgAdmin* button to open the
|
||||
:ref:`Preferences dialog <preferences>` to customize your pgAdmin client.
|
||||
|
||||
|
||||