2021-05-25 09:42:57 -05:00
|
|
|
.. _psql_tool:
|
|
|
|
|
|
|
|
|
|
******************
|
|
|
|
|
`PSQL Tool`:index:
|
|
|
|
|
******************
|
|
|
|
|
|
2021-06-15 05:09:52 -05:00
|
|
|
The PSQL tool allows users to connect to PostgreSQL or EDB Advanced server using
|
|
|
|
|
the psql command line interface through their browser.
|
2021-05-25 09:42:57 -05:00
|
|
|
|
2021-06-15 05:09:52 -05:00
|
|
|
* Open the PSQL tool from the Tools or browser tree context menu, or use PSQL
|
|
|
|
|
tool button at the top of the browser tree.
|
2021-05-25 09:42:57 -05:00
|
|
|
|
2021-06-15 05:09:52 -05:00
|
|
|
* PSQL will connect to the current connected database from the browser tree.
|
2021-05-25 09:42:57 -05:00
|
|
|
|
|
|
|
|
.. image:: images/psql_tool.png
|
|
|
|
|
:alt: PSQL tool window
|
|
|
|
|
:align: center
|
|
|
|
|
|
2021-06-15 05:09:52 -05:00
|
|
|
You can open multiple instances of the PSQL tool in individual tabs simultaneously.
|
2021-05-25 09:42:57 -05:00
|
|
|
To close the PSQL tool, click the *X* in the upper-right hand corner of the tab bar.
|
|
|
|
|
|
2021-06-15 05:09:52 -05:00
|
|
|
**Note:** On the Windows platform, this feature is available on Windows 10 (1809
|
|
|
|
|
version), and Windows Server 2019 and onwards.
|
2021-06-14 01:15:54 -05:00
|
|
|
|
2021-06-15 05:09:52 -05:00
|
|
|
**Note:** The PSQL tool is always available when pgAdmin is running in Desktop
|
|
|
|
|
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.
|
