Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0ee096dbf6 | ||
|
|
8908c5b2d3 | ||
|
|
ae99ce7428 | ||
|
|
d45c5c0874 | ||
|
|
7d0fe669ca | ||
|
|
3026b470e9 | ||
|
|
4f5eeffd1f | ||
|
|
fc34f85aa3 | ||
|
|
03d348f7c2 | ||
|
|
980ab4735e | ||
|
|
9224ce77b3 | ||
|
|
3484998775 | ||
|
|
648eebd230 | ||
|
|
e43ff84627 | ||
|
|
85a7104e2c | ||
|
|
52906dd020 | ||
|
|
2a778f3c16 | ||
|
|
3210975568 | ||
|
|
061a9d9322 | ||
|
|
a35288e25d | ||
|
|
d133e33c4b | ||
|
|
4a7607445f | ||
|
|
a1f65e981f | ||
|
|
a563e17f9b | ||
|
|
991cbcabcb | ||
|
|
19b4f9e01f | ||
|
|
eb5a97bc3c | ||
|
|
5051470bc7 | ||
|
|
8b8e6fe59b | ||
|
|
bfe1b773b3 | ||
|
|
800d5d71d7 | ||
|
|
691f01b623 | ||
|
|
f4e76a22b9 | ||
|
|
3f25e9331f | ||
|
|
40b075389f | ||
|
|
1a84c35628 | ||
|
|
237f93591f | ||
|
|
c16df45f2c | ||
|
|
c04b729c1d | ||
|
|
f1eca516f0 | ||
|
|
2c06ab4ac3 | ||
|
|
fc955537a8 | ||
|
|
dd4705af60 | ||
|
|
01801e4acb | ||
|
|
ac37d60c03 | ||
|
|
3350eaceab | ||
|
|
f1dd39e5e9 | ||
|
|
95c79e3a4c | ||
|
|
05e7ee5a05 | ||
|
|
2c62d1a4b7 | ||
|
|
35243b9869 | ||
|
|
1172e31019 | ||
|
|
a53811ef27 | ||
|
|
be100b82e6 | ||
|
|
f2b6ab816b | ||
|
|
3bcc5a4bd3 | ||
|
|
8c279421f3 | ||
|
|
69d8f01d01 | ||
|
|
fd6c43b393 | ||
|
|
bc4703c5b7 | ||
|
|
b94b47f021 | ||
|
|
014eb2a5c2 | ||
|
|
7e27c6280f | ||
|
|
e9dc1496e2 | ||
|
|
359b1d0176 | ||
|
|
262ae7d28c | ||
|
|
4dc563d71c | ||
|
|
c702ef9c48 | ||
|
|
5f3511ce39 | ||
|
|
bc16a1a61f | ||
|
|
73988bcece | ||
|
|
fc295f94a3 | ||
|
|
cef0dc7c88 | ||
|
|
931f671756 | ||
|
|
fa917a0828 | ||
|
|
a800b19c87 | ||
|
|
f9393aee44 | ||
|
|
b8d0f410df | ||
|
|
7c45d54d94 | ||
|
|
17b6053f45 | ||
|
|
29fbbb581f | ||
|
|
d4e5d9c4f4 | ||
|
|
0717b40543 | ||
|
|
fc40197d39 | ||
|
|
0e11f4d082 | ||
|
|
71ec9ef914 | ||
|
|
6b95d6ac75 | ||
|
|
5dbbd8e638 | ||
|
|
e881695050 | ||
|
|
b0b21fd46c | ||
|
|
62c1369938 | ||
|
|
93706ee40b | ||
|
|
fe1c86cbbe | ||
|
|
0f12defd20 | ||
|
|
d87a6a15ac | ||
|
|
677008af10 | ||
|
|
8b770ae479 | ||
|
|
1f9d0ffc54 | ||
|
|
970d3aafbf | ||
|
|
702609517f | ||
|
|
f5dde481c0 | ||
|
|
c331b514a9 | ||
|
|
1783e040e6 | ||
|
|
9e8e3fc787 | ||
|
|
d9804ae2a2 | ||
|
|
6b84dc832a | ||
|
|
6cfa022e35 | ||
|
|
fcd33162a9 | ||
|
|
d5a91c969c | ||
|
|
085f8e198e |
No files matched your search
@@ -20,12 +20,9 @@ web/regression/test_config.json
|
||||
pgadmin4.log
|
||||
*.swp
|
||||
*.swo
|
||||
/pgadmin4
|
||||
/pgadmin4.egg-info
|
||||
/MANIFEST.in
|
||||
/build
|
||||
/mac-build
|
||||
/src-build
|
||||
/pip-build
|
||||
/dist
|
||||
pkg/win32/win-build
|
||||
pkg/win32/installer.iss
|
||||
|
||||
@@ -47,7 +47,7 @@ REM Main function Ends
|
||||
ECHO Calling clean target...
|
||||
IF EXIST "%PGBUILDPATH%" rd "%PGBUILDPATH%" /S /Q
|
||||
|
||||
FOR /R "%WD%" %%f in (*.pyc) do DEL /q "%%f" > nul
|
||||
FOR /R "%WD%" %%f in (*.pyc *.pyo) do DEL /q "%%f" > nul
|
||||
IF EXIST "%WD%\pkg\win32\Output" rd "%WD%\pkg\win32\Output" /S /Q
|
||||
IF EXIST DEL /q "%WD%\pkg\win32\installer.iss" > nul
|
||||
CD %WD%
|
||||
@@ -125,7 +125,8 @@ GOTO:EOF
|
||||
SET APP_SUFFIX_VERSION=%APP_SUFFIX_VERSION:'=%
|
||||
SET APP_NAME=""
|
||||
FOR /F "tokens=2* DELims='" %%a IN ('findstr /C:"APP_NAME =" web\config.py') DO SET APP_NAME=%%a
|
||||
SET INSTALLERNAME=%APP_NAME%-v%APP_RELEASE%.%APP_REVISION_VERSION%-%APP_SUFFIX_VERSION%-%ARCHITECTURE%.exe
|
||||
FOR /f "tokens=1 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "print '%APP_NAME%'.lower().replace(' ', '')"') DO SET APP_SHORTNAME=%%G
|
||||
SET INSTALLERNAME=%APP_SHORTNAME%-%APP_RELEASE%.%APP_REVISION_VERSION%-%APP_SUFFIX_VERSION%-%ARCHITECTURE%.exe
|
||||
|
||||
SET PGADMIN4_VERSION=v%APP_RELEASE%
|
||||
SET PGADMIN4_APP_VERSION=%APP_RELEASE%.%APP_REVISION_VERSION%
|
||||
@@ -181,8 +182,8 @@ GOTO:EOF
|
||||
IF NOT EXIST "%QTDIR%\..\%QT_MSVC_PATH%" GOTO err_handle_qt_mismatch
|
||||
|
||||
REM get Python version ex. 2.7.1 will get as 27
|
||||
for /f "tokens=1 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "import sys; print sys.version.split(' ')[0]"') DO SET PYTHON_MAJOR=%%G
|
||||
for /f "tokens=2 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "import sys; print sys.version.split(' ')[0]"') DO SET PYTHON_MINOR=%%G
|
||||
FOR /f "tokens=1 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "import sys; print sys.version.split(' ')[0]"') DO SET PYTHON_MAJOR=%%G
|
||||
FOR /f "tokens=2 DELims=." %%G IN ('%PYTHON_HOME%/python.exe -c "import sys; print sys.version.split(' ')[0]"') DO SET PYTHON_MINOR=%%G
|
||||
SET "PYTHON_VERSION=%PYTHON_MAJOR%%PYTHON_MINOR%"
|
||||
|
||||
IF NOT EXIST "%PYTHON_HOME%\Scripts\virtualenv.exe" GOTO err_handle_pythonvirtualenv
|
||||
@@ -231,16 +232,19 @@ GOTO:EOF
|
||||
XCOPY /S /I /E /H /Y "%WD%\web" "%PGBUILDPATH%\web" > nul
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
|
||||
REM Clean up .pyc, pgadmin4.db, config_local.py
|
||||
REM Clean up .pyc, .pyo, pgadmin4.db, config_local.py
|
||||
ECHO Cleaning up unnecessary files...
|
||||
for /R "%PGBUILDPATH%\web" %%f in (*.pyc) do DEL /q "%%f"
|
||||
IF EXIST DEL /s "%PGBUILDPATH%\web\pgadmin4.db" > nul
|
||||
IF EXIST DEL /s "%PGBUILDPATH%\web\config_local.py" > nul
|
||||
FOR /R "%PGBUILDPATH%\web" %%f in (*.pyc *.pyo) do DEL /q "%%f"
|
||||
DEL /q "%PGBUILDPATH%\web\pgadmin4.db"
|
||||
DEL /q "%PGBUILDPATH%\web\config_local.py"
|
||||
|
||||
ECHO Creating config_distro.py
|
||||
ECHO SERVER_MODE = False > "%PGBUILDPATH%\web\config_distro.py"
|
||||
ECHO HELP_PATH = '../../../docs/en_US/html/' >> "%PGBUILDPATH%\web\config_distro.py"
|
||||
ECHO MINIFY_HTML = False >> "%PGBUILDPATH%\web\config_distro.py"
|
||||
|
||||
ECHO Creating config_local.py
|
||||
ECHO SERVER_MODE = False > "%PGBUILDPATH%\web\config_local.py"
|
||||
ECHO HELP_PATH = '../../../docs/en_US/html/' >> "%PGBUILDPATH%\web\config_local.py"
|
||||
ECHO MINIFY_HTML = False >> "%PGBUILDPATH%\web\config_local.py"
|
||||
ECHO # Add any configuration changes to this file. > "%PGBUILDPATH%\web\config_local.py"
|
||||
|
||||
ECHO Building docs...
|
||||
MKDIR "%PGBUILDPATH%\docs\en_US\html"
|
||||
@@ -343,6 +347,13 @@ GOTO:EOF
|
||||
:CREATE_PYTHON_ENV
|
||||
copy %PYTHON_DLL% "%PGBUILDPATH%\runtime" > nul
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
|
||||
REM Copy Python interpretor as it's needed to run background processes
|
||||
copy %PYTHON_HOME%\python.exe "%PGBUILDPATH%\runtime" > nul
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
copy %PYTHON_HOME%\pythonw.exe "%PGBUILDPATH%\runtime" > nul
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
|
||||
XCOPY /S /I /E /H /Y "%PYTHON_HOME%\DLLs" "%PGBUILDPATH%\%VIRTUALENV%\DLLs" > nul
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
XCOPY /S /I /E /H /Y "%PYTHON_HOME%\Lib" "%PGBUILDPATH%\%VIRTUALENV%\Lib" > nul
|
||||
@@ -357,7 +368,7 @@ GOTO:EOF
|
||||
|
||||
copy "%WD%\pkg\win32\Resources\pgAdmin4.ico" "%PGBUILDPATH%"
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
REM search and replace string from config.py and copy to config_local.py
|
||||
|
||||
CD "%WD%"
|
||||
CD pkg
|
||||
CD win32
|
||||
@@ -376,16 +387,16 @@ GOTO:EOF
|
||||
|
||||
DEL /s "%WD%\pkg\win32\installer.iss.in_stage*" > nul
|
||||
ECHO Creating windows installer... using INNO tool
|
||||
ECHO "%INNOTOOL%\ISCC.exe" /q "%WD%\pkg\win32\installer.iss"
|
||||
|
||||
CALL "%INNOTOOL%\ISCC.exe" /q "%WD%\pkg\win32\installer.iss"
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
ECHO move "%WD%\pkg\win32\Output\Setup.exe" "%TARGETINSTALLER%\%INSTALLERNAME%"
|
||||
|
||||
MOVE "%WD%\pkg\win32\Output\Setup.exe" "%TARGETINSTALLER%\%INSTALLERNAME%"
|
||||
IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
|
||||
|
||||
ECHO "Location - %TARGETINSTALLER%\%INSTALLERNAME%"
|
||||
ECHO Installer generated successfully.
|
||||
GOTO CLEAN_RELEASE
|
||||
|
||||
CD %WD%
|
||||
GOTO:EOF
|
||||
|
||||
|
||||
@@ -14,105 +14,36 @@ SHELL = /bin/sh
|
||||
#########################################################################
|
||||
|
||||
# Include only platform-independent builds in all
|
||||
all: docs install-pip-requirements pip src
|
||||
all: docs pip src
|
||||
|
||||
# Include all clean sub-targets in clean
|
||||
clean: clean-dist clean-docs clean-pip clean-appbundle clean-src
|
||||
|
||||
#########################################################################
|
||||
# Python PIP package
|
||||
#########################################################################
|
||||
|
||||
ERROR_PERMISSIONS = by 'make install-pip-requirements'. The user must have permission to add files to site-packages for Python installation/virtual environment
|
||||
|
||||
IS_WHEEL_INSTALLED=0
|
||||
WHEEL_CHECK_CMD = which pip &> /dev/null && pip list wheel | grep wheel 2> /dev/null
|
||||
WHEEL_INSTALL_CMD = pip install wheel
|
||||
|
||||
IS_PIP_INSTALLED=0
|
||||
PIP_INSTALL_CMD = easy_install pip
|
||||
PIP_CHECK_CMD = which pip &> /dev/null && pip show pip | grep Metadata-Version 2>/dev/null
|
||||
|
||||
PGADMIN_SRC_DIR = pgadmin4
|
||||
PGADMIN_EGG = ${PGADMIN_SRC_DIR}.egg-info
|
||||
PGADMIN_BUILD = build
|
||||
PGADMIN_MACBUILD = mac-build
|
||||
PGADMIN_SRCBUILD = src-build
|
||||
PGADMIN_DIST = dist
|
||||
PGADMIN_MANIFEST = MANIFEST.in
|
||||
PGADMIN_INSTALL_CMD = pip install --use-wheel --find-links=${PGADMIN_DIST} ${PGADMIN_SRC_DIR}
|
||||
|
||||
|
||||
define create_manifest
|
||||
@printf 'recursive-include ${PGADMIN_SRC_DIR} *\nglobal-exclude config_local.py\nglobal-exclude *.pyc' > ${PGADMIN_MANIFEST}
|
||||
endef
|
||||
|
||||
define build
|
||||
python pkg/pip/setup_pip.py bdist_wheel
|
||||
endef
|
||||
|
||||
|
||||
install-pip-requirements:
|
||||
ifeq ($(shell ${PIP_CHECK_CMD}),)
|
||||
${PIP_INSTALL_CMD}
|
||||
$(eval IS_PIP_INSTALLED=1)
|
||||
endif
|
||||
|
||||
ifeq ($(shell ${WHEEL_CHECK_CMD}),)
|
||||
${WHEEL_INSTALL_CMD}
|
||||
$(eval IS_WHEEL_INSTALLED=1)
|
||||
endif
|
||||
|
||||
pip:
|
||||
ifeq ($(shell ${PIP_CHECK_CMD}),)
|
||||
@if [ $(value IS_PIP_INSTALLED) -ne 1 ]; \
|
||||
then \
|
||||
echo >&2 "Install pip ${ERROR_PERMISSIONS}"; \
|
||||
false; \
|
||||
fi
|
||||
endif
|
||||
|
||||
ifeq ($(shell ${WHEEL_CHECK_CMD}),)
|
||||
@if [ $(value IS_WHEEL_INSTALLED) -ne 1 ]; \
|
||||
then \
|
||||
echo >&2 "Install wheel ${ERROR_PERMISSIONS}"; \
|
||||
false; \
|
||||
fi
|
||||
endif
|
||||
rm -rf ${PGADMIN_SRC_DIR}
|
||||
cp -r web ${PGADMIN_SRC_DIR}
|
||||
$(call create_manifest)
|
||||
$(call build)
|
||||
|
||||
install-pip:
|
||||
${PGADMIN_INSTALL_CMD}
|
||||
pip: docs
|
||||
./pkg/pip/build.sh
|
||||
|
||||
appbundle: docs
|
||||
./pkg/mac/build.sh
|
||||
|
||||
src:
|
||||
./pkg/src/build.sh
|
||||
|
||||
docs:
|
||||
LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 $(MAKE) -C docs/en_US -f Makefile.sphinx html
|
||||
|
||||
clean-pip:
|
||||
rm -rf pip-build/
|
||||
|
||||
clean-appbundle:
|
||||
rm -rf mac-build/
|
||||
|
||||
clean-src:
|
||||
rm -rf src-build/
|
||||
|
||||
clean-docs:
|
||||
LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 $(MAKE) -C docs/en_US -f Makefile.sphinx clean
|
||||
|
||||
clean-pip:
|
||||
rm -rf ${PGADMIN_SRC_DIR}
|
||||
rm -rf ${PGADMIN_EGG}
|
||||
rm -rf ${PGADMIN_BUILD}
|
||||
rm -f ${PGADMIN_MANIFEST}
|
||||
|
||||
clean-appbundle:
|
||||
rm -rf ${PGADMIN_MACBUILD}
|
||||
rm -rf ${PGADMIN_DIST}/pgadmin4*.dmg*
|
||||
|
||||
src:
|
||||
./pkg/src/build.sh
|
||||
|
||||
clean-src:
|
||||
rm -rf ${PGADMIN_SRCBUILD}
|
||||
rm -rf ${PGADMIN_DIST}/pgadmin4*.tar.gz
|
||||
|
||||
clean-dist:
|
||||
rm -rf ${PGADMIN_DIST}
|
||||
rm -rf dist/
|
||||
|
||||
.PHONY: docs
|
||||
@@ -14,7 +14,4 @@ For more information about using a restore point as a recovery target, please se
|
||||
documentation <http://www.postgresql.org/docs/9.5/static/recovery-target-settings.html#RECOVERY-TARGET-NAME>`_.
|
||||
|
||||
* Click the *OK* button to save the restore point.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
|
||||
|
||||
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
@@ -0,0 +1,16 @@
|
||||
.. _backup_and_restore:
|
||||
|
||||
******************
|
||||
Backup and Restore
|
||||
******************
|
||||
|
||||
A powerful, but user-friendly Backup and Restore tool provides an easy way to use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of databases or database objects for use in a development environment.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
backup_dialog
|
||||
backup_globals_dialog
|
||||
backup_server_dialog
|
||||
restore_dialog
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _backup_dialog:
|
||||
|
||||
|
||||
*****************
|
||||
The Backup Dialog
|
||||
*****************
|
||||
@@ -106,8 +105,4 @@ If the backup is successful, a popup window will confirm success. Click *Click h
|
||||
|
||||
.. image:: images/backup_process_watcher.png
|
||||
|
||||
If the backup is unsuccessful, you can review the error messages returned by the backup command on the *Process Watcher*.
|
||||
|
||||
|
||||
|
||||
|
||||
If the backup is unsuccessful, you can review the error messages returned by the backup command on the *Process Watcher*.
|
||||
@@ -26,4 +26,4 @@ If the backup is successful, a popup window will confirm success. Click *Click h
|
||||
|
||||
.. image:: images/backup_globals_process_watcher.png
|
||||
|
||||
If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.
|
||||
If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.
|
||||
@@ -25,4 +25,4 @@ Click the *Backup* button to build and execute a command based on your selection
|
||||
If the backup is successful, a popup window will confirm success. Click *Click here for details* on the popup window to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the backup and provides additional information for troubleshooting.
|
||||
|
||||
.. image:: images/backup_server_process_watcher.png
|
||||
␍If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.␍
|
||||
␍If the backup is unsuccessful, review the error message returned by the *Process Watcher* to resolve any issue.
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _browser:
|
||||
|
||||
********************
|
||||
The pgAdmin 4 Client
|
||||
********************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _cast:
|
||||
.. _cast_dialog:
|
||||
|
||||
***************
|
||||
The Cast Dialog
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _change_password_dialog:
|
||||
|
||||
|
||||
**************************
|
||||
The Change Password Dialog
|
||||
**************************
|
||||
@@ -24,4 +23,4 @@ Use the *Change Password* dialog to change your password:
|
||||
* Enter the desired password for in the *New Password* field.
|
||||
* Re-enter the new password in the *Confirm Password* field.
|
||||
|
||||
Click the *OK* button to change your password; click *Cancel* to exit the dialog without changing your password.
|
||||
Click the *OK* button to change your password; click *Cancel* to exit the dialog without changing your password.
|
||||
@@ -40,6 +40,4 @@ The example shown demonstrates creating a check constraint named *check_price* o
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _code_overview:
|
||||
|
||||
*************
|
||||
Code Overview
|
||||
*************
|
||||
@@ -210,4 +212,4 @@ divided each module in small chunks as much as possible. Not all javascript
|
||||
modules are required to be loaded (i.e. loading a javascript module for
|
||||
database will make sense only when a server node is loaded competely.) Please
|
||||
look at the the javascript files node.js, browser.js, menu.js, panel.js, etc for
|
||||
better understanding of the code.
|
||||
better understanding of the code.
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _code_review:
|
||||
|
||||
*****************
|
||||
Code Review Notes
|
||||
*****************
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _coding_standards:
|
||||
|
||||
****************
|
||||
Coding Standards
|
||||
****************
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
The Collation Dialog
|
||||
********************
|
||||
|
||||
|
||||
Use the *Collation* dialog to define a collation. A collation is an SQL schema object that maps a SQL name to operating system locales. To create a collation, you must have a CREATE privilege on the destination schema.
|
||||
|
||||
The *Collation* dialog organizes the development of a collation through the following dialog tabs: *General* and *Definition*. The *SQL* tab displays the SQL code generated by dialog selections.
|
||||
|
||||
@@ -67,7 +67,4 @@ The example shown demonstrates creating a column named *territory* in the table
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _connect_error:
|
||||
|
||||
|
||||
**************************
|
||||
`Connection error`:index:
|
||||
**************************
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _connect_to_server:
|
||||
|
||||
|
||||
*****************
|
||||
Connect to server
|
||||
*****************
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
.. _connecting:
|
||||
|
||||
**********************
|
||||
Connecting to a Server
|
||||
**********************
|
||||
|
||||
Before you can use the pgAdmin client to manage your Postgres installation, you must define a connection to the server.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
server_group_dialog
|
||||
server_dialog
|
||||
connect_to_server
|
||||
connect_error
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
.. _contributions:
|
||||
|
||||
*****************************
|
||||
pgAdmin Project Contributions
|
||||
*****************************
|
||||
|
||||
pgAdmin is an open-source project that invites you to get involved in the development process. For more information about contributing to the pgAdmin project, contact the developers on the pgAdmin mailing list <mailto:pgadmin-hackers@postgresql.org> to discuss any ideas you might have for enhancements or bug fixes.
|
||||
|
||||
In the sections listed below, you'll find detailed information about the development process used to develop, improve, and maintain the pgAdmin client.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
submitting_patches
|
||||
code_overview
|
||||
coding_standards
|
||||
code_snippets
|
||||
code_review
|
||||
translations
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _database:
|
||||
.. _database_dialog:
|
||||
|
||||
*******************
|
||||
The Database Dialog
|
||||
|
||||
@@ -1,5 +1,100 @@
|
||||
********
|
||||
Debugger
|
||||
********
|
||||
.. _debugger:
|
||||
|
||||
*************************
|
||||
`pgAdmin Debugger`:index:
|
||||
*************************
|
||||
|
||||
.. image:: images/debug_main.png
|
||||
|
||||
The debugger may be used to debug PL/pgSQL functions in PostgreSQL, as well as EDB-SPL functions, stored procedures and packages in Advanced Server. The Debugger is available as an extension for your PostgreSQL installation, and is distributed as part of Advanced Server. You must have superuser privileges to use the debugger.
|
||||
|
||||
Before using the debugger, you must modify the *postgresql.conf* file, adding the server-side debugger components to the the value of the *shared_preload_libraries* parameter:
|
||||
|
||||
shared_preload_libraries = '$libdir/*other_libraries*/plugin_debugger'
|
||||
|
||||
After modifying the *shared_preload_libraries* parameter, restart the server to apply the changes.
|
||||
|
||||
The debugger may be used for either in-context debugging or direct debugging of a target function or procedure. When you use the debugger for in-context debugging, you set a breakpoint at the first line of a program; when a session invokes the target, control is transferred to the debugger. When using direct debugging, the debugger prompts you for any parameters required by the target, and then allows you to step through the code.
|
||||
|
||||
**In-context Debugging**
|
||||
|
||||
To set a breakpoint at the first line of a program, right-click the name of the object you would like to debug, and select *Set breakpoint* from the *Debugging* sub-menu. The debugger window will open, waiting for another session to invoke the program.
|
||||
|
||||
.. image:: images/debug_set_breakpoint.png
|
||||
|
||||
When another session invokes the target, the debugger will display the code, allowing you to add break points, or step through line-by-line. The other session is suspended until the debugging completes; then control is returned to the session.
|
||||
|
||||
.. image:: images/debug_ic_step_in.png
|
||||
|
||||
|
||||
**Direct Debugging**
|
||||
|
||||
To use the debugger for direct debugging, right click on the name of the object that you wish to debug in the pgAdmin tree control and select *Debug* from the *Debugging* sub-menu. The debugger window will open, prompting you for any values required by the program:
|
||||
|
||||
.. image:: images/debug_params.png
|
||||
|
||||
Use the fields on the *Debugger* dialog to provide a value for each parameter:
|
||||
|
||||
* The *Name* field contains the formal parameter name.
|
||||
* The *Type* field contains the parameter data type.
|
||||
* Check the *Null?* checkbox to indicate that the parameter is a NULL value.
|
||||
* Check the *Expression?* checkbox if the Value field contains an expression.
|
||||
* Use the *Value* field to provide the parameter value that will be passed to the program. When entering parameter values, type the value into the appropriate cell on the grid, or, leave the cell empty to represent NULL, enter '' (two single quotes) to represent an empty string, or to enter a literal string consisting of just two single quotes, enter \'\'. PostgreSQL 8.4 and above supports variadic function parameters. These may be entered as a comma-delimited list of values, quoted and/or cast as required.
|
||||
* Check the *Use default?* checkbox to indicate that the program should use the value in the Default Value field.
|
||||
* The *Default Value* field contains the default value of the parameter.
|
||||
|
||||
Provide values required by the program, and click the *Debug* button to start stepping through the program.
|
||||
|
||||
.. image:: images/debug_step_in.png
|
||||
|
||||
|
||||
**Using the Debugger**
|
||||
|
||||
The main debugger window consists of two panels and a context-sensitive toolbar. Use toolbar icons to manage breakpoints and step into or through code; hover over an icon for a tooltip that identifies the option associated with the icon. The toolbar options are:
|
||||
|
||||
.. image:: images/debug_toolbar.png
|
||||
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| Option | Action |
|
||||
+=========================+===========================================================================================================+
|
||||
| *Step into* | Click the *Step into* icon to execute the currently highlighted line of code. |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| *Step over* | Click the *Step over* icon to execute a line of code, stepping over any sub-functions invoked by the code.|
|
||||
| | The sub-function executes, but is not debugged unless it contains a breakpoint. |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| *Continue/Start* | Click the *Continue/Start* icon to execute the highlighted code, and continue until the program |
|
||||
| | encounters a breakpoint or completes. |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| *Toggle breakpoint* | Use the *Toggle breakpoint* icon to enable or disable a breakpoint (without removing the breakpoint). |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| *Clear all breakpoints* | Click the *Clear all breakpoints* icon to remove all breakpoints from the program. |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| *Stop* | Click the *Stop* icon to halt the execution of a program. |
|
||||
+-------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
The top panel of the debugger window displays the program body; click in the grey margin next to a line number to add a breakpoint. The highlighted line in the top panel is the line that is about to execute.
|
||||
|
||||
.. image:: images/debug_main.png
|
||||
|
||||
The lower panel of the debugger window provides a set of tabs that allow you to review information about the program:
|
||||
|
||||
* The *Parameters* tab displays the value of each parameter.
|
||||
* The *Local* variables tab displays the current value of the program variables.
|
||||
* The *Messages* tab displays any messages returned by the server (errors, warnings and informational messages).
|
||||
* The *Results* tab displays the server message when the program completes.
|
||||
* The *Stack* tab displays the list of functions that have been invoked, but which have not yet completed.
|
||||
|
||||
As you step through a program, the *Local variables* tab displays the current value of each variable:
|
||||
|
||||
.. image:: images/debug_variables.png
|
||||
|
||||
When you step into a subroutine, the *Stack* tab displays the call stack, including the name of each caller, the parameter values for each caller (if any), and the line number within each caller:
|
||||
|
||||
.. image:: images/debug_stack.png
|
||||
|
||||
Select a caller to change focus to that stack frame and display the state of the caller in the upper panel.
|
||||
|
||||
When the program completes, the *Results* tab displays the message returned by the server. If the program encounters an error, the *Messages* tab displays details:
|
||||
|
||||
.. image:: images/debug_error_message.png
|
||||
|
||||
The Debugger allows you to debug PL/PGSQL functions interactively.
|
||||
@@ -0,0 +1,15 @@
|
||||
.. _deployment:
|
||||
|
||||
******************
|
||||
pgAdmin Deployment
|
||||
******************
|
||||
|
||||
Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. If you are interested in learning more about the project, or if a pgAdmin installer is not available for your environment, the pages listed below will provide detailed information about creating a custom deployment.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
desktop_deployment
|
||||
server_deployment
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _desktop_deployment:
|
||||
|
||||
******************
|
||||
Desktop Deployment
|
||||
******************
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
.. _developer_tools:
|
||||
|
||||
***************
|
||||
Developer Tools
|
||||
***************
|
||||
|
||||
The pgAdmin *Tools* menu displays a list of powerful developer tools that you can use to execute and analyze complex SQL commands, manage data, and debug PL/SQL code.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
debugger
|
||||
query_tool
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _domain_constraint:
|
||||
.. _domain_constraint_dialog:
|
||||
|
||||
****************************
|
||||
The Domain Constraint Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _domain:
|
||||
.. _domain_dialog:
|
||||
|
||||
*****************
|
||||
The Domain Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _event trigger:
|
||||
.. _event_trigger_dialog:
|
||||
|
||||
************************
|
||||
The Event Trigger Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _exclusion_constraint:
|
||||
.. _exclusion_constraint_dialog:
|
||||
|
||||
*******************************
|
||||
The Exclusion constraint Dialog
|
||||
@@ -59,6 +59,4 @@ The example shown demonstrates creating an exclusion constraint named *exclude_d
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _extension:
|
||||
.. _extension_dialog:
|
||||
|
||||
********************
|
||||
The Extension Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _fdw:
|
||||
.. _foreign_data_wrapper_dialog:
|
||||
|
||||
*******************************
|
||||
The Foreign Data Wrapper Dialog
|
||||
|
||||
@@ -86,6 +86,4 @@ The example shown demonstrates creating a foreign key constraint named *territor
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _foreign_server:
|
||||
.. _foreign_server_dialog:
|
||||
|
||||
*************************
|
||||
The Foreign Server Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _fts_configuration:
|
||||
.. _fts_configuration_dialog:
|
||||
|
||||
****************************
|
||||
The FTS Configuration dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _fts_dictionary:
|
||||
.. _fts_dictionary_dialog:
|
||||
|
||||
*************************
|
||||
The FTS Dictionary Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _fts_parser:
|
||||
.. _fts_parser_dialog:
|
||||
|
||||
*********************
|
||||
The FTS Parser Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _fts_template:
|
||||
.. _fts_template_dialog:
|
||||
|
||||
***********************
|
||||
The FTS Template Dialog
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
.. _getting_started:
|
||||
|
||||
***************
|
||||
Getting Started
|
||||
***************
|
||||
|
||||
pgAdmin 4 features a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment.
|
||||
|
||||
When you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password. The first role registered with pgAdmin will be an administrative user. When you authenticate with pgAdmin, pgAdmin displays the server definitions associated with that login role in the tree control. The tree control provides an elegant overview of the managed servers, and the objects that reside on each server. Right-click on a node within the tree control to access context-sensitive menus that provide quick access to management tasks for the selected object.
|
||||
|
||||
The tabbed browser provide quick access to statistical information about each object in the tree control, and pgAdmin tools and utilities (such as the Query tool and the debugger). pgAdmin opens additional feature tabs each time you access the extended functionality offered by pgAdmin tools; you can open, close, and re-arrange feature tabs as needed.
|
||||
|
||||
Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
|
||||
|
||||
*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open.
|
||||
|
||||
An administrative role can use the pgAdmin User Management dialog to create and manage additional pgAdmin user accounts.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
pgadmin_login
|
||||
browser
|
||||
pgadmin_menu_bar
|
||||
pgadmin_tabbed_browser
|
||||
pgadmin_tree_control
|
||||
preferences
|
||||
pgadmin_user
|
||||
|
||||
@@ -46,10 +46,6 @@ The following is an example of the sql command generated by user selections in t
|
||||
|
||||
The commands displayed assign a role named *Bob* *INSERT* and *UPDATE* privileges *WITH GRANT OPTION* on the *sales_meetings* and the *sales_territories* tables.
|
||||
|
||||
|
||||
* Click the *Back* button to select or deselect additional database objects, roles and privileges.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Finish* button to save selections and exit the wizard.
|
||||
|
||||
|
||||
|
||||
* Click the *Finish* button to save selections and exit the wizard.
|
||||
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 46 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 33 KiB |
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 143 KiB |
|
After Width: | Height: | Size: 3.2 KiB |
|
After Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 206 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 338 KiB |
|
After Width: | Height: | Size: 47 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 37 KiB |
|
After Width: | Height: | Size: 65 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 73 KiB |
|
After Width: | Height: | Size: 65 KiB |
|
After Width: | Height: | Size: 56 KiB |
|
After Width: | Height: | Size: 76 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 59 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 20 KiB |
@@ -4,7 +4,6 @@
|
||||
The Import/Export data Dialog
|
||||
*****************************
|
||||
|
||||
|
||||
Use the *Import/Export data* dialog to copy data from a table to a file, or copy data from a file into a table.
|
||||
|
||||
The *Import/Export data* dialog organizes the import/export of data through the *Options* and *Columns* tabs.
|
||||
@@ -52,9 +51,4 @@ After completing the *Import/Export data* dialog, click the *OK* button to perfo
|
||||
|
||||
Use the *Click here for details* link on the notification to open the *Process Watcher* and review detailed information about the execution of the command that performed the import or export:
|
||||
|
||||
.. image:: images/import_export_pw.png
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.. image:: images/import_export_pw.png
|
||||
@@ -8,219 +8,34 @@ pgAdmin 4
|
||||
|
||||
Welcome to pgAdmin 4. pgAdmin is the leading Open Source management tool for Postgres, the world's most advanced Open Source database. pgAdmin 4 is designed to meet the needs of both novice and experienced Postgres users alike, providing a powerful graphical interface that simplifies the creation, maintenance and use of database objects.
|
||||
|
||||
Client Features
|
||||
===============
|
||||
|
||||
pgAdmin 4 has a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment. The client features a tree control that provides an elegant overview of the managed servers, and the objects that reside on each server. Tabbed dialogs provide quick access to statistical information about each object in the tree control.
|
||||
|
||||
Use the *Preferences* dialog to customize the content and colors of the pgAdmin display. To open the *Preferences* dialog, select *Preferences* from the *File* menu.
|
||||
|
||||
*Help* buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the *Help* menu, and selecting the name of the resource that you wish to open.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
pgadmin_index
|
||||
browser
|
||||
pgadmin_menu_bar
|
||||
pgadmin_tabbed_browser
|
||||
pgadmin_tree_control
|
||||
preferences
|
||||
help
|
||||
getting_started
|
||||
connecting
|
||||
managing_cluster_objects
|
||||
managing_database_objects
|
||||
modifying_tables
|
||||
management_basics
|
||||
backup_and_restore
|
||||
developer_tools
|
||||
deployment
|
||||
contributions
|
||||
licence
|
||||
|
||||
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
Before you can use the pgAdmin client to manage your Postgres installation, you must define a connection to the server.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
server_group_dialog
|
||||
server_dialog
|
||||
connect_to_server
|
||||
connect_error
|
||||
|
||||
|
||||
Creating Cluster Level Objects
|
||||
==============================
|
||||
|
||||
Some object definitions reside at the cluster level; pgAdmin 4 provides dialogs that allow you to create these objects, manage them, and control their relationships to each other. To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Databases* node, and select *Create Database...*
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
database_dialog
|
||||
resource_group_dialog
|
||||
role_dialog
|
||||
tablespace_dialog
|
||||
|
||||
|
||||
Creating Database Objects
|
||||
=========================
|
||||
|
||||
pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object.
|
||||
|
||||
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cast_dialog
|
||||
collation_dialog
|
||||
domain_dialog
|
||||
domain_constraint_dialog
|
||||
event_trigger_dialog
|
||||
extension_dialog
|
||||
foreign_data_wrapper_dialog
|
||||
foreign_server_dialog
|
||||
foreign_table_dialog
|
||||
fts_configuration_dialog
|
||||
fts_dictionary_dialog
|
||||
fts_parser_dialog
|
||||
fts_template_dialog
|
||||
function_dialog
|
||||
materialized_view_dialog
|
||||
procedure_dialog
|
||||
schema_dialog
|
||||
sequence_dialog
|
||||
type_dialog
|
||||
user_mapping_dialog
|
||||
view_dialog
|
||||
|
||||
|
||||
Creating or Modifying a Table
|
||||
=============================
|
||||
|
||||
pgAdmin 4 provides dialogs that allow you to modify all table properties and attributes.
|
||||
|
||||
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
check_dialog
|
||||
column_dialog
|
||||
exclusion_constraint_dialog
|
||||
foreign_key_dialog
|
||||
index_dialog
|
||||
primary_key_dialog
|
||||
rule_dialog
|
||||
table_dialog
|
||||
trigger_dialog
|
||||
unique_constraint_dialog
|
||||
|
||||
|
||||
Management Basics
|
||||
=================
|
||||
|
||||
pgAdmin provides a graphical interface that you can use to manage security issues related to your Postgres servers. Point and click dialogs allow you to create login or group roles, administer object privileges, and control access to the server.
|
||||
|
||||
The configuration editor provides a graphical interface that allows a sufficiently-privileged user to set configuration parameters in the postgresql.conf, pg_hba.conf, and .pgpass.conf files:
|
||||
|
||||
* The postgresql.conf file contains parameters that you can use to control the server and server behaviors.
|
||||
* The pg_hba.conf file contains settings that specify client authentication behavior enforced by the server.
|
||||
* The .pgpass.conf file specifies passwords that can be used to satisfy authentication requirements.
|
||||
|
||||
To modify the postgresql.conf or pg_hba.conf file, you must have sufficient privileges to modify and save files in the Postgres *data* directory. Please note that incorrect configuration can slow performance, or prevent the server from restarting without reverting your changes. Please consult the PostgreSQL core documentation for detailed information about configuring your server.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
add_restore_point_dialog
|
||||
managing_server
|
||||
change_password_dialog
|
||||
configuration_editor
|
||||
grant_wizard
|
||||
import_export_data
|
||||
maintenance_dialog
|
||||
|
||||
|
||||
Backup and Restore
|
||||
==================
|
||||
|
||||
A powerful, but user-friendly Backup and Restore tool provides an easy way to use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of databases or database objects for use in a development environment.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
backup_dialog
|
||||
backup_globals_dialog
|
||||
backup_server_dialog
|
||||
restore_dialog
|
||||
|
||||
|
||||
Developer Tools
|
||||
===============
|
||||
|
||||
The pgAdmin *Tools* menu displays a list of powerful developer tools that you can use to execute and analyze complex SQL commands, manage data, and debug PL/SQL code.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
query_tool
|
||||
data_editor
|
||||
data_filter
|
||||
debugger
|
||||
|
||||
|
||||
pgAdmin Deployment
|
||||
==================
|
||||
|
||||
Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible. If you are interested in learning more about the project, or if a pgAdmin installer is not available for your environment, the pages listed below will provide detailed information about creating a custom deployment.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
desktop_deployment
|
||||
server_deployment
|
||||
|
||||
|
||||
pgAdmin Project Contributions
|
||||
=============================
|
||||
|
||||
pgAdmin is an open-source project that invites you to get involved in the development process. For more information about contributing to the pgAdmin project, contact the developers on the pgAdmin mailing list <mailto:pgadmin-hackers@postgresql.org> to discuss any ideas you might have for enhancements or bug fixes.
|
||||
|
||||
In the sections listed below, you'll find detailed information about the development process used to develop, improve, and maintain the pgAdmin client.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
submitting_patches
|
||||
code_overview
|
||||
coding_standards
|
||||
code_snippets
|
||||
code_review
|
||||
translations
|
||||
|
||||
|
||||
Licence
|
||||
=======
|
||||
|
||||
pgAdmin is released under the
|
||||
`PostgreSQL Licence <http://www.postgresql.org/about/licence>`_, which is a
|
||||
liberal Open Source licence similar to BSD or MIT, and approved by the Open
|
||||
Source Initiative. The copyright for the project source code, website and
|
||||
documentation is attributed to the
|
||||
`pgAdmin Development Team <https://www.pgadmin.org/development/team.php>`_.
|
||||
@@ -68,6 +68,4 @@ The example shown demonstrates creating an index named *dist_codes* that indexes
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _licence:
|
||||
|
||||
*******
|
||||
Licence
|
||||
*******
|
||||
|
||||
pgAdmin is released under the `PostgreSQL Licence <http://www.postgresql.org/about/licence>`_, which is a liberal Open Source licence similar to BSD or MIT, and approved by the Open Source Initiative. The copyright for the project source code, website and documentation is attributed to the `pgAdmin Development Team <https://www.pgadmin.org/development/team.php>`_.
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _maintenance_dialog:
|
||||
|
||||
|
||||
*************************
|
||||
The Maintenance... Dialog
|
||||
*************************
|
||||
@@ -35,7 +34,4 @@ pgAdmin will inform you when the background process completes:
|
||||
|
||||
Use the *Click here for details* link on the notification to open the *Process Watcher* and review detailed information about the execution of the command that performed the import or export:
|
||||
|
||||
.. image:: images/maintenance_pw.png
|
||||
|
||||
|
||||
|
||||
.. image:: images/maintenance_pw.png
|
||||
@@ -0,0 +1,25 @@
|
||||
.. _management_basics:
|
||||
|
||||
*****************
|
||||
Management Basics
|
||||
*****************
|
||||
|
||||
pgAdmin provides a graphical interface that you can use to manage security issues related to your Postgres servers. Point and click dialogs allow you to create login or group roles, administer object privileges, and control access to the server.
|
||||
|
||||
The configuration editor provides a graphical interface that allows a sufficiently-privileged user to set configuration parameters in the postgresql.conf, pg_hba.conf, and .pgpass.conf files:
|
||||
|
||||
* The postgresql.conf file contains parameters that you can use to control the server and server behaviors.
|
||||
* The pg_hba.conf file contains settings that specify client authentication behavior enforced by the server.
|
||||
* The .pgpass.conf file specifies passwords that can be used to satisfy authentication requirements.
|
||||
|
||||
To modify the postgresql.conf or pg_hba.conf file, you must have sufficient privileges to modify and save files in the Postgres *data* directory. Please note that incorrect configuration can slow performance, or prevent the server from restarting without reverting your changes. Please consult the PostgreSQL core documentation for detailed information about configuring your server.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
add_restore_point_dialog
|
||||
change_password_dialog
|
||||
grant_wizard
|
||||
import_export_data
|
||||
maintenance_dialog
|
||||
@@ -0,0 +1,17 @@
|
||||
.. _managing_cluster_objects:
|
||||
|
||||
******************************
|
||||
Managing Cluster Level Objects
|
||||
******************************
|
||||
|
||||
Some object definitions reside at the cluster level; pgAdmin 4 provides dialogs that allow you to create these objects, manage them, and control their relationships to each other. To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Databases* node, and select *Create Database...*
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
database_dialog
|
||||
move_objects
|
||||
resource_group_dialog
|
||||
role_dialog
|
||||
tablespace_dialog
|
||||
@@ -0,0 +1,35 @@
|
||||
.. _managing_database_objects:
|
||||
|
||||
*************************
|
||||
Managing Database Objects
|
||||
*************************
|
||||
|
||||
pgAdmin 4 provides simple but powerful dialogs that you can use to design and create database objects. Each dialog contains a series of tabs that you use to describe the object that will be created by the dialog; the SQL tab displays the SQL command that the server will execute when creating the object.
|
||||
|
||||
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
cast_dialog
|
||||
collation_dialog
|
||||
domain_dialog
|
||||
domain_constraint_dialog
|
||||
event_trigger_dialog
|
||||
extension_dialog
|
||||
foreign_data_wrapper_dialog
|
||||
foreign_server_dialog
|
||||
foreign_table_dialog
|
||||
fts_configuration_dialog
|
||||
fts_dictionary_dialog
|
||||
fts_parser_dialog
|
||||
fts_template_dialog
|
||||
function_dialog
|
||||
materialized_view_dialog
|
||||
procedure_dialog
|
||||
schema_dialog
|
||||
sequence_dialog
|
||||
type_dialog
|
||||
user_mapping_dialog
|
||||
view_dialog
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _materialized_view:
|
||||
.. _materialized_view_dialog:
|
||||
|
||||
****************************
|
||||
The Materialized View Dialog
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
.. _modifying_tables:
|
||||
|
||||
*****************************
|
||||
Creating or Modifying a Table
|
||||
*****************************
|
||||
|
||||
pgAdmin 4 provides dialogs that allow you to modify all table properties and attributes.
|
||||
|
||||
To access a dialog that allows you to create a database object, right-click on the object type in the pgAdmin tree control, and select the *Create* option for that object. For example, to create a new database, right-click on the *Casts* node, and select *Create Cast...*
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
|
||||
check_dialog
|
||||
column_dialog
|
||||
exclusion_constraint_dialog
|
||||
foreign_key_dialog
|
||||
index_dialog
|
||||
primary_key_dialog
|
||||
rule_dialog
|
||||
table_dialog
|
||||
trigger_dialog
|
||||
unique_constraint_dialog
|
||||
@@ -0,0 +1,42 @@
|
||||
.. _move_objects:
|
||||
|
||||
***********************
|
||||
The Move Objects Dialog
|
||||
***********************
|
||||
|
||||
Use the *Move Objects* dialog to to move database objects from one tablespace to another tablespace.
|
||||
|
||||
The *Move Objects* dialog organizes the movement of database objects with the *General* tab; the *SQL* tab displays the SQL code generated by dialog selections.
|
||||
|
||||
.. image:: images/move_objects_general.png
|
||||
|
||||
Use the fields in the *General* tab to identify the items that will be moved and the tablespace to which they will be moved:
|
||||
|
||||
* Use the *New tablespace* drop-down listbox to select a pre-existing tablespace to which the object will be moved. (To create a tablespace, use the *Tablespace* dialog; access the dialog by right clicking *Tablespaces* in the *pgAdmin* tree control and selecting *Create Tablespace...* from the context-menu.)
|
||||
* Use the *Object type* drop-down listbox to select from the following:
|
||||
|
||||
* Select *All* to move all tables, indexes, and materialized views from the current tablespace (currently selected in the *pgAdmin* tree control) to the new tablespace.
|
||||
* Select *Tables* to move tables from the current tablespace to the new tablespace.
|
||||
* Select *Indexes* to move indexes from the current tablespace to the new tablespace.
|
||||
* Select *Materialized views* to move materialized views from the current tablespace to the new tablespace.
|
||||
|
||||
* Use the *Object owner* drop-down listbox to select the role that owns the objects selected in the *Object type* field. This field is optional.
|
||||
|
||||
Click the *SQL* tab to continue.
|
||||
|
||||
Your entries in the *Move Objects* dialog generate a SQL command (see an example below). Use the *SQL* tab for review; revisit the *General* tab to modify the SQL command.
|
||||
|
||||
**Example**
|
||||
|
||||
The following is an example of the sql command generated by user selections in the *Move Objects* dialog:
|
||||
|
||||
.. image:: images/move_objects_sql.png
|
||||
|
||||
The example shown demonstrates moving materialized views owned by Alice from tablespace *tbspace_01* to *tbspace_02*.
|
||||
|
||||
* Click the *Help* button (?) to access online help.
|
||||
* Click the *OK* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
.. _pgadmin_login:
|
||||
|
||||
************************
|
||||
The pgAdmin Login Dialog
|
||||
************************
|
||||
|
||||
Use the *pgAdmin Login* dialog to log in to pgAdmin:
|
||||
|
||||
.. image:: images/pgadmin_login.png
|
||||
|
||||
Use the fields in the *pgAdmin Login* dialog to authenticate your connection:
|
||||
|
||||
#. Provide the email address associated with your account in the *Email Address* field.
|
||||
#. Provide your password in the *Password* field.
|
||||
#. Click the *Login* button to securely log into pgAdmin.
|
||||
|
||||
**Recovering a Lost Password**
|
||||
|
||||
If you cannot supply your password, click the *Forgotten your password?* button to launch a password recovery utility.
|
||||
|
||||
.. image:: images/pgadmin_login_recover.png
|
||||
|
||||
#. Provide the email address associated with your account in the *Email Address* field.
|
||||
#. Click the *Recover Password* button to initiate recovery. An email, with directions on how to reset a password, will be sent to the address entered in the *Email Address* field.
|
||||
|
||||
If you have forgotten the email associated with your account, please contact your administrator.
|
||||
|
||||
@@ -4,13 +4,12 @@
|
||||
The pgAdmin Menu Bar
|
||||
********************
|
||||
|
||||
|
||||
The pgAdmin menu bar provides drop-down menus for access to options, commands, and utilities. The menu bar displays the following selections: *File*, *Object*, Tools*, and *Help*. Selections may be grayed out which indicates they are disabled for the object currently selected in the *pgAdmin* tree control.
|
||||
|
||||
.. image:: /images/file_menu.png
|
||||
|
||||
**The File Menu**
|
||||
|
||||
.. image:: /images/file_menu.png
|
||||
|
||||
Use the *File* menu to access the following options:
|
||||
|
||||
+----------------------+---------------------------------------------------------------------------------------------------------+
|
||||
@@ -18,13 +17,13 @@ Use the *File* menu to access the following options:
|
||||
+======================+=========================================================================================================+
|
||||
| *Change Password...* | Click to open the :ref:`Change Password... <change_password_dialog>` dialog to change your password. |
|
||||
+----------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| *Preferences* | Click to open the :ref:`Preferences <preferences_dialog>` dialog to to customize your pgAdmin settings. |
|
||||
| *Preferences* | Click to open the :ref:`Preferences <preferences>` dialog to to customize your pgAdmin settings. |
|
||||
+----------------------+---------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. image:: /images/object_menu.png
|
||||
|
||||
**The Object Menu**
|
||||
|
||||
.. image:: /images/object_menu.png
|
||||
|
||||
The *Object* menu is context-sensitive. Use the *Object* menu to access the following options (in alphabetical order):
|
||||
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -45,7 +44,7 @@ The *Object* menu is context-sensitive. Use the *Object* menu to access the foll
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Refresh...* | Click to refresh the currently selected object. |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Scripts* | Click to open the :ref:`Query tool <query_tool_overview>` to edit or view the selected script from the flyout menu. |
|
||||
| *Scripts* | Click to open the :ref:`Query tool <query_tool>` to edit or view the selected script from the flyout menu. |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Trigger(s)* | Click to *Disable* or *Enable* trigger(s) for the currently selected table. Options are displayed on the flyout menu. |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -55,16 +54,17 @@ The *Object* menu is context-sensitive. Use the *Object* menu to access the foll
|
||||
| *View Data* | Click to access a context menu that provides several options for viewing data (see below). |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. image:: /images/tool_menu.png
|
||||
|
||||
**The Tool Menu**
|
||||
|
||||
.. image:: /images/tool_menu.png
|
||||
|
||||
Use the *Tools* menu to access the following options (in alphabetical order):
|
||||
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Option | Action |
|
||||
+===========================+===========================================================================================================================================+
|
||||
| *Add named restore point* | Click to open the :ref:`Add named restore point... <add_restore_point>` dialog to take a point-in-time record of the current server state.|
|
||||
| *Add named restore point* | Click to open the :ref:`Add named restore point... <add_restore_point_dialog>` dialog to take a point-in-time snapshot of the current |
|
||||
| | server state. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Backup...* | Click to open the :ref:`Backup... <backup_dialog>` dialog to backup database objects. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -80,7 +80,7 @@ Use the *Tools* menu to access the following options (in alphabetical order):
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Pause replay of WAL* | Click to pause the replay of the WAL log. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Query tool* | Click to open the :ref:`Query tool <query_tool_overview>` for the currently selected object. |
|
||||
| *Query tool* | Click to open the :ref:`Query tool <query_tool>` for the currently selected object. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Reload Configuration...* | Click to update configuration files without restarting the server. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -89,10 +89,10 @@ Use the *Tools* menu to access the following options (in alphabetical order):
|
||||
| *Resume replay of WAL* | Click to resume the replay of the WAL log. |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. image:: images/help_menu.png
|
||||
|
||||
**The Help Menu**
|
||||
|
||||
.. image:: images/help_menu.png
|
||||
|
||||
Use the options on the *Help* menu to access online help documents, or to review information about the pgAdmin installation (in alphabetical order):
|
||||
|
||||
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@@ -17,21 +17,51 @@ The *Dashboard* tab provides a graphical analysis of the usage statistics for th
|
||||
* The *Tuples In* graph displays the number of tuples inserted, updated, and deleted into the managed server or database.
|
||||
* The *Tuples out* graph displays the number of tuples fetched and returned into the managed server or database.
|
||||
* The *Block I/O* graph displays the number of transactions processed by the managed server or database.
|
||||
* The *Server activity* graph displays information about sessions, locks, prepared transactions and configuration. The information is presented in context-sensitive tables.
|
||||
|
||||
The *Server activity* panel displays information about sessions, locks, prepared transactions and configuration. The information is presented in context-sensitive tables.
|
||||
|
||||
Click the *Properties* tab to continue.
|
||||
|
||||
.. image:: images/main_properties_table.png
|
||||
|
||||
Review properties on expandable windows specific to the *Object* selected. If multiple boxes are displayed, you can click the arrow to the left on the blue bar at the top of each box:
|
||||
|
||||
* Point the arrow to the right to contract the box.
|
||||
* Point the arrow down to expand the window.
|
||||
|
||||
.. image:: images/main_properties_edit.png
|
||||
|
||||
Click the *Edit* icon in the toolbar under the browser tabs to launch a dialog.
|
||||
|
||||
.. image:: images/main_properties_icons.png
|
||||
|
||||
If you change properties in the opened dialog, save your work. The *Properties* tab updates to show recent modifications.
|
||||
|
||||
Click the *SQL* tab to continue.
|
||||
|
||||
.. image:: images/main_sql.png
|
||||
|
||||
The SQL pane on the *SQL* tab contains an SQL script that creates the highlighted object, and if applicable, a (commented out) SQL statement that will *DROP* the selected object. You can copy the SQL statements to an editor of your choice using cut & paste shortcuts.
|
||||
|
||||
Click the *Statistics* tab to continue.
|
||||
|
||||
.. image:: images/main_statistics.png
|
||||
|
||||
The *Statistics* tab displays the statistics gathered for each database on the current server. Click a column heading to sort the table by the data displayed in the column; click again to reverse the sort order.
|
||||
The *Statistics* tab displays the statistics gathered for each object on the tree control; the statistics displayed in the table vary by the type of object that is selected. Click a column heading to sort the table by the data displayed in the column; click again to reverse the sort order. The following table lists some of the statistics that are available:
|
||||
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| Panel | Description |
|
||||
+============================+============================================================================================================+
|
||||
| *PID* | The process ID associated with the row. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| *User* | The name of the user that owns the object. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| *Database* | displays the database name. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| *Backends* | displays the number of current connections to the database. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| *Backend start* | The start time of the backend process. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| *Xact Committed* | displays the number of transactions committed to the database within the last week. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| *Xact Rolled Back* | displays the number of transactions rolled back within the last week. |
|
||||
@@ -73,36 +103,6 @@ The *Statistics* tab displays the statistics gathered for each database on the c
|
||||
| *Size* | displays the size (in megabytes) of the selected database. |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
Click the *Properties* tab to continue.
|
||||
|
||||
.. image:: images/main_properties_table.png
|
||||
|
||||
Review properties on expandable windows specific to the *Object* selected. If multiple boxes are displayed, you can click the arrow to the left on the blue bar at the top of each box:
|
||||
|
||||
* Point the arrow to the right to contract the box.
|
||||
* Point the arrow down to expand the window.
|
||||
|
||||
.. image:: images/main_properties_edit.png
|
||||
|
||||
Click the *Edit* icon in the toolbar under the browser tabs to launch a dialog.
|
||||
|
||||
.. image:: images/main_properties_icons.png
|
||||
|
||||
If you change properties in the opened dialog, save your work. The *Properties* tab updates to show recent modifications.
|
||||
|
||||
Click the *SQL* tab to continue.
|
||||
|
||||
.. image:: images/main_sql.png
|
||||
|
||||
The SQL pane on the *SQL* tab contains an SQL script that creates the highlighted object, and if applicable, a (commented out) SQL statement that will *DROP* the selected object. You can copy the SQL statements to an editor of your choice using cut & paste shortcuts.
|
||||
|
||||
Click the *Statistics* tab to continue.
|
||||
|
||||
.. image:: images/main_statistics.png
|
||||
|
||||
The *Statistics* tab displays available statistical information about the object currently selected in the *pgAdmin* browser.
|
||||
|
||||
Click the *Dependencies* tab to continue.
|
||||
|
||||
.. image:: images/main_dependencies.png
|
||||
|
||||
@@ -31,7 +31,7 @@ Access context-sensitive menus by right-clicking on a node of the tree control t
|
||||
| *Create* | Click to access a context menu that provides context-sensitive selections. |
|
||||
| | Your selection opens a *Create* dialog for creating a new object. |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| *CREATE Script* | Click to open the :ref:`Query tool <query_tool_overview>` to edit or view the CREATE script. |
|
||||
| *CREATE Script* | Click to open the :ref:`Query tool <query_tool>` to edit or view the CREATE script. |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Debugging* | Click through to open the :ref:`Debug <debugger>` tool or to select *Set breakpoint* to stop or pause a script execution. |
|
||||
+---------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -69,7 +69,7 @@ The context-sensitive menus associated with *Tables* and nested *Table* nodes pr
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Reset Statistics* | Click to reset statistics for the selected table. |
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Scripts* | Click to open the :ref:`Query tool <query_tool_overview>` to edit or view the selected script from the flyout menu. |
|
||||
| *Scripts* | Click to open the :ref:`Query tool <query_tool>` to edit or view the selected script from the flyout menu. |
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| *Truncate* | Click to remove all rows from a table. |
|
||||
+-------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
.. _pgadmin_user:
|
||||
|
||||
**************************
|
||||
The User Management Dialog
|
||||
**************************
|
||||
|
||||
When invoking pgAdmin in desktop mode, a password is randomly generated, and then ignored. If you install pgAdmin in server mode, you will be prompted for an administrator email and password for the pgAdmin client.
|
||||
|
||||
When you authenticate with pgAdmin, the server definitions associated with that login role are made available in the tree control. An administrative user can use the *User Management* dialog to
|
||||
|
||||
* add or delete pgAdmin roles
|
||||
* assign privileges
|
||||
* manage the password associated with a role
|
||||
|
||||
.. image:: images/pgadmin_user.png
|
||||
|
||||
Use the *Filter by email* search field to find a user; enter a user's email address to find a user. If the user exists, the *User Management* table will display the user's current information.
|
||||
|
||||
To add a user, click *Add* to add new role.
|
||||
|
||||
.. image:: images/add_pgadmin_user.png
|
||||
|
||||
Provide information about the new pgAdmin role in the row:
|
||||
|
||||
* Click in the *Email* field, and provide an email address for the user; this address will be used to recover the password associated with the role should the password be lost.
|
||||
* Use the drop-down listbox next to *Role* to select whether a user is an *Administrator* or a *User*.
|
||||
|
||||
* Select *Administrator* if the user will have administrative privileges within the pgAdmin client.
|
||||
* Select *User* to create a non-administrative user account.
|
||||
|
||||
* Move the *Active* switch to the *No* position if the account is not currently active; the default is *Yes*. Use this switch to disable account activity without deleting an account.
|
||||
* Use the *New password* field to provide the password associated with the user specified in the *Email* field.
|
||||
* Re-enter the password in the *Confirm password* field.
|
||||
|
||||
To discard a user, and revoke access to pgAdmin, click the trash icon to the left of the row and confirm deletion in the *Delete user?* dialog.
|
||||
|
||||
Users with the *Administrator* role are able to add, edit and remove pgAdmin users, but otherwise have the same capabilities as those with the *User* role.
|
||||
|
||||
* Click the *Help* button (?) to access online help.
|
||||
* Click the *Close* button to save work. You will be prompted to return to the dialog if your selections cannot be saved.
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _preferences:
|
||||
|
||||
|
||||
*******************
|
||||
pgAdmin Preferences
|
||||
*******************
|
||||
|
||||
@@ -43,6 +43,4 @@ The example shown demonstrates creating a primary key constraint named *dept_pke
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -104,6 +104,4 @@ The example demonstrates creating a procedure that returns a list of employees f
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -1,6 +1,177 @@
|
||||
**********
|
||||
Query Tool
|
||||
**********
|
||||
.. _query_tool:
|
||||
|
||||
The Query Tool allows you to compose and execute arbitrary SQL statements and
|
||||
view the results.
|
||||
**************
|
||||
The Query tool
|
||||
**************
|
||||
|
||||
The Query tool is a powerful, feature-rich environment that allows you to execute arbitrary SQL commands and review the result set. If you access the Query tool via the *Query Tool* menu selection from the *Tools* menu, you can:
|
||||
|
||||
* Issue ad-hoc SQL queries.
|
||||
* Execute arbitrary SQL commands.
|
||||
* Save the data displayed in the output panel to a CSV file.
|
||||
* Review the execution plan of a SQL statement in either a text or a graphical format.
|
||||
* View analytical information about a SQL statement.
|
||||
|
||||
If you open the Query tool via the *View Data* context-menu selection, the Query tool acts as a data editor, allowing you to:
|
||||
|
||||
* View or modify the data that is stored in a table.
|
||||
* Filter the result set.
|
||||
* Save the data displayed in the output panel to a CSV file.
|
||||
* Review the execution plan of a SQL statement in either a text or a graphical format.
|
||||
* View analytical information about a SQL statement.
|
||||
|
||||
.. image:: images/query_tool.png
|
||||
|
||||
The Query tool features a toolbar with frequently used options, and a work environment divided into two panels:
|
||||
|
||||
* The upper panel of the Query tool contains the *SQL Editor*. You can use the panel to manually enter a query, or review the query that generated the result set displayed in the lower panel.
|
||||
* The lower panel of the Query tool contains the *Data Output* panel. The output panel displays the result of a query, or information about a query's execution plan.
|
||||
|
||||
pgAdmin allows you to open multiple copies of the Query tool (in individual tabs) simultaneously. For example, if you select *Query tool* from the *Tools* menu, the Query tool opens in a tab labeled *Query-1*; if you open the Query tool again (without closing *Query-1*), a second copy will open in *Query-2*. To close a copy of the Query tool, click the *X* in the upper-right hand corner of the tab bar.
|
||||
|
||||
**The Query tool Toolbar**
|
||||
|
||||
The *Query tool* toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled.
|
||||
|
||||
.. image:: images/query_toolbar.png
|
||||
|
||||
Hover over an icon to display a tooltip that describes the icon's functionality.
|
||||
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| Icon | Behavior |
|
||||
+====================+===================================================================================================+
|
||||
| *Open File* | Click the *Open File* icon to display the content of a saved data set or query in the |
|
||||
| | SQL Editor. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Save* | Click the *Save* icon to save the query that is currently displayed in the SQL Editor panel. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Copy* | Click the *Copy* icon to copy the currently selected row. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Paste* | Click the *Paste* icon to paste the content that is currently on the clipboard. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Add New Row* | Use the *Add New Row* icon to add a new row in the output panel. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Filter* | Click the *Filter* icon to open a dialog that allows you to write and apply a filter for the |
|
||||
| | content currently displayed in the output panel. Click the down arrow to open the *Filter* drop- |
|
||||
| | down menu and select from pre-defined options: |
|
||||
| | |
|
||||
| | Select *Remove* to remove the currently applied filter and display the complete result set. |
|
||||
| | |
|
||||
| | Select *By selection* to refresh the displayed data, displaying only those rows that have columns|
|
||||
| | that match the currently highlighted value. |
|
||||
| | |
|
||||
| | Select *Exclude selection* to refresh the displayed data, excluding those rows that have columns |
|
||||
| | that match the currently highlighted value. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *No limit* | Use the *No limit* drop-down listbox to specify how many rows to display in the output panel. |
|
||||
| | Select from *No limit* (the default), *1000 rows*, *500 rows*, or *100 rows*. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Execute/Refresh* | Click the *Execute/Refresh* icon to either execute or refresh the query highlighted in the SQL |
|
||||
| | editor panel. Click the down arrow to access other execution options: |
|
||||
| | |
|
||||
| | Select *Explain* to view an explanation plan for the current query. The result of the |
|
||||
| | EXPLAIN is displayed graphically on the *Explain* tab of the output panel, and in text |
|
||||
| | form on the *Data Output* tab. |
|
||||
| | |
|
||||
| | Select *Explain analyze* to invoke an EXPLAIN ANALYZE command on the current query. |
|
||||
| | |
|
||||
| | Navigate through the *Explain Options* menu to select options for the EXPLAIN command: |
|
||||
| | |
|
||||
| | Select *Verbose* to display additional information regarding the query plan. |
|
||||
| | |
|
||||
| | Select *Costs* to include information on the estimated startup and total cost of each |
|
||||
| | plan node, as well as the estimated number of rows and the estimated width of each |
|
||||
| | row. |
|
||||
| | |
|
||||
| | Select *Buffers* to include information on buffer usage. |
|
||||
| | |
|
||||
| | Select *Timing* to include information about the startup time and the amount of time |
|
||||
| | spent in each node of the query. |
|
||||
| | |
|
||||
| | Add a check next to *Auto-Rollback* to instruct the server to automatically roll back a |
|
||||
| | transaction if an error occurs during the transaction. |
|
||||
| | |
|
||||
| | Add a check next to *Auto-Commit* to instruct the server to automatically commit each |
|
||||
| | transaction. Any changes made by the transaction will be visible to others, and |
|
||||
| | durable in the event of a crash. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Stop* | Click the *Stop* icon to cancel the execution of the currently running query. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Edit* | Use options on the *Edit* drop-down menu to erase the contents of the query window or erase |
|
||||
| | the content of the *History* tab. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Download as CSV* | Click the *Download as CSV* icon to download the result set of the current query to a |
|
||||
| | comma-separated list. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
| *Search* | Use the *Search* field to search the result set for specific content. |
|
||||
+--------------------+---------------------------------------------------------------------------------------------------+
|
||||
|
||||
**The SQL Editor Panel**
|
||||
|
||||
The *SQL editor* panel contains a workspace for entering commands; you can read a query from a file, or type a query. It features syntax coloring and autocompletion to help you write queries.
|
||||
|
||||
.. image:: images/query_sql_editor.png
|
||||
|
||||
To use autocomplete, start typing your query, and press the Control+Space shortcut to see a list of possible object names to insert. For example, type "\*SELECT \* FROM\* " (without the quotes, but with the trailing space), and then press the Control+Space key combination to select from a popup menu of autocomplete options.
|
||||
|
||||
.. image:: images/query_autocomplete.png
|
||||
|
||||
After entering a query, select the *Execute/Refresh* icon from the toolbar. The complete contents of the SQL editor panel will be sent to the database server for execution. To execute a section of the code that is displayed in the SQL editor, highlight the text that you want the server to execute, and click the *Execute/Refresh* icon.
|
||||
|
||||
.. image:: images/query_execute_section.png
|
||||
|
||||
The message returned by the server is displayed on the *Messages* tab of the output panel. If the command is successful, the *Messages* tab displays execution details.
|
||||
|
||||
.. image:: images/query_tool_message.png
|
||||
|
||||
The editor also offers several features that help with code formatting:
|
||||
|
||||
* The auto-indent feature will automatically indent text to the same depth as the previous line when you press the Return key.
|
||||
* Block indent text by selecting two or more lines and pressing the Tab key.
|
||||
* Block outdent text that has been indented using the Shift+Tab key combination.
|
||||
* Comment out SQL by selecting some text and pressing Control+K.
|
||||
* Uncomment SQL by selecting some text starting with a comment and pressing Control+Shift+K.
|
||||
* Shift the selected text to upper case by pressing Control+U.
|
||||
* Shift the selected text to lower case by pressing Control+Shift+U.
|
||||
|
||||
**The Data Output Panel**
|
||||
|
||||
Use the *Data Output* panel of the *Query tool* to view data and information generated by a query in the *SQL editor*, or to *View Data* for an object currently selected in the *pgAdmin* tree control.
|
||||
|
||||
The *Data Output* panel organizes output through the following tabs: *Data Output*, *Explain*, *Messages*, and *History*.
|
||||
|
||||
.. image:: images/query_output_data.png
|
||||
|
||||
If the Query tool is opened through the *Query tool* menu option, you can use the *Data Output* tab to view the results of an arbitrary query in a table format. If the Query tool is opened through a *View Data* menu option, you can use the *Data Output* tab to review the data stored in the selected table.
|
||||
|
||||
* Click a column header to sort data by that column. Click again to reverse the sorting order.
|
||||
* If enabled, use the *Filter* options from the Query tool toolbar to refine the result set displayed on the *Data Output* tab.
|
||||
* If enabled, use the *No limit* drop-down to specify how many rows to display on the *Data Output* tab.
|
||||
* If enabled, use the *Execute/Refresh* options to retrieve query execution information and set query execution options.
|
||||
* Use the *Download as CSV* icon to download the content of the *Data Output* tab as a comma-delimited file.
|
||||
|
||||
All rowsets from previous queries or commands that are displayed in the *Data Output* panel will be discarded when you invoke another query; open another query tool from the menu bar or context-menu to keep results available.
|
||||
|
||||
Use the *Explain* tab to view a graphical representation of a query:
|
||||
|
||||
.. image:: images/query_output_explain.png
|
||||
|
||||
To generate a graphical explain diagram, navigate to the *Explain* tab, and select *Explain*, *Explain Analyze*, or one or more options from the *Explain options* menu on the *Execute/Refresh* drop-down. Please note that *EXPLAIN VERBOSE* cannot be displayed graphically. Hover over an icon on the *Explain* tab to review information about that item; a popup window will display information about the selected object:
|
||||
|
||||
.. image:: images/query_output_explain_details.png
|
||||
|
||||
Note that the *QUERY PLAN* that accompanies the *Explain analyze* is available in the *Data Output* tab.
|
||||
|
||||
Use the *Messages* tab to view information about the last-executed query; if the server returns an error, the error message will be displayed on the *Messages* tab:
|
||||
|
||||
.. image:: images/query_output_error.png
|
||||
|
||||
If a query succeeds, the *Messages* tab displays how long the query took to complete and how many rows were retrieved:
|
||||
|
||||
.. image:: images/query_output_messages.png
|
||||
|
||||
Use the *History* tab to review activity for the current session:
|
||||
|
||||
.. image:: images/query_output_history.png
|
||||
|
||||
To erase the content of the *History* tab, select *Clear history* from the *Edit* drop-down menu.
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _resource_group:
|
||||
.. _resource_group_dialog:
|
||||
|
||||
*************************
|
||||
The Resource Group Dialog
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
.. _restore_dialog:
|
||||
|
||||
|
||||
******************
|
||||
The Restore Dialog
|
||||
******************
|
||||
@@ -77,31 +76,4 @@ When you’ve specified the details that will be incorporated into the pg_restor
|
||||
|
||||
Click *Click here for details* on the popup to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the restore, and provides additional information for troubleshooting should the restore command encounter problems.
|
||||
|
||||
.. image:: images/restore_process_watcher.png
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.. image:: images/restore_process_watcher.png
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _role:
|
||||
.. _role_dialog:
|
||||
|
||||
***************************
|
||||
The Login/Group Role Dialog
|
||||
|
||||
@@ -41,6 +41,4 @@ The example sends a notification when an UPDATE executes against a table.
|
||||
* Click the *Info* button (i) to access online help. View context-sensitive help in the *Tabbed browser*, where a new tab displays the PostgreSQL core documentation.
|
||||
* Click the *Save* button to save work.
|
||||
* Click the *Cancel* button to exit without saving work.
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
|
||||
|
||||
* Click the *Reset* button to restore configuration parameters.
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _schema:
|
||||
.. _schema_dialog:
|
||||
|
||||
*****************
|
||||
The Schema Dialog
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _sequence:
|
||||
.. _sequence_dialog:
|
||||
|
||||
*******************
|
||||
The Sequence Dialog
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _server_deployment:
|
||||
|
||||
*****************
|
||||
Server Deployment
|
||||
*****************
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _server:
|
||||
.. _server_dialog:
|
||||
|
||||
*****************
|
||||
The Server Dialog
|
||||
@@ -24,7 +24,7 @@ Use the fields in the *Connection* tab to configure a connection:
|
||||
|
||||
* Specify the IP address of the server host, or the fully qualified domain name in the *Host Name/Address* field. On Unix based systems, the address field may be left blank to use the default PostgreSQL Unix Domain Socket on the local machine, or may be set to an alternate path containing a PostgreSQL socket. If you enter a path, the path must begin with a "/".
|
||||
* Enter the listener port number of the server host in the *Port* field.
|
||||
* Use the *Maintenance Database* field to specify the name of the initial database to which the client will connect. If you will be using pgAgent or adminpack objects, the :ref:`pgAgent <pgagent>` schema and :ref:`adminpack <extend>` objects should be installed on that database.
|
||||
* Use the *Maintenance Database* field to specify the name of the initial database to which the client will connect. If you will be using pgAgent or adminpack objects, the pgAgent schema and adminpack objects should be installed on that database.
|
||||
* Use the *User Name* field to specify the name of a role that will be used 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. This selection allows you to connect as one role, and then assume the permissions of this specified role after the connection is established. Note that the connecting role must be a member of the role specified.
|
||||
* Use the drop-down list box in the SSL field to select the type of SSL connection the server should use. For more information about using SSL encryption, see Section 31.18 of the Postgres documentation:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _server_group:
|
||||
.. _server_group_dialog:
|
||||
|
||||
***********************
|
||||
The Server Group Dialog
|
||||
|
||||