Compare commits
251 Commits
| Author | SHA1 | Date |
|---|---|---|
|
|
aa3dc389e4 | |
|
|
92bb092718 | |
|
|
3598840203 | |
|
|
792441ab95 | |
|
|
2c626d1181 | |
|
|
278e812293 | |
|
|
1d51a1a943 | |
|
|
bf649420b7 | |
|
|
1c93f93a6a | |
|
|
3ba887001a | |
|
|
257654849b | |
|
|
d7f462c22c | |
|
|
6296016b67 | |
|
|
e3472103bb | |
|
|
990b4f5e54 | |
|
|
74b1a3bcc4 | |
|
|
01c2d12b51 | |
|
|
e5cf456fae | |
|
|
da55da4d32 | |
|
|
b301bdcecd | |
|
|
23bd3359c1 | |
|
|
0bc4edbab5 | |
|
|
34aa360830 | |
|
|
7e39fc8477 | |
|
|
8f74b2e6d4 | |
|
|
c8cb744ffd | |
|
|
b3aa78c0a5 | |
|
|
78e3b67eb1 | |
|
|
c8bd75c9a8 | |
|
|
a0e6da0772 | |
|
|
8ca765478f | |
|
|
f49c967bfd | |
|
|
0a539c32d9 | |
|
|
395ff36322 | |
|
|
00a44a5d76 | |
|
|
3ecdc57a59 | |
|
|
08b0f6fe7b | |
|
|
6d18741f1a | |
|
|
dc47bf48f7 | |
|
|
5b231ddd3f | |
|
|
3e48c21fe5 | |
|
|
4cc74c13f7 | |
|
|
2cf5d39a01 | |
|
|
f4112c9a0a | |
|
|
6f69120af5 | |
|
|
cf6d7f3b89 | |
|
|
b78fc884e3 | |
|
|
caafc6bb1b | |
|
|
e9e52905cc | |
|
|
cae00a1dc6 | |
|
|
5dd63ca16b | |
|
|
97c90f1e69 | |
|
|
bcd48a92b9 | |
|
|
6d0d387f53 | |
|
|
3995ba9a95 | |
|
|
4bb6b72377 | |
|
|
080fcc1cfb | |
|
|
93e2f23a48 | |
|
|
965a27db39 | |
|
|
7b377ff3da | |
|
|
2dedb6e69a | |
|
|
b15f15960f | |
|
|
50f78bf210 | |
|
|
0842f36f16 | |
|
|
5002419611 | |
|
|
f2756a3dcf | |
|
|
2715932464 | |
|
|
b366d210dc | |
|
|
fbbc12a0a3 | |
|
|
9039080214 | |
|
|
f52584eef8 | |
|
|
5abd9e3c5b | |
|
|
3e05f7a14f | |
|
|
9464e44887 | |
|
|
18c73d00ce | |
|
|
aa33a99b0d | |
|
|
6000cc0fb4 | |
|
|
ef1b69bd5a | |
|
|
5103c47fdf | |
|
|
b539740d8e | |
|
|
0cb6738343 | |
|
|
eee9989dde | |
|
|
596b14a0f4 | |
|
|
a46d4c22d8 | |
|
|
c47c79c3dc | |
|
|
c45502dc01 | |
|
|
5edab2f621 | |
|
|
8f39f8a6bc | |
|
|
26ea03f421 | |
|
|
63e3ad8d33 | |
|
|
31d1dbc697 | |
|
|
0cac007970 | |
|
|
93605c0baa | |
|
|
3d1cd444b0 | |
|
|
a500939532 | |
|
|
3dab883d88 | |
|
|
7c36eaba90 | |
|
|
e0ba1dd68e | |
|
|
90be555ec8 | |
|
|
402ddafa2a | |
|
|
74c8b2d0a1 | |
|
|
bef374d023 | |
|
|
a9d56402a1 | |
|
|
62e2d18b02 | |
|
|
3b184dbeee | |
|
|
71920c2903 | |
|
|
d30fd5d67e | |
|
|
d26aa0a8de | |
|
|
f63f8f7342 | |
|
|
1301e5d2ff | |
|
|
cc0377fb59 | |
|
|
79de352636 | |
|
|
965a6ad886 | |
|
|
c6551145a3 | |
|
|
04583fe8f0 | |
|
|
a1d2308dc9 | |
|
|
52daa56a04 | |
|
|
19532f534f | |
|
|
7462a6a91f | |
|
|
c3da32f0f7 | |
|
|
01e8d0c7e9 | |
|
|
30f032b7d8 | |
|
|
a9bf4c23bc | |
|
|
a5e9315b89 | |
|
|
cf123a3290 | |
|
|
44434948e2 | |
|
|
a2ea57fc2e | |
|
|
5dd07d5d4b | |
|
|
491fbe8a36 | |
|
|
63397a003a | |
|
|
10669d60a6 | |
|
|
1457f08343 | |
|
|
dc801e362e | |
|
|
55a332be5b | |
|
|
51bd866a3a | |
|
|
d5a909f14c | |
|
|
5129905307 | |
|
|
6f5c69a4c8 | |
|
|
dd51290d06 | |
|
|
d46bce2d7b | |
|
|
e50d839ac0 | |
|
|
d26888c65c | |
|
|
2ef67a5fa2 | |
|
|
c6406dbaa4 | |
|
|
f55fcf7baf | |
|
|
71719db3ab | |
|
|
086fa9bf87 | |
|
|
dc7873c2b2 | |
|
|
56040aa116 | |
|
|
9c8df1ad3b | |
|
|
e7db3510e1 | |
|
|
0132ce2001 | |
|
|
70e4435b04 | |
|
|
ec3b508ba6 | |
|
|
7885ed7f87 | |
|
|
d1b25c99cc | |
|
|
c7909958da | |
|
|
8c153be335 | |
|
|
65860fc12c | |
|
|
fc04e2eb1a | |
|
|
d481507569 | |
|
|
6d01a247db | |
|
|
27779370d8 | |
|
|
482549b951 | |
|
|
f06668aed9 | |
|
|
4129d38410 | |
|
|
c03b55042c | |
|
|
f22aa1597f | |
|
|
467e496599 | |
|
|
7b85a09603 | |
|
|
57f88cf5af | |
|
|
d6b2379fbe | |
|
|
39c2f397f7 | |
|
|
63ee81202b | |
|
|
14dec7e5ed | |
|
|
5e472ec42a | |
|
|
60c56b3285 | |
|
|
f251fdfdb1 | |
|
|
09d2b7eeb0 | |
|
|
e374edc692 | |
|
|
1d397395f7 | |
|
|
ed52a44b17 | |
|
|
06fb5a45c1 | |
|
|
d1805c5640 | |
|
|
c04b9198c8 | |
|
|
ec63acc4c5 | |
|
|
f906326003 | |
|
|
39b6f40482 | |
|
|
e6f6a90d2f | |
|
|
d80cc6f8f9 | |
|
|
38ebb43bac | |
|
|
48b4a8d448 | |
|
|
d9b3f950ad | |
|
|
986ba41ba9 | |
|
|
08379d6ae0 | |
|
|
7251c1f628 | |
|
|
061450c8d7 | |
|
|
b62212b8e5 | |
|
|
282a956f4f | |
|
|
00dbe58125 | |
|
|
abdcd983f6 | |
|
|
c7a6056ee3 | |
|
|
55c5e86fe0 | |
|
|
8d55e9a445 | |
|
|
c1da777fba | |
|
|
9e35c32ef2 | |
|
|
37a164cccb | |
|
|
c20d035f1b | |
|
|
9a44fee646 | |
|
|
0a14db01be | |
|
|
53a994ba1e | |
|
|
91ad54d17b | |
|
|
ea5ee74205 | |
|
|
5f22b4e2d2 | |
|
|
758bbc7272 | |
|
|
618e03b65f | |
|
|
e9b97d61f8 | |
|
|
83377d4a50 | |
|
|
c03d21899b | |
|
|
d03a0cdce6 | |
|
|
f3567518d3 | |
|
|
b30520adc0 | |
|
|
c6af61afd3 | |
|
|
04024c7f61 | |
|
|
9e6ab295df | |
|
|
5c9acc1c3d | |
|
|
c75bba03c2 | |
|
|
93bbadb994 | |
|
|
42ff67c845 | |
|
|
5376d88444 | |
|
|
f733d124bd | |
|
|
7ff3c4bbeb | |
|
|
e5590797c0 | |
|
|
8576a5e7e6 | |
|
|
3e66b6f7be | |
|
|
2fd2a144f1 | |
|
|
500a5c7101 | |
|
|
5498682934 | |
|
|
cdeb18fcbb | |
|
|
0de635cc4c | |
|
|
e09af0a0e9 | |
|
|
ade57d4ec4 | |
|
|
fc41c795f1 | |
|
|
7caaf2de82 | |
|
|
09bc544e83 | |
|
|
42a47126aa | |
|
|
db87df8f82 | |
|
|
15c212a2df | |
|
|
68627ab44e | |
|
|
800fdce316 | |
|
|
a5557b466c |
|
|
@ -0,0 +1,186 @@
|
||||||
|
language: en-US
|
||||||
|
tone_instructions: ''
|
||||||
|
early_access: false
|
||||||
|
enable_free_tier: true
|
||||||
|
reviews:
|
||||||
|
profile: chill
|
||||||
|
request_changes_workflow: false
|
||||||
|
high_level_summary: true
|
||||||
|
high_level_summary_placeholder: '@coderabbitai summary'
|
||||||
|
high_level_summary_in_walkthrough: false
|
||||||
|
auto_title_placeholder: '@coderabbitai'
|
||||||
|
auto_title_instructions: ''
|
||||||
|
review_status: true
|
||||||
|
commit_status: true
|
||||||
|
fail_commit_status: false
|
||||||
|
collapse_walkthrough: false
|
||||||
|
changed_files_summary: true
|
||||||
|
sequence_diagrams: true
|
||||||
|
estimate_code_review_effort: true
|
||||||
|
assess_linked_issues: true
|
||||||
|
related_issues: true
|
||||||
|
related_prs: true
|
||||||
|
suggested_labels: true
|
||||||
|
labeling_instructions: []
|
||||||
|
auto_apply_labels: false
|
||||||
|
suggested_reviewers: true
|
||||||
|
auto_assign_reviewers: false
|
||||||
|
in_progress_fortune: true
|
||||||
|
poem: false
|
||||||
|
path_filters: []
|
||||||
|
path_instructions: []
|
||||||
|
abort_on_close: true
|
||||||
|
disable_cache: false
|
||||||
|
auto_review:
|
||||||
|
enabled: true
|
||||||
|
auto_incremental_review: true
|
||||||
|
ignore_title_keywords: []
|
||||||
|
labels: []
|
||||||
|
drafts: false
|
||||||
|
base_branches: []
|
||||||
|
ignore_usernames: []
|
||||||
|
finishing_touches:
|
||||||
|
docstrings:
|
||||||
|
enabled: true
|
||||||
|
unit_tests:
|
||||||
|
enabled: true
|
||||||
|
pre_merge_checks:
|
||||||
|
docstrings:
|
||||||
|
mode: warning
|
||||||
|
threshold: 80
|
||||||
|
title:
|
||||||
|
mode: warning
|
||||||
|
requirements: ''
|
||||||
|
description:
|
||||||
|
mode: warning
|
||||||
|
issue_assessment:
|
||||||
|
mode: warning
|
||||||
|
custom_checks: []
|
||||||
|
tools:
|
||||||
|
ast-grep:
|
||||||
|
rule_dirs: []
|
||||||
|
util_dirs: []
|
||||||
|
essential_rules: true
|
||||||
|
packages: []
|
||||||
|
shellcheck:
|
||||||
|
enabled: true
|
||||||
|
ruff:
|
||||||
|
enabled: true
|
||||||
|
markdownlint:
|
||||||
|
enabled: true
|
||||||
|
github-checks:
|
||||||
|
enabled: true
|
||||||
|
timeout_ms: 900000
|
||||||
|
languagetool:
|
||||||
|
enabled: true
|
||||||
|
enabled_rules: []
|
||||||
|
disabled_rules: []
|
||||||
|
enabled_categories: []
|
||||||
|
disabled_categories: []
|
||||||
|
enabled_only: false
|
||||||
|
level: default
|
||||||
|
biome:
|
||||||
|
enabled: true
|
||||||
|
hadolint:
|
||||||
|
enabled: true
|
||||||
|
swiftlint:
|
||||||
|
enabled: true
|
||||||
|
phpstan:
|
||||||
|
enabled: true
|
||||||
|
level: default
|
||||||
|
phpmd:
|
||||||
|
enabled: true
|
||||||
|
phpcs:
|
||||||
|
enabled: true
|
||||||
|
golangci-lint:
|
||||||
|
enabled: true
|
||||||
|
yamllint:
|
||||||
|
enabled: true
|
||||||
|
gitleaks:
|
||||||
|
enabled: true
|
||||||
|
checkov:
|
||||||
|
enabled: true
|
||||||
|
detekt:
|
||||||
|
enabled: true
|
||||||
|
eslint:
|
||||||
|
enabled: true
|
||||||
|
flake8:
|
||||||
|
enabled: true
|
||||||
|
rubocop:
|
||||||
|
enabled: true
|
||||||
|
buf:
|
||||||
|
enabled: true
|
||||||
|
regal:
|
||||||
|
enabled: true
|
||||||
|
actionlint:
|
||||||
|
enabled: true
|
||||||
|
pmd:
|
||||||
|
enabled: true
|
||||||
|
clang:
|
||||||
|
enabled: true
|
||||||
|
cppcheck:
|
||||||
|
enabled: true
|
||||||
|
semgrep:
|
||||||
|
enabled: true
|
||||||
|
circleci:
|
||||||
|
enabled: true
|
||||||
|
clippy:
|
||||||
|
enabled: true
|
||||||
|
sqlfluff:
|
||||||
|
enabled: true
|
||||||
|
prismaLint:
|
||||||
|
enabled: true
|
||||||
|
pylint:
|
||||||
|
enabled: true
|
||||||
|
oxc:
|
||||||
|
enabled: true
|
||||||
|
shopifyThemeCheck:
|
||||||
|
enabled: true
|
||||||
|
luacheck:
|
||||||
|
enabled: true
|
||||||
|
brakeman:
|
||||||
|
enabled: true
|
||||||
|
dotenvLint:
|
||||||
|
enabled: true
|
||||||
|
htmlhint:
|
||||||
|
enabled: true
|
||||||
|
checkmake:
|
||||||
|
enabled: true
|
||||||
|
osvScanner:
|
||||||
|
enabled: true
|
||||||
|
chat:
|
||||||
|
art: true
|
||||||
|
auto_reply: true
|
||||||
|
integrations:
|
||||||
|
jira:
|
||||||
|
usage: auto
|
||||||
|
linear:
|
||||||
|
usage: auto
|
||||||
|
knowledge_base:
|
||||||
|
opt_out: false
|
||||||
|
web_search:
|
||||||
|
enabled: true
|
||||||
|
code_guidelines:
|
||||||
|
enabled: true
|
||||||
|
filePatterns: []
|
||||||
|
learnings:
|
||||||
|
scope: auto
|
||||||
|
issues:
|
||||||
|
scope: auto
|
||||||
|
jira:
|
||||||
|
usage: auto
|
||||||
|
project_keys: []
|
||||||
|
linear:
|
||||||
|
usage: auto
|
||||||
|
team_keys: []
|
||||||
|
pull_requests:
|
||||||
|
scope: auto
|
||||||
|
mcp:
|
||||||
|
usage: auto
|
||||||
|
disabled_servers: []
|
||||||
|
code_generation:
|
||||||
|
docstrings:
|
||||||
|
language: en-US
|
||||||
|
path_instructions: []
|
||||||
|
unit_tests:
|
||||||
|
path_instructions: []
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
web/node_modules
|
web/node_modules
|
||||||
|
web/config_*.py
|
||||||
web/*.log
|
web/*.log
|
||||||
web/regression
|
web/regression
|
||||||
web/**/tests/
|
web/**/tests/
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,2 @@
|
||||||
|
# Auto detect text files and normalize end of lines to LF (\n)
|
||||||
|
* text=auto eol=lf
|
||||||
|
|
@ -21,7 +21,7 @@ jobs:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
pgver: [13, 14, 15, 16, 17]
|
pgver: [14, 15, 16, 17, 18]
|
||||||
|
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@ jobs:
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
pgver: [13, 14, 15, 16, 17]
|
pgver: [14, 15, 16, 17, 18]
|
||||||
|
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ jobs:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-22.04, windows-latest]
|
os: [ubuntu-22.04, windows-latest]
|
||||||
pgver: [13, 14, 15, 16, 17]
|
pgver: [14, 15, 16, 17, 18]
|
||||||
|
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
|
|
@ -73,6 +73,14 @@ jobs:
|
||||||
IF %ERRORLEVEL% EQU 3010 cmd /c "exit /b 0"
|
IF %ERRORLEVEL% EQU 3010 cmd /c "exit /b 0"
|
||||||
shell: cmd
|
shell: cmd
|
||||||
|
|
||||||
|
- name: Add pg_config path to PATH
|
||||||
|
shell: pwsh
|
||||||
|
run: |
|
||||||
|
$pgPath = "C:\\EPAS\\${{ matrix.pgver }}\\bin"
|
||||||
|
Write-Output $pgPath
|
||||||
|
Add-Content -Path $env:GITHUB_PATH -Value $pgPath
|
||||||
|
pg_config --version
|
||||||
|
|
||||||
- name: Create the tablespace directory on Linux
|
- name: Create the tablespace directory on Linux
|
||||||
if: ${{ matrix.os == 'ubuntu-22.04' }}
|
if: ${{ matrix.os == 'ubuntu-22.04' }}
|
||||||
run: |
|
run: |
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@ jobs:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [macos-latest, ubuntu-22.04, windows-latest]
|
os: [macos-latest, ubuntu-22.04, windows-latest]
|
||||||
pgver: [13, 14, 15, 16, 17]
|
pgver: [14, 15, 16, 17, 18]
|
||||||
|
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
|
|
||||||
|
|
@ -64,6 +64,7 @@ jobs:
|
||||||
brew install postgresql@${{ matrix.pgver }}
|
brew install postgresql@${{ matrix.pgver }}
|
||||||
echo "/opt/homebrew/opt/postgresql@${{ matrix.pgver }}/bin" >> $GITHUB_PATH
|
echo "/opt/homebrew/opt/postgresql@${{ matrix.pgver }}/bin" >> $GITHUB_PATH
|
||||||
|
|
||||||
|
|
||||||
- name: Uninstall PostgreSQL if already present on windows
|
- name: Uninstall PostgreSQL if already present on windows
|
||||||
if: ${{ matrix.os == 'windows-latest' }}
|
if: ${{ matrix.os == 'windows-latest' }}
|
||||||
run: |
|
run: |
|
||||||
|
|
@ -78,13 +79,21 @@ jobs:
|
||||||
run: |
|
run: |
|
||||||
FOR /f "delims=" %%F IN ('python tools\get_sb_package.py "https://www.postgresql.org/applications-v2.xml" "postgresql_${{ matrix.pgver }}" "windows-x64"') DO SET INSTALLER_EXE=%%F
|
FOR /f "delims=" %%F IN ('python tools\get_sb_package.py "https://www.postgresql.org/applications-v2.xml" "postgresql_${{ matrix.pgver }}" "windows-x64"') DO SET INSTALLER_EXE=%%F
|
||||||
ECHO Running %INSTALLER_EXE%...
|
ECHO Running %INSTALLER_EXE%...
|
||||||
%INSTALLER_EXE% --prefix C:\PostgreSQL\${{ matrix.pgver }} --datadir C:\PostgreSQL\${{ matrix.pgver }}\data --serverport 59${{ matrix.pgver }} --superpassword postgres --install_runtimes 0 --mode unattended --unattendedmodeui none --disable-components pgAdmin,stackbuilder --enable-components server,commandlinetools"
|
%INSTALLER_EXE% --prefix C:\PostgreSQL_custom\${{ matrix.pgver }} --datadir C:\PostgreSQL_custom\${{ matrix.pgver }}\data --serverport 59${{ matrix.pgver }} --superpassword postgres --install_runtimes 0 --mode unattended --unattendedmodeui none --disable-components pgAdmin,stackbuilder --enable-components server,commandlinetools"
|
||||||
choco install -y mitkerberos
|
choco install -y mitkerberos
|
||||||
|
|
||||||
REM Ignore error 3010 (reboot required)
|
REM Ignore error 3010 (reboot required)
|
||||||
IF %ERRORLEVEL% EQU 3010 cmd /c "exit /b 0"
|
IF %ERRORLEVEL% EQU 3010 cmd /c "exit /b 0"
|
||||||
shell: cmd
|
shell: cmd
|
||||||
|
|
||||||
|
- name: Add pg_config path to PATH
|
||||||
|
shell: pwsh
|
||||||
|
run: |
|
||||||
|
$pgPath = "C:\\PostgreSQL_custom\\${{ matrix.pgver }}\\bin"
|
||||||
|
Write-Output $pgPath
|
||||||
|
Add-Content -Path $env:GITHUB_PATH -Value $pgPath
|
||||||
|
pg_config --version
|
||||||
|
|
||||||
- name: Create the tablespace directory on Linux
|
- name: Create the tablespace directory on Linux
|
||||||
if: ${{ matrix.os == 'ubuntu-22.04' }}
|
if: ${{ matrix.os == 'ubuntu-22.04' }}
|
||||||
run: |
|
run: |
|
||||||
|
|
|
||||||
117
Dockerfile
|
|
@ -2,7 +2,7 @@
|
||||||
#
|
#
|
||||||
# pgAdmin 4 - PostgreSQL Tools
|
# pgAdmin 4 - PostgreSQL Tools
|
||||||
#
|
#
|
||||||
# Copyright (C) 2013 - 2025, The pgAdmin Development Team
|
# Copyright (C) 2013 - 2026, The pgAdmin Development Team
|
||||||
# This software is released under the PostgreSQL Licence
|
# This software is released under the PostgreSQL Licence
|
||||||
#
|
#
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
@ -31,51 +31,38 @@ RUN apk add --no-cache \
|
||||||
yarn \
|
yarn \
|
||||||
zlib-dev
|
zlib-dev
|
||||||
|
|
||||||
COPY .git .git
|
# Create the /pgadmin4 directory and copy the source into it
|
||||||
# Create the /pgadmin4 directory and copy the source into it. Explicitly
|
|
||||||
# remove the node_modules directory as we'll recreate a clean version, as well
|
|
||||||
# as various other files we don't want
|
|
||||||
COPY web /pgadmin4/web
|
COPY web /pgadmin4/web
|
||||||
RUN rm -rf /pgadmin4/web/*.log \
|
|
||||||
/pgadmin4/web/config_*.py \
|
|
||||||
/pgadmin4/web/node_modules \
|
|
||||||
/pgadmin4/web/regression \
|
|
||||||
`find /pgadmin4/web -type d -name tests` \
|
|
||||||
`find /pgadmin4/web -type f -name .DS_Store`
|
|
||||||
|
|
||||||
WORKDIR /pgadmin4/web
|
WORKDIR /pgadmin4/web
|
||||||
|
|
||||||
# Build the JS vendor code in the app-builder, and then remove the vendor source.
|
# Build the JS vendor code in the app-builder, and then remove the vendor source.
|
||||||
RUN export CPPFLAGS="-DPNG_ARM_NEON_OPT=0" && \
|
RUN --mount=type=bind,source=.git,target=/pgadmin4/.git \
|
||||||
|
--mount=type=tmpfs,target=node_modules \
|
||||||
|
--mount=type=tmpfs,target=pgadmin/static/js/generated/.cache \
|
||||||
|
export CPPFLAGS="-DPNG_ARM_NEON_OPT=0" && \
|
||||||
npm install -g corepack && \
|
npm install -g corepack && \
|
||||||
corepack enable && \
|
corepack enable && \
|
||||||
yarn set version berry && \
|
yarn set version berry && \
|
||||||
yarn set version 4 && \
|
yarn set version 4 && \
|
||||||
yarn install && \
|
yarn install && \
|
||||||
yarn run bundle && \
|
yarn run bundle && \
|
||||||
rm -rf node_modules \
|
rm -rf yarn.lock \
|
||||||
yarn.lock \
|
|
||||||
package.json \
|
package.json \
|
||||||
.[^.]* \
|
.[^.]* \
|
||||||
babel.cfg \
|
babel.cfg \
|
||||||
webpack.* \
|
webpack.* \
|
||||||
jest.config.js \
|
jest.config.js \
|
||||||
babel.* \
|
babel.*
|
||||||
./pgadmin/static/js/generated/.cache \
|
|
||||||
/pgadmin4/.git
|
|
||||||
|
|
||||||
#########################################################################
|
#########################################################################
|
||||||
# Next, create the base environment for Python
|
# Next, create the base environment for Python
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
||||||
FROM alpine:latest AS env-builder
|
FROM python:3-alpine AS env-builder
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
COPY requirements.txt /
|
|
||||||
RUN apk add --no-cache \
|
RUN apk add --no-cache \
|
||||||
make \
|
make && \
|
||||||
python3 \
|
|
||||||
py3-pip && \
|
|
||||||
apk add --no-cache --virtual build-deps \
|
apk add --no-cache --virtual build-deps \
|
||||||
build-base \
|
build-base \
|
||||||
openssl-dev \
|
openssl-dev \
|
||||||
|
|
@ -86,9 +73,9 @@ RUN apk add --no-cache \
|
||||||
cargo \
|
cargo \
|
||||||
zlib-dev \
|
zlib-dev \
|
||||||
libjpeg-turbo-dev \
|
libjpeg-turbo-dev \
|
||||||
libpng-dev \
|
libpng-dev
|
||||||
python3-dev && \
|
COPY requirements.txt /
|
||||||
python3 -m venv --system-site-packages --without-pip /venv && \
|
RUN python3 -m venv --system-site-packages --without-pip /venv && \
|
||||||
/venv/bin/python3 -m pip install --no-cache-dir -r requirements.txt && \
|
/venv/bin/python3 -m pip install --no-cache-dir -r requirements.txt && \
|
||||||
apk del --no-cache build-deps
|
apk del --no-cache build-deps
|
||||||
|
|
||||||
|
|
@ -120,21 +107,16 @@ RUN rm -rf /pgadmin4/docs/en_US/_build/html/_static/*.png
|
||||||
# Create additional builders to get all of the PostgreSQL utilities
|
# Create additional builders to get all of the PostgreSQL utilities
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
||||||
FROM postgres:12-alpine AS pg12-builder
|
|
||||||
FROM postgres:13-alpine AS pg13-builder
|
FROM postgres:13-alpine AS pg13-builder
|
||||||
FROM postgres:14-alpine AS pg14-builder
|
FROM postgres:14-alpine AS pg14-builder
|
||||||
FROM postgres:15-alpine AS pg15-builder
|
FROM postgres:15-alpine AS pg15-builder
|
||||||
FROM postgres:16-alpine AS pg16-builder
|
FROM postgres:16-alpine AS pg16-builder
|
||||||
FROM postgres:17-alpine AS pg17-builder
|
FROM postgres:17-alpine AS pg17-builder
|
||||||
|
FROM postgres:18-alpine AS pg18-builder
|
||||||
|
|
||||||
FROM alpine:latest AS tool-builder
|
FROM alpine:latest AS tool-builder
|
||||||
|
|
||||||
# Copy the PG binaries
|
# Copy the PG binaries
|
||||||
COPY --from=pg12-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-12/
|
|
||||||
COPY --from=pg12-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-12/
|
|
||||||
COPY --from=pg12-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-12/
|
|
||||||
COPY --from=pg12-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-12/
|
|
||||||
|
|
||||||
COPY --from=pg13-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-13/
|
COPY --from=pg13-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-13/
|
||||||
COPY --from=pg13-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-13/
|
COPY --from=pg13-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-13/
|
||||||
COPY --from=pg13-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-13/
|
COPY --from=pg13-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-13/
|
||||||
|
|
@ -160,44 +142,21 @@ COPY --from=pg17-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-17/
|
||||||
COPY --from=pg17-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-17/
|
COPY --from=pg17-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-17/
|
||||||
COPY --from=pg17-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-17/
|
COPY --from=pg17-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-17/
|
||||||
|
|
||||||
|
COPY --from=pg18-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-18/
|
||||||
|
COPY --from=pg18-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-18/
|
||||||
|
COPY --from=pg18-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-18/
|
||||||
|
COPY --from=pg18-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-18/
|
||||||
|
|
||||||
#########################################################################
|
#########################################################################
|
||||||
# Assemble everything into the final container.
|
# Assemble everything into the final container.
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
||||||
FROM alpine:latest
|
FROM python:3-alpine
|
||||||
|
|
||||||
# Copy in the Python packages
|
# Install runtime dependencies
|
||||||
COPY --from=env-builder /venv /venv
|
RUN apk update && apk upgrade && \
|
||||||
|
apk add \
|
||||||
# Copy in the tools
|
|
||||||
COPY --from=tool-builder /usr/local/pgsql /usr/local/
|
|
||||||
COPY --from=pg17-builder /usr/local/lib/libpq.so.5.17 /usr/lib/
|
|
||||||
COPY --from=pg17-builder /usr/lib/libzstd.so.1.5.7 /usr/lib/
|
|
||||||
COPY --from=pg17-builder /usr/lib/liblz4.so.1.10.0 /usr/lib/
|
|
||||||
|
|
||||||
RUN ln -s libpq.so.5.17 /usr/lib/libpq.so.5 && \
|
|
||||||
ln -s libpq.so.5.17 /usr/lib/libpq.so && \
|
|
||||||
ln -s libzstd.so.1.5.7 /usr/lib/libzstd.so.1 && \
|
|
||||||
ln -s liblz4.so.1.10.0 /usr/lib/liblz4.so.1
|
|
||||||
|
|
||||||
WORKDIR /pgadmin4
|
|
||||||
ENV PYTHONPATH=/pgadmin4
|
|
||||||
|
|
||||||
# Copy in the code and docs
|
|
||||||
COPY --from=app-builder /pgadmin4/web /pgadmin4
|
|
||||||
COPY --from=docs-builder /pgadmin4/docs/en_US/_build/html/ /pgadmin4/docs
|
|
||||||
COPY pkg/docker/run_pgadmin.py /pgadmin4
|
|
||||||
COPY pkg/docker/gunicorn_config.py /pgadmin4
|
|
||||||
COPY pkg/docker/entrypoint.sh /entrypoint.sh
|
|
||||||
|
|
||||||
# License files
|
|
||||||
COPY LICENSE /pgadmin4/LICENSE
|
|
||||||
|
|
||||||
# Install runtime dependencies and configure everything in one RUN step
|
|
||||||
RUN apk add --no-cache \
|
|
||||||
python3 \
|
|
||||||
bash \
|
bash \
|
||||||
py3-pip \
|
|
||||||
postfix \
|
postfix \
|
||||||
krb5-libs \
|
krb5-libs \
|
||||||
libjpeg-turbo \
|
libjpeg-turbo \
|
||||||
|
|
@ -207,7 +166,33 @@ RUN apk add --no-cache \
|
||||||
libedit \
|
libedit \
|
||||||
libldap \
|
libldap \
|
||||||
libcap && \
|
libcap && \
|
||||||
/venv/bin/python3 -m pip install --no-cache-dir gunicorn==23.0.0 && \
|
rm -rf /var/cache/apk/*
|
||||||
|
|
||||||
|
# Copy in the Python packages
|
||||||
|
COPY --from=env-builder /venv /venv
|
||||||
|
|
||||||
|
# Copy in the tools
|
||||||
|
COPY --from=tool-builder /usr/local/pgsql /usr/local/
|
||||||
|
COPY --from=pg18-builder /usr/local/lib/libpq.so.5.18 /usr/lib/liblz4.so.1.10.0 /usr/lib/
|
||||||
|
|
||||||
|
RUN ln -s libpq.so.5.18 /usr/lib/libpq.so.5 && \
|
||||||
|
ln -s libpq.so.5.18 /usr/lib/libpq.so && \
|
||||||
|
ln -s liblz4.so.1.10.0 /usr/lib/liblz4.so.1
|
||||||
|
|
||||||
|
WORKDIR /pgadmin4
|
||||||
|
ENV PYTHONPATH=/pgadmin4
|
||||||
|
|
||||||
|
# Copy in the code and docs
|
||||||
|
COPY --from=app-builder /pgadmin4/web /pgadmin4
|
||||||
|
COPY --from=docs-builder /pgadmin4/docs/en_US/_build/html/ /pgadmin4/docs
|
||||||
|
COPY pkg/docker/run_pgadmin.py pkg/docker/gunicorn_config.py /pgadmin4/
|
||||||
|
COPY pkg/docker/entrypoint.sh /entrypoint.sh
|
||||||
|
|
||||||
|
# License files
|
||||||
|
COPY LICENSE /pgadmin4/LICENSE
|
||||||
|
|
||||||
|
# Configure everything in one RUN step
|
||||||
|
RUN /venv/bin/python3 -m pip install --no-cache-dir gunicorn==23.0.0 && \
|
||||||
find / -type d -name '__pycache__' -exec rm -rf {} + && \
|
find / -type d -name '__pycache__' -exec rm -rf {} + && \
|
||||||
useradd -r -u 5050 -g root -s /sbin/nologin pgadmin && \
|
useradd -r -u 5050 -g root -s /sbin/nologin pgadmin && \
|
||||||
mkdir -p /run/pgadmin /var/lib/pgadmin && \
|
mkdir -p /run/pgadmin /var/lib/pgadmin && \
|
||||||
|
|
@ -217,7 +202,7 @@ RUN apk add --no-cache \
|
||||||
chown pgadmin:root /pgadmin4/config_distro.py && \
|
chown pgadmin:root /pgadmin4/config_distro.py && \
|
||||||
chmod g=u /pgadmin4/config_distro.py && \
|
chmod g=u /pgadmin4/config_distro.py && \
|
||||||
chmod g=u /etc/passwd && \
|
chmod g=u /etc/passwd && \
|
||||||
setcap CAP_NET_BIND_SERVICE=+eip /usr/bin/python3.12 && \
|
setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/python3.[0-9][0-9] && \
|
||||||
echo "pgadmin ALL = NOPASSWD: /usr/sbin/postfix start" > /etc/sudoers.d/postfix && \
|
echo "pgadmin ALL = NOPASSWD: /usr/sbin/postfix start" > /etc/sudoers.d/postfix && \
|
||||||
echo "pgadminr ALL = NOPASSWD: /usr/sbin/postfix start" >> /etc/sudoers.d/postfix
|
echo "pgadminr ALL = NOPASSWD: /usr/sbin/postfix start" >> /etc/sudoers.d/postfix
|
||||||
|
|
||||||
|
|
|
||||||
2
LICENSE
|
|
@ -4,7 +4,7 @@ pgAdmin 4
|
||||||
This software is released under the PostgreSQL licence.
|
This software is released under the PostgreSQL licence.
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
Copyright (C) 2013 - 2025, The pgAdmin Development Team
|
Copyright (C) 2013 - 2026, The pgAdmin Development Team
|
||||||
|
|
||||||
Permission to use, copy, modify, and distribute this software and its
|
Permission to use, copy, modify, and distribute this software and its
|
||||||
documentation for any purpose, without fee, and without a written agreement is
|
documentation for any purpose, without fee, and without a written agreement is
|
||||||
|
|
|
||||||
39
Make.bat
|
|
@ -59,6 +59,7 @@ REM Main build sequence Ends
|
||||||
IF "%PGADMIN_VCREDIST_DIR%" == "" SET "PGADMIN_VCREDIST_DIR=C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Redist\MSVC\14.40.33807"
|
IF "%PGADMIN_VCREDIST_DIR%" == "" SET "PGADMIN_VCREDIST_DIR=C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Redist\MSVC\14.40.33807"
|
||||||
IF "%PGADMIN_VCREDIST_FILE%" == "" SET "PGADMIN_VCREDIST_FILE=vc_redist.x64.exe"
|
IF "%PGADMIN_VCREDIST_FILE%" == "" SET "PGADMIN_VCREDIST_FILE=vc_redist.x64.exe"
|
||||||
IF "%PGADMIN_SIGNTOOL_DIR%" == "" SET "PGADMIN_SIGNTOOL_DIR=C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64"
|
IF "%PGADMIN_SIGNTOOL_DIR%" == "" SET "PGADMIN_SIGNTOOL_DIR=C:\Program Files (x86)\Windows Kits\10\bin\10.0.22621.0\x64"
|
||||||
|
IF "%PGADMIN_WINDOWS_CSC%" == "" SET "PGADMIN_WINDOWS_CSC="
|
||||||
|
|
||||||
REM Set additional variables we need
|
REM Set additional variables we need
|
||||||
FOR /F "tokens=3" %%a IN ('findstr /C:"APP_RELEASE =" %WD%\web\version.py') DO SET APP_MAJOR=%%a
|
FOR /F "tokens=3" %%a IN ('findstr /C:"APP_RELEASE =" %WD%\web\version.py') DO SET APP_MAJOR=%%a
|
||||||
|
|
@ -99,6 +100,11 @@ REM Main build sequence Ends
|
||||||
ECHO VC++ redist file: %PGADMIN_VCREDIST_FILE%
|
ECHO VC++ redist file: %PGADMIN_VCREDIST_FILE%
|
||||||
ECHO InnoTool directory: %PGADMIN_INNOTOOL_DIR%
|
ECHO InnoTool directory: %PGADMIN_INNOTOOL_DIR%
|
||||||
ECHO signtool directory: %PGADMIN_SIGNTOOL_DIR%
|
ECHO signtool directory: %PGADMIN_SIGNTOOL_DIR%
|
||||||
|
IF "%PGADMIN_WINDOWS_CSC%" == "" (
|
||||||
|
ECHO Code signing certificate: [NONE - Signing disabled]
|
||||||
|
) ELSE (
|
||||||
|
ECHO Code signing certificate: %PGADMIN_WINDOWS_CSC%
|
||||||
|
)
|
||||||
ECHO.
|
ECHO.
|
||||||
ECHO App version: %APP_VERSION%
|
ECHO App version: %APP_VERSION%
|
||||||
ECHO App version suffix: %APP_VERSION_SUFFIX%
|
ECHO App version suffix: %APP_VERSION_SUFFIX%
|
||||||
|
|
@ -282,7 +288,7 @@ REM Main build sequence Ends
|
||||||
|
|
||||||
REM WGET
|
REM WGET
|
||||||
FOR /f "tokens=*" %%i IN ('npm info electron version') DO SET "ELECTRON_VERSION=%%i"
|
FOR /f "tokens=*" %%i IN ('npm info electron version') DO SET "ELECTRON_VERSION=%%i"
|
||||||
SET ELECTRON_VERSION="35.4.0"
|
|
||||||
:GET_NW
|
:GET_NW
|
||||||
wget https://github.com/electron/electron/releases/download/v%ELECTRON_VERSION%/electron-v%ELECTRON_VERSION%-win32-x64.zip -O "%TMPDIR%\electron-v%ELECTRON_VERSION%-win32-x64.zip"
|
wget https://github.com/electron/electron/releases/download/v%ELECTRON_VERSION%/electron-v%ELECTRON_VERSION%-win32-x64.zip -O "%TMPDIR%\electron-v%ELECTRON_VERSION%-win32-x64.zip"
|
||||||
IF %ERRORLEVEL% NEQ 0 GOTO GET_NW
|
IF %ERRORLEVEL% NEQ 0 GOTO GET_NW
|
||||||
|
|
@ -306,14 +312,18 @@ REM Main build sequence Ends
|
||||||
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-version-string "ProductName" "%APP_NAME%"
|
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-version-string "ProductName" "%APP_NAME%"
|
||||||
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-product-version "%APP_VERSION%""
|
%TMPDIR%\rcedit-x64.exe "%BUILDROOT%\runtime\pgAdmin4.exe" --set-product-version "%APP_VERSION%""
|
||||||
|
|
||||||
ECHO Attempting to sign the pgAdmin4.exe...
|
IF NOT "%PGADMIN_WINDOWS_CSC%" == "" (
|
||||||
CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" sign /fd certHash /tr http://timestamp.digicert.com /td SHA256 "%BUILDROOT%\runtime\pgAdmin4.exe"
|
ECHO Attempting to sign the pgAdmin4.exe...
|
||||||
IF %ERRORLEVEL% NEQ 0 (
|
CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" sign /sm /n "%PGADMIN_WINDOWS_CSC%" /tr http://timestamp.digicert.com /td sha256 /fd sha1 /v "%BUILDROOT%\runtime\pgAdmin4.exe"
|
||||||
ECHO.
|
IF %ERRORLEVEL% NEQ 0 (
|
||||||
ECHO ************************************************************
|
ECHO.
|
||||||
ECHO * Failed to sign the pgAdmin4.exe
|
ECHO ************************************************************
|
||||||
ECHO ************************************************************
|
ECHO * Failed to sign the pgAdmin4.exe
|
||||||
PAUSE
|
ECHO ************************************************************
|
||||||
|
PAUSE
|
||||||
|
)
|
||||||
|
) ELSE (
|
||||||
|
ECHO Skipping code signing ^(PGADMIN_WINDOWS_CSC is not set^)...
|
||||||
)
|
)
|
||||||
|
|
||||||
ECHO Staging PostgreSQL components...
|
ECHO Staging PostgreSQL components...
|
||||||
|
|
@ -356,7 +366,11 @@ REM Main build sequence Ends
|
||||||
DEL /s "%WD%\pkg\win32\installer.iss.in_stage*" > nul
|
DEL /s "%WD%\pkg\win32\installer.iss.in_stage*" > nul
|
||||||
|
|
||||||
ECHO Creating windows installer using INNO tool...
|
ECHO Creating windows installer using INNO tool...
|
||||||
CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" "%WD%\pkg\win32\installer.iss" "/SpgAdminSigntool=%PGADMIN_SIGNTOOL_DIR%\signtool.exe sign /fd certHash /tr http://timestamp.digicert.com /td SHA256 $f" || EXIT /B 1
|
IF NOT "%PGADMIN_WINDOWS_CSC%" == "" (
|
||||||
|
CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" "%WD%\pkg\win32\installer.iss" "/SpgAdminSigntool=%PGADMIN_SIGNTOOL_DIR%\signtool.exe sign /sm /n $q%PGADMIN_WINDOWS_CSC%$q /tr http://timestamp.digicert.com /td sha256 /fd sha1 /v $f" || EXIT /B 1
|
||||||
|
) ELSE (
|
||||||
|
CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" "%WD%\pkg\win32\installer.iss" || EXIT /B 1
|
||||||
|
)
|
||||||
|
|
||||||
ECHO Renaming installer...
|
ECHO Renaming installer...
|
||||||
MOVE "%WD%\pkg\win32\Output\pgadmin4-setup.exe" "%DISTROOT%\%INSTALLERNAME%" > nul || EXIT /B 1
|
MOVE "%WD%\pkg\win32\Output\pgadmin4-setup.exe" "%DISTROOT%\%INSTALLERNAME%" > nul || EXIT /B 1
|
||||||
|
|
@ -374,6 +388,11 @@ REM Main build sequence Ends
|
||||||
EXIT /B 0
|
EXIT /B 0
|
||||||
|
|
||||||
:VERIFY_SIGNATURE
|
:VERIFY_SIGNATURE
|
||||||
|
IF "%PGADMIN_WINDOWS_CSC%" == "" (
|
||||||
|
ECHO Skipping signature verification ^(PGADMIN_WINDOWS_CSC is not set^)...
|
||||||
|
EXIT /B 0
|
||||||
|
)
|
||||||
|
|
||||||
ECHO Verifying the installer signature...
|
ECHO Verifying the installer signature...
|
||||||
|
|
||||||
CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" verify /pa /v "%DISTROOT%\%INSTALLERNAME%"
|
CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" verify /pa /v "%DISTROOT%\%INSTALLERNAME%"
|
||||||
|
|
|
||||||
2
Makefile
|
|
@ -2,7 +2,7 @@
|
||||||
#
|
#
|
||||||
# pgAdmin 4 - PostgreSQL Tools
|
# pgAdmin 4 - PostgreSQL Tools
|
||||||
#
|
#
|
||||||
# Copyright (C) 2013 - 2025, The pgAdmin Development Team
|
# Copyright (C) 2013 - 2026, The pgAdmin Development Team
|
||||||
# This software is released under the PostgreSQL Licence
|
# This software is released under the PostgreSQL Licence
|
||||||
#
|
#
|
||||||
#########################################################################
|
#########################################################################
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,249 @@
|
||||||
|
.. _ai_tools:
|
||||||
|
|
||||||
|
*******************
|
||||||
|
`AI Reports`:index:
|
||||||
|
*******************
|
||||||
|
|
||||||
|
**AI Reports** is a feature that provides AI-powered database analysis and insights
|
||||||
|
using Large Language Models (LLMs). Use the *Tools → AI Reports* menu to access
|
||||||
|
the various AI-powered reports.
|
||||||
|
|
||||||
|
The AI Reports feature allows you to:
|
||||||
|
|
||||||
|
* Generate security reports to identify potential security vulnerabilities and configuration issues.
|
||||||
|
|
||||||
|
* Create performance reports with optimization recommendations for queries and configurations.
|
||||||
|
|
||||||
|
* Perform design reviews to analyze database schema structure and suggest improvements.
|
||||||
|
|
||||||
|
**Prerequisites:**
|
||||||
|
|
||||||
|
Before using AI Reports, you must:
|
||||||
|
|
||||||
|
1. Ensure AI features are enabled in the server configuration (set ``LLM_ENABLED`` to ``True`` in ``config.py``).
|
||||||
|
|
||||||
|
2. Configure an LLM provider in :ref:`Preferences → AI <preferences>`.
|
||||||
|
|
||||||
|
**Note:**
|
||||||
|
|
||||||
|
* AI Reports using cloud providers (Anthropic, OpenAI) require an active internet connection.
|
||||||
|
Local providers (Ollama, Docker Model Runner) do not require internet access.
|
||||||
|
|
||||||
|
* API usage may incur costs depending on your LLM provider's pricing model.
|
||||||
|
Local providers (Ollama, Docker Model Runner) are free to use.
|
||||||
|
|
||||||
|
* The quality and accuracy of reports depend on the LLM provider and model configured.
|
||||||
|
|
||||||
|
|
||||||
|
Configuring AI Reports
|
||||||
|
**********************
|
||||||
|
|
||||||
|
To configure AI Reports, navigate to *File → Preferences → AI* (or click the *Settings*
|
||||||
|
button and select *AI*).
|
||||||
|
|
||||||
|
.. image:: images/preferences_ai.png
|
||||||
|
:alt: AI preferences
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
Select your preferred LLM provider from the dropdown:
|
||||||
|
|
||||||
|
**Anthropic**
|
||||||
|
Use Claude models from Anthropic, or any Anthropic-compatible API provider.
|
||||||
|
|
||||||
|
* **API URL**: Custom API endpoint URL (leave empty for default: https://api.anthropic.com/v1).
|
||||||
|
* **API Key File**: Path to a file containing your Anthropic API key (obtain from https://console.anthropic.com/). This path refers to the filesystem where the pgAdmin server is running (e.g., inside the container if using Docker). The ``~`` prefix is expanded to the home directory of the user running the pgAdmin server process. Optional when using a custom URL with a provider that does not require authentication.
|
||||||
|
* **Model**: Select from available Claude models (e.g., claude-sonnet-4-20250514).
|
||||||
|
|
||||||
|
**OpenAI**
|
||||||
|
Use GPT models from OpenAI, or any OpenAI-compatible API provider (e.g.,
|
||||||
|
LiteLLM, LM Studio, EXO, or other local inference servers).
|
||||||
|
|
||||||
|
* **API URL**: Custom API endpoint URL (leave empty for default: https://api.openai.com/v1). Include the ``/v1`` path prefix if required by your provider.
|
||||||
|
* **API Key File**: Path to a file containing your OpenAI API key (obtain from https://platform.openai.com/). This path refers to the filesystem where the pgAdmin server is running (e.g., inside the container if using Docker). The ``~`` prefix is expanded to the home directory of the user running the pgAdmin server process. Optional when using a custom URL with a provider that does not require authentication.
|
||||||
|
* **Model**: Select from available GPT models (e.g., gpt-4).
|
||||||
|
|
||||||
|
**Ollama**
|
||||||
|
Use locally-hosted open-source models via Ollama. Requires a running Ollama instance.
|
||||||
|
|
||||||
|
* **API URL**: The URL of your Ollama server (default: http://localhost:11434).
|
||||||
|
* **Model**: Enter the name of the Ollama model to use (e.g., llama2, mistral).
|
||||||
|
|
||||||
|
**Docker Model Runner**
|
||||||
|
Use models running in Docker Desktop's built-in model runner (available in Docker Desktop 4.40+).
|
||||||
|
No API key is required.
|
||||||
|
|
||||||
|
* **API URL**: The URL of the Docker Model Runner API (default: http://localhost:12434).
|
||||||
|
* **Model**: Select from available models or enter a custom model name.
|
||||||
|
|
||||||
|
.. note:: You can also use the *OpenAI* provider with a custom API URL for any
|
||||||
|
OpenAI-compatible endpoint, including Docker Model Runner and other local
|
||||||
|
inference servers.
|
||||||
|
|
||||||
|
After configuring your provider, click *Save* to apply the changes.
|
||||||
|
|
||||||
|
|
||||||
|
Security Reports
|
||||||
|
****************
|
||||||
|
|
||||||
|
Security Reports analyze your PostgreSQL server, database, or schema for potential
|
||||||
|
security vulnerabilities and configuration issues.
|
||||||
|
|
||||||
|
To generate a security report:
|
||||||
|
|
||||||
|
1. In the *Browser* tree, select a server, database, or schema.
|
||||||
|
|
||||||
|
2. Choose *Tools → AI Reports → Security* from the menu, or right-click the
|
||||||
|
object and select *Security* from the context menu.
|
||||||
|
|
||||||
|
3. The report will be generated and displayed in a new tab.
|
||||||
|
|
||||||
|
.. image:: images/ai_security_report.png
|
||||||
|
:alt: AI security report
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
**Security Report Scope:**
|
||||||
|
|
||||||
|
* **Server Level**: Analyzes server configuration, authentication settings, roles, and permissions.
|
||||||
|
|
||||||
|
* **Database Level**: Reviews database-specific security settings, roles with database access, and object permissions.
|
||||||
|
|
||||||
|
* **Schema Level**: Examines schema permissions, object ownership, and access controls.
|
||||||
|
|
||||||
|
Each report includes:
|
||||||
|
|
||||||
|
* **Security Findings**: Identified vulnerabilities or security concerns.
|
||||||
|
|
||||||
|
* **Risk Assessment**: Severity levels for each finding (Critical, High, Medium, Low).
|
||||||
|
|
||||||
|
* **Recommendations**: Specific actions to remediate security issues.
|
||||||
|
|
||||||
|
* **Best Practices**: General security recommendations for PostgreSQL.
|
||||||
|
|
||||||
|
|
||||||
|
Performance Reports
|
||||||
|
*******************
|
||||||
|
|
||||||
|
Performance Reports analyze query performance, configuration settings, and provide
|
||||||
|
optimization recommendations.
|
||||||
|
|
||||||
|
To generate a performance report:
|
||||||
|
|
||||||
|
1. In the *Browser* tree, select a server or database.
|
||||||
|
|
||||||
|
2. Choose *Tools → AI Reports → Performance* from the menu, or right-click the
|
||||||
|
object and select *Performance* from the context menu.
|
||||||
|
|
||||||
|
3. The report will be generated and displayed in a new tab.
|
||||||
|
|
||||||
|
**Performance Report Scope:**
|
||||||
|
|
||||||
|
* **Server Level**: Analyzes server configuration parameters, resource utilization, and overall server performance metrics.
|
||||||
|
|
||||||
|
* **Database Level**: Reviews database-specific configuration, query performance, index usage, and table statistics.
|
||||||
|
|
||||||
|
Each report includes:
|
||||||
|
|
||||||
|
* **Performance Metrics**: Key performance indicators and statistics.
|
||||||
|
|
||||||
|
* **Configuration Analysis**: Review of relevant configuration parameters.
|
||||||
|
|
||||||
|
* **Query Optimization**: Recommendations for improving slow queries.
|
||||||
|
|
||||||
|
* **Index Recommendations**: Suggestions for adding, removing, or modifying indexes.
|
||||||
|
|
||||||
|
* **Capacity Planning**: Resource utilization trends and recommendations.
|
||||||
|
|
||||||
|
|
||||||
|
Design Review Reports
|
||||||
|
*********************
|
||||||
|
|
||||||
|
Design Review Reports analyze your database schema structure and suggest
|
||||||
|
improvements for normalization, naming conventions, and best practices.
|
||||||
|
|
||||||
|
To generate a design review report:
|
||||||
|
|
||||||
|
1. In the *Browser* tree, select a database or schema.
|
||||||
|
|
||||||
|
2. Choose *Tools → AI Reports → Design* from the menu, or right-click the
|
||||||
|
object and select *Design* from the context menu.
|
||||||
|
|
||||||
|
3. The report will be generated and displayed in a new tab.
|
||||||
|
|
||||||
|
**Design Review Scope:**
|
||||||
|
|
||||||
|
* **Database Level**: Reviews overall database structure, schema organization, and cross-schema dependencies.
|
||||||
|
|
||||||
|
* **Schema Level**: Analyzes tables, views, functions, and other objects within the schema.
|
||||||
|
|
||||||
|
Each report includes:
|
||||||
|
|
||||||
|
* **Schema Structure Analysis**: Review of table structures, relationships, and constraints.
|
||||||
|
|
||||||
|
* **Normalization Review**: Recommendations for database normalization (1NF, 2NF, 3NF, etc.).
|
||||||
|
|
||||||
|
* **Naming Conventions**: Suggestions for consistent naming patterns.
|
||||||
|
|
||||||
|
* **Data Type Usage**: Review of data type choices and recommendations.
|
||||||
|
|
||||||
|
* **Index Design**: Analysis of indexing strategy.
|
||||||
|
|
||||||
|
* **Best Practices**: General PostgreSQL schema design recommendations.
|
||||||
|
|
||||||
|
|
||||||
|
Working with Reports
|
||||||
|
********************
|
||||||
|
|
||||||
|
All AI reports are displayed in a dedicated panel with the following features:
|
||||||
|
|
||||||
|
**Report Display**
|
||||||
|
Reports are formatted as Markdown and rendered with syntax highlighting for SQL code.
|
||||||
|
|
||||||
|
**Toolbar Actions**
|
||||||
|
|
||||||
|
* **Stop** - Cancel the current report generation. This is useful if the report
|
||||||
|
is taking too long or if you want to change parameters.
|
||||||
|
|
||||||
|
* **Regenerate** - Generate a new report for the same object. Useful when you
|
||||||
|
want to get a fresh analysis or if data has changed.
|
||||||
|
|
||||||
|
* **Download** - Download the report as a Markdown (.md) file. The filename
|
||||||
|
includes the report type, object name, and date for easy identification.
|
||||||
|
|
||||||
|
**Multiple Reports**
|
||||||
|
You can generate and view multiple reports simultaneously. Each report opens in
|
||||||
|
a new tab, allowing you to compare reports across different servers, databases,
|
||||||
|
or schemas.
|
||||||
|
|
||||||
|
**Report Management**
|
||||||
|
Each report tab can be closed individually by clicking the *X* in the tab.
|
||||||
|
Panel titles show the object name and report type for easy identification.
|
||||||
|
|
||||||
|
**Copying Content**
|
||||||
|
You can select and copy text from reports to use in documentation or share with
|
||||||
|
your team.
|
||||||
|
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
***************
|
||||||
|
|
||||||
|
**"AI features are disabled in the server configuration"**
|
||||||
|
The administrator has disabled AI features on the server. Contact your
|
||||||
|
pgAdmin administrator to enable the ``LLM_ENABLED`` configuration option.
|
||||||
|
|
||||||
|
**"Please configure an LLM provider in Preferences"**
|
||||||
|
You need to configure an LLM provider before using AI Reports. See *Configuring AI Reports* above.
|
||||||
|
|
||||||
|
**"Please connect to the server/database first"**
|
||||||
|
You must establish a connection to the server or database before generating reports.
|
||||||
|
|
||||||
|
**API Connection Errors**
|
||||||
|
* Verify your API key is correct (for Anthropic and OpenAI).
|
||||||
|
* Check your internet connection (for cloud providers).
|
||||||
|
* For Ollama, ensure the Ollama server is running and accessible.
|
||||||
|
* For Docker Model Runner, ensure Docker Desktop 4.40+ is running with the model runner enabled.
|
||||||
|
* Check that your firewall allows connections to the LLM provider's API.
|
||||||
|
|
||||||
|
**Report Generation Fails**
|
||||||
|
* Check the pgAdmin logs for detailed error messages.
|
||||||
|
* Verify the database connection is still active.
|
||||||
|
* Ensure the selected model is available for your account/subscription.
|
||||||
|
|
@ -77,13 +77,13 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Sections** field box to select a portion of the object
|
* Move switches in the **Sections** field box to select a portion of the object
|
||||||
that will be backed up.
|
that will be backed up.
|
||||||
|
|
||||||
* Move the switch next to *Pre-data* towards right position to include all
|
* Move the switch next to *Pre-data* to the *Yes* position to include all
|
||||||
data definition items not included in the data or post-data item lists.
|
data definition items not included in the data or post-data item lists.
|
||||||
|
|
||||||
* Move the switch next to *Data* towards right position to backup actual table
|
* Move the switch next to *Data* to the *Yes* position to backup actual table
|
||||||
data, large-object contents, and sequence values.
|
data, large-object contents, and sequence values.
|
||||||
|
|
||||||
* Move the switch next to *Post-data* towards right position to include
|
* Move the switch next to *Post-data* to the *Yes* position to include
|
||||||
definitions of indexes, triggers, rules, and constraints other than
|
definitions of indexes, triggers, rules, and constraints other than
|
||||||
validated check constraints.
|
validated check constraints.
|
||||||
|
|
||||||
|
|
@ -94,13 +94,13 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Type of objects** field box to specify details about
|
* Move switches in the **Type of objects** field box to specify details about
|
||||||
the type of objects that will be backed up.
|
the type of objects that will be backed up.
|
||||||
|
|
||||||
* Move the switch next to *Only data* towards right position to limit the back
|
* Move the switch next to *Only data* to the *Yes* position to limit the back
|
||||||
up to data.
|
up to data.
|
||||||
|
|
||||||
* Move the switch next to *Only schemas* to limit the back up to schema-level
|
* Move the switch next to *Only schemas* to limit the back up to schema-level
|
||||||
database objects.
|
database objects.
|
||||||
|
|
||||||
* Move the switch next to *Blobs* towards left position to exclude large
|
* Move the switch next to *Blobs* to the *No* position to exclude large
|
||||||
objects in the backup.
|
objects in the backup.
|
||||||
|
|
||||||
.. image:: images/backup_do_not_save.png
|
.. image:: images/backup_do_not_save.png
|
||||||
|
|
@ -110,36 +110,36 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Do not save** field box to select the objects that will
|
* Move switches in the **Do not save** field box to select the objects that will
|
||||||
not be included in the backup.
|
not be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Owner* towards right position to exclude commands
|
* Move the switch next to *Owner* to the *Yes* position to exclude commands
|
||||||
that set object ownership.
|
that set object ownership.
|
||||||
|
|
||||||
* Move the switch next to *Privileges* towards right position to exclude
|
* Move the switch next to *Privileges* to the *Yes* position to exclude
|
||||||
commands that create access privileges.
|
commands that create access privileges.
|
||||||
|
|
||||||
* Move the switch next to *Tablespaces* towards right position to exclude
|
* Move the switch next to *Tablespaces* to the *Yes* position to exclude
|
||||||
tablespaces.
|
tablespaces.
|
||||||
|
|
||||||
* Move the switch next to *Unlogged table data* towards right position to
|
* Move the switch next to *Unlogged table data* to the *Yes* position to
|
||||||
exclude the contents of unlogged tables.
|
exclude the contents of unlogged tables.
|
||||||
|
|
||||||
* Move the switch next to *Comments* towards right position to exclude
|
* Move the switch next to *Comments* to the *Yes* position to exclude
|
||||||
commands that set the comments. **Note:** This option is visible only for
|
commands that set the comments. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 11.
|
database server greater than or equal to 11.
|
||||||
|
|
||||||
* Move the switch next to *Publications* towards right position to exclude
|
* Move the switch next to *Publications* to the *Yes* position to exclude
|
||||||
publications.
|
publications.
|
||||||
|
|
||||||
* Move the switch next to *Subscriptions* towards right position to exclude
|
* Move the switch next to *Subscriptions* to the *Yes* position to exclude
|
||||||
subscriptions.
|
subscriptions.
|
||||||
|
|
||||||
* Move the switch next to *Security labels* towards right position to exclude
|
* Move the switch next to *Security labels* to the *Yes* position to exclude
|
||||||
Security labels.
|
Security labels.
|
||||||
|
|
||||||
* Move the switch next to *Toast compressions* towards right position to exclude
|
* Move the switch next to *Toast compressions* to the *Yes* position to exclude
|
||||||
Toast compressions. **Note:** This option is visible only for
|
Toast compressions. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 14.
|
database server greater than or equal to 14.
|
||||||
|
|
||||||
* Move the switch next to *Table access methods* towards right position to exclude
|
* Move the switch next to *Table access methods* to the *Yes* position to exclude
|
||||||
Table access methods. **Note:** This option is visible only for
|
Table access methods. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 15.
|
database server greater than or equal to 15.
|
||||||
|
|
||||||
|
|
@ -150,7 +150,7 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
Click the *Query Options* tab to continue. Use these additional fields to specify
|
Click the *Query Options* tab to continue. Use these additional fields to specify
|
||||||
the type of statements that should be included in the backup.
|
the type of statements that should be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Use INSERT commands* towards right position to
|
* Move the switch next to *Use INSERT commands* to the *Yes* position to
|
||||||
dump the data in the form of INSERT statements rather than using a COPY
|
dump the data in the form of INSERT statements rather than using a COPY
|
||||||
command. Please note: this may make restoration from backup slow.
|
command. Please note: this may make restoration from backup slow.
|
||||||
|
|
||||||
|
|
@ -165,16 +165,16 @@ the type of statements that should be included in the backup.
|
||||||
**Note:** This option is visible only for database server greater than or
|
**Note:** This option is visible only for database server greater than or
|
||||||
equal to 12.
|
equal to 12.
|
||||||
|
|
||||||
* Move the switch next to *Include CREATE DATABASE statement* towards right
|
* Move the switch next to *Include CREATE DATABASE statement* to the *Yes*
|
||||||
position to include a command in the backup that creates a new database
|
position to include a command in the backup that creates a new database
|
||||||
when restoring the backup.
|
when restoring the backup.
|
||||||
|
|
||||||
* Move the switch next to *Include DROP DATABASE statement* towards right
|
* Move the switch next to *Include DROP DATABASE statement* to the *Yes*
|
||||||
position to include a command in the backup that will drop any existing
|
position to include a command in the backup that will drop any existing
|
||||||
database object with the same name before recreating the object during a
|
database object with the same name before recreating the object during a
|
||||||
backup.
|
backup.
|
||||||
|
|
||||||
* Move the switch next to *Include IF EXISTS clause* towards right
|
* Move the switch next to *Include IF EXISTS clause* to the *Yes*
|
||||||
position to add an IF EXISTS clause to drop databases and other objects.
|
position to add an IF EXISTS clause to drop databases and other objects.
|
||||||
This option is not valid unless *Include DROP DATABASE statement* is also set.
|
This option is not valid unless *Include DROP DATABASE statement* is also set.
|
||||||
|
|
||||||
|
|
@ -185,17 +185,17 @@ the type of statements that should be included in the backup.
|
||||||
Click the *Table Options* tab to continue. Use the fields in the *Table Options*
|
Click the *Table Options* tab to continue. Use the fields in the *Table Options*
|
||||||
tab related to tables that should be included in the backup.
|
tab related to tables that should be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Use Column INSERTS* towards right position to dump
|
* Move the switch next to *Use Column INSERTS* to the *Yes* position to dump
|
||||||
the data in the form of INSERT statements and include explicit column
|
the data in the form of INSERT statements and include explicit column
|
||||||
names. Please note: this may make restoration from backup slow.
|
names. Please note: this may make restoration from backup slow.
|
||||||
|
|
||||||
* Move the switch next to *Load via partition root* towards right position,
|
* Move the switch next to *Load via partition root* to the *Yes* position,
|
||||||
so when dumping a COPY or INSERT statement for a partitioned table, target
|
so when dumping a COPY or INSERT statement for a partitioned table, target
|
||||||
the root of the partitioning hierarchy which contains it rather than the
|
the root of the partitioning hierarchy which contains it rather than the
|
||||||
partition itself. **Note:** This option is visible only for database server
|
partition itself. **Note:** This option is visible only for database server
|
||||||
greater than or equal to 11.
|
greater than or equal to 11.
|
||||||
|
|
||||||
* Move the switch next to *Enable row security* towards right position to
|
* Move the switch next to *Enable row security* to the *Yes* position to
|
||||||
set row_security to on instead, allowing the user to dump the parts of the
|
set row_security to on instead, allowing the user to dump the parts of the
|
||||||
contents of the table that they have access to. This option is relevant
|
contents of the table that they have access to. This option is relevant
|
||||||
only when dumping the contents of a table which has row security.
|
only when dumping the contents of a table which has row security.
|
||||||
|
|
@ -235,10 +235,10 @@ tab to provide other backup options.
|
||||||
that should be excluded from the backup.
|
that should be excluded from the backup.
|
||||||
|
|
||||||
* Move the switch next to *Triggers* (active when creating a data-only backup)
|
* Move the switch next to *Triggers* (active when creating a data-only backup)
|
||||||
towards right position to include commands that will disable triggers on the
|
to the *Yes* position to include commands that will disable triggers on the
|
||||||
target table while the data is being loaded.
|
target table while the data is being loaded.
|
||||||
|
|
||||||
* Move the switch next to *$ quoting* towards right position to enable dollar
|
* Move the switch next to *$ quoting* to the *Yes* position to enable dollar
|
||||||
quoting within function bodies; if disabled, the function body will be
|
quoting within function bodies; if disabled, the function body will be
|
||||||
quoted using SQL standard string syntax.
|
quoted using SQL standard string syntax.
|
||||||
|
|
||||||
|
|
@ -249,13 +249,13 @@ tab to provide other backup options.
|
||||||
* Move switches in the **Miscellaneous** field box to specify miscellaneous
|
* Move switches in the **Miscellaneous** field box to specify miscellaneous
|
||||||
backup options.
|
backup options.
|
||||||
|
|
||||||
* Move the switch next to *Verbose messages* towards left position to instruct
|
* Move the switch next to *Verbose messages* to the *No* position to instruct
|
||||||
*pg_dump* to exclude verbose messages.
|
*pg_dump* to exclude verbose messages.
|
||||||
|
|
||||||
* Move the switch next to *Force double quotes on identifiers* towards right
|
* Move the switch next to *Force double quotes on identifiers* to the *Yes*
|
||||||
position to force the quoting of all identifiers.
|
position to force the quoting of all identifiers.
|
||||||
|
|
||||||
* Move the switch next to *Use SET SESSION AUTHORIZATION* towards right
|
* Move the switch next to *Use SET SESSION AUTHORIZATION* to the *Yes*
|
||||||
position to include a statement that will use a SET SESSION AUTHORIZATION
|
position to include a statement that will use a SET SESSION AUTHORIZATION
|
||||||
command to determine object ownership (instead of an ALTER OWNER command).
|
command to determine object ownership (instead of an ALTER OWNER command).
|
||||||
|
|
||||||
|
|
@ -265,9 +265,9 @@ tab to provide other backup options.
|
||||||
* Use the *Extra float digits* field to use the specified value when dumping
|
* Use the *Extra float digits* field to use the specified value when dumping
|
||||||
floating-point data, instead of the maximum available precision.
|
floating-point data, instead of the maximum available precision.
|
||||||
|
|
||||||
* Use the *Lock wait timeout* field to do not wait forever to acquire shared
|
* Use the *Lock wait timeout* field to specify a timeout rather than waiting
|
||||||
table locks at the beginning of the dump. Instead, fail if unable to lock a
|
indefinitely to acquire shared table locks at the beginning of the dump.
|
||||||
table within the specified timeout.
|
If unable to lock a table within the specified timeout, the operation will fail.
|
||||||
|
|
||||||
Click the *Objects* tab to continue.
|
Click the *Objects* tab to continue.
|
||||||
|
|
||||||
|
|
@ -287,6 +287,6 @@ command:
|
||||||
|
|
||||||
* Click the *Cancel* button to exit without saving work.
|
* Click the *Cancel* button to exit without saving work.
|
||||||
|
|
||||||
pgAdmin will run the backup process in background. You can view all the background
|
pgAdmin will run the backup process in the background. You can view all the background
|
||||||
process with there running status and logs on the :ref:`Processes <processes>`
|
processes with their running status and logs on the :ref:`Processes <processes>`
|
||||||
tab
|
tab.
|
||||||
|
|
|
||||||
|
|
@ -34,6 +34,6 @@ statements that should be included in the backup.
|
||||||
Click the *Backup* button to build and execute a command based on your
|
Click the *Backup* button to build and execute a command based on your
|
||||||
selections; click the *Cancel* button to exit without saving work.
|
selections; click the *Cancel* button to exit without saving work.
|
||||||
|
|
||||||
pgAdmin will run the backup process in background. You can view all the background
|
pgAdmin will run the backup process in the background. You can view all the background
|
||||||
process with there running status and logs on the :ref:`Processes <processes>`
|
processes with their running status and logs on the :ref:`Processes <processes>`
|
||||||
tab
|
tab.
|
||||||
|
|
@ -34,7 +34,7 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Type of objects** field box to specify details about
|
* Move switches in the **Type of objects** field box to specify details about
|
||||||
the type of objects that will be backed up.
|
the type of objects that will be backed up.
|
||||||
|
|
||||||
* Move the switch next to *Only data* towards right position to limit the back
|
* Move the switch next to *Only data* to the *Yes* position to limit the back
|
||||||
up to data.
|
up to data.
|
||||||
|
|
||||||
* Move the switch next to *Only schemas* to limit the back up to schema-level
|
* Move the switch next to *Only schemas* to limit the back up to schema-level
|
||||||
|
|
@ -52,39 +52,39 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Do not save** field box to select the objects that will
|
* Move switches in the **Do not save** field box to select the objects that will
|
||||||
not be included in the backup.
|
not be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Owner* towards right position to exclude commands
|
* Move the switch next to *Owner* to the *Yes* position to exclude commands
|
||||||
that set object ownership.
|
that set object ownership.
|
||||||
|
|
||||||
* Move the switch next to *Role passwords* towards right position to exclude
|
* Move the switch next to *Role passwords* to the *Yes* position to exclude
|
||||||
passwords for roles.
|
passwords for roles.
|
||||||
|
|
||||||
* Move the switch next to *Privileges* towards right position to exclude
|
* Move the switch next to *Privileges* to the *Yes* position to exclude
|
||||||
commands that create access privileges.
|
commands that create access privileges.
|
||||||
|
|
||||||
* Move the switch next to *Tablespaces* towards right position to exclude
|
* Move the switch next to *Tablespaces* to the *Yes* position to exclude
|
||||||
tablespaces.
|
tablespaces.
|
||||||
|
|
||||||
* Move the switch next to *Unlogged table data* towards right position to
|
* Move the switch next to *Unlogged table data* to the *Yes* position to
|
||||||
exclude the contents of unlogged tables.
|
exclude the contents of unlogged tables.
|
||||||
|
|
||||||
* Move the switch next to *Comments* towards right position to exclude
|
* Move the switch next to *Comments* to the *Yes* position to exclude
|
||||||
commands that set the comments. **Note:** This option is visible only for
|
commands that set the comments. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 11.
|
database server greater than or equal to 11.
|
||||||
|
|
||||||
* Move the switch next to *Publications* towards right position to exclude
|
* Move the switch next to *Publications* to the *Yes* position to exclude
|
||||||
publications.
|
publications.
|
||||||
|
|
||||||
* Move the switch next to *Subscriptions* towards right position to exclude
|
* Move the switch next to *Subscriptions* to the *Yes* position to exclude
|
||||||
subscriptions.
|
subscriptions.
|
||||||
|
|
||||||
* Move the switch next to *Security labels* towards right position to exclude
|
* Move the switch next to *Security labels* to the *Yes* position to exclude
|
||||||
Security labels.
|
Security labels.
|
||||||
|
|
||||||
* Move the switch next to *Toast compressions* towards right position to exclude
|
* Move the switch next to *Toast compressions* to the *Yes* position to exclude
|
||||||
Toast compressions. **Note:** This option is visible only for
|
Toast compressions. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 14.
|
database server greater than or equal to 14.
|
||||||
|
|
||||||
* Move the switch next to *Table access methods* towards right position to exclude
|
* Move the switch next to *Table access methods* to the *Yes* position to exclude
|
||||||
Table access methods. **Note:** This option is visible only for
|
Table access methods. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 15.
|
database server greater than or equal to 15.
|
||||||
|
|
||||||
|
|
@ -95,7 +95,7 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
Click the *Query Options* tab to continue. Use these additional fields to specify
|
Click the *Query Options* tab to continue. Use these additional fields to specify
|
||||||
the type of statements that should be included in the backup.
|
the type of statements that should be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Use INSERT commands* towards right position to
|
* Move the switch next to *Use INSERT commands* to the *Yes* position to
|
||||||
dump the data in the form of INSERT statements rather than using a COPY
|
dump the data in the form of INSERT statements rather than using a COPY
|
||||||
command. Please note: this may make restoration from backup slow.
|
command. Please note: this may make restoration from backup slow.
|
||||||
|
|
||||||
|
|
@ -110,12 +110,12 @@ the type of statements that should be included in the backup.
|
||||||
**Note:** This option is visible only for database server greater than or
|
**Note:** This option is visible only for database server greater than or
|
||||||
equal to 12.
|
equal to 12.
|
||||||
|
|
||||||
* Move the switch next to *Include DROP DATABASE statement* towards right
|
* Move the switch next to *Include DROP DATABASE statement* to the *Yes*
|
||||||
position to include a command in the backup that will drop any existing
|
position to include a command in the backup that will drop any existing
|
||||||
database object with the same name before recreating the object during a
|
database object with the same name before recreating the object during a
|
||||||
backup.
|
backup.
|
||||||
|
|
||||||
* Move the switch next to *Include IF EXISTS clause* towards right
|
* Move the switch next to *Include IF EXISTS clause* to the *Yes*
|
||||||
position to add an IF EXISTS clause to drop databases and other objects.
|
position to add an IF EXISTS clause to drop databases and other objects.
|
||||||
This option is not valid unless *Include DROP DATABASE statement* is also set.
|
This option is not valid unless *Include DROP DATABASE statement* is also set.
|
||||||
|
|
||||||
|
|
@ -126,11 +126,11 @@ the type of statements that should be included in the backup.
|
||||||
Click the *Table Options* tab to continue. Use the fields in the *Table Options*
|
Click the *Table Options* tab to continue. Use the fields in the *Table Options*
|
||||||
tab related to tables that should be included in the backup.
|
tab related to tables that should be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Use Column INSERTS* towards right position to dump
|
* Move the switch next to *Use Column INSERTS* to the *Yes* position to dump
|
||||||
the data in the form of INSERT statements and include explicit column
|
the data in the form of INSERT statements and include explicit column
|
||||||
names. Please note: this may make restoration from backup slow.
|
names. Please note: this may make restoration from backup slow.
|
||||||
|
|
||||||
* Move the switch next to *Load via partition root* towards right position,
|
* Move the switch next to *Load via partition root* to the *Yes* position,
|
||||||
so when dumping a COPY or INSERT statement for a partitioned table, target
|
so when dumping a COPY or INSERT statement for a partitioned table, target
|
||||||
the root of the partitioning hierarchy which contains it rather than the
|
the root of the partitioning hierarchy which contains it rather than the
|
||||||
partition itself. **Note:** This option is visible only for database server
|
partition itself. **Note:** This option is visible only for database server
|
||||||
|
|
@ -147,10 +147,10 @@ tab to provide other backup options.
|
||||||
that should be excluded from the backup.
|
that should be excluded from the backup.
|
||||||
|
|
||||||
* Move the switch next to *Triggers* (active when creating a data-only backup)
|
* Move the switch next to *Triggers* (active when creating a data-only backup)
|
||||||
towards right position to include commands that will disable triggers on the
|
to the *Yes* position to include commands that will disable triggers on the
|
||||||
target table while the data is being loaded.
|
target table while the data is being loaded.
|
||||||
|
|
||||||
* Move the switch next to *$ quoting* towards right position to enable dollar
|
* Move the switch next to *$ quoting* to the *Yes* position to enable dollar
|
||||||
quoting within function bodies; if disabled, the function body will be
|
quoting within function bodies; if disabled, the function body will be
|
||||||
quoted using SQL standard string syntax.
|
quoted using SQL standard string syntax.
|
||||||
|
|
||||||
|
|
@ -161,13 +161,13 @@ tab to provide other backup options.
|
||||||
* Move switches in the **Miscellaneous** field box to specify miscellaneous
|
* Move switches in the **Miscellaneous** field box to specify miscellaneous
|
||||||
backup options.
|
backup options.
|
||||||
|
|
||||||
* Move the switch next to *Verbose messages* towards left position to instruct
|
* Move the switch next to *Verbose messages* to the *No* position to instruct
|
||||||
*pg_dumpall* to exclude verbose messages.
|
*pg_dumpall* to exclude verbose messages.
|
||||||
|
|
||||||
* Move the switch next to *Force double quotes on identifiers* towards right
|
* Move the switch next to *Force double quotes on identifiers* to the *Yes*
|
||||||
position to force the quoting of all identifiers.
|
position to force the quoting of all identifiers.
|
||||||
|
|
||||||
* Move the switch next to *Use SET SESSION AUTHORIZATION* towards right
|
* Move the switch next to *Use SET SESSION AUTHORIZATION* to the *Yes*
|
||||||
position to include a statement that will use a SET SESSION AUTHORIZATION
|
position to include a statement that will use a SET SESSION AUTHORIZATION
|
||||||
command to determine object ownership (instead of an ALTER OWNER command).
|
command to determine object ownership (instead of an ALTER OWNER command).
|
||||||
|
|
||||||
|
|
@ -177,9 +177,9 @@ tab to provide other backup options.
|
||||||
* Use the *Extra float digits* field to use the specified value when dumping
|
* Use the *Extra float digits* field to use the specified value when dumping
|
||||||
floating-point data, instead of the maximum available precision.
|
floating-point data, instead of the maximum available precision.
|
||||||
|
|
||||||
* Use the *Lock wait timeout* field to do not wait forever to acquire shared
|
* Use the *Lock wait timeout* field to specify a timeout rather than waiting
|
||||||
table locks at the beginning of the dump. Instead, fail if unable to lock a
|
indefinitely to acquire shared table locks at the beginning of the dump.
|
||||||
table within the specified timeout.
|
If unable to lock a table within the specified timeout, the operation will fail.
|
||||||
|
|
||||||
When you’ve specified the details that will be incorporated into the pg_dumpall
|
When you’ve specified the details that will be incorporated into the pg_dumpall
|
||||||
command:
|
command:
|
||||||
|
|
@ -189,6 +189,6 @@ command:
|
||||||
|
|
||||||
* Click the *Cancel* button to exit without saving work.
|
* Click the *Cancel* button to exit without saving work.
|
||||||
|
|
||||||
pgAdmin will run the backup process in background. You can view all the background
|
pgAdmin will run the backup process in the background. You can view all the background
|
||||||
process with there running status and logs on the :ref:`Processes <processes>`
|
processes with their running status and logs on the :ref:`Processes <processes>`
|
||||||
tab
|
tab.
|
||||||
|
|
|
||||||
|
|
@ -91,8 +91,8 @@ button to deploy the instance on Amazon RDS.
|
||||||
|
|
||||||
Once you click on the finish, one background process will start which will
|
Once you click on the finish, one background process will start which will
|
||||||
deploy the instance in the cloud and monitor the progress of the deployment.
|
deploy the instance in the cloud and monitor the progress of the deployment.
|
||||||
You can view all the background process with there running status and logs
|
You can view all the background processes with their running status and logs
|
||||||
on the :ref:`Processes <processes>` tab
|
on the :ref:`Processes <processes>` tab.
|
||||||
|
|
||||||
The Server will be added to the tree with the cloud deployment icon. Once the
|
The Server will be added to the tree with the cloud deployment icon. Once the
|
||||||
deployment is done, the server details will be updated.
|
deployment is done, the server details will be updated.
|
||||||
|
|
|
||||||
|
|
@ -107,8 +107,8 @@ button to deploy the instance on Azure Database.
|
||||||
|
|
||||||
Once you click on the finish, one background process will start which will
|
Once you click on the finish, one background process will start which will
|
||||||
deploy the instance in the cloud and monitor the progress of the deployment.
|
deploy the instance in the cloud and monitor the progress of the deployment.
|
||||||
You can view all the background process with there running status and logs
|
You can view all the background processes with their running status and logs
|
||||||
on the :ref:`Processes <processes>` tab
|
on the :ref:`Processes <processes>` tab.
|
||||||
|
|
||||||
.. image:: images/cloud_azure_bg_process_watcher.png
|
.. image:: images/cloud_azure_bg_process_watcher.png
|
||||||
:alt: Cloud Deployment
|
:alt: Cloud Deployment
|
||||||
|
|
|
||||||
|
|
@ -103,8 +103,8 @@ button to deploy the instance on EDB BigAnimal.
|
||||||
|
|
||||||
Once you click on the finish, one background process will start which will
|
Once you click on the finish, one background process will start which will
|
||||||
deploy the instance in the cloud and monitor the progress of the deployment.
|
deploy the instance in the cloud and monitor the progress of the deployment.
|
||||||
You can view all the background process with there running status and logs
|
You can view all the background processes with their running status and logs
|
||||||
on the :ref:`Processes <processes>` tab
|
on the :ref:`Processes <processes>` tab.
|
||||||
|
|
||||||
The Server will be added to the tree with the cloud deployment icon. Once the
|
The Server will be added to the tree with the cloud deployment icon. Once the
|
||||||
deployment is done, the server details will be updated.
|
deployment is done, the server details will be updated.
|
||||||
|
|
|
||||||
|
|
@ -105,8 +105,8 @@ button to deploy the instance on Azure PostgreSQL.
|
||||||
|
|
||||||
Once you click on the finish, one background process will start which will
|
Once you click on the finish, one background process will start which will
|
||||||
deploy the instance in the cloud and monitor the progress of the deployment.
|
deploy the instance in the cloud and monitor the progress of the deployment.
|
||||||
You can view all the background process with there running status and logs
|
You can view all the background processes with their running status and logs
|
||||||
on the :ref:`Processes <processes>` tab
|
on the :ref:`Processes <processes>` tab.
|
||||||
|
|
||||||
|
|
||||||
The Server will be added to the tree with the cloud deployment icon. Once the
|
The Server will be added to the tree with the cloud deployment icon. Once the
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@ review process for any changes submitted for inclusion in pgAdmin.
|
||||||
bulk updates every year). The start date should always be 2013, and the end year
|
bulk updates every year). The start date should always be 2013, and the end year
|
||||||
the current year, e.g.
|
the current year, e.g.
|
||||||
|
|
||||||
Copyright (C) 2013 - 2025, The pgAdmin Development Team
|
Copyright (C) 2013 - 2026, The pgAdmin Development Team
|
||||||
|
|
||||||
* Ensure there's a blank line immediately following any copyright headers.
|
* Ensure there's a blank line immediately following any copyright headers.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -120,7 +120,7 @@ with the required file header is shown below::
|
||||||
#
|
#
|
||||||
# pgAdmin 4 - PostgreSQL Tools
|
# pgAdmin 4 - PostgreSQL Tools
|
||||||
#
|
#
|
||||||
# Copyright (C) 2013 - 2025, The pgAdmin Development Team
|
# Copyright (C) 2013 - 2026, The pgAdmin Development Team
|
||||||
# This software is released under the PostgreSQL Licence
|
# This software is released under the PostgreSQL Licence
|
||||||
#
|
#
|
||||||
##########################################################################
|
##########################################################################
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,7 @@ settings:
|
||||||
deterministic comparisons. By default, this option is set to true. In a
|
deterministic comparisons. By default, this option is set to true. In a
|
||||||
deterministic comparison, strings that are not byte-wise equal are considered
|
deterministic comparison, strings that are not byte-wise equal are considered
|
||||||
unequal, even if they are considered logically equal in the comparison.
|
unequal, even if they are considered logically equal in the comparison.
|
||||||
* Use the *Rules* field to specify a rules for customizing the behavior of the collation.
|
* Use the *Rules* field to specify rules for customizing the behavior of the collation.
|
||||||
It includes considerations such as character ordering, case sensitivity, and accent
|
It includes considerations such as character ordering, case sensitivity, and accent
|
||||||
sensitivity.
|
sensitivity.
|
||||||
* Use the *Version* field to specify version string to store with the collation object.
|
* Use the *Version* field to specify version string to store with the collation object.
|
||||||
|
|
@ -65,8 +65,8 @@ settings:
|
||||||
|
|
||||||
Click the *SQL* tab to continue.
|
Click the *SQL* tab to continue.
|
||||||
|
|
||||||
Your entries in the *Collation* dialog generate a SQL command (see an example b
|
Your entries in the *Collation* dialog generate a SQL command (see an example
|
||||||
elow). Use the *SQL* tab for review; revisit or switch tabs to make any changes
|
below). Use the *SQL* tab for review; revisit or switch tabs to make any changes
|
||||||
to the SQL command.
|
to the SQL command.
|
||||||
|
|
||||||
Example
|
Example
|
||||||
|
|
@ -80,7 +80,7 @@ the *Collation* dialog:
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
The example shown demonstrates creating a collation named *french* that uses the
|
The example shown demonstrates creating a collation named *french* that uses the
|
||||||
rules specified for the locale, *fr-BI-x-icu. The collation is owned by
|
rules specified for the locale, *fr-BI-x-icu*. The collation is owned by
|
||||||
*postgres*.
|
*postgres*.
|
||||||
|
|
||||||
* Click the *Info* button (i) to access online help. For more information about
|
* Click the *Info* button (i) to access online help. For more information about
|
||||||
|
|
|
||||||
|
|
@ -144,7 +144,7 @@ the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -53,6 +53,7 @@ The default binary paths set in the container are as follows:
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
DEFAULT_BINARY_PATHS = {
|
DEFAULT_BINARY_PATHS = {
|
||||||
|
'pg-18': '/usr/local/pgsql-18',
|
||||||
'pg-17': '/usr/local/pgsql-17',
|
'pg-17': '/usr/local/pgsql-17',
|
||||||
'pg-16': '/usr/local/pgsql-16',
|
'pg-16': '/usr/local/pgsql-16',
|
||||||
'pg-15': '/usr/local/pgsql-15',
|
'pg-15': '/usr/local/pgsql-15',
|
||||||
|
|
|
||||||
|
|
@ -63,7 +63,7 @@ Use the *Definition* tab to set properties for the database:
|
||||||
* Specify a connection limit in the *Connection Limit* field to configure the
|
* Specify a connection limit in the *Connection Limit* field to configure the
|
||||||
maximum number of connection requests. The default value (*-1*) allows
|
maximum number of connection requests. The default value (*-1*) allows
|
||||||
unlimited connections to the database.
|
unlimited connections to the database.
|
||||||
* If the *templates?* is set to true, then database will be a template database.
|
* If *Template?* is set to *Yes*, the database will be a template database.
|
||||||
|
|
||||||
Click the *Security* tab to continue.
|
Click the *Security* tab to continue.
|
||||||
|
|
||||||
|
|
@ -89,7 +89,7 @@ database. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
@ -125,8 +125,8 @@ Use the *Advanced* tab to set advanced parameters for the database.
|
||||||
|
|
||||||
* Use *Schema restriction* field to provide a SQL restriction that will be used
|
* Use *Schema restriction* field to provide a SQL restriction that will be used
|
||||||
against the pg_namespace table to limit the schemas that you see.
|
against the pg_namespace table to limit the schemas that you see.
|
||||||
For example, you might enter: *public* so that only *public* are shown in
|
For example, you might enter: *public* so that only *public* is shown in
|
||||||
the pgAdmin browser.Separate entries with a comma or tab as you type.
|
the pgAdmin browser. Separate entries with a comma or tab as you type.
|
||||||
|
|
||||||
Click the *SQL* tab to continue.
|
Click the *SQL* tab to continue.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -17,3 +17,4 @@ PL/SQL code.
|
||||||
schema_diff
|
schema_diff
|
||||||
erd_tool
|
erd_tool
|
||||||
psql_tool
|
psql_tool
|
||||||
|
ai_tools
|
||||||
|
|
|
||||||
|
|
@ -89,7 +89,7 @@ Use the *Security Labels* panel to assign security labels. Click the *Add* icon
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -49,7 +49,7 @@ To modify the displayed data:
|
||||||
* To change a numeric value within the grid, double-click the value to select
|
* To change a numeric value within the grid, double-click the value to select
|
||||||
the field. Modify the content in the square in which it is displayed.
|
the field. Modify the content in the square in which it is displayed.
|
||||||
* To change a non-numeric value within the grid, double-click the content to
|
* To change a non-numeric value within the grid, double-click the content to
|
||||||
access the edit bubble. After modifying the contentof the edit bubble, click
|
access the edit bubble. After modifying the content of the edit bubble, click
|
||||||
the *Ok* button to display your changes in the data grid, or *Cancel* to
|
the *Ok* button to display your changes in the data grid, or *Cancel* to
|
||||||
exit the edit bubble without saving.
|
exit the edit bubble without saving.
|
||||||
|
|
||||||
|
|
@ -62,7 +62,7 @@ table. As soon as you store the data, the row is assigned a row number, and a
|
||||||
fresh empty line is added to the data grid.
|
fresh empty line is added to the data grid.
|
||||||
|
|
||||||
To write a SQL NULL to the table, simply leave the field empty. When you store
|
To write a SQL NULL to the table, simply leave the field empty. When you store
|
||||||
the new row, the will server fill in the default value for that column. If you
|
the new row, the server will fill in the default value for that column. If you
|
||||||
store a change to an existing row, the value NULL will explicitly be written.
|
store a change to an existing row, the value NULL will explicitly be written.
|
||||||
|
|
||||||
To write an empty string to the table, enter the special string '' (two single
|
To write an empty string to the table, enter the special string '' (two single
|
||||||
|
|
@ -110,9 +110,9 @@ properties of the geometries directly in map, just click the specific geometry:
|
||||||
|
|
||||||
**JSON Data Editor**
|
**JSON Data Editor**
|
||||||
|
|
||||||
A built in json editor is provided for *JSON/JSONB Data*.Double clicking on json/jsonb
|
A built-in JSON editor is provided for *JSON/JSONB Data*. Double-clicking on a JSON/JSONB
|
||||||
data type cell in data grid will open JSON Editor.Editor provides different mode to
|
data type cell in the data grid will open the JSON Editor. The editor provides different modes to
|
||||||
view and edit json data.
|
view and edit JSON data.
|
||||||
|
|
||||||
|
|
||||||
.. image:: images/json_editor_modes.png
|
.. image:: images/json_editor_modes.png
|
||||||
|
|
@ -120,21 +120,21 @@ view and edit json data.
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
*Code Mode*:
|
*Code Mode*:
|
||||||
Provides way to format & compact json data.Also provides ability to repair json data
|
Provides a way to format and compact JSON data. Also provides the ability to repair JSON data
|
||||||
by fixing quotes and escape characters, removing comments and JSONP notation and
|
by fixing quotes and escape characters, removing comments and JSONP notation, and
|
||||||
turn JavaScript objects into JSON.
|
turning JavaScript objects into JSON.
|
||||||
|
|
||||||
*Tree Mode*:
|
*Tree Mode*:
|
||||||
Enabled to change, add, move, remove, and duplicate fields and values.Provides ability
|
Enables changing, adding, moving, removing, and duplicating fields and values. Provides the ability
|
||||||
to searh & hilight data.
|
to search and highlight data.
|
||||||
|
|
||||||
*Form Mode*:
|
*Form Mode*:
|
||||||
Allows only to edit values in json data there by providing ability to keep data structure
|
Allows editing only the values in JSON data, thereby providing the ability to keep the data structure
|
||||||
unchanged while editing.
|
unchanged while editing.
|
||||||
|
|
||||||
*Preview Mode*:
|
*Preview Mode*:
|
||||||
Provides ability to check data before saving and also shows size of current json data.
|
Provides the ability to check data before saving and also shows the size of the current JSON data.
|
||||||
Format and compact json data as well.
|
Allows formatting and compacting JSON data as well.
|
||||||
|
|
||||||
|
|
||||||
*Editor Toolbar*
|
*Editor Toolbar*
|
||||||
|
|
@ -170,18 +170,18 @@ Tree/Form mode:
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Transform* | Click to *Transform* to filter data using JSME query language. | Code, Preview, Tree |
|
| *Transform* | Click to *Transform* to filter data using JSME query language. | Code, Preview, Tree |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Undo* | Click to *Undo* to undo last action performed on data . | Code, Preview, Tree, From |
|
| *Undo* | Click to *Undo* to undo last action performed on data. | Code, Preview, Tree, Form |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Redo* | Click to *Redo* to repat last action performed on data . | Code, Preview, Tree, From |
|
| *Redo* | Click to *Redo* to repeat last action performed on data. | Code, Preview, Tree, Form |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Mode* | Click to *Mode* dropdown to change dipaly mode of editor.Different modes avaialble | Code, Tree, From, Preview |
|
| *Mode* | Click the *Mode* dropdown to change the display mode of the editor. Different modes | Code, Tree, Form, Preview |
|
||||||
| | are Code, Preview, Tree, From. | |
|
| | available are Code, Preview, Tree, and Form. | |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Expand All* | Click to *Expand All* to expand json data. | Tree, From |
|
| *Expand All* | Click *Expand All* to expand JSON data. | Tree, Form |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Collapse All* | Click to *Redo* to collapse json data. | Tree, From |
|
| *Collapse All* | Click *Collapse All* to collapse JSON data. | Tree, Form |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
| *Search Box* | Enter partial/complete string to search in data. | Tree, From |
|
| *Search Box* | Enter partial/complete string to search in data. | Tree, Form |
|
||||||
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
+----------------------+----------------------------------------------------------------------------------------+---------------------------+
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -235,6 +235,6 @@ A View/Edit Data tab can be converted to a Query Tool Tab just by editing the qu
|
||||||
:alt: Promote View/Edit Data tab to Query Tool tab warning
|
:alt: Promote View/Edit Data tab to Query Tool tab warning
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
You can disable the dialog by selecting the "Don't Ask again" checkbox. If you wish to resume the confirmation dialog, you can do it from "Prefrences -> Query Tool -> Editor -> Show View/Edit Data Promotion Warning?"
|
You can disable the dialog by selecting the "Don't Ask again" checkbox. If you wish to resume the confirmation dialog, you can do it from "Preferences -> Query Tool -> Editor -> Show View/Edit Data Promotion Warning?"
|
||||||
|
|
||||||
Once you chose to continue, you won't be able to use the features of View/Edit mode like the filter and sorting options, limit, etc. It is a one-way conversion. It will be a query tool now.
|
Once you chose to continue, you won't be able to use the features of View/Edit mode like the filter and sorting options, limit, etc. It is a one-way conversion. It will be a query tool now.
|
||||||
|
|
@ -72,7 +72,7 @@ Export Options
|
||||||
| | You can select the option *With DROP Table* if you wish to have DROP Table DDL statements before | |
|
| | You can select the option *With DROP Table* if you wish to have DROP Table DDL statements before | |
|
||||||
| | each CREATE Table DDL. You can see the option by clicking the down arrow beside the SQL button. | |
|
| | each CREATE Table DDL. You can see the option by clicking the down arrow beside the SQL button. | |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *Download image* | Click the *Download image* icon to save the ERD diagram in a image formate | Option/Alt + |
|
| *Download image* | Click the *Download image* icon to save the ERD diagram in an image format. | Option/Alt + |
|
||||||
| | | Ctrl + I |
|
| | | Ctrl + I |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
|
|
||||||
|
|
@ -86,6 +86,9 @@ Editing Options
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| Icon | Behavior | Shortcut |
|
| Icon | Behavior | Shortcut |
|
||||||
+======================+===================================================================================================+================+
|
+======================+===================================================================================================+================+
|
||||||
|
| *Search table* | Click to search for a table in the diagram. Selecting a table from the search results will bring | Option/Alt + |
|
||||||
|
| | it into view and highlight it. | Ctrl + F |
|
||||||
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *Add table* | Click this button to add a new table to the diagram. On clicking, this will open a table dialog | Option/Alt + |
|
| *Add table* | Click this button to add a new table to the diagram. On clicking, this will open a table dialog | Option/Alt + |
|
||||||
| | where you can put the table details. | Ctrl + A |
|
| | where you can put the table details. | Ctrl + A |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
|
|
@ -109,11 +112,14 @@ Table Relationship Options
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| Icon | Behavior | Shortcut |
|
| Icon | Behavior | Shortcut |
|
||||||
+======================+===================================================================================================+================+
|
+======================+===================================================================================================+================+
|
||||||
| *1M* | Click this button to open a one-to-many relationship dialog to add a relationship between the | Option/Alt + |
|
| *1-1* | Click this button to open a one-to-one relationship dialog to add a relationship between the | Option/Alt + |
|
||||||
|
| | two tables. The selected table becomes the referencing table. | Ctrl + B |
|
||||||
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
|
| *1-M* | Click this button to open a one-to-many relationship dialog to add a relationship between the | Option/Alt + |
|
||||||
| | two tables. The selected table becomes the referencing table and will have the *many* endpoint of | Ctrl + O |
|
| | two tables. The selected table becomes the referencing table and will have the *many* endpoint of | Ctrl + O |
|
||||||
| | the link. | |
|
| | the link. | |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *MM* | Click this button to open a many-to-many relationship dialog to add a relationship between the | Option/Alt + |
|
| *M-M* | Click this button to open a many-to-many relationship dialog to add a relationship between the | Option/Alt + |
|
||||||
| | two tables. This option will create a new table based on the selected columns for the two relating| Ctrl + M |
|
| | two tables. This option will create a new table based on the selected columns for the two relating| Ctrl + M |
|
||||||
| | tables and link them. | |
|
| | tables and link them. | |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
|
|
@ -129,7 +135,7 @@ Node Color Options
|
||||||
| Icon | Behavior |
|
| Icon | Behavior |
|
||||||
+======================+==========================================================================================================+
|
+======================+==========================================================================================================+
|
||||||
| *Fill Color* | Use Fill Color to change the background color of a table node. This is helpful if you want to |
|
| *Fill Color* | Use Fill Color to change the background color of a table node. This is helpful if you want to |
|
||||||
| | identify a of group tables. Once set, all the newly added tables will take the same color. |
|
| | identify a group of tables. Once set, all the newly added tables will take the same color. |
|
||||||
+----------------------+----------------------------------------------------------------------------------------------------------+
|
+----------------------+----------------------------------------------------------------------------------------------------------+
|
||||||
| *Text Color* | Use Text Color to change the text color of a table node based on the fill color to make text |
|
| *Text Color* | Use Text Color to change the text color of a table node based on the fill color to make text |
|
||||||
| | easily readable. |
|
| | easily readable. |
|
||||||
|
|
@ -148,7 +154,7 @@ Utility Options
|
||||||
| *Add/Edit note* | Click this button to make notes on tables nodes while designing the database. | Option/Alt + |
|
| *Add/Edit note* | Click this button to make notes on tables nodes while designing the database. | Option/Alt + |
|
||||||
| | | Ctrl + N |
|
| | | Ctrl + N |
|
||||||
+-------------------------+------------------------------------------------------------------------------------------------+----------------+
|
+-------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *Auto align* | Click this button to auto align all tables and links to make it look more cleaner. | Option/Alt + |
|
| *Auto align* | Click this button to auto-align all tables and links to make them look cleaner. | Option/Alt + |
|
||||||
| | | Ctrl + L |
|
| | | Ctrl + L |
|
||||||
+-------------------------+------------------------------------------------------------------------------------------------+----------------+
|
+-------------------------+------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *Show details* | Click this button to toggle the column details visibility. It allows you to show few or more | Option/Alt + |
|
| *Show details* | Click this button to toggle the column details visibility. It allows you to show few or more | Option/Alt + |
|
||||||
|
|
@ -188,7 +194,7 @@ Table Dialog
|
||||||
The table dialog allows you to:
|
The table dialog allows you to:
|
||||||
|
|
||||||
* Change the table structure details.
|
* Change the table structure details.
|
||||||
* It can be used edit an existing table or add a new one.
|
* It can be used to edit an existing table or add a new one.
|
||||||
* Refer :ref:`table dialog <table_dialog>` for information on different fields.
|
* Refer :ref:`table dialog <table_dialog>` for information on different fields.
|
||||||
|
|
||||||
Table Node
|
Table Node
|
||||||
|
|
@ -200,11 +206,11 @@ Table Node
|
||||||
|
|
||||||
The table node shows table details in a graphical representation:
|
The table node shows table details in a graphical representation:
|
||||||
|
|
||||||
* The top bar has a *details toggle button* that is used to toggle column details visibility. There is also a *note button* that is visible only if there is some note added. you can click on this button to quickly change the note.
|
* The top bar has a *details toggle button* that is used to toggle column details visibility. There is also a *note button* that is visible only if there is some note added. You can click on this button to quickly change the note.
|
||||||
* The first row shows the schema name of the table. Eg. *public* in above image.
|
* The first row shows the schema name of the table. Eg. *public* in above image.
|
||||||
* The second row shows the table name. Eg. *users* in above image.
|
* The second row shows the table name. Eg. *users* in above image.
|
||||||
* All other rows below the table name are the columns of the table along with data type. If the column is a primary key then it will have lock key icon eg. id is the primary key in above image. Otherwise, it will have column icon.
|
* All other rows below the table name are the columns of the table along with data type. If the column is a primary key then it will have lock key icon eg. id is the primary key in above image. Otherwise, it will have column icon.
|
||||||
* you can click on the node and drag to move on the canvas.
|
* You can click on the node and drag to move on the canvas.
|
||||||
* Upon double click on the table node or by clicking the edit button from the toolbar, the table dialog opens where you can change the table details. Refer :ref:`table dialog <table_dialog>` for information on different fields.
|
* Upon double click on the table node or by clicking the edit button from the toolbar, the table dialog opens where you can change the table details. Refer :ref:`table dialog <table_dialog>` for information on different fields.
|
||||||
|
|
||||||
The One to One Link Dialog
|
The One to One Link Dialog
|
||||||
|
|
@ -219,7 +225,7 @@ The one to one link dialog allows you to:
|
||||||
* Add a one to one relationship between two tables.
|
* Add a one to one relationship between two tables.
|
||||||
* *Local Table* is the table that references a table and has the *one* end point.
|
* *Local Table* is the table that references a table and has the *one* end point.
|
||||||
* *Local Column* the column that references.
|
* *Local Column* the column that references.
|
||||||
* *Select Constraint* To implement one to one relationship, the *Local Column* must have primaty key or unique constraint. The default is a unique constraint. Please note that this field is visible only when the selected *Local Column* does not have either of the mentioned constraints.
|
* *Select Constraint* To implement a one-to-one relationship, the *Local Column* must have a primary key or unique constraint. The default is a unique constraint. Please note that this field is visible only when the selected *Local Column* does not have either of the mentioned constraints.
|
||||||
* *Referenced Table* is the table that is being referred and has the *one* end point.
|
* *Referenced Table* is the table that is being referred and has the *one* end point.
|
||||||
* *Referenced Column* the column that is being referred.
|
* *Referenced Column* the column that is being referred.
|
||||||
|
|
||||||
|
|
@ -266,7 +272,7 @@ The table link shows relationship between tables:
|
||||||
* The single line endpoint of the link shows the column that is being referred.
|
* The single line endpoint of the link shows the column that is being referred.
|
||||||
* The three line endpoint of the link shows the column that refers.
|
* The three line endpoint of the link shows the column that refers.
|
||||||
* If one of the columns that is being referred or that refers is removed from the table then the link will get dropped.
|
* If one of the columns that is being referred or that refers is removed from the table then the link will get dropped.
|
||||||
* you can click on the link and drag to move on the canvas.
|
* You can click on the link and drag to move on the canvas.
|
||||||
|
|
||||||
|
|
||||||
The Table Notes
|
The Table Notes
|
||||||
|
|
|
||||||
|
|
@ -67,7 +67,7 @@ in the *Delete Row* popup.
|
||||||
|
|
||||||
Click the *SQL* tab to continue.
|
Click the *SQL* tab to continue.
|
||||||
|
|
||||||
Your entries in the *Event Trigger* dialog generate a generate a SQL command.
|
Your entries in the *Event Trigger* dialog generate a SQL command.
|
||||||
Use the *SQL* tab for review; revisit or switch tabs to make any changes to the
|
Use the *SQL* tab for review; revisit or switch tabs to make any changes to the
|
||||||
SQL command.
|
SQL command.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -58,8 +58,8 @@ Click the *Query* tab to continue.
|
||||||
|
|
||||||
Use the fields in the *Query* tab to write the query that will be exported:
|
Use the fields in the *Query* tab to write the query that will be exported:
|
||||||
|
|
||||||
* Use the *Export Data Query* field to specifies A SELECT, VALUES, INSERT, UPDATE,
|
* Use the *Export Data Query* field to specify a SELECT, VALUES, INSERT, UPDATE,
|
||||||
DELETE, or MERGE command whose results are to be copied .
|
DELETE, or MERGE command whose results are to be copied.
|
||||||
|
|
||||||
* Use *Force Quote columns* field to forces quoting to be used for all non-NULL
|
* Use *Force Quote columns* field to forces quoting to be used for all non-NULL
|
||||||
values in each specified column. NULL output is never quoted. This is a creatable
|
values in each specified column. NULL output is never quoted. This is a creatable
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ Use the fields in the *General* tab to identify an extension:
|
||||||
|
|
||||||
* Use the drop-down listbox in the *Name* field to select the extension. Each
|
* Use the drop-down listbox in the *Name* field to select the extension. Each
|
||||||
extension must have a unique name.
|
extension must have a unique name.
|
||||||
* Move the switch next to *Cascade?* towards right position to automatically
|
* Move the switch next to *Cascade?* to the *Yes* position to automatically
|
||||||
install any extensions that this extension depends on that are not already
|
install any extensions that this extension depends on that are not already
|
||||||
installed.
|
installed.
|
||||||
* Store notes about the extension in the *Comment* field.
|
* Store notes about the extension in the *Comment* field.
|
||||||
|
|
|
||||||
|
|
@ -131,7 +131,7 @@ function. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,9 @@ Use the fields in the *Definition* tab to define the function:
|
||||||
will change to an input text field.
|
will change to an input text field.
|
||||||
* Use the drop-down listbox next to *Language* to select the implementation
|
* Use the drop-down listbox next to *Language* to select the implementation
|
||||||
language. The default is *sql*.
|
language. The default is *sql*.
|
||||||
|
* Use the drop-down listbox next to *Depends on extensions* to select the extension that this function
|
||||||
|
depends on (for example, plpgsql). If set, dropping the extension will automatically drop the
|
||||||
|
function as well.
|
||||||
* Use the fields in the *Arguments* to define an argument. Click the *Add*
|
* Use the fields in the *Arguments* to define an argument. Click the *Add*
|
||||||
icon (+) to set parameters and values for the argument:
|
icon (+) to set parameters and values for the argument:
|
||||||
|
|
||||||
|
|
@ -153,7 +156,7 @@ function. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
@ -164,7 +167,7 @@ in the *Delete Row* popup.
|
||||||
|
|
||||||
Click the *SQL* tab to continue.
|
Click the *SQL* tab to continue.
|
||||||
|
|
||||||
Your entries in the *Function* dialog generate a generate a SQL command (see an
|
Your entries in the *Function* dialog generate a SQL command (see an
|
||||||
example below). Use the *SQL* tab for review; revisit or switch tabs to make any
|
example below). Use the *SQL* tab for review; revisit or switch tabs to make any
|
||||||
changes to the SQL command.
|
changes to the SQL command.
|
||||||
|
|
||||||
|
|
@ -178,8 +181,8 @@ the *Function* dialog:
|
||||||
:alt: Function dialog sql tab
|
:alt: Function dialog sql tab
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
The example demonstrates creating an *plpgsql* function named *hire_salesmen*. The
|
The example demonstrates creating a *plpgsql* function named *hire_salesmen*. The
|
||||||
function have three columns (p_ename, p_sal and p_comm).
|
function has three columns (p_ename, p_sal and p_comm).
|
||||||
|
|
||||||
* Click the *Info* button (i) to access online help.
|
* Click the *Info* button (i) to access online help.
|
||||||
* Click the *Save* button to save work.
|
* Click the *Save* button to save work.
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@ Use the fields in the *Privileges Selection* window to grant
|
||||||
privileges. If you grant a privilege WITH GRANT OPTION, the Grantee will have
|
privileges. If you grant a privilege WITH GRANT OPTION, the Grantee will have
|
||||||
the right to grant privileges on the object to others. If WITH GRANT OPTION is
|
the right to grant privileges on the object to others. If WITH GRANT OPTION is
|
||||||
subsequently revoked, any role who received access to that object from that
|
subsequently revoked, any role who received access to that object from that
|
||||||
Grantee (directly or through a chain of grants) will lose thier privileges on
|
Grantee (directly or through a chain of grants) will lose their privileges on
|
||||||
the object.
|
the object.
|
||||||
|
|
||||||
* Click the *Add* icon (+) to assign a set of privileges.
|
* Click the *Add* icon (+) to assign a set of privileges.
|
||||||
|
|
|
||||||
|
After Width: | Height: | Size: 237 KiB |
|
Before Width: | Height: | Size: 340 KiB After Width: | Height: | Size: 679 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 7.0 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 101 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
Before Width: | Height: | Size: 189 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 125 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 67 KiB |
|
After Width: | Height: | Size: 158 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 247 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 70 KiB |
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 213 KiB |
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 72 KiB |
|
|
@ -196,4 +196,4 @@ The following example shows both a minimally defined and a fully defined server:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.. note:: If you're running pgAdmin in Server Mode, the values for parameters that require file paths should be specified relative to the user's home directory which is /<DATA_DIR>/storage/<user_id>/. If DATA_DIR is not specified, then it will /var/libe/pgadmin/storage/<user_id>/
|
.. note:: If you're running pgAdmin in Server Mode, the values for parameters that require file paths should be specified relative to the user's home directory which is /<DATA_DIR>/storage/<user_id>/. If DATA_DIR is not specified, then it will be /var/lib/pgadmin/storage/<user_id>/
|
||||||
|
|
|
||||||
|
|
@ -48,6 +48,31 @@ Use the fields in the *Definition* tab to define the index:
|
||||||
* Select *brin* to create a BRIN index. A BRIN index may improve
|
* Select *brin* to create a BRIN index. A BRIN index may improve
|
||||||
performance when managing minimum and maximum values and ranges.
|
performance when managing minimum and maximum values and ranges.
|
||||||
|
|
||||||
|
* Use the drop-down listbox next to *Depends on extensions* to select the extension
|
||||||
|
that this index depends on (for example, edbspl). If set, dropping the extension
|
||||||
|
will automatically drop the index as well.
|
||||||
|
* Move the switch next to *Only Table?* to the *Yes* position to create the index
|
||||||
|
only on the parent table without recursing to its partitions. This button will be
|
||||||
|
enabled for partition tables only. The default is *No*.
|
||||||
|
* Move the switch next to *Unique?* to the *Yes* position to check for duplicate values
|
||||||
|
in the table when the index is created and when data is added. The default is *No*.
|
||||||
|
* Move the switch next to *NULLs not distinct?* to the *Yes* position to treat null values as not distinct.
|
||||||
|
The default is *No*. This option is available only on PostgreSQL 15 and above.
|
||||||
|
* Move the *Clustered?* switch to the *Yes* position to instruct the server to
|
||||||
|
cluster the table.
|
||||||
|
* Move the *Concurrent build?* switch to the *Yes* position to build the index
|
||||||
|
without taking any locks that prevent concurrent inserts, updates, or deletes
|
||||||
|
on the table.
|
||||||
|
* Use the *Constraint* field to provide a constraint expression; a constraint
|
||||||
|
expression limits the entries in the index to those rows that satisfy the
|
||||||
|
constraint.
|
||||||
|
|
||||||
|
Click the *With* tab to continue.
|
||||||
|
|
||||||
|
.. image:: images/index_with.png
|
||||||
|
:alt: Index dialog with tab
|
||||||
|
:align: center
|
||||||
|
|
||||||
* Use the *Fill Factor* field to specify a fill factor for the index. The fill
|
* Use the *Fill Factor* field to specify a fill factor for the index. The fill
|
||||||
factor specifies how full the selected method will try to fill each index
|
factor specifies how full the selected method will try to fill each index
|
||||||
page.
|
page.
|
||||||
|
|
@ -57,24 +82,12 @@ Use the fields in the *Definition* tab to define the index:
|
||||||
for each entry of a BRIN index.
|
for each entry of a BRIN index.
|
||||||
* Select *Buffering* to specify whether the buffering build technique is used to build the index. The default is
|
* Select *Buffering* to specify whether the buffering build technique is used to build the index. The default is
|
||||||
*Auto*
|
*Auto*
|
||||||
* Move the switch next to *Deduplicate items?* towards the *right position* to control usage of the B-tree
|
* Move the switch next to *Deduplicate items?* to the *Yes* position to control usage of the B-tree
|
||||||
deduplication technique. The default is *Yes*. This option is available only on PostgreSQL 13 and above.
|
deduplication technique. The default is *Yes*. This option is available only on PostgreSQL 13 and above.
|
||||||
* Move the switch next to *Fast update?* towards the *right position* to control usage of the fast update technique.
|
* Move the switch next to *Fast update?* to the *Yes* position to control usage of the fast update technique.
|
||||||
The default is *Yes*.
|
The default is *Yes*.
|
||||||
* Move the switch next to *Autosummarize* towards the *right position* to define whether a summarization run is
|
* Move the switch next to *Autosummarize* to the *Yes* position to define whether a summarization run is
|
||||||
queued for the previous page range whenever an insertion is detected on the next one. The default is *No*
|
queued for the previous page range whenever an insertion is detected on the next one. The default is *No*
|
||||||
* Move the switch next to *Unique?* towards the *right position* to check for duplicate values
|
|
||||||
in the table when the index is created and when data is added. The default is *No*.
|
|
||||||
* Move the switch next to *NULLs not distinct?* towards the *right position* to treat null values as not distinct.
|
|
||||||
The default is*No*. This option is available only on PostgreSQL 15 and above.
|
|
||||||
* Move the *Clustered?* switch to the *Yes* position to instruct the server to
|
|
||||||
cluster the table.
|
|
||||||
* Move the *Concurrent build?* switch to the *Yes* position to build the index
|
|
||||||
without taking any locks that prevent concurrent inserts, updates, or deletes
|
|
||||||
on the table.
|
|
||||||
* Use the *Constraint* field to provide a constraint expression; a constraint
|
|
||||||
expression limits the entries in the index to those rows that satisfy the
|
|
||||||
constraint.
|
|
||||||
|
|
||||||
Click the *Columns* tab to continue.
|
Click the *Columns* tab to continue.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,7 @@ function. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -87,6 +87,8 @@ There are 3 ways to configure LDAP:
|
||||||
"LDAP_KEY_FILE","Specifies the path to the server private key file. This parameter
|
"LDAP_KEY_FILE","Specifies the path to the server private key file. This parameter
|
||||||
is applicable only if you are using *ldaps* as connection protocol or you have
|
is applicable only if you are using *ldaps* as connection protocol or you have
|
||||||
set *LDAP_USE_STARTTLS* parameter to *True*."
|
set *LDAP_USE_STARTTLS* parameter to *True*."
|
||||||
|
"LDAP_CERT_VALIDATE", "Set this parameter to *False* if you want to bypass
|
||||||
|
the TLS certificate validation. By default it is set to True."
|
||||||
"LDAP_IGNORE_MALFORMED_SCHEMA", "Some flaky LDAP servers returns malformed schema.
|
"LDAP_IGNORE_MALFORMED_SCHEMA", "Some flaky LDAP servers returns malformed schema.
|
||||||
If this parameter set to *True*, no exception will be raised and schema is thrown away
|
If this parameter set to *True*, no exception will be raised and schema is thrown away
|
||||||
but authentication will be done. This parameter should remain False, as recommended."
|
but authentication will be done. This parameter should remain False, as recommended."
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@ documentation is attributed to the
|
||||||
|
|
||||||
.. topic:: pgAdmin 4
|
.. topic:: pgAdmin 4
|
||||||
|
|
||||||
Copyright (C) 2013 - 2025, The pgAdmin Development Team
|
Copyright (C) 2013 - 2026, The pgAdmin Development Team
|
||||||
|
|
||||||
Permission to use, copy, modify, and distribute this software and its
|
Permission to use, copy, modify, and distribute this software and its
|
||||||
documentation for any purpose, without fee, and without a written agreement is
|
documentation for any purpose, without fee, and without a written agreement is
|
||||||
|
|
|
||||||
|
|
@ -29,31 +29,31 @@ maintenance:
|
||||||
* Move the *ANALYZE* switch to the *Yes* position to issue ANALYZE commands
|
* Move the *ANALYZE* switch to the *Yes* position to issue ANALYZE commands
|
||||||
whenever the content of a table has changed sufficiently.
|
whenever the content of a table has changed sufficiently.
|
||||||
|
|
||||||
* Move the *DISABLE PAGE SKIPPING* switch to the *Yes* position to disables
|
* Move the *DISABLE PAGE SKIPPING* switch to the *Yes* position to disable
|
||||||
all page-skipping behavior.
|
all page-skipping behavior.
|
||||||
|
|
||||||
* Move the *SKIP LOCKED* switch to the *Yes* position to specifies that
|
* Move the *SKIP LOCKED* switch to the *Yes* position to specify that
|
||||||
VACUUM should not wait for any conflicting locks to be released when
|
VACUUM should not wait for any conflicting locks to be released when
|
||||||
beginning work on a relation. This option is available from v12 onwards.
|
beginning work on a relation. This option is available from v12 onwards.
|
||||||
|
|
||||||
* Move the *TRUNCATE* switch to the *Yes* position to specifies that VACUUM
|
* Move the *TRUNCATE* switch to the *Yes* position to specify that VACUUM
|
||||||
should attempt to truncate off any empty pages at the end of the table and
|
should attempt to truncate off any empty pages at the end of the table and
|
||||||
allow the disk space for the truncated pages to be returned to the operating
|
allow the disk space for the truncated pages to be returned to the operating
|
||||||
system. This option is available from v12 onwards.
|
system. This option is available from v12 onwards.
|
||||||
|
|
||||||
* Move the *PROCESS TOAST* switch to the *Yes* position to specifies that
|
* Move the *PROCESS TOAST* switch to the *Yes* position to specify that
|
||||||
VACUUM should attempt to process the corresponding TOAST table for each
|
VACUUM should attempt to process the corresponding TOAST table for each
|
||||||
relation, if one exists. This option is available from v14 onwards.
|
relation, if one exists. This option is available from v14 onwards.
|
||||||
|
|
||||||
* Move the *PROCESS MAIN* switch to the *Yes* position to specifies that
|
* Move the *PROCESS MAIN* switch to the *Yes* position to specify that
|
||||||
VACUUM should attempt to process the main relation. This option is available
|
VACUUM should attempt to process the main relation. This option is available
|
||||||
from v16 onwards.
|
from v16 onwards.
|
||||||
|
|
||||||
* Move the *SKIP DATABASE STATS* switch to the *Yes* position to specifies
|
* Move the *SKIP DATABASE STATS* switch to the *Yes* position to specify
|
||||||
that VACUUM should skip updating the database-wide statistics about oldest
|
that VACUUM should skip updating the database-wide statistics about oldest
|
||||||
unfrozen XIDs. This option is available from v16 onwards.
|
unfrozen XIDs. This option is available from v16 onwards.
|
||||||
|
|
||||||
* Move the *ONLY DATABASE STATS* switch to the *Yes* position to specifies
|
* Move the *ONLY DATABASE STATS* switch to the *Yes* position to specify
|
||||||
that VACUUM should do nothing except update the database-wide statistics
|
that VACUUM should do nothing except update the database-wide statistics
|
||||||
about oldest unfrozen XIDs . This option is available from v16 onwards.
|
about oldest unfrozen XIDs . This option is available from v16 onwards.
|
||||||
|
|
||||||
|
|
@ -64,7 +64,7 @@ maintenance:
|
||||||
of VACUUM in parallel using integer background workers. This option is
|
of VACUUM in parallel using integer background workers. This option is
|
||||||
available from v13 onwards.
|
available from v13 onwards.
|
||||||
|
|
||||||
* Use the *BUFFER USAGE LIMIT* field to specifies the Buffer Access Strategy
|
* Use the *BUFFER USAGE LIMIT* field to specify the Buffer Access Strategy
|
||||||
ring buffer size for VACUUM. This size is used to calculate the number of
|
ring buffer size for VACUUM. This size is used to calculate the number of
|
||||||
shared buffers which will be reused as part of this strategy. This option
|
shared buffers which will be reused as part of this strategy. This option
|
||||||
is available from v16 onwards
|
is available from v16 onwards
|
||||||
|
|
@ -78,11 +78,11 @@ maintenance:
|
||||||
This enables the query optimizer to select the fastest query plan for optimal
|
This enables the query optimizer to select the fastest query plan for optimal
|
||||||
performance.
|
performance.
|
||||||
|
|
||||||
* Move the *SKIP LOCKED* switch to the *Yes* position to specifies that
|
* Move the *SKIP LOCKED* switch to the *Yes* position to specify that
|
||||||
ANALYZE should not wait for any conflicting locks to be released when
|
ANALYZE should not wait for any conflicting locks to be released when
|
||||||
beginning work on a relation. This option is available from v12 onwards.
|
beginning work on a relation. This option is available from v12 onwards.
|
||||||
|
|
||||||
* Use the *BUFFER USAGE LIMIT* field to specifies the Buffer Access Strategy
|
* Use the *BUFFER USAGE LIMIT* field to specify the Buffer Access Strategy
|
||||||
ring buffer size for ANALYZE. This size is used to calculate the number of
|
ring buffer size for ANALYZE. This size is used to calculate the number of
|
||||||
shared buffers which will be reused as part of this strategy. This option
|
shared buffers which will be reused as part of this strategy. This option
|
||||||
is available from v16 onwards
|
is available from v16 onwards
|
||||||
|
|
@ -103,7 +103,7 @@ maintenance:
|
||||||
without taking any locks that prevent concurrent inserts, updates, or
|
without taking any locks that prevent concurrent inserts, updates, or
|
||||||
deletes on the table. This option is available from v12 onwards.
|
deletes on the table. This option is available from v12 onwards.
|
||||||
|
|
||||||
* Use the *TABLESPACE* field to specifies that indexes will be rebuilt on
|
* Use the *TABLESPACE* field to specify that indexes will be rebuilt on
|
||||||
a new tablespace. This option is available from v14 onwards.
|
a new tablespace. This option is available from v14 onwards.
|
||||||
|
|
||||||
.. image:: images/maintenance_cluster.png
|
.. image:: images/maintenance_cluster.png
|
||||||
|
|
@ -118,6 +118,6 @@ switch to the *No* position; by default, status messages are included.
|
||||||
When you've completed the dialog, click *OK* to start the background process;
|
When you've completed the dialog, click *OK* to start the background process;
|
||||||
to exit the dialog without performing maintenance operations, click *Cancel*.
|
to exit the dialog without performing maintenance operations, click *Cancel*.
|
||||||
|
|
||||||
pgAdmin will run the maintenance process in background. You can view all the background
|
pgAdmin will run the maintenance process in the background. You can view all the background
|
||||||
process with there running status and logs on the :ref:`Processes <processes>`
|
processes with their running status and logs on the :ref:`Processes <processes>`
|
||||||
tab.
|
tab.
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ the REFRESH MATERIALIZED VIEW command to update the content of a materialized
|
||||||
view.
|
view.
|
||||||
|
|
||||||
The *Materialized View* dialog organizes the development of a materialized_view
|
The *Materialized View* dialog organizes the development of a materialized_view
|
||||||
through the following dialog tabs: *General*, *Definition*, *Storage*,
|
through the following dialog tabs: *General*, *Definition*, *Code*,
|
||||||
*Parameter*, and *Security*. The *SQL* tab displays the SQL code generated by
|
*Parameter*, and *Security*. The *SQL* tab displays the SQL code generated by
|
||||||
dialog selections.
|
dialog selections.
|
||||||
|
|
||||||
|
|
@ -31,10 +31,10 @@ Use the fields in the *General* tab to identify the materialized view:
|
||||||
Click the *Definition* tab to continue.
|
Click the *Definition* tab to continue.
|
||||||
|
|
||||||
.. image:: images/materialized_view_definition.png
|
.. image:: images/materialized_view_definition.png
|
||||||
:alt: Materialized view dialog storage tab
|
:alt: Materialized view dialog definition tab
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Use the fields in the *Storage* tab to maintain the materialized view:
|
Use the fields in the *Definition* tab to maintain the materialized view:
|
||||||
|
|
||||||
* Move the *With Data* switch to the *Yes* position to specify the materialized
|
* Move the *With Data* switch to the *Yes* position to specify the materialized
|
||||||
view should be populated at creation time. If not, the materialized view
|
view should be populated at creation time. If not, the materialized view
|
||||||
|
|
@ -47,11 +47,14 @@ Use the fields in the *Storage* tab to maintain the materialized view:
|
||||||
* Use the *Fill Factor* field to specify a fill factor for the materialized
|
* Use the *Fill Factor* field to specify a fill factor for the materialized
|
||||||
view. The fill factor for a table is a percentage between 10 and 100. 100
|
view. The fill factor for a table is a percentage between 10 and 100. 100
|
||||||
(complete packing) is the default.
|
(complete packing) is the default.
|
||||||
|
* Use the drop-down listbox next to *Depends on extensions* to select the extension that this materialized view
|
||||||
|
depends on (for example, edbspl). If set, dropping the extension will automatically drop the
|
||||||
|
materialized view as well.
|
||||||
|
|
||||||
Click the *Code* tab to continue.
|
Click the *Code* tab to continue.
|
||||||
|
|
||||||
.. image:: images/materialized_view_code.png
|
.. image:: images/materialized_view_code.png
|
||||||
:alt: Materialized view dialog definition tab
|
:alt: Materialized view dialog code tab
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Use the text editor field in the *Code* tab to provide the query that will
|
Use the text editor field in the *Code* tab to provide the query that will
|
||||||
|
|
@ -101,7 +104,7 @@ selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,10 @@
|
||||||
*****************
|
*****************
|
||||||
|
|
||||||
The pgAdmin menu bar provides drop-down menus for access to options, commands,
|
The pgAdmin menu bar provides drop-down menus for access to options, commands,
|
||||||
and utilities. The menu bar displays the following selections: *File*, *Object*,
|
and utilities. Its layout adapts based on your deployment: in Web mode,
|
||||||
Tools*, and *Help*. Selections may be grayed out which indicates they are
|
you will see *File*, *Object*, *Tools*, and *Help* menus. In Desktop mode,
|
||||||
|
the *pgAdmin4* application menu replaces the standard *File* menu.
|
||||||
|
Selections may be grayed out which indicates they are
|
||||||
disabled for the object currently selected in the *pgAdmin* tree control.
|
disabled for the object currently selected in the *pgAdmin* tree control.
|
||||||
|
|
||||||
The File Menu
|
The File Menu
|
||||||
|
|
@ -16,7 +18,7 @@ The File Menu
|
||||||
:alt: pgAdmin file menu bar
|
:alt: pgAdmin file menu bar
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Use the *File* menu to access the following options:
|
Use the *File* menu available in web mode to access the following options:
|
||||||
|
|
||||||
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| Option | Action |
|
| Option | Action |
|
||||||
|
|
@ -25,8 +27,30 @@ Use the *File* menu to access the following options:
|
||||||
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| *Reset Layout* | If you have modified the workspace, click to restore the default layout. |
|
| *Reset Layout* | If you have modified the workspace, click to restore the default layout. |
|
||||||
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
| *Runtime* | Click to open a submenu to Configure, View Log and Zoom settings. Only visible when pgAdmin4 runs in |
|
|
||||||
| | desktop mode. To know more about runtime menu :ref:`click here <desktop_deployment>` |
|
|
||||||
|
The pgAdmin4 Menu
|
||||||
|
*****************
|
||||||
|
|
||||||
|
.. image:: /images/pgadmin4_menu.png
|
||||||
|
:alt: pgAdmin pgadmin4 menu bar
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
Use the *pgAdmin4* menu available in desktop mode to access the following options:
|
||||||
|
|
||||||
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
| Option | Action |
|
||||||
|
+=========================+=========================================================================================================+
|
||||||
|
| *About pgAdmin 4* | Provide pgadmin4 configuration information like version, mode etc. |
|
||||||
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
| *Preferences/settings* | Click to open the :ref:`Preferences <preferences>` dialog to customize your pgAdmin settings. |
|
||||||
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
| *Reset Layout* | If you have modified the workspace, click to restore the default layout. |
|
||||||
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
| *View Logs* | This will show current pgadmin4 logs. |
|
||||||
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
| *Configure runtime* | Click to open a window that allows to configure application port, connection timeout to launch the |
|
||||||
|
| | application. To know more about runtime menu :ref:`click here <desktop_deployment>` |
|
||||||
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
+-------------------------+---------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
The Object Menu
|
The Object Menu
|
||||||
|
|
@ -81,9 +105,9 @@ following options (in alphabetical order):
|
||||||
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| *Trigger(s)* | Click to *Disable* or *Enable* trigger(s) for the currently selected table. Options are displayed on the flyout menu. |
|
| *Trigger(s)* | Click to *Disable* or *Enable* trigger(s) for the currently selected table. Options are displayed on the flyout menu. |
|
||||||
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| *Truncate* | Click to remove all rows from a table (*Truncate*), to remove all rows from a table and its child tables |
|
| *Truncate* | Click to remove all rows from a table/foreign tables (*Truncate*), to remove all rows from a table/foreign tables and |
|
||||||
| | (*Truncate Cascade*) or to remove all rows from a table and automatically restart sequences owned by columns |
|
| | its child tables (*Truncate Cascade*) or to remove all rows from a table/foreign tables and automatically restart |
|
||||||
| | (*Truncate Restart Identity*). Options are displayed on the flyout menu. |
|
| | sequences owned by columns (*Truncate Restart Identity*). Options are displayed on the flyout menu. |
|
||||||
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
| *View Data* | Click to access a context menu that provides several options for viewing data (see below). |
|
| *View Data* | Click to access a context menu that provides several options for viewing data (see below). |
|
||||||
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------+--------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
@ -132,6 +156,12 @@ Use the *Tools* menu to access the following options (in alphabetical order):
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| *Search Objects...* | Click to open the :ref:`Search Objects... <search_objects>` and start searching any kind of objects in a database. |
|
| *Search Objects...* | Click to open the :ref:`Search Objects... <search_objects>` and start searching any kind of objects in a database. |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| *AI Reports* | Click to access a submenu with AI-powered analysis options (requires :ref:`AI configuration <ai_tools>`): |
|
||||||
|
| | |
|
||||||
|
| | - *Security Report* - Generate an AI-powered security analysis for the selected server, database, or schema. |
|
||||||
|
| | - *Performance Report* - Generate an AI-powered performance analysis for the selected server or database. |
|
||||||
|
| | - *Design Report* - Generate an AI-powered design review for the selected database or schema. |
|
||||||
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| *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 |
|
| *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. |
|
| | server state. |
|
||||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,40 @@
|
||||||
.. _oauth2:
|
.. _oauth2:
|
||||||
|
|
||||||
*****************************************
|
*******************************************************
|
||||||
`Enabling OAUTH2 Authentication`:index:
|
`Enabling OAUTH2 and OIDC Authentication`:index:
|
||||||
*****************************************
|
*******************************************************
|
||||||
|
|
||||||
|
|
||||||
To enable OAUTH2 authentication for pgAdmin, you must configure the OAUTH2
|
To enable OAUTH2 or OpenID Connect (OIDC) authentication for pgAdmin, you must
|
||||||
settings in the *config_local.py* or *config_system.py* file (see the
|
configure the OAUTH2 settings in the *config_local.py* or *config_system.py*
|
||||||
:ref:`config.py <config_py>` documentation) on the system where pgAdmin is
|
file (see the :ref:`config.py <config_py>` documentation) on the system where
|
||||||
installed in Server mode. You can copy these settings from *config.py* file
|
pgAdmin is installed in Server mode. You can copy these settings from *config.py*
|
||||||
and modify the values for the following parameters:
|
file and modify the values for the following parameters.
|
||||||
|
|
||||||
|
OAuth2 vs OpenID Connect (OIDC)
|
||||||
|
================================
|
||||||
|
|
||||||
|
pgAdmin supports both OAuth2 and OIDC authentication protocols:
|
||||||
|
|
||||||
|
**OAuth2** is an authorization framework that allows third-party applications to
|
||||||
|
obtain limited access to user accounts. When using OAuth2, pgAdmin must explicitly
|
||||||
|
call the provider's userinfo endpoint to retrieve user profile information.
|
||||||
|
|
||||||
|
**OpenID Connect (OIDC)** is an identity layer built on top of OAuth2 that provides
|
||||||
|
standardized user authentication and profile information. When using OIDC, user
|
||||||
|
identity information is included directly in the ID token, which is more efficient
|
||||||
|
and secure.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
When **OAUTH2_SERVER_METADATA_URL** is configured, pgAdmin treats the provider
|
||||||
|
as an OIDC provider and will:
|
||||||
|
|
||||||
|
- Use ID token claims for user identity (sub, email, preferred_username)
|
||||||
|
- Skip the userinfo endpoint call when ID token contains sufficient information
|
||||||
|
- Validate the ID token automatically using the provider's public keys
|
||||||
|
|
||||||
|
This is the **recommended approach** for modern identity providers like
|
||||||
|
Microsoft Entra ID (Azure AD), Google, Keycloak, Auth0, and Okta.
|
||||||
|
|
||||||
|
|
||||||
.. _AzureAD: https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles
|
.. _AzureAD: https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles
|
||||||
|
|
@ -23,29 +48,28 @@ and modify the values for the following parameters:
|
||||||
|
|
||||||
"AUTHENTICATION_SOURCES", "The default value for this parameter is *internal*.
|
"AUTHENTICATION_SOURCES", "The default value for this parameter is *internal*.
|
||||||
To enable OAUTH2 authentication, you must include *oauth2* in the list of values
|
To enable OAUTH2 authentication, you must include *oauth2* in the list of values
|
||||||
for this parameter. you can modify the value as follows:
|
for this parameter. You can modify the value as follows:
|
||||||
|
|
||||||
* [‘oauth2’, ‘internal’]: pgAdmin will display an additional button for authenticating with oauth2"
|
* [‘oauth2’, ‘internal’]: pgAdmin will display an additional button for authenticating with oauth2"
|
||||||
"OAUTH2_NAME", "The name of the Oauth2 provider, ex: Google, Github"
|
"OAUTH2_NAME", "The name of the Oauth2 provider, ex: Google, Github"
|
||||||
"OAUTH2_DISPLAY_NAME", "Oauth2 display name in pgAdmin"
|
"OAUTH2_DISPLAY_NAME", "Oauth2 display name in pgAdmin"
|
||||||
"OAUTH2_CLIENT_ID", "Oauth2 Client ID"
|
"OAUTH2_CLIENT_ID", "Oauth2 Client ID"
|
||||||
"OAUTH2_CLIENT_SECRET", "Oauth2 Client Secret"
|
"OAUTH2_CLIENT_SECRET", "Oauth2 Client Secret. **Optional for public clients using Authorization Code + PKCE**. For confidential clients (server-side apps), keep this set. For public clients (no secret), pgAdmin will enforce PKCE and perform an unauthenticated token exchange."
|
||||||
|
"OAUTH2_CLIENT_AUTH_METHOD", "Client authentication method for the token endpoint. Default behavior uses *OAUTH2_CLIENT_SECRET* (confidential client), or PKCE when no secret is provided (public client). Set to *workload_identity* to authenticate using an Azure Entra ID workload identity (federated credential) without a client secret."
|
||||||
|
"OAUTH2_WORKLOAD_IDENTITY_TOKEN_FILE", "When **OAUTH2_CLIENT_AUTH_METHOD** is *workload_identity*, path to the projected OIDC token file (Kubernetes service account JWT). This file must exist at pgAdmin startup."
|
||||||
"OAUTH2_TOKEN_URL", "Oauth2 Access Token endpoint"
|
"OAUTH2_TOKEN_URL", "Oauth2 Access Token endpoint"
|
||||||
"OAUTH2_AUTHORIZATION_URL", "Endpoint for user authorization"
|
"OAUTH2_AUTHORIZATION_URL", "Endpoint for user authorization"
|
||||||
"OAUTH2_SERVER_METADATA_URL", "Server metadata url for your OAuth2 provider"
|
"OAUTH2_SERVER_METADATA_URL", "**OIDC Discovery URL** (recommended for OIDC providers). When set, pgAdmin will use OIDC flow with automatic ID token validation and user claims from the ID token. Example: *https://login.microsoftonline.com/{tenant}/v2.0/.well-known/openid-configuration*. When using this parameter, OAUTH2_TOKEN_URL and OAUTH2_AUTHORIZATION_URL are optional as they will be discovered automatically."
|
||||||
"OAUTH2_API_BASE_URL", "Oauth2 base URL endpoint to make requests simple, ex: *https://api.github.com/*"
|
"OAUTH2_API_BASE_URL", "Oauth2 base URL endpoint to make requests simple, ex: *https://api.github.com/*"
|
||||||
"OAUTH2_USERINFO_ENDPOINT", "User Endpoint, ex: *user* (for github, or *user/emails* if the user's email address is private) and *userinfo* (for google),"
|
"OAUTH2_USERINFO_ENDPOINT", "User Endpoint, ex: *user* (for github, or *user/emails* if the user's email address is private) and *userinfo* (for google). **For OIDC providers**, this is optional if the ID token contains sufficient claims (email, preferred_username, or sub)."
|
||||||
"OAUTH2_SCOPE", "Oauth scope, ex: 'openid email profile'. Note that an 'email' claim is required in the resulting profile."
|
"OAUTH2_SCOPE", "Oauth scope, ex: 'openid email profile'. **For OIDC providers**, include 'openid' scope to receive an ID token."
|
||||||
"OAUTH2_ICON", "The Font-awesome icon to be placed on the oauth2 button, ex: fa-github"
|
"OAUTH2_ICON", "The Font-awesome icon to be placed on the oauth2 button, ex: fa-github"
|
||||||
"OAUTH2_BUTTON_COLOR", "Oauth2 button color"
|
"OAUTH2_BUTTON_COLOR", "Oauth2 button color"
|
||||||
"OAUTH2_USERNAME_CLAIM", "The claim which is used for the username. If the value is empty
|
"OAUTH2_USERNAME_CLAIM", "The claim which is used for the username. If the value is empty, **for OIDC providers** pgAdmin will use: 1) email, 2) preferred_username, or 3) sub (in that order). **For OAuth2 providers** without OIDC, email is required. Ex: *oid* (for AzureAD), *email* (for Github), *preferred_username* (for Keycloak)"
|
||||||
the email is used as username, but if a value is provided, the claim has to exist. Ex: *oid* (for AzureAD), *email* (for Github)"
|
|
||||||
"OAUTH2_AUTO_CREATE_USER", "Set the value to *True* if you want to automatically
|
"OAUTH2_AUTO_CREATE_USER", "Set the value to *True* if you want to automatically
|
||||||
create a pgAdmin user corresponding to a successfully authenticated Oauth2 user.
|
create a pgAdmin user corresponding to a successfully authenticated Oauth2 user.
|
||||||
Please note that password is not stored in the pgAdmin database."
|
Please note that password is not stored in the pgAdmin database."
|
||||||
"OAUTH2_ADDITIONAL_CLAIMS", "If a dictionary is provided, pgAdmin will check for a matching key and value on the userinfo endpoint
|
"OAUTH2_ADDITIONAL_CLAIMS", "If a dictionary is provided, pgAdmin will check for a matching key and value on the **ID token first** (for OIDC providers), then fall back to the userinfo endpoint response. In case there is no match with the provided config, the user will receive an authorization error. Useful for checking AzureAD_ *wids* or *groups*, GitLab_ *owner*, *maintainer* and *reporter* claims."
|
||||||
and in the Id Token. In case there is no match with the provided config, the user will receive an authorization error.
|
|
||||||
Useful for checking AzureAD_ *wids* or *groups*, GitLab_ *owner*, *maintainer* and *reporter* claims."
|
|
||||||
"OAUTH2_SSL_CERT_VERIFICATION", "Set this variable to False to disable SSL certificate verification for OAuth2 provider.
|
"OAUTH2_SSL_CERT_VERIFICATION", "Set this variable to False to disable SSL certificate verification for OAuth2 provider.
|
||||||
This may need to set False, in case of self-signed certificates."
|
This may need to set False, in case of self-signed certificates."
|
||||||
"OAUTH2_CHALLENGE_METHOD", "Enable PKCE workflow. PKCE method name, only *S256* is supported"
|
"OAUTH2_CHALLENGE_METHOD", "Enable PKCE workflow. PKCE method name, only *S256* is supported"
|
||||||
|
|
@ -83,3 +107,240 @@ Ref: https://oauth.net/2/pkce
|
||||||
|
|
||||||
To enable PKCE workflow, set the configuration parameters OAUTH2_CHALLENGE_METHOD to *S256* and OAUTH2_RESPONSE_TYPE to *code*.
|
To enable PKCE workflow, set the configuration parameters OAUTH2_CHALLENGE_METHOD to *S256* and OAUTH2_RESPONSE_TYPE to *code*.
|
||||||
Both parameters are mandatory to enable PKCE workflow.
|
Both parameters are mandatory to enable PKCE workflow.
|
||||||
|
|
||||||
|
Public vs Confidential OAuth Clients
|
||||||
|
====================================
|
||||||
|
|
||||||
|
OAuth providers support two common client types:
|
||||||
|
|
||||||
|
- **Confidential clients** have a client secret and can authenticate to the token endpoint.
|
||||||
|
- **Public clients** do not have a client secret (or the secret cannot be safely stored).
|
||||||
|
|
||||||
|
pgAdmin supports interactive user login for both client types:
|
||||||
|
|
||||||
|
- If **OAUTH2_CLIENT_SECRET** is set, pgAdmin treats the provider as a confidential client.
|
||||||
|
- If **OAUTH2_CLIENT_SECRET** is missing, empty, or set to *None*, pgAdmin treats the provider as a public client and **requires PKCE**.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
For public clients, pgAdmin uses Authlib's native behavior to perform an **unauthenticated token exchange**
|
||||||
|
(token endpoint client authentication method: ``none``). This is required for Authorization Code + PKCE
|
||||||
|
flows where no client secret is available.
|
||||||
|
|
||||||
|
Azure Entra ID Workload Identity (AKS) (No Client Secret)
|
||||||
|
=========================================================
|
||||||
|
|
||||||
|
pgAdmin can authenticate to Microsoft Entra ID (Azure AD) **without a client secret** using an
|
||||||
|
AKS Workload Identity projected service account token (OIDC federated credential).
|
||||||
|
|
||||||
|
This is a **confidential client** scenario (server-side app), but client authentication to the token
|
||||||
|
endpoint is performed using a **JWT client assertion**.
|
||||||
|
|
||||||
|
Enable workload identity mode
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
Set the following parameters in your provider configuration:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
'OAUTH2_NAME': 'entra-workload-identity',
|
||||||
|
'OAUTH2_DISPLAY_NAME': 'Microsoft Entra ID',
|
||||||
|
'OAUTH2_CLIENT_ID': '<Application (client) ID>',
|
||||||
|
'OAUTH2_CLIENT_SECRET': None, # not required
|
||||||
|
'OAUTH2_CLIENT_AUTH_METHOD': 'workload_identity',
|
||||||
|
'OAUTH2_WORKLOAD_IDENTITY_TOKEN_FILE':
|
||||||
|
'/var/run/secrets/azure/tokens/azure-identity-token',
|
||||||
|
'OAUTH2_SERVER_METADATA_URL':
|
||||||
|
'https://login.microsoftonline.com/<tenant-id>/v2.0/.well-known/openid-configuration',
|
||||||
|
'OAUTH2_SCOPE': 'openid email profile',
|
||||||
|
}]
|
||||||
|
|
||||||
|
With this configuration:
|
||||||
|
|
||||||
|
- pgAdmin will **not** require **OAUTH2_CLIENT_SECRET**.
|
||||||
|
- pgAdmin will **not** use PKCE for this provider.
|
||||||
|
- During the token exchange, pgAdmin will send:
|
||||||
|
|
||||||
|
- ``client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer``
|
||||||
|
- ``client_assertion=<projected service account JWT>``
|
||||||
|
|
||||||
|
Azure App Registration setup
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
In Microsoft Entra ID:
|
||||||
|
|
||||||
|
- Create an **App registration** for pgAdmin.
|
||||||
|
- Configure a **Redirect URI** to ``<http/https>://<pgAdmin Server URL>/oauth2/authorize``.
|
||||||
|
- In **Certificates & secrets**, you do **not** need to create a client secret for workload identity.
|
||||||
|
|
||||||
|
Federated credential (workload identity) configuration
|
||||||
|
------------------------------------------------------
|
||||||
|
|
||||||
|
Add a **Federated credential** to the App registration:
|
||||||
|
|
||||||
|
- **Issuer**: your AKS cluster OIDC issuer URL.
|
||||||
|
- **Subject**: ``system:serviceaccount:<namespace>:<serviceaccount-name>``
|
||||||
|
- **Audience**: typically ``api://AzureADTokenExchange``
|
||||||
|
|
||||||
|
AKS ServiceAccount example
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
Example ServiceAccount for AKS Workload Identity:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
apiVersion: v1
|
||||||
|
kind: ServiceAccount
|
||||||
|
metadata:
|
||||||
|
name: pgadmin
|
||||||
|
namespace: pgadmin
|
||||||
|
annotations:
|
||||||
|
azure.workload.identity/client-id: "<Application (client) ID>"
|
||||||
|
---
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: pgadmin
|
||||||
|
namespace: pgadmin
|
||||||
|
spec:
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
azure.workload.identity/use: "true"
|
||||||
|
spec:
|
||||||
|
serviceAccountName: pgadmin
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
The projected token file path can vary by cluster configuration.
|
||||||
|
In many AKS setups it is provided via the ``AZURE_FEDERATED_TOKEN_FILE`` environment
|
||||||
|
variable and mounted under ``/var/run/secrets/azure/tokens/``.
|
||||||
|
|
||||||
|
OIDC Configuration Examples
|
||||||
|
============================
|
||||||
|
|
||||||
|
Using OIDC with Discovery Metadata (Recommended)
|
||||||
|
-------------------------------------------------
|
||||||
|
|
||||||
|
When using OIDC providers, configure the **OAUTH2_SERVER_METADATA_URL** parameter
|
||||||
|
to enable automatic discovery and ID token validation:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
'OAUTH2_NAME': 'my-oidc-provider',
|
||||||
|
'OAUTH2_DISPLAY_NAME': 'My OIDC Provider',
|
||||||
|
'OAUTH2_CLIENT_ID': 'your-client-id',
|
||||||
|
'OAUTH2_CLIENT_SECRET': 'your-client-secret',
|
||||||
|
'OAUTH2_SERVER_METADATA_URL': 'https://provider.example.com/.well-known/openid-configuration',
|
||||||
|
'OAUTH2_SCOPE': 'openid email profile',
|
||||||
|
# OAUTH2_USERINFO_ENDPOINT is optional when using OIDC
|
||||||
|
# Token and authorization URLs are discovered automatically
|
||||||
|
}]
|
||||||
|
|
||||||
|
With this configuration:
|
||||||
|
|
||||||
|
- pgAdmin will use the OIDC discovery endpoint to automatically find token and authorization URLs
|
||||||
|
- User identity will be extracted from ID token claims (sub, email, preferred_username)
|
||||||
|
- The userinfo endpoint will only be called as a fallback if ID token lacks required claims
|
||||||
|
- ID token will be automatically validated using the provider's public keys
|
||||||
|
|
||||||
|
Using OIDC as a Public Client (No Client Secret) with PKCE
|
||||||
|
-----------------------------------------------------------
|
||||||
|
|
||||||
|
If your OAuth/OIDC application is configured as a **public client** (no client secret), pgAdmin can still perform
|
||||||
|
interactive user login using Authorization Code + PKCE.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
'OAUTH2_NAME': 'my-oidc-public',
|
||||||
|
'OAUTH2_DISPLAY_NAME': 'My OIDC Provider (Public Client)',
|
||||||
|
'OAUTH2_CLIENT_ID': 'your-client-id',
|
||||||
|
# Public client: omit OAUTH2_CLIENT_SECRET or set it to None/empty.
|
||||||
|
'OAUTH2_CLIENT_SECRET': None,
|
||||||
|
'OAUTH2_SERVER_METADATA_URL': 'https://provider.example.com/.well-known/openid-configuration',
|
||||||
|
'OAUTH2_SCOPE': 'openid email profile',
|
||||||
|
# PKCE is mandatory for public clients
|
||||||
|
'OAUTH2_CHALLENGE_METHOD': 'S256',
|
||||||
|
'OAUTH2_RESPONSE_TYPE': 'code',
|
||||||
|
}]
|
||||||
|
|
||||||
|
With this configuration:
|
||||||
|
|
||||||
|
- pgAdmin enforces PKCE (challenge method + response type)
|
||||||
|
- The token exchange is performed without a client secret
|
||||||
|
|
||||||
|
Username Resolution for OIDC
|
||||||
|
-----------------------------
|
||||||
|
|
||||||
|
When **OAUTH2_SERVER_METADATA_URL** is configured (OIDC mode), pgAdmin will
|
||||||
|
resolve the username in the following order:
|
||||||
|
|
||||||
|
1. **OAUTH2_USERNAME_CLAIM** (if configured) - checks ID token first, then userinfo
|
||||||
|
2. **email** claim from ID token or userinfo endpoint
|
||||||
|
3. **preferred_username** claim from ID token (standard OIDC claim)
|
||||||
|
4. **sub** claim from ID token (always present in OIDC, used as last resort)
|
||||||
|
|
||||||
|
Example with custom username claim:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
# ... other config ...
|
||||||
|
'OAUTH2_USERNAME_CLAIM': 'preferred_username',
|
||||||
|
# pgAdmin will use 'preferred_username' from ID token for the username
|
||||||
|
}]
|
||||||
|
|
||||||
|
Example without custom claim (uses automatic fallback):
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
# ... other config ...
|
||||||
|
# No OAUTH2_USERNAME_CLAIM specified
|
||||||
|
# pgAdmin will try: email -> preferred_username -> sub
|
||||||
|
}]
|
||||||
|
|
||||||
|
Additional Claims Authorization with OIDC
|
||||||
|
------------------------------------------
|
||||||
|
|
||||||
|
When using **OAUTH2_ADDITIONAL_CLAIMS** with OIDC providers, pgAdmin will:
|
||||||
|
|
||||||
|
1. Check the ID token claims first (more secure, no additional network call)
|
||||||
|
2. Fall back to userinfo endpoint response if needed
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
# ... other config ...
|
||||||
|
'OAUTH2_ADDITIONAL_CLAIMS': {
|
||||||
|
'groups': ['admin-group', 'pgadmin-users'],
|
||||||
|
'roles': ['database-admin']
|
||||||
|
},
|
||||||
|
# pgAdmin will check these claims in ID token first,
|
||||||
|
# then userinfo endpoint if not found
|
||||||
|
}]
|
||||||
|
|
||||||
|
Legacy OAuth2 Configuration (Without OIDC)
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
For providers that don't support OIDC discovery, configure all endpoints manually:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
OAUTH2_CONFIG = [{
|
||||||
|
'OAUTH2_NAME': 'github',
|
||||||
|
'OAUTH2_DISPLAY_NAME': 'GitHub',
|
||||||
|
'OAUTH2_CLIENT_ID': 'your-client-id',
|
||||||
|
'OAUTH2_CLIENT_SECRET': 'your-client-secret',
|
||||||
|
'OAUTH2_TOKEN_URL': 'https://github.com/login/oauth/access_token',
|
||||||
|
'OAUTH2_AUTHORIZATION_URL': 'https://github.com/login/oauth/authorize',
|
||||||
|
'OAUTH2_API_BASE_URL': 'https://api.github.com/',
|
||||||
|
'OAUTH2_USERINFO_ENDPOINT': 'user',
|
||||||
|
'OAUTH2_SCOPE': 'user:email',
|
||||||
|
# No OAUTH2_SERVER_METADATA_URL - pure OAuth2 mode
|
||||||
|
}]
|
||||||
|
|
||||||
|
In this mode, user identity is retrieved only from the userinfo endpoint.
|
||||||
|
|
|
||||||
|
|
@ -27,6 +27,83 @@ The left pane of the *Preferences* tab displays a tree control; each node of
|
||||||
the tree control provides access to options that are related to the node under
|
the tree control provides access to options that are related to the node under
|
||||||
which they are displayed.
|
which they are displayed.
|
||||||
|
|
||||||
|
The AI Node
|
||||||
|
***********
|
||||||
|
|
||||||
|
Use preferences found in the *AI* node of the tree control to configure
|
||||||
|
AI-powered features and LLM (Large Language Model) providers.
|
||||||
|
|
||||||
|
.. image:: images/preferences_ai.png
|
||||||
|
:alt: Preferences AI section
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
**Note:** AI features must be enabled in the server configuration (``LLM_ENABLED = True``
|
||||||
|
in ``config.py``) for these preferences to be available.
|
||||||
|
|
||||||
|
Use the fields on the *AI* panel to configure your LLM provider:
|
||||||
|
|
||||||
|
* Use the *Default Provider* drop-down to select your LLM provider. Options include:
|
||||||
|
*Anthropic*, *OpenAI*, *Ollama*, or *Docker Model Runner*.
|
||||||
|
|
||||||
|
**Anthropic Settings:**
|
||||||
|
|
||||||
|
* Use the *API URL* field to set a custom API endpoint URL. Leave empty to use
|
||||||
|
the default Anthropic API (``https://api.anthropic.com/v1``). Set a custom URL
|
||||||
|
to use an Anthropic-compatible API provider.
|
||||||
|
|
||||||
|
* Use the *API Key File* field to specify the path to a file containing your
|
||||||
|
Anthropic API key. This path refers to the filesystem where the pgAdmin
|
||||||
|
server is running (e.g., inside the container if using Docker). The ``~``
|
||||||
|
prefix is expanded to the home directory of the user running the pgAdmin
|
||||||
|
server process. The API key may be optional when using a custom API URL
|
||||||
|
with a provider that does not require authentication.
|
||||||
|
|
||||||
|
* Use the *Model* field to select from the available Claude models. Click the
|
||||||
|
refresh button to fetch the latest available models from your configured
|
||||||
|
endpoint.
|
||||||
|
|
||||||
|
**OpenAI Settings:**
|
||||||
|
|
||||||
|
* Use the *API URL* field to set a custom API endpoint URL. Leave empty to use
|
||||||
|
the default OpenAI API (``https://api.openai.com/v1``). Set a custom URL to
|
||||||
|
use any OpenAI-compatible API provider (e.g., LiteLLM, LM Studio, EXO).
|
||||||
|
Include the ``/v1`` path prefix if required by your provider
|
||||||
|
(e.g., ``http://localhost:1234/v1``).
|
||||||
|
|
||||||
|
* Use the *API Key File* field to specify the path to a file containing your
|
||||||
|
OpenAI API key. This path refers to the filesystem where the pgAdmin
|
||||||
|
server is running (e.g., inside the container if using Docker). The ``~``
|
||||||
|
prefix is expanded to the home directory of the user running the pgAdmin
|
||||||
|
server process. The API key may be optional when using a custom API URL
|
||||||
|
with a provider that does not require authentication.
|
||||||
|
|
||||||
|
* Use the *Model* field to select from the available GPT models. Click the
|
||||||
|
refresh button to fetch the latest available models from your configured
|
||||||
|
endpoint.
|
||||||
|
|
||||||
|
**Ollama Settings:**
|
||||||
|
|
||||||
|
* Use the *API URL* field to specify the Ollama server URL
|
||||||
|
(default: ``http://localhost:11434``).
|
||||||
|
|
||||||
|
* Use the *Model* field to select from the available models or enter a custom
|
||||||
|
model name (e.g., ``llama2``, ``mistral``). Click the refresh button to fetch
|
||||||
|
the latest available models from your Ollama server.
|
||||||
|
|
||||||
|
**Docker Model Runner Settings:**
|
||||||
|
|
||||||
|
* Use the *API URL* field to specify the Docker Model Runner API URL
|
||||||
|
(default: ``http://localhost:12434``). Available in Docker Desktop 4.40+.
|
||||||
|
|
||||||
|
* Use the *Model* field to select from the available models or enter a custom
|
||||||
|
model name. Click the refresh button to fetch the latest available models
|
||||||
|
from your Docker Model Runner.
|
||||||
|
|
||||||
|
.. note:: You can also use the *OpenAI* provider with a custom API URL for any
|
||||||
|
OpenAI-compatible endpoint, including Docker Model Runner, LM Studio, EXO,
|
||||||
|
and other local inference servers. This can be useful when you want to use
|
||||||
|
a provider that isn't explicitly listed but supports the OpenAI API format.
|
||||||
|
|
||||||
The Browser Node
|
The Browser Node
|
||||||
****************
|
****************
|
||||||
|
|
||||||
|
|
@ -60,6 +137,9 @@ Use the fields on the *Display* panel to specify general display preferences:
|
||||||
all the shared servers from the object explorer. **Note:** This option is visible only when
|
all the shared servers from the object explorer. **Note:** This option is visible only when
|
||||||
pgAdmin is running in server mode.
|
pgAdmin is running in server mode.
|
||||||
|
|
||||||
|
* When the *Show column data type?* switch is turned off, then the data types
|
||||||
|
of the columns will not be displayed alongside their column names.
|
||||||
|
|
||||||
* When the *Show empty object collections?* switch is turned off, then all object
|
* When the *Show empty object collections?* switch is turned off, then all object
|
||||||
collections which are empty will be hidden from browser tree.
|
collections which are empty will be hidden from browser tree.
|
||||||
|
|
||||||
|
|
@ -101,7 +181,7 @@ related settings:
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
* Use *Enable object breadcrumbs?* to enable or disable object breadcrumbs
|
* Use *Enable object breadcrumbs?* to enable or disable object breadcrumbs
|
||||||
displayed on on object mouse hover.
|
displayed on object mouse hover.
|
||||||
|
|
||||||
* Use *Show comment with object breadcrumbs?* to enable or disable the
|
* Use *Show comment with object breadcrumbs?* to enable or disable the
|
||||||
comment visibility which comes displayed with object breadcrumbs.
|
comment visibility which comes displayed with object breadcrumbs.
|
||||||
|
|
@ -139,11 +219,11 @@ Use field on *Tab settings* panel to specify the tab related properties.
|
||||||
|
|
||||||
* Use *Debugger tab title placeholder* field to customize the Debugger tab title.
|
* Use *Debugger tab title placeholder* field to customize the Debugger tab title.
|
||||||
|
|
||||||
* When the *Dynamic tab size* If set to True, the tabs will take full size as per the title, it will also applicable for already opened tabs
|
* When the *Dynamic tab size* switch is set to *True*, the tabs will take full size as per the title. This will also apply to already opened tabs.
|
||||||
|
|
||||||
* Use the *PSQL tool tab title placeholder* field to customize the PSQL tool tab title.
|
* Use the *PSQL tool tab title placeholder* field to customize the PSQL tool tab title.
|
||||||
|
|
||||||
* When the *Open in new browser tab* filed is selected for Query tool, Schema Diff or Debugger, it will
|
* When the *Open in new browser tab* field is selected for Query tool, Schema Diff or Debugger, it will
|
||||||
open in a new browser tab when invoked.
|
open in a new browser tab when invoked.
|
||||||
|
|
||||||
* Use the *Query tool tab title placeholder* field to customize the query tool tab title.
|
* Use the *Query tool tab title placeholder* field to customize the query tool tab title.
|
||||||
|
|
@ -172,7 +252,7 @@ Expand the *Dashboards* node to specify your dashboard display preferences.
|
||||||
:alt: Preferences dashboard refresh options
|
:alt: Preferences dashboard refresh options
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
Use the fields on the *Refresh rates* panel to specify your refersh rates
|
Use the fields on the *Refresh rates* panel to specify your refresh rate
|
||||||
preferences for the graphs on the *Dashboard* tab:
|
preferences for the graphs on the *Dashboard* tab:
|
||||||
|
|
||||||
* Use the *Average load statistics refresh rate* field to specify the number of
|
* Use the *Average load statistics refresh rate* field to specify the number of
|
||||||
|
|
@ -254,6 +334,12 @@ Use the fields on the *Options* panel to manage ERD preferences.
|
||||||
* Use *Cardinality Notation* to change the cardinality notation format
|
* Use *Cardinality Notation* to change the cardinality notation format
|
||||||
used to present relationship links.
|
used to present relationship links.
|
||||||
|
|
||||||
|
* Use *Format ERD Project File?* if you want to format the .pgerd ERD
|
||||||
|
project file. It's a JSON file which will be formatted.
|
||||||
|
|
||||||
|
* Use *Image Download Resolution* to change the ERD image download
|
||||||
|
resolution. Higher values will use higher memory and slower rendering.
|
||||||
|
|
||||||
* When the *SQL With DROP Table* switch is set to *True*, the SQL
|
* When the *SQL With DROP Table* switch is set to *True*, the SQL
|
||||||
generated by the ERD Tool will add DROP table DDL before each CREATE
|
generated by the ERD Tool will add DROP table DDL before each CREATE
|
||||||
table DDL.
|
table DDL.
|
||||||
|
|
@ -383,11 +469,17 @@ Use the fields on the *File Downloads* panel to manage file downloads related pr
|
||||||
|
|
||||||
* When the *Automatically open downloaded files?* switch is set to *True*
|
* When the *Automatically open downloaded files?* switch is set to *True*
|
||||||
the downloaded file will automatically open in the system's default
|
the downloaded file will automatically open in the system's default
|
||||||
application associated with that file type.
|
application associated with that file type. **Note:** This option is applicable and
|
||||||
|
visible only in desktop mode.
|
||||||
|
|
||||||
|
* When the *Enable binary data download?* switch is set to *True*,
|
||||||
|
binary data can be downloaded from the result grid. Default is set to *False*
|
||||||
|
to prevent excessive memory usage on the server.
|
||||||
|
|
||||||
* When the *Prompt for the download location?* switch is set to *True*
|
* When the *Prompt for the download location?* switch is set to *True*
|
||||||
a prompt will appear after clicking the download button, allowing you
|
a prompt will appear after clicking the download button, allowing you
|
||||||
to choose the download location.
|
to choose the download location. **Note:** This option is applicable and
|
||||||
|
visible only in desktop mode.
|
||||||
|
|
||||||
**Note:** File Downloads related settings are applicable and visible only in desktop mode.
|
**Note:** File Downloads related settings are applicable and visible only in desktop mode.
|
||||||
|
|
||||||
|
|
@ -451,7 +543,7 @@ monitored databases:
|
||||||
locations used by PostgreSQL.
|
locations used by PostgreSQL.
|
||||||
|
|
||||||
**Note:** Use the 'Validate path' button to check the existence of the utility
|
**Note:** Use the 'Validate path' button to check the existence of the utility
|
||||||
programs (pg_dump, pg_dumpall, pg_restore and psql) and there respective versions.
|
programs (pg_dump, pg_dumpall, pg_restore and psql) and their respective versions.
|
||||||
|
|
||||||
.. image:: images/preferences_paths_help.png
|
.. image:: images/preferences_paths_help.png
|
||||||
:alt: Preferences binary path help section
|
:alt: Preferences binary path help section
|
||||||
|
|
|
||||||
|
|
@ -36,6 +36,9 @@ Use the fields in the *Definition* tab to define the procedure:
|
||||||
|
|
||||||
* Use the drop-down listbox next to *Language* to select a language. The default
|
* Use the drop-down listbox next to *Language* to select a language. The default
|
||||||
is *edbspl*.
|
is *edbspl*.
|
||||||
|
* Use the drop-down listbox next to *Depends on extensions* to select the extension that this procedure
|
||||||
|
depends on (for example, edbspl). If set, dropping the extension will automatically drop the
|
||||||
|
procedure as well.
|
||||||
* Use the fields in the *Arguments* section to define an argument. Click *Add* to set
|
* Use the fields in the *Arguments* section to define an argument. Click *Add* to set
|
||||||
parameters and values for the argument:
|
parameters and values for the argument:
|
||||||
* Use the drop-down listbox next to *Data type* to select a data type.
|
* Use the drop-down listbox next to *Data type* to select a data type.
|
||||||
|
|
@ -132,7 +135,7 @@ procedure. Click *Add* to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -32,8 +32,9 @@ The Query Tool features two panels:
|
||||||
|
|
||||||
* The upper panel displays the *SQL Editor*. You can use the panel to enter,
|
* The upper panel displays the *SQL Editor*. You can use the panel to enter,
|
||||||
edit, or execute a query or a script. It also shows the *History* tab which can be used
|
edit, or execute a query or a script. It also shows the *History* tab which can be used
|
||||||
to view the queries that have been executed in the session, and a *Scratch Pad*
|
to view the queries that have been executed in the session, a *Scratch Pad*
|
||||||
which can be used to hold text snippets during editing. If the Scratch Pad is
|
which can be used to hold text snippets during editing, and an *AI Assistant*
|
||||||
|
tab for generating SQL from natural language (when AI is configured). If the Scratch Pad is
|
||||||
closed, it can be re-opened (or additional ones opened) by right-clicking in
|
closed, it can be re-opened (or additional ones opened) by right-clicking in
|
||||||
the SQL Editor and other panels and adding a new panel.
|
the SQL Editor and other panels and adding a new panel.
|
||||||
* The lower panel displays the *Data Output* panel. The tabbed panel displays
|
* The lower panel displays the *Data Output* panel. The tabbed panel displays
|
||||||
|
|
@ -201,6 +202,49 @@ can be adjusted in ``config_local.py`` or ``config_system.py`` (see the
|
||||||
`MAX_QUERY_HIST_STORED` value. See the :ref:`Deployment <deployment>` section
|
`MAX_QUERY_HIST_STORED` value. See the :ref:`Deployment <deployment>` section
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
|
AI Assistant Panel
|
||||||
|
******************
|
||||||
|
|
||||||
|
The *AI Assistant* tab provides a chat-style interface for generating SQL queries
|
||||||
|
from natural language descriptions. This feature requires an AI provider to be
|
||||||
|
configured in *Preferences > AI*. For configuration details, see the
|
||||||
|
:ref:`preferences` documentation.
|
||||||
|
|
||||||
|
.. image:: images/query_ai_assistant.png
|
||||||
|
:alt: Query tool AI Assistant panel
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
To use the AI Assistant:
|
||||||
|
|
||||||
|
1. Click on the *AI Assistant* tab in the upper panel, or use the *AI Assistant*
|
||||||
|
toolbar button.
|
||||||
|
2. Type a description of the SQL query you need in natural language.
|
||||||
|
3. Press Enter or click the send button to submit your request.
|
||||||
|
4. The AI will analyze your database schema and generate appropriate SQL.
|
||||||
|
|
||||||
|
The AI Assistant displays conversations with your messages and AI responses. When
|
||||||
|
the AI generates SQL, it appears in a syntax-highlighted code block with action
|
||||||
|
buttons:
|
||||||
|
|
||||||
|
* **Insert** - Insert the SQL at the current cursor position in the SQL Editor.
|
||||||
|
* **Replace** - Replace all content in the SQL Editor with the generated SQL.
|
||||||
|
* **Copy** - Copy the SQL to the clipboard.
|
||||||
|
|
||||||
|
The AI Assistant maintains conversation context, allowing you to refine queries
|
||||||
|
iteratively. For example, you can ask for a query and then follow up with
|
||||||
|
"also add a filter for active users" to modify the previous result.
|
||||||
|
|
||||||
|
**Tips for effective use:**
|
||||||
|
|
||||||
|
* Be specific about table and column names if you know them.
|
||||||
|
* Describe the desired output format (e.g., "show count by category").
|
||||||
|
* For complex queries, break down requirements step by step.
|
||||||
|
* Use the *Clear* button to start a fresh conversation.
|
||||||
|
|
||||||
|
**Note:** The AI Assistant uses database schema inspection tools to understand
|
||||||
|
your database structure. It supports SELECT, INSERT, UPDATE, DELETE, and DDL
|
||||||
|
statements. All generated queries should be reviewed before execution.
|
||||||
|
|
||||||
The Data Output Panel
|
The Data Output Panel
|
||||||
*********************
|
*********************
|
||||||
|
|
||||||
|
|
@ -275,6 +319,8 @@ the drop down on the right side of *Explain Analyze* button in the toolbar.
|
||||||
|
|
||||||
Please note that pgAdmin generates the *Explain [Analyze]* plan in JSON format.
|
Please note that pgAdmin generates the *Explain [Analyze]* plan in JSON format.
|
||||||
|
|
||||||
|
**Note**: If multiple queries are present and none is selected, *Explain [Analyze]* runs the query located at the cursor position.
|
||||||
|
|
||||||
On successful generation of *Explain* plan, it will create three tabs/panels
|
On successful generation of *Explain* plan, it will create three tabs/panels
|
||||||
under the Explain panel.
|
under the Explain panel.
|
||||||
|
|
||||||
|
|
@ -333,6 +379,44 @@ If planner mis-estimated number of rows (actual vs planned) by
|
||||||
:alt: Query tool explain plan statistics
|
:alt: Query tool explain plan statistics
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
|
* AI Insights
|
||||||
|
|
||||||
|
The *AI Insights* tab provides AI-powered analysis of query execution plans,
|
||||||
|
identifying performance bottlenecks and suggesting optimizations. This tab is
|
||||||
|
only available when an AI provider is configured in *Preferences > AI*.
|
||||||
|
|
||||||
|
.. image:: images/query_explain_ai_insights.png
|
||||||
|
:alt: Query tool explain plan AI insights
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
When you switch to the AI Insights tab, the AI analyzes the execution plan and
|
||||||
|
provides:
|
||||||
|
|
||||||
|
**Performance Bottlenecks** - Issues identified in the query plan, such as:
|
||||||
|
|
||||||
|
* Sequential scans on large tables that could benefit from indexes
|
||||||
|
* Significant differences between estimated and actual row counts
|
||||||
|
* Expensive sort or hash operations
|
||||||
|
* Nested loops with high iteration counts
|
||||||
|
|
||||||
|
**Recommendations** - Concrete suggestions to improve query performance:
|
||||||
|
|
||||||
|
* Index creation statements with appropriate columns
|
||||||
|
* ANALYZE commands to update table statistics
|
||||||
|
* Configuration parameter adjustments
|
||||||
|
* Query restructuring suggestions
|
||||||
|
|
||||||
|
Each recommendation that includes SQL (such as CREATE INDEX statements) has
|
||||||
|
action buttons to *Copy* the SQL to the clipboard or *Insert* it into the
|
||||||
|
Query Editor.
|
||||||
|
|
||||||
|
Click the *Regenerate* button to request a fresh analysis of the current plan.
|
||||||
|
|
||||||
|
**Note:** AI analysis is generated on-demand when you first click the AI Insights
|
||||||
|
tab or when a new explain plan is generated while the tab is active. The analysis
|
||||||
|
provides guidance but all suggested changes should be carefully evaluated before
|
||||||
|
applying to production databases.
|
||||||
|
|
||||||
Messages Panel
|
Messages Panel
|
||||||
**************
|
**************
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -241,6 +241,8 @@ Pagination Options
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *Edit Range* | Click to open the from and to rows range inputs to allow setting them. | |
|
| *Edit Range* | Click to open the from and to rows range inputs to allow setting them. | |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
|
| *Show Entire Range* | Click to get all the rows and set the from and to rows range | |
|
||||||
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *Page No* | Enter the page no you want to jump to out of total shown next to this input | |
|
| *Page No* | Enter the page no you want to jump to out of total shown next to this input | |
|
||||||
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
|
||||||
| *First Page* | Click to go to the first page. | |
|
| *First Page* | Click to go to the first page. | |
|
||||||
|
|
|
||||||
|
|
@ -12,6 +12,13 @@ notes for it.
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
|
||||||
|
release_notes_9_14
|
||||||
|
release_notes_9_13
|
||||||
|
release_notes_9_12
|
||||||
|
release_notes_9_11
|
||||||
|
release_notes_9_10
|
||||||
|
release_notes_9_9
|
||||||
|
release_notes_9_8
|
||||||
release_notes_9_7
|
release_notes_9_7
|
||||||
release_notes_9_6
|
release_notes_9_6
|
||||||
release_notes_9_5
|
release_notes_9_5
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,47 @@
|
||||||
|
************
|
||||||
|
Version 9.10
|
||||||
|
************
|
||||||
|
|
||||||
|
Release date: 2025-11-13
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.9.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.0
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #4306 <https://github.com/pgadmin-org/pgadmin4/issues/4306>`_ - Added the ability to search for tables and automatically bring them into view in the ERD tool.
|
||||||
|
| `Issue #6391 <https://github.com/pgadmin-org/pgadmin4/issues/6391>`_ - Add support of DEPENDS/NO DEPENDS ON EXTENSION for PROCEDURE.
|
||||||
|
| `Issue #6698 <https://github.com/pgadmin-org/pgadmin4/issues/6698>`_ - Add support for setting image download resolution in the ERD tool.
|
||||||
|
| `Issue #7885 <https://github.com/pgadmin-org/pgadmin4/issues/7885>`_ - Add support for displaying detailed Citus query plans instead of 'Custom Scan' placeholder.
|
||||||
|
| `Issue #8912 <https://github.com/pgadmin-org/pgadmin4/issues/8912>`_ - Add support for formatting .pgerd ERD project file.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #8676 <https://github.com/pgadmin-org/pgadmin4/issues/8676>`_ - Migrate pgAdmin UI to use React 19.
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #8504 <https://github.com/pgadmin-org/pgadmin4/issues/8504>`_ - Fixed an issue where data output column resize is not sticking in Safari.
|
||||||
|
| `Issue #9117 <https://github.com/pgadmin-org/pgadmin4/issues/9117>`_ - Fixed an issue where Schema Diff does not ignore Tablespace for indexes.
|
||||||
|
| `Issue #9132 <https://github.com/pgadmin-org/pgadmin4/issues/9132>`_ - Fixed an issue where the 2FA window redirected to the login page after session expiration.
|
||||||
|
| `Issue #9233 <https://github.com/pgadmin-org/pgadmin4/issues/9233>`_ - Fixed an issue where the Select All option on the columns tab of import/export data was not working in languages other than English.
|
||||||
|
| `Issue #9240 <https://github.com/pgadmin-org/pgadmin4/issues/9240>`_ - Fixed an issue where the Debian build process failed with a "Sphinx module not found" error when using a Python virtual environment.
|
||||||
|
| `Issue #9281 <https://github.com/pgadmin-org/pgadmin4/issues/9281>`_ - Fixed an issue where the last used storage directory was reset to blank, leading to access denied errors during backup or restore operations.
|
||||||
|
| `Issue #9304 <https://github.com/pgadmin-org/pgadmin4/issues/9304>`_ - Fixed an issue that prevented assigning multiple users to an RLS policy.
|
||||||
|
| `Issue #9320 <https://github.com/pgadmin-org/pgadmin4/issues/9320>`_ - Fixed remote code execution vulnerability when restoring PLAIN-format SQL dumps in server mode (CVE-2025-12762).
|
||||||
|
| `Issue #9323 <https://github.com/pgadmin-org/pgadmin4/issues/9323>`_ - Fixed Command injection vulnerability allowing arbitrary command execution on Windows (CVE-2025-12763).
|
||||||
|
| `Issue #9324 <https://github.com/pgadmin-org/pgadmin4/issues/9324>`_ - Fixed LDAP authentication flow vulnerable to TLS certificate verification bypass (CVE-2025-12765).
|
||||||
|
| `Issue #9325 <https://github.com/pgadmin-org/pgadmin4/issues/9325>`_ - Fixed LDAP injection vulnerability in LDAP authentication flow (CVE-2025-12764).
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
************
|
||||||
|
Version 9.11
|
||||||
|
************
|
||||||
|
|
||||||
|
Release date: 2025-12-11
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.10.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.0
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #6388 <https://github.com/pgadmin-org/pgadmin4/issues/6388>`_ - Add support of DEPENDS/NO DEPENDS ON EXTENSION for INDEX.
|
||||||
|
| `Issue #6390 <https://github.com/pgadmin-org/pgadmin4/issues/6390>`_ - Add support of DEPENDS/NO DEPENDS ON EXTENSION for MATERIALIZED VIEW.
|
||||||
|
| `Issue #8968 <https://github.com/pgadmin-org/pgadmin4/issues/8968>`_ - Add support for showing the column data type beside column name in the object explorer.
|
||||||
|
| `Issue #9263 <https://github.com/pgadmin-org/pgadmin4/issues/9263>`_ - Added Ubuntu 25.10 and Fedora 43
|
||||||
|
| `Issue #9345 <https://github.com/pgadmin-org/pgadmin4/issues/9345>`_ - Add conditional TLS support for the Ingress in the Helm chart.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #9036 <https://github.com/pgadmin-org/pgadmin4/issues/9036>`_ - Fixed an issue on type casting of default string function/procedure arguments in debugger tool.
|
||||||
|
| `Issue #9155 <https://github.com/pgadmin-org/pgadmin4/issues/9155>`_ - Fix pkg_resources deprecation warning by migrating Docker base image to python:3-alpine from alpine:latest.
|
||||||
|
| `Issue #9297 <https://github.com/pgadmin-org/pgadmin4/issues/9297>`_ - Fixed an issue where EXPLAIN should run on query under cursor if no text is selected.
|
||||||
|
| `Issue #9351 <https://github.com/pgadmin-org/pgadmin4/issues/9351>`_ - Fixed an issue where opening file in Query Tool does not retain file name in tab.
|
||||||
|
| `Issue #9354 <https://github.com/pgadmin-org/pgadmin4/issues/9354>`_ - Fixed an issue where connection is failing via Query Tool/PSQL Tool workspaces.
|
||||||
|
| `Issue #9368 <https://github.com/pgadmin-org/pgadmin4/issues/9368>`_ - Plain SQL restore runs with '\restrict' option to prevent harmful psql meta-commands (CVE-2025-13780).
|
||||||
|
| `Issue #9372 <https://github.com/pgadmin-org/pgadmin4/issues/9372>`_ - Fixed an issue where copying highlighted text in the query tool data output cell editor would copy the complete string.
|
||||||
|
| `Issue #9373 <https://github.com/pgadmin-org/pgadmin4/issues/9373>`_ - Fixed an issue where copying a single cell should not add quoting.
|
||||||
|
| `Issue #9393 <https://github.com/pgadmin-org/pgadmin4/issues/9393>`_ - Fix the Helm chart server definition and change the app version.
|
||||||
|
| `Issue #9399 <https://github.com/pgadmin-org/pgadmin4/issues/9399>`_ - Specify the correct hostname placeholder for the Password Exec command.
|
||||||
|
| `Issue #9408 <https://github.com/pgadmin-org/pgadmin4/issues/9408>`_ - Ensure the proper handling of extra volume mount configurations in the Helm deployment template by correcting the configuration value references.
|
||||||
|
|
@ -0,0 +1,60 @@
|
||||||
|
************
|
||||||
|
Version 9.12
|
||||||
|
************
|
||||||
|
|
||||||
|
Release date: 2026-02-05
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.11.
|
||||||
|
|
||||||
|
.. warning:: Starting with this release, pgAdmin Windows installers are signed
|
||||||
|
with a new code signing certificate. When installing or running pgAdmin on
|
||||||
|
Windows, you should verify that the digital signature shows the certificate
|
||||||
|
name as **"Open Source Developer, David John Page"**. This certificate will
|
||||||
|
be used for this and future releases.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.0
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #6451 <https://github.com/pgadmin-org/pgadmin4/issues/6451>`_ - Add new options like INHERIT and SET to the Role's membership tab.
|
||||||
|
| `Issue #8890 <https://github.com/pgadmin-org/pgadmin4/issues/8890>`_ - Add a new button in the query tool data output toolbar to get entire range of data.
|
||||||
|
| `Issue #9292 <https://github.com/pgadmin-org/pgadmin4/issues/9292>`_ - Enhance OAUTH2 and OIDC authentication support with improved claims handling and configuration options.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #8916 <https://github.com/pgadmin-org/pgadmin4/issues/8916>`_ - Warn user of unsaved data output edits before page navigation.
|
||||||
|
| `Issue #8987 <https://github.com/pgadmin-org/pgadmin4/issues/8987>`_ - Fix Query Tool state restoration for new connections and queries.
|
||||||
|
| `Issue #9074 <https://github.com/pgadmin-org/pgadmin4/issues/9074>`_ - Fix pg_restore logs to distinguish UI sync issues from actual failures.
|
||||||
|
| `Issue #9110 <https://github.com/pgadmin-org/pgadmin4/issues/9110>`_ - Optimize checkbox selection logic in backup dialog objects tree.
|
||||||
|
| `Issue #9196 <https://github.com/pgadmin-org/pgadmin4/issues/9196>`_ - Fixed an issue where double click to open a file in the file manager is not working.
|
||||||
|
| `Issue #9223 <https://github.com/pgadmin-org/pgadmin4/issues/9223>`_ - Upgrade ID column in the database table to BigInteger to support large OID values.
|
||||||
|
| `Issue #9235 <https://github.com/pgadmin-org/pgadmin4/issues/9235>`_ - Fixed an issue where "View/Edit Data" shortcut opened "First 100 rows" instead of "All Rows".
|
||||||
|
| `Issue #9258 <https://github.com/pgadmin-org/pgadmin4/issues/9258>`_ - Ensure saved shared server passwords are re-encrypted on password change.
|
||||||
|
| `Issue #9260 <https://github.com/pgadmin-org/pgadmin4/issues/9260>`_ - Fixed an issue where data filter dialog removes newline character when sending SQL to the query tool.
|
||||||
|
| `Issue #9285 <https://github.com/pgadmin-org/pgadmin4/issues/9285>`_ - Fixed an issue where the dashboard freezes on initial render when there is a high number of locks.
|
||||||
|
| `Issue #9293 <https://github.com/pgadmin-org/pgadmin4/issues/9293>`_ - Fixed the SSL certificate issue while checking for the upgrade.
|
||||||
|
| `Issue #9332 <https://github.com/pgadmin-org/pgadmin4/issues/9332>`_ - Fixed a sorting issue in the system stats memory usage table.
|
||||||
|
| `Issue #9350 <https://github.com/pgadmin-org/pgadmin4/issues/9350>`_ - Disable Parameters and Membership fields when object is not new for Login and group roles.
|
||||||
|
| `Issue #9380 <https://github.com/pgadmin-org/pgadmin4/issues/9380>`_ - Fixed an issue where the Query History panel would auto-scroll to the top and did not preserve the scroll bar position for the selected entry.
|
||||||
|
| `Issue #9402 <https://github.com/pgadmin-org/pgadmin4/issues/9402>`_ - Fixed an issue where pgAdmin4 app on macOS cannot auto-update while running on a read-only volume even if present in the Applications folder.
|
||||||
|
| `Issue #9500 <https://github.com/pgadmin-org/pgadmin4/issues/9500>`_ - Fixed an issue where connection parameters were using localized values instead of literal values, causing connection failures.
|
||||||
|
| `Issue #9518 <https://github.com/pgadmin-org/pgadmin4/issues/9518>`_ - Mask the secret key for restrict option in the process watcher when restoring plain SQL file (CVE-2026-1707).
|
||||||
|
| `Issue #9522 <https://github.com/pgadmin-org/pgadmin4/issues/9522>`_ - Ensure the container deployment supports boolean values in yaml format.
|
||||||
|
| `Issue #9552 <https://github.com/pgadmin-org/pgadmin4/issues/9552>`_ - Ensure that the tooltip for the password cell is not visible.
|
||||||
|
| `Issue #9553 <https://github.com/pgadmin-org/pgadmin4/issues/9553>`_ - Fix pgAdmin fails when performing Backup/Restore on a PostgreSQL connection defined exclusively via pg_service.conf.
|
||||||
|
| `Issue #9567 <https://github.com/pgadmin-org/pgadmin4/issues/9567>`_ - Update menu bar documentation.
|
||||||
|
|
@ -0,0 +1,44 @@
|
||||||
|
************
|
||||||
|
Version 9.13
|
||||||
|
************
|
||||||
|
|
||||||
|
Release date: 2026-03-05
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.12.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.0
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #229 <https://github.com/pgadmin-org/pgadmin4/issues/229>`_ - Allow users to customize "OF TYPE" columns during table creation.
|
||||||
|
| `Issue #5578 <https://github.com/pgadmin-org/pgadmin4/issues/5578>`_ - No FK are shown in diagram created from existing tables in the ERD Tool.
|
||||||
|
| `Issue #6386 <https://github.com/pgadmin-org/pgadmin4/issues/6386>`_ - Add support for 'ONLY' in Index creation dialog.
|
||||||
|
| `Issue #8198 <https://github.com/pgadmin-org/pgadmin4/issues/8198>`_ - Allow "drag-n-drop" for only user chosen tables, and show relations between them.
|
||||||
|
| `Issue #9229 <https://github.com/pgadmin-org/pgadmin4/issues/9229>`_ - Load predefined users from a JSON file through command line.
|
||||||
|
| `Issue #9641 <https://github.com/pgadmin-org/pgadmin4/issues/9641>`_ - Core LLM integration infrastructure, AI reports for security, schema, and performance, AI chat for the Query Tool, and AI Insights for EXPLAIN.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #7578 <https://github.com/pgadmin-org/pgadmin4/issues/7578>`_ - Fixed an issue where the 'Quote strings only' configuration was ignored when downloading the result set.
|
||||||
|
| `Issue #8988 <https://github.com/pgadmin-org/pgadmin4/issues/8988>`_ - Fixed an issue where tools settings changed by the users were not restored on application relaunch.
|
||||||
|
| `Issue #9258 <https://github.com/pgadmin-org/pgadmin4/issues/9258>`_ - Fixed an issue where modifying a shared server incorrectly updated the original server details.
|
||||||
|
| `Issue #9484 <https://github.com/pgadmin-org/pgadmin4/issues/9484>`_ - Fixed an issue where a long name in ERD table node was not breaking into multiple lines.
|
||||||
|
| `Issue #9486 <https://github.com/pgadmin-org/pgadmin4/issues/9486>`_ - Fixed an issue where column comments were not displayed in the SQL tab for materialised views.
|
||||||
|
| `Issue #9572 <https://github.com/pgadmin-org/pgadmin4/issues/9572>`_ - Fix an issue where deployment of helm chart crashing with operation not permitted.
|
||||||
|
| `Issue #9583 <https://github.com/pgadmin-org/pgadmin4/issues/9583>`_ - Fix translation compilation.
|
||||||
|
| `Issue #9649 <https://github.com/pgadmin-org/pgadmin4/issues/9649>`_ - Fix broken checkbox selection in backup dialog objects tree.
|
||||||
|
| `Issue #9651 <https://github.com/pgadmin-org/pgadmin4/issues/9651>`_ - Fixed an issue in file dialog where rename was not working.
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
************
|
||||||
|
Version 9.14
|
||||||
|
************
|
||||||
|
|
||||||
|
Release date: 2026-04-02
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.13.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 18.0
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #4011 <https://github.com/pgadmin-org/pgadmin4/issues/4011>`_ - Added support to download binary data from result grid.
|
||||||
|
| `Issue #9703 <https://github.com/pgadmin-org/pgadmin4/issues/9703>`_ - Added support for custom LLM provider URLs for OpenAI and Anthropic, allowing use of OpenAI-compatible providers such as LM Studio, EXO, and LiteLLM.
|
||||||
|
| `Issue #9709 <https://github.com/pgadmin-org/pgadmin4/issues/9709>`_ - Fixed an issue where AI features (AI Assistant tab, AI Reports menus, and AI Preferences) were visible in the UI even when LLM_ENABLED is set to False.
|
||||||
|
| `Issue #9738 <https://github.com/pgadmin-org/pgadmin4/issues/9738>`_ - Allow copying of text from the AI Assistant chat panel.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #8992 <https://github.com/pgadmin-org/pgadmin4/issues/8992>`_ - Fixed an issue where selecting all in the Query Tool's Messages tab would select the entire page content.
|
||||||
|
| `Issue #9279 <https://github.com/pgadmin-org/pgadmin4/issues/9279>`_ - Fixed an issue where OAuth2 authentication fails with 'object has no attribute' if OAUTH2_AUTO_CREATE_USER is False.
|
||||||
|
| `Issue #9392 <https://github.com/pgadmin-org/pgadmin4/issues/9392>`_ - Ensure that the Geometry Viewer refreshes when re-running queries or switching geometry columns, preventing stale data from being displayed.
|
||||||
|
| `Issue #9457 <https://github.com/pgadmin-org/pgadmin4/issues/9457>`_ - Fixed Process Watcher garbled text on Windows with non-UTF-8 locales.
|
||||||
|
| `Issue #9570 <https://github.com/pgadmin-org/pgadmin4/issues/9570>`_ - Fixed an issue where ALT+F5 for executing a query in the Query Tool shows a crosshair cursor icon for rectangular selection.
|
||||||
|
| `Issue #9648 <https://github.com/pgadmin-org/pgadmin4/issues/9648>`_ - Fixed an issue where the default fillfactor value for B-tree indexes was incorrect.
|
||||||
|
| `Issue #9694 <https://github.com/pgadmin-org/pgadmin4/issues/9694>`_ - Fixed an issue where AI Reports are grayed out after setting an API key by auto-selecting the default provider.
|
||||||
|
| `Issue #9696 <https://github.com/pgadmin-org/pgadmin4/issues/9696>`_ - Fixed an issue where AI Assistant does not notify that No API Key or Provider is Set.
|
||||||
|
| `Issue #9702 <https://github.com/pgadmin-org/pgadmin4/issues/9702>`_ - Fixed misleading AI activity messages that could be mistaken for actual database operations.
|
||||||
|
| `Issue #9719 <https://github.com/pgadmin-org/pgadmin4/issues/9719>`_ - Fixed an issue where AI Reports fail with OpenAI models that do not support the temperature parameter.
|
||||||
|
| `Issue #9721 <https://github.com/pgadmin-org/pgadmin4/issues/9721>`_ - Fixed an issue where permissions page is not completely accessible on full scroll.
|
||||||
|
| `Issue #9729 <https://github.com/pgadmin-org/pgadmin4/issues/9729>`_ - Fixed an issue where some LLM models would not use database tools in the AI assistant, instead returning text descriptions of tool calls.
|
||||||
|
| `Issue #9732 <https://github.com/pgadmin-org/pgadmin4/issues/9732>`_ - Improve the AI Assistant user prompt to be more descriptive of the actual functionality.
|
||||||
|
| `Issue #9734 <https://github.com/pgadmin-org/pgadmin4/issues/9734>`_ - Fixed an issue where LLM responses are not streamed or rendered properly in the AI Assistant.
|
||||||
|
| `Issue #9736 <https://github.com/pgadmin-org/pgadmin4/issues/9736>`_ - Fix an issue where the AI Assistant was not retaining conversation context between messages, with chat history compaction to manage token budgets.
|
||||||
|
| `Issue #9740 <https://github.com/pgadmin-org/pgadmin4/issues/9740>`_ - Fixed an issue where the AI Assistant input textbox sometimes swallows the first character of input.
|
||||||
|
| `Issue #9758 <https://github.com/pgadmin-org/pgadmin4/issues/9758>`_ - Clarify where the LLM API key files should be.
|
||||||
|
| `Issue #9789 <https://github.com/pgadmin-org/pgadmin4/issues/9789>`_ - Fixed an issue where the Query tool kept prompting for a password when using a shared server.
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
***********
|
||||||
|
Version 9.8
|
||||||
|
***********
|
||||||
|
|
||||||
|
Release date: 2025-09-04
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.7.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16 and 17
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16 and 17
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 17.5
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #6396 <https://github.com/pgadmin-org/pgadmin4/issues/6396>`_ - Add menu items for truncating foreign tables.
|
||||||
|
| `Issue #7928 <https://github.com/pgadmin-org/pgadmin4/issues/7928>`_ - Added Debian Trixie as a supported platform for pgAdmin.
|
||||||
|
| `Issue #8891 <https://github.com/pgadmin-org/pgadmin4/issues/8891>`_ - Allow user to configure security related gunicorn parameters.
|
||||||
|
| `Issue #9093 <https://github.com/pgadmin-org/pgadmin4/issues/9093>`_ - Change the default pgAdmin theme to System.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #7448 <https://github.com/pgadmin-org/pgadmin4/issues/7448>`_ - Remove usage of BrowserFS as it is deprecated.
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #9090 <https://github.com/pgadmin-org/pgadmin4/issues/9090>`_ - Pin Paramiko to version 3.5.1 to fix the DSSKey error introduced in the latest release.
|
||||||
|
| `Issue #9095 <https://github.com/pgadmin-org/pgadmin4/issues/9095>`_ - Fixed an issue where pgAdmin config migration was failing while upgrading to v9.7.
|
||||||
|
| `Issue #9114 <https://github.com/pgadmin-org/pgadmin4/issues/9114>`_ - Fixed Cross-Origin Opener Policy (COOP) vulnerability in the OAuth 2.0 authentication flow (CVE-2025-9636).
|
||||||
|
| `Issue #9116 <https://github.com/pgadmin-org/pgadmin4/issues/9116>`_ - Fixed an issue where editor shortcuts fail when using Option key combinations on macOS, due to macOS treating Option+Key as a different key input.
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
***********
|
||||||
|
Version 9.9
|
||||||
|
***********
|
||||||
|
|
||||||
|
Release date: 2025-10-16
|
||||||
|
|
||||||
|
This release contains a number of bug fixes and new features since the release of pgAdmin 4 v9.8.
|
||||||
|
|
||||||
|
Supported Database Servers
|
||||||
|
**************************
|
||||||
|
**PostgreSQL**: 13, 14, 15, 16, 17 and 18
|
||||||
|
|
||||||
|
**EDB Advanced Server**: 13, 14, 15, 16 and 17
|
||||||
|
|
||||||
|
Bundled PostgreSQL Utilities
|
||||||
|
****************************
|
||||||
|
**psql**, **pg_dump**, **pg_dumpall**, **pg_restore**: 17.5
|
||||||
|
|
||||||
|
|
||||||
|
New features
|
||||||
|
************
|
||||||
|
|
||||||
|
| `Issue #6385 <https://github.com/pgadmin-org/pgadmin4/issues/6385>`_ - Add support of DEPENDS/NO DEPENDS ON EXTENSION for ALTER FUNCTION.
|
||||||
|
| `Issue #6394 <https://github.com/pgadmin-org/pgadmin4/issues/6394>`_ - Added "MULTIRANGE_TYPE_NAME" option while creating a Range Type.
|
||||||
|
| `Issue #6395 <https://github.com/pgadmin-org/pgadmin4/issues/6395>`_ - Added "SUBSCRIPT" option while creating a External Type.
|
||||||
|
| `Issue #6996 <https://github.com/pgadmin-org/pgadmin4/issues/6996>`_ - Added option to skip the password dialog when using an identity file.
|
||||||
|
| `Issue #8932 <https://github.com/pgadmin-org/pgadmin4/issues/8932>`_ - Added 'failover' and 'two_phase' parameter support in CREATE/ALTER SUBSCRIPTION for PostgreSQL v17+.
|
||||||
|
| `Issue #9225 <https://github.com/pgadmin-org/pgadmin4/issues/9225>`_ - Add support for initializing the pgAdmin4 Kubernetes Helm chart.
|
||||||
|
|
||||||
|
Housekeeping
|
||||||
|
************
|
||||||
|
|
||||||
|
|
||||||
|
Bug fixes
|
||||||
|
*********
|
||||||
|
|
||||||
|
| `Issue #9098 <https://github.com/pgadmin-org/pgadmin4/issues/9098>`_ - Fixed an issue where the query tool displayed 'default' instead of 'null' for null text data in the data output.
|
||||||
|
| `Issue #9125 <https://github.com/pgadmin-org/pgadmin4/issues/9125>`_ - Fixed an issue where the pgAdmin configuration database wasn't being created on a fresh install when an external database was used for the configuration.
|
||||||
|
| `Issue #9157 <https://github.com/pgadmin-org/pgadmin4/issues/9157>`_ - Fixed an issue where shortcuts are not working as expected on multiple keyboard layouts.
|
||||||
|
| `Issue #9158 <https://github.com/pgadmin-org/pgadmin4/issues/9158>`_ - Fixed an issue where saving the newly changed preferences was not reflecting on the preferences tab.
|
||||||
|
|
@ -29,6 +29,10 @@ restore process:
|
||||||
copy of the backed-up object.
|
copy of the backed-up object.
|
||||||
* Select *Plain* to restore a plain SQL backup. When selecting this option
|
* Select *Plain* to restore a plain SQL backup. When selecting this option
|
||||||
all the other options will not be applicable.
|
all the other options will not be applicable.
|
||||||
|
**Note:** The plain SQL restore process is executed in the backend using
|
||||||
|
the psql command with the \restrict option. The purpose of \restrict is to
|
||||||
|
enhance security by preventing dangerous commands embedded in a plain text
|
||||||
|
dump file from being executed on a PostgreSQL server.
|
||||||
* Select *Directory* to restore from a compressed directory-format archive.
|
* Select *Directory* to restore from a compressed directory-format archive.
|
||||||
|
|
||||||
* Enter the complete path to the backup file in the *Filename* field.
|
* Enter the complete path to the backup file in the *Filename* field.
|
||||||
|
|
@ -50,13 +54,13 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Sections** field box to specify the content that will be
|
* Move switches in the **Sections** field box to specify the content that will be
|
||||||
restored:
|
restored:
|
||||||
|
|
||||||
* Move the switch next to *Pre-data* towards right position to restore all
|
* Move the switch next to *Pre-data* to the *Yes* position to restore all
|
||||||
data definition items not included in the data or post-data item lists.
|
data definition items not included in the data or post-data item lists.
|
||||||
|
|
||||||
* Move the switch next to *Data* towards right position to restore actual
|
* Move the switch next to *Data* to the *Yes* position to restore actual
|
||||||
table data, large-object contents, and sequence values.
|
table data, large-object contents, and sequence values.
|
||||||
|
|
||||||
* Move the switch next to *Post-data* towards right position position to restore
|
* Move the switch next to *Post-data* to the *Yes* position to restore
|
||||||
definitions of indexes, triggers, rules, and constraints (other than
|
definitions of indexes, triggers, rules, and constraints (other than
|
||||||
validated check constraints).
|
validated check constraints).
|
||||||
|
|
||||||
|
|
@ -67,7 +71,7 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Type of objects** field box to specify the objects that
|
* Move switches in the **Type of objects** field box to specify the objects that
|
||||||
will be restored:
|
will be restored:
|
||||||
|
|
||||||
* Move the switch next to *Only data* towards right position to limit the
|
* Move the switch next to *Only data* to the *Yes* position to limit the
|
||||||
restoration to data.
|
restoration to data.
|
||||||
|
|
||||||
* Move the switch next to *Only schema* to limit the restoration to
|
* Move the switch next to *Only schema* to limit the restoration to
|
||||||
|
|
@ -80,29 +84,29 @@ tab to provide options related to data or pgAdmin objects that correspond to *pg
|
||||||
* Move switches in the **Do not save** box to specify which objects will not
|
* Move switches in the **Do not save** box to specify which objects will not
|
||||||
be restored:
|
be restored:
|
||||||
|
|
||||||
* Move the switch next to *Owner* towards right position to exclude commands
|
* Move the switch next to *Owner* to the *Yes* position to exclude commands
|
||||||
that set object ownership.
|
that set object ownership.
|
||||||
|
|
||||||
* Move the switch next to *Privileges* towards right position to exclude
|
* Move the switch next to *Privileges* to the *Yes* position to exclude
|
||||||
commands that create access privileges.
|
commands that create access privileges.
|
||||||
|
|
||||||
* Move the switch next to *Tablespaces* towards right position to exclude
|
* Move the switch next to *Tablespaces* to the *Yes* position to exclude
|
||||||
tablespaces.
|
tablespaces.
|
||||||
|
|
||||||
* Move the switch next to *Comments* towards right position to exclude
|
* Move the switch next to *Comments* to the *Yes* position to exclude
|
||||||
commands that set the comments. **Note:** This option is visible only for
|
commands that set the comments. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 11.
|
database server greater than or equal to 11.
|
||||||
|
|
||||||
* Move the switch next to *Publications* towards right position to exclude
|
* Move the switch next to *Publications* to the *Yes* position to exclude
|
||||||
publications.
|
publications.
|
||||||
|
|
||||||
* Move the switch next to *Subscriptions* towards right position to exclude
|
* Move the switch next to *Subscriptions* to the *Yes* position to exclude
|
||||||
subscriptions.
|
subscriptions.
|
||||||
|
|
||||||
* Move the switch next to *Security labels* towards right position to exclude
|
* Move the switch next to *Security labels* to the *Yes* position to exclude
|
||||||
Security labels.
|
Security labels.
|
||||||
|
|
||||||
* Move the switch next to *Table access methods* towards right position to exclude
|
* Move the switch next to *Table access methods* to the *Yes* position to exclude
|
||||||
Table access methods. **Note:** This option is visible only for
|
Table access methods. **Note:** This option is visible only for
|
||||||
database server greater than or equal to 15.
|
database server greater than or equal to 15.
|
||||||
|
|
||||||
|
|
@ -114,17 +118,17 @@ Click the *Query Options* tab to continue. Use these additional fields to specif
|
||||||
the type of statements that should be included in the restore:
|
the type of statements that should be included in the restore:
|
||||||
|
|
||||||
|
|
||||||
* Move the switch next to *Include CREATE DATABASE statement* towards right position
|
* Move the switch next to *Include CREATE DATABASE statement* to the *Yes* position
|
||||||
to include a command that creates a new database before performing the restore.
|
to include a command that creates a new database before performing the restore.
|
||||||
|
|
||||||
* Move the switch next to *Clean before restore* towards right position to
|
* Move the switch next to *Clean before restore* to the *Yes* position to
|
||||||
drop each existing database object (and data) before restoring.
|
drop each existing database object (and data) before restoring.
|
||||||
|
|
||||||
* Move the switch next to *Include IF EXISTS clause* towards right
|
* Move the switch next to *Include IF EXISTS clause* to the *Yes*
|
||||||
position to add an IF EXISTS clause to drop databases and other objects.
|
position to add an IF EXISTS clause to drop databases and other objects.
|
||||||
This option is not valid unless *Clean before restore* is also set.
|
This option is not valid unless *Clean before restore* is also set.
|
||||||
|
|
||||||
* Move the switch next to *Single transaction* towards right position to
|
* Move the switch next to *Single transaction* to the *Yes* position to
|
||||||
execute the restore as a single transaction (that is, wrap the emitted
|
execute the restore as a single transaction (that is, wrap the emitted
|
||||||
commands in *BEGIN/COMMIT*). This ensures that either all the commands
|
commands in *BEGIN/COMMIT*). This ensures that either all the commands
|
||||||
complete successfully, or no changes are applied. This option implies
|
complete successfully, or no changes are applied. This option implies
|
||||||
|
|
@ -137,12 +141,12 @@ the type of statements that should be included in the restore:
|
||||||
Click the *Table Options* tab to continue. Use the fields in the *Table Options*
|
Click the *Table Options* tab to continue. Use the fields in the *Table Options*
|
||||||
tab related to tables that should be included in the backup.
|
tab related to tables that should be included in the backup.
|
||||||
|
|
||||||
* Move the switch next to *Enable row security* towards right position to
|
* Move the switch next to *Enable row security* to the *Yes* position to
|
||||||
set row_security to on instead, allowing the user to dump the parts of the
|
set row_security to on instead, allowing the user to dump the parts of the
|
||||||
contents of the table that they have access to. This option is relevant
|
contents of the table that they have access to. This option is relevant
|
||||||
only when dumping the contents of a table which has row security.
|
only when dumping the contents of a table which has row security.
|
||||||
|
|
||||||
* Move the switch next to *No data for failed tables* towards right position
|
* Move the switch next to *No data for failed tables* to the *Yes* position
|
||||||
to ignore data that fails a trigger.
|
to ignore data that fails a trigger.
|
||||||
|
|
||||||
Click the *Options* tab to continue. Use the fields in the *Options*
|
Click the *Options* tab to continue. Use the fields in the *Options*
|
||||||
|
|
@ -156,20 +160,20 @@ tab to provide other restore options.
|
||||||
should be excluded from the restore:
|
should be excluded from the restore:
|
||||||
|
|
||||||
* Move the switch next to *Triggers* (active when creating a data-only
|
* Move the switch next to *Triggers* (active when creating a data-only
|
||||||
restore) towards right position to include commands that will disable
|
restore) to the *Yes* position to include commands that will disable
|
||||||
triggers on the target table while the data is being loaded.
|
triggers on the target table while the data is being loaded.
|
||||||
|
|
||||||
* Move switches in the **Miscellaneous/Behavior** box to specify
|
* Move switches in the **Miscellaneous/Behavior** box to specify
|
||||||
miscellaneous restore options:
|
miscellaneous restore options:
|
||||||
|
|
||||||
* Move the switch next to *Verbose messages* towards left to instruct
|
* Move the switch next to *Verbose messages* to the *No* position to instruct
|
||||||
*pg_restore* to exclude verbose messages.
|
*pg_restore* to exclude verbose messages.
|
||||||
|
|
||||||
* Move the switch next to *Use SET SESSION AUTHORIZATION* towards right position
|
* Move the switch next to *Use SET SESSION AUTHORIZATION* to the *Yes* position
|
||||||
to include a statement that will use a SET SESSION AUTHORIZATION
|
to include a statement that will use a SET SESSION AUTHORIZATION
|
||||||
command to determine object ownership (instead of an ALTER OWNER command).
|
command to determine object ownership (instead of an ALTER OWNER command).
|
||||||
|
|
||||||
* Move the switch next to *Exit on error* towards right position to instruct
|
* Move the switch next to *Exit on error* to the *Yes* position to instruct
|
||||||
*pg_restore* to exit restore if there is an error in sending SQL commands.
|
*pg_restore* to exit restore if there is an error in sending SQL commands.
|
||||||
The default is to continue and to display a count of errors at the end of
|
The default is to continue and to display a count of errors at the end of
|
||||||
the restore.
|
the restore.
|
||||||
|
|
@ -182,6 +186,6 @@ command, click the *Restore* button to start the process, or click the *Cancel*
|
||||||
button to exit without saving your work. A popup will confirm if the restore is
|
button to exit without saving your work. A popup will confirm if the restore is
|
||||||
successful.
|
successful.
|
||||||
|
|
||||||
pgAdmin will run the restore process in background. You can view all the background
|
pgAdmin will run the restore process in the background. You can view all the background
|
||||||
process with there running status and logs on the :ref:`Processes <processes>`
|
processes with their running status and logs on the :ref:`Processes <processes>`
|
||||||
tab
|
tab.
|
||||||
|
|
|
||||||
|
|
@ -65,15 +65,26 @@ Use the *Privileges* tab to grant privileges to the role.
|
||||||
* Move the *Bypass RLS?* switch to the *Yes* position to control whether a
|
* Move the *Bypass RLS?* switch to the *Yes* position to control whether a
|
||||||
role can bypasses every row-level security (RLS) policy. The default value is *No*.
|
role can bypasses every row-level security (RLS) policy. The default value is *No*.
|
||||||
|
|
||||||
|
Click the *Membership* tab to continue.
|
||||||
|
|
||||||
.. image:: images/role_membership.png
|
.. image:: images/role_membership.png
|
||||||
:alt: Role dialog membership tab
|
:alt: Role dialog membership tab
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
* Specify member of the role in the *Member of* field and specify the members in the *Member* field.
|
Use the *Membership* tab to define role memberships. A role can be a member of
|
||||||
Confirm each selection by checking the checkbox to the right of the role name;
|
other roles and can have other roles as members.
|
||||||
delete a selection by clicking the *x* to the left of the role name.
|
|
||||||
Membership conveys the privileges granted to the specified role to each of
|
* Use *Member of* section to specify roles of which the current role
|
||||||
its members.
|
is a member. To assign *Admin Option* for a selected role, click on
|
||||||
|
the appropriate checkbox.
|
||||||
|
* Use *Members* section to specify roles that are members of the current
|
||||||
|
role. To assign *Admin Option* for a selected role, click on the appropriate checkbox.
|
||||||
|
|
||||||
|
Click the *Add* icon (+) to add more roles; to discard a
|
||||||
|
role, click the trash icon to the left of the row and confirm the deletion
|
||||||
|
in the *Delete Row* popup.
|
||||||
|
|
||||||
|
**Note:** Apart from *Admin Option*, *Inherit Option* and *Set Option* are available for both *Member of* section and *Members* section from PostgreSQL version >= 16.
|
||||||
|
|
||||||
Click the *Parameters* tab to continue.
|
Click the *Parameters* tab to continue.
|
||||||
|
|
||||||
|
|
@ -105,7 +116,7 @@ Use the *Security* tab to define security labels applied to the role. Click the
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -49,7 +49,7 @@ panel:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -79,13 +79,13 @@ same or different (and within the same server or from different servers).
|
||||||
|
|
||||||
Use the drop-down near to *Compare* button to ignore owner, whitespace, tablespace and grants.
|
Use the drop-down near to *Compare* button to ignore owner, whitespace, tablespace and grants.
|
||||||
|
|
||||||
* Ignore Owner – Select to ignores the owner while comparing the objects.
|
* Ignore Owner – Select to ignore the owner while comparing the objects.
|
||||||
|
|
||||||
* Ignore Whitespace – Select to ignores the whitespace while comparing the string objects. Whitespace includes space, tabs, and CRLF.
|
* Ignore Whitespace – Select to ignore the whitespace while comparing the string objects. Whitespace includes space, tabs, and CRLF.
|
||||||
|
|
||||||
* Ignore Tablespace – Select to ignores the tablespace while comparing the objects.
|
* Ignore Tablespace – Select to ignore the tablespace while comparing the objects.
|
||||||
|
|
||||||
* Ignore Grant/Revoke – Select to ignores the grant and revoke command while comparing the objects.
|
* Ignore Grant/Revoke – Select to ignore the grant and revoke command while comparing the objects.
|
||||||
|
|
||||||
After you select servers, and databases, click on the
|
After you select servers, and databases, click on the
|
||||||
*Compare* button to obtain the *Comparison Result*.
|
*Compare* button to obtain the *Comparison Result*.
|
||||||
|
|
|
||||||
|
|
@ -55,11 +55,11 @@ Use the fields in the *Definition* tab to define the sequence:
|
||||||
to be preallocated and stored in memory for faster access. The minimum value
|
to be preallocated and stored in memory for faster access. The minimum value
|
||||||
is 1 (only one value can be generated at a time, i.e., no cache), and this is
|
is 1 (only one value can be generated at a time, i.e., no cache), and this is
|
||||||
also the default.
|
also the default.
|
||||||
* Move the switch next to *Cycled* towards the *right position* to allow the sequence to wrap
|
* Move the switch next to *Cycled* to the *Yes* position to allow the sequence to wrap
|
||||||
around when the MAXVALUE or the MINVALUE has been reached by an ascending or
|
around when the MAXVALUE or the MINVALUE has been reached by an ascending or
|
||||||
descending sequence respectively. If the limit is reached, the next number
|
descending sequence respectively. If the limit is reached, the next number
|
||||||
generated will be the MINVALUE or MAXVALUE, respectively. The default is *No*.
|
generated will be the MINVALUE or MAXVALUE, respectively. The default is *No*.
|
||||||
* Move the switch next to *Unlogged?* towards the *right position* to make the sequence Unlogged.
|
* Move the switch next to *Unlogged?* to the *Yes* position to make the sequence Unlogged.
|
||||||
The default is *No*. This option is available only on PostgreSQL 15 and above.
|
The default is *No*. This option is available only on PostgreSQL 15 and above.
|
||||||
* The *OWNED BY* option causes the sequence to be associated with a specific
|
* The *OWNED BY* option causes the sequence to be associated with a specific
|
||||||
table column, such that if that column (or its whole table) is dropped, the
|
table column, such that if that column (or its whole table) is dropped, the
|
||||||
|
|
@ -93,7 +93,7 @@ sequence. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
@ -104,7 +104,7 @@ in the *Delete Row* popup.
|
||||||
|
|
||||||
Click the *SQL* tab to continue.
|
Click the *SQL* tab to continue.
|
||||||
|
|
||||||
Your entries in the *Sequence* dialog generate a generate a SQL command (see an
|
Your entries in the *Sequence* dialog generate a SQL command (see an
|
||||||
example below). Use the *SQL* tab for review; revisit or switch tabs to make any
|
example below). Use the *SQL* tab for review; revisit or switch tabs to make any
|
||||||
changes to the SQL command.
|
changes to the SQL command.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -177,6 +177,9 @@ not be able to connect directly.
|
||||||
*Identity file* field to specify the location of the key file.
|
*Identity file* field to specify the location of the key file.
|
||||||
* If the SSH host is expecting a password of the user name or an identity file
|
* If the SSH host is expecting a password of the user name or an identity file
|
||||||
if being used, use the *Password* field to specify the password.
|
if being used, use the *Password* field to specify the password.
|
||||||
|
* Check the box next to *Prompt for password?* to to have pgAdmin prompt for
|
||||||
|
a password if the identity file includes one. This setting applies only when
|
||||||
|
using an identity file, which may or may not require a password.
|
||||||
* Check the box next to *Save password?* to instruct pgAdmin to save the
|
* Check the box next to *Save password?* to instruct pgAdmin to save the
|
||||||
password for future use. Use
|
password for future use. Use
|
||||||
:ref:`Clear SSH Tunnel Password <clear_saved_passwords>` to remove the saved
|
:ref:`Clear SSH Tunnel Password <clear_saved_passwords>` to remove the saved
|
||||||
|
|
|
||||||
|
|
@ -106,6 +106,7 @@ Use the *With* tab to define some parameters for a subscription:
|
||||||
* Move the *Run as owner?* switch to *true* position to specify all replication actions are performed as the subscription owner. If *false*, replication workers will perform actions on each table as the owner of that table. The default is *false*. This option is available only on PostgreSQL 16 and above.
|
* Move the *Run as owner?* switch to *true* position to specify all replication actions are performed as the subscription owner. If *false*, replication workers will perform actions on each table as the owner of that table. The default is *false*. This option is available only on PostgreSQL 16 and above.
|
||||||
* Use the *Password required?* to specify whether connections to the publisher made as a result of this subscription must use password authentication. This setting is ignored when the subscription is owned by a superuser. The default is true. Only superusers can set this value to *false*. This option is available only on PostgreSQL 16 and above.
|
* Use the *Password required?* to specify whether connections to the publisher made as a result of this subscription must use password authentication. This setting is ignored when the subscription is owned by a superuser. The default is true. Only superusers can set this value to *false*. This option is available only on PostgreSQL 16 and above.
|
||||||
* Use the *Origin* to specify whether the subscription will request the publisher to only send changes that don't have an origin or send changes regardless of origin. The default is *any*. This option is available only on PostgreSQL 16 and above.
|
* Use the *Origin* to specify whether the subscription will request the publisher to only send changes that don't have an origin or send changes regardless of origin. The default is *any*. This option is available only on PostgreSQL 16 and above.
|
||||||
|
* Use the *Failover* to specify whether the replication slots associated with the subscription are enabled to be synced to the standbys so that logical replication can be resumed from the new primary after failover. The default is false. This option is available only on PostgreSQL 17 and above.
|
||||||
|
|
||||||
Click the *SQL* tab to continue.
|
Click the *SQL* tab to continue.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -421,20 +421,20 @@ not-null constraints; after saving the new or modified table, any changes to
|
||||||
the original table will not be applied to the new table.
|
the original table will not be applied to the new table.
|
||||||
|
|
||||||
* Use the drop-down listbox next to *Relation* to select a reference table.
|
* Use the drop-down listbox next to *Relation* to select a reference table.
|
||||||
* Move the switch next to *With default values?* towards the *right position* to copy default
|
* Move the switch next to *With default values?* to the *Yes* position to copy default
|
||||||
values.
|
values.
|
||||||
* Move the switch next to *With constraints?* towards the *right position* to copy table and
|
* Move the switch next to *With constraints?* to the *Yes* position to copy table and
|
||||||
column constraints.
|
column constraints.
|
||||||
* Move the switch next to *With indexes?* towards the *right position* to copy indexes.
|
* Move the switch next to *With indexes?* to the *Yes* position to copy indexes.
|
||||||
* Move the switch next to *With storage?* towards the *right position* to copy storage settings.
|
* Move the switch next to *With storage?* to the *Yes* position to copy storage settings.
|
||||||
* Move the switch next to *With comments?* towards the *right position* to copy comments.
|
* Move the switch next to *With comments?* to the *Yes* position to copy comments.
|
||||||
* Move the switch next to *With compression?* towards the *right position* to copy
|
* Move the switch next to *With compression?* to the *Yes* position to copy
|
||||||
compression method. This option is available only on PostgreSQL 14 and above.
|
compression method. This option is available only on PostgreSQL 14 and above.
|
||||||
* Move the switch next to *With generated?* towards the *right position* to copy
|
* Move the switch next to *With generated?* to the *Yes* position to copy
|
||||||
generation expressions of copied column. This option is available only on PostgreSQL 12 and above.
|
generation expressions of copied column. This option is available only on PostgreSQL 12 and above.
|
||||||
* Move the switch next to *With identity?* towards the *right position* to copy
|
* Move the switch next to *With identity?* to the *Yes* position to copy
|
||||||
any identity specifications of copied column.
|
any identity specifications of copied column.
|
||||||
* Move the switch next to *With statistics?* towards the *right position* to copy
|
* Move the switch next to *With statistics?* to the *Yes* position to copy
|
||||||
extended statistics.
|
extended statistics.
|
||||||
|
|
||||||
With PostgreSQL 10 forward, the *Partition* tab will be visible.
|
With PostgreSQL 10 forward, the *Partition* tab will be visible.
|
||||||
|
|
@ -531,7 +531,7 @@ function. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -75,7 +75,7 @@ tablespace. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -139,7 +139,7 @@ function. Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -109,17 +109,17 @@ On the *Optional-1* tab:
|
||||||
to select a type_modifier_output_function. It is allowed to omit the
|
to select a type_modifier_output_function. It is allowed to omit the
|
||||||
type_modifier_output_function, in which case the default display format is the
|
type_modifier_output_function, in which case the default display format is the
|
||||||
stored typmod integer value enclosed in parentheses.
|
stored typmod integer value enclosed in parentheses.
|
||||||
|
* Use the drop-down listbox next to the optional *Analyze function* field to
|
||||||
|
select a function for performing type-specific statistics collection for
|
||||||
|
columns of the data type.
|
||||||
|
* Use the drop-down listbox next to the optional *Subscript function* field to
|
||||||
|
select a function for allows the data type to be subscripted in SQL commands.
|
||||||
* Use the optional *Internal length* to specify a value for internal
|
* Use the optional *Internal length* to specify a value for internal
|
||||||
representation.
|
representation.
|
||||||
* Move the *Variable?* switch to specify the internal representation is of
|
|
||||||
variable length (VARIABLE). The default is a fixed length positive integer.
|
|
||||||
* Specify a default value in the optional *Default* field in cases where a
|
* Specify a default value in the optional *Default* field in cases where a
|
||||||
column of the data type defaults to something other than the null value.
|
column of the data type defaults to something other than the null value.
|
||||||
Specify the default with the DEFAULT key word. (A default can be overridden
|
Specify the default with the DEFAULT key word. (A default can be overridden
|
||||||
by an explicit DEFAULT clause attached to a particular column.)
|
by an explicit DEFAULT clause attached to a particular column.)
|
||||||
* Use the drop-down listbox next to the optional *Analyze function* field to
|
|
||||||
select a function for performing type-specific statistics collection for
|
|
||||||
columns of the data type.
|
|
||||||
* Use the drop-down listbox next to the optional *Category type* field to help
|
* Use the drop-down listbox next to the optional *Category type* field to help
|
||||||
control which implicit cast will be applied in ambiguous situations.
|
control which implicit cast will be applied in ambiguous situations.
|
||||||
* Move the *Preferred?* switch to *Yes* to specify the selected category type is
|
* Move the *Preferred?* switch to *Yes* to specify the selected category type is
|
||||||
|
|
@ -162,6 +162,9 @@ disabled.
|
||||||
values to a canonical form.
|
values to a canonical form.
|
||||||
* Use the drop-down listbox next to *Sub-type diff function* to select a
|
* Use the drop-down listbox next to *Sub-type diff function* to select a
|
||||||
user-defined subtype_diff function.
|
user-defined subtype_diff function.
|
||||||
|
* Specify the optional *Multirange type name* parameter to specify the
|
||||||
|
name of the corresponding multirange type. If not specified, this name is
|
||||||
|
chosen automatically.
|
||||||
|
|
||||||
If you select *Shell* in the *Type* field, the *Definition* tab displays the
|
If you select *Shell* in the *Type* field, the *Definition* tab displays the
|
||||||
*Shell* panel:
|
*Shell* panel:
|
||||||
|
|
|
||||||
|
|
@ -270,6 +270,50 @@ username/email address.
|
||||||
/path/to/python /path/to/setup.py get-users --username user1@gmail.com
|
/path/to/python /path/to/setup.py get-users --username user1@gmail.com
|
||||||
|
|
||||||
|
|
||||||
|
Load Users
|
||||||
|
**********
|
||||||
|
|
||||||
|
To bulk import users from a JSON file, invoke ``setup.py`` with ``load-users`` command line option,
|
||||||
|
followed by the path to the JSON file.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
/path/to/python /path/to/setup.py load-users /path/to/users.json
|
||||||
|
|
||||||
|
**JSON File Format**
|
||||||
|
|
||||||
|
The input JSON file must contain a ``users`` array with user objects:
|
||||||
|
|
||||||
|
.. code-block:: json
|
||||||
|
|
||||||
|
{
|
||||||
|
"users": [
|
||||||
|
{
|
||||||
|
"username": "admin@example.com",
|
||||||
|
"email": "admin@example.com",
|
||||||
|
"password": "securepassword",
|
||||||
|
"role": "Administrator",
|
||||||
|
"active": true,
|
||||||
|
"auth_source": "internal"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"username": "ldap_user",
|
||||||
|
"email": "ldap_user@example.com",
|
||||||
|
"role": "User",
|
||||||
|
"active": true,
|
||||||
|
"auth_source": "ldap"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
The command handles errors gracefully:
|
||||||
|
|
||||||
|
* Users that already exist are skipped
|
||||||
|
* Invalid roles are reported and skipped
|
||||||
|
* Missing passwords for internal auth are reported and skipped
|
||||||
|
* Passwords shorter than 6 characters are reported and skipped
|
||||||
|
|
||||||
|
|
||||||
Output
|
Output
|
||||||
******
|
******
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -86,7 +86,7 @@ Click the *Add* icon (+) to add each security label selection:
|
||||||
|
|
||||||
* Specify a security label provider in the *Provider* field. The named provider
|
* Specify a security label provider in the *Provider* field. The named provider
|
||||||
must be loaded and must consent to the proposed labeling operation.
|
must be loaded and must consent to the proposed labeling operation.
|
||||||
* Specify a a security label in the *Security Label* field. The meaning of a
|
* Specify a security label in the *Security Label* field. The meaning of a
|
||||||
given label is at the discretion of the label provider. PostgreSQL places no
|
given label is at the discretion of the label provider. PostgreSQL places no
|
||||||
restrictions on whether or how a label provider must interpret security
|
restrictions on whether or how a label provider must interpret security
|
||||||
labels; it merely provides a mechanism for storing them.
|
labels; it merely provides a mechanism for storing them.
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@ Debian and Ubuntu.
|
||||||
|
|
||||||
## Supported platforms
|
## Supported platforms
|
||||||
|
|
||||||
* Debian 11 & 12
|
* Debian 11, 12 & 13
|
||||||
* Ubuntu 22.04, 24.04 & 24.10
|
* Ubuntu 22.04, 24.04 & 25.04
|
||||||
|
|
||||||
## Build configuration
|
## Build configuration
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,8 @@ set -e
|
||||||
trap 'ERRCODE=$? && if [ ${ERRCODE} -ne 0 ]; then echo "The command \"${BASH_COMMAND}\" failed in \"${FUNCNAME}\" with exit code ${ERRCODE}."; fi' EXIT
|
trap 'ERRCODE=$? && if [ ${ERRCODE} -ne 0 ]; then echo "The command \"${BASH_COMMAND}\" failed in \"${FUNCNAME}\" with exit code ${ERRCODE}."; fi' EXIT
|
||||||
|
|
||||||
OS_ARCH=$(dpkg-architecture -qDEB_HOST_ARCH)
|
OS_ARCH=$(dpkg-architecture -qDEB_HOST_ARCH)
|
||||||
|
DISTRO=$(lsb_release -cs)
|
||||||
|
RELEASE=1
|
||||||
|
|
||||||
# Stop creating pyc files.
|
# Stop creating pyc files.
|
||||||
export PYTHONDONTWRITEBYTECODE=1
|
export PYTHONDONTWRITEBYTECODE=1
|
||||||
|
|
@ -58,7 +60,7 @@ EOF
|
||||||
|
|
||||||
# Build the Debian package for the server
|
# Build the Debian package for the server
|
||||||
chmod -R u+rwX,go+rX,go-w "${SERVERROOT}"
|
chmod -R u+rwX,go+rX,go-w "${SERVERROOT}"
|
||||||
fakeroot dpkg-deb --build "${SERVERROOT}" "${DISTROOT}/${APP_NAME}-server_${APP_LONG_VERSION}_${OS_ARCH}.deb"
|
fakeroot dpkg-deb --build "${SERVERROOT}" "${DISTROOT}/${APP_NAME}-server_${APP_LONG_VERSION}-${RELEASE}.${DISTRO}_${OS_ARCH}.deb"
|
||||||
|
|
||||||
#
|
#
|
||||||
# Desktop package
|
# Desktop package
|
||||||
|
|
@ -84,7 +86,11 @@ EOF
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
|
|
||||||
echo "Load apparmor pgAdmin profile..."
|
echo "Load apparmor pgAdmin profile..."
|
||||||
apparmor_parser -r /etc/apparmor.d/pgadmin4
|
if command -v apparmor_parser >/dev/null 2>&1; then
|
||||||
|
apparmor_parser -r /etc/apparmor.d/pgadmin4
|
||||||
|
else
|
||||||
|
echo "Warning: apparmor_parser not found, skipping profile load. pgAdmin desktop may not work on Ubuntu 24+ with userns restrictions."
|
||||||
|
fi
|
||||||
EOF
|
EOF
|
||||||
chmod 755 "${DESKTOPROOT}/DEBIAN/postinst"
|
chmod 755 "${DESKTOPROOT}/DEBIAN/postinst"
|
||||||
fi
|
fi
|
||||||
|
|
@ -102,7 +108,7 @@ EOF
|
||||||
|
|
||||||
# Build the Debian package for the desktop
|
# Build the Debian package for the desktop
|
||||||
chmod -R u+rwX,go+rX,go-w "${DESKTOPROOT}"
|
chmod -R u+rwX,go+rX,go-w "${DESKTOPROOT}"
|
||||||
fakeroot dpkg-deb --build "${DESKTOPROOT}" "${DISTROOT}/${APP_NAME}-desktop_${APP_LONG_VERSION}_${OS_ARCH}.deb"
|
fakeroot dpkg-deb --build "${DESKTOPROOT}" "${DISTROOT}/${APP_NAME}-desktop_${APP_LONG_VERSION}-${RELEASE}.${DISTRO}_${OS_ARCH}.deb"
|
||||||
|
|
||||||
#
|
#
|
||||||
# Web package
|
# Web package
|
||||||
|
|
@ -132,7 +138,7 @@ cp "${SOURCEDIR}/pkg/debian/pgadmin4.conf" "${WEBROOT}/etc/apache2/conf-availabl
|
||||||
|
|
||||||
# Build the Debian package for the web
|
# Build the Debian package for the web
|
||||||
chmod -R u+rwX,go+rX,go-w "${WEBROOT}"
|
chmod -R u+rwX,go+rX,go-w "${WEBROOT}"
|
||||||
fakeroot dpkg-deb --build "${WEBROOT}" "${DISTROOT}/${APP_NAME}-web_${APP_LONG_VERSION}_all.deb"
|
fakeroot dpkg-deb --build "${WEBROOT}" "${DISTROOT}/${APP_NAME}-web_${APP_LONG_VERSION}-${RELEASE}.${DISTRO}_all.deb"
|
||||||
|
|
||||||
#
|
#
|
||||||
# Meta package
|
# Meta package
|
||||||
|
|
@ -154,7 +160,7 @@ Description: Installs all required components to run pgAdmin in desktop and web
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
# Build the Debian meta package
|
# Build the Debian meta package
|
||||||
fakeroot dpkg-deb --build "${METAROOT}" "${DISTROOT}/${APP_NAME}_${APP_LONG_VERSION}_all.deb"
|
fakeroot dpkg-deb --build "${METAROOT}" "${DISTROOT}/${APP_NAME}_${APP_LONG_VERSION}-${RELEASE}.${DISTRO}_all.deb"
|
||||||
|
|
||||||
# Get the libpq package
|
# Get the libpq package
|
||||||
pushd "${DISTROOT}" 1> /dev/null
|
pushd "${DISTROOT}" 1> /dev/null
|
||||||
|
|
|
||||||
|
|
@ -23,6 +23,10 @@ function file_env() {
|
||||||
local val="$def"
|
local val="$def"
|
||||||
if [ "${!var:-}" ]; then
|
if [ "${!var:-}" ]; then
|
||||||
val="${!var}"
|
val="${!var}"
|
||||||
|
elif [ "${!fileVar:-}" ] && [ ! -r "${!fileVar}" ]; then
|
||||||
|
printf >&2 'error: %s is set to "%s" but the file does not exist or is not readable\n' \
|
||||||
|
"$fileVar" "${!fileVar}"
|
||||||
|
exit 1
|
||||||
elif [ "${!fileVar:-}" ]; then
|
elif [ "${!fileVar:-}" ]; then
|
||||||
val="$(< "${!fileVar}")"
|
val="$(< "${!fileVar}")"
|
||||||
fi
|
fi
|
||||||
|
|
@ -48,7 +52,8 @@ CA_FILE = '/etc/ssl/certs/ca-certificates.crt'
|
||||||
LOG_FILE = '/dev/null'
|
LOG_FILE = '/dev/null'
|
||||||
HELP_PATH = '../../docs'
|
HELP_PATH = '../../docs'
|
||||||
DEFAULT_BINARY_PATHS = {
|
DEFAULT_BINARY_PATHS = {
|
||||||
'pg': '/usr/local/pgsql-17',
|
'pg': '/usr/local/pgsql-18',
|
||||||
|
'pg-18': '/usr/local/pgsql-18',
|
||||||
'pg-17': '/usr/local/pgsql-17',
|
'pg-17': '/usr/local/pgsql-17',
|
||||||
'pg-16': '/usr/local/pgsql-16',
|
'pg-16': '/usr/local/pgsql-16',
|
||||||
'pg-15': '/usr/local/pgsql-15',
|
'pg-15': '/usr/local/pgsql-15',
|
||||||
|
|
@ -60,9 +65,14 @@ EOF
|
||||||
# This is a bit kludgy, but necessary as the container uses BusyBox/ash as
|
# This is a bit kludgy, but necessary as the container uses BusyBox/ash as
|
||||||
# it's shell and not bash which would allow a much cleaner implementation
|
# it's shell and not bash which would allow a much cleaner implementation
|
||||||
for var in $(env | grep "^PGADMIN_CONFIG_" | cut -d "=" -f 1); do
|
for var in $(env | grep "^PGADMIN_CONFIG_" | cut -d "=" -f 1); do
|
||||||
# shellcheck disable=SC2086
|
# Get the raw value
|
||||||
# shellcheck disable=SC2046
|
val=$(eval "echo \"\$$var\"")
|
||||||
echo ${var#PGADMIN_CONFIG_} = $(eval "echo \$$var") >> "${CONFIG_DISTRO_FILE_PATH}"
|
# This normalization step is what makes 'true', 'True'
|
||||||
|
case "$(echo "$val" | tr '[:upper:]' '[:lower:]')" in
|
||||||
|
true) val="True" ;;
|
||||||
|
false) val="False" ;;
|
||||||
|
esac
|
||||||
|
echo "${var#PGADMIN_CONFIG_} = $val" >> "${CONFIG_DISTRO_FILE_PATH}"
|
||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
@ -188,5 +198,5 @@ fi
|
||||||
if [ -n "${PGADMIN_ENABLE_TLS}" ]; then
|
if [ -n "${PGADMIN_ENABLE_TLS}" ]; then
|
||||||
exec /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --timeout "${TIMEOUT}" --bind "${BIND_ADDRESS}" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" --keyfile /certs/server.key --certfile /certs/server.cert -c gunicorn_config.py run_pgadmin:app
|
exec /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --timeout "${TIMEOUT}" --bind "${BIND_ADDRESS}" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" --keyfile /certs/server.key --certfile /certs/server.cert -c gunicorn_config.py run_pgadmin:app
|
||||||
else
|
else
|
||||||
exec /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --timeout "${TIMEOUT}" --bind "${BIND_ADDRESS}" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" -c gunicorn_config.py run_pgadmin:app
|
exec /venv/bin/gunicorn --limit-request-line "${GUNICORN_LIMIT_REQUEST_LINE:-8190}" --limit-request-fields "${GUNICORN_LIMIT_REQUEST_FIELDS:-100}" --limit-request-field_size "${GUNICORN_LIMIT_REQUEST_FIELD_SIZE:-8190}" --timeout "${TIMEOUT}" --bind "${BIND_ADDRESS}" -w 1 --threads "${GUNICORN_THREADS:-25}" --access-logfile "${GUNICORN_ACCESS_LOGFILE:--}" -c gunicorn_config.py run_pgadmin:app
|
||||||
fi
|
fi
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,45 @@
|
||||||
|
# PgAdmin4 K8S Helm Chart
|
||||||
|
|
||||||
|
Its been a struggle to deploy pgadmin4 container on different restricted k8s distributions for example openshift, gke or vanilla k8s pod security standards.
|
||||||
|
This helm chart follows best security measures and practices and compatible with all different security contexts and restrictions.
|
||||||
|
Further explanation about the security implementation can be read here: https://korenp1.github.io
|
||||||
|
|
||||||
|
The helm chart also implements most pgadmin4 features, for instance, config_local.py, predefined server definitions or preferences.
|
||||||
|
|
||||||
|
The majority of features and values are covered in the helm chart but always can be more customable or tpl'able, open for contributions.
|
||||||
|
|
||||||
|
### Package && Push
|
||||||
|
The chart should dump its version and appVersion in the Chart.yaml file every release and pushed to docker.io/dpage repository.
|
||||||
|
`helm package . && helm push pgadmin4-helm-<VERSION>.tgz oci://docker.io/dpage`
|
||||||
|
|
||||||
|
### Installation Example:
|
||||||
|
`helm install mypgadmin4 oci://docker.io/dpage/pgadmin4-helm --set ingress.enabled=true`
|
||||||
|
|
||||||
|
### Important Values
|
||||||
|
| Value | Description | Default |
|
||||||
|
| --------- | ----------- | ------- |
|
||||||
|
| `containerPort` | Internal PgAdmin4 Port | `5050` |
|
||||||
|
| `image.registry` | Image registry | `"docker.io"` |
|
||||||
|
| `image.repository` | Image Repository | `"dpage/pgadmin4"` |
|
||||||
|
| `image.tag` | Image tag (If empty, will use .Chart.AppVersion) | `""` |
|
||||||
|
| `auth.email` | Admin Email | `"admin@pgadmin.org"` |
|
||||||
|
| `auth.password` | Admin password (If both auth.password and auth.existingSecret are empty, the password will be randomly generated) | `""` |
|
||||||
|
| `auth.existingSecret` | Existing secret name for admin password (If both auth.password and auth.existingSecret are empty, the password will be randomly generated) | `""` |
|
||||||
|
| `extraEnvVars` | Extra environment variables | `[]` |
|
||||||
|
| `config_local.enabled` | Whether to mount config_local.py file | `false` |
|
||||||
|
| `config_local.data` | config_local.py configuration content | `""` |
|
||||||
|
| `config_local.existingSecret` | Existing secret name containing config_local.py file | `""` |
|
||||||
|
| `serverDefinitions.enabled` | Whether to mount servers.json | `false` |
|
||||||
|
| `serverDefinitions.data` | Server definitions to import | `{}` |
|
||||||
|
| `preferences.enabled` | Whether to mount preferences.json | `false` |
|
||||||
|
| `preferences.data` | Preferences to load | `{}` |
|
||||||
|
| `resources.*` | Allocated requests and limits resources | `{"requests": {...}, "limits": {...}}` |
|
||||||
|
| `persistence.enabled` | PVC resource creation | `true` |
|
||||||
|
| `service.type` | Service type | `"ClusterIP"` |
|
||||||
|
| `service.loadBalancerIP` | Load balancer IP (Only if service.type is LoadBalancer) | `""` |
|
||||||
|
| `ingress.enabled` | Ingress resource creation | `false` |
|
||||||
|
| `ingress.hostname` | Ingress resource hostname | `"pgadmin4.local"` |
|
||||||
|
| `ingress.tlsSecret` | Ingress tls secret name | `""` |
|
||||||
|
| `strategy.type` | Deployment strategy type (RollingUpdate or Recreate) | Kubernetes default (RollingUpdate) |
|
||||||
|
| `strategy.rollingUpdate.maxSurge` | Maximum number of pods that can be created over the desired replicas | Kubernetes default (25%) |
|
||||||
|
| `strategy.rollingUpdate.maxUnavailable` | Maximum number of pods that can be unavailable during the update | Kubernetes default (25%) |
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
Thanks for using PgAdmin4 Helm Chart :)
|
||||||
|
|
||||||
|
Image: {{ template "pgadmin4.image" . }}
|
||||||
|
|
||||||
|
Credentials:
|
||||||
|
Email: {{ .Values.auth.email }}
|
||||||
|
Password: {{ printf "kubectl get secret %s -n %s -o jsonpath='{.data.%s}' | base64 -d" (include "pgadmin4.fullname" .) .Release.Namespace .Values.auth.passwordKey }}
|
||||||
|
|
||||||
|
Ingress: {{ ternary (tpl .Values.ingress.hostname .) "DISABLED" .Values.ingress.enabled }}
|
||||||
|
|
||||||
|
GOOD LUCK!
|
||||||