Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- pgsql/pgAdmin 4/docs/en_US/html/.buildinfo +4 -0
- pgsql/pgAdmin 4/docs/en_US/html/add_restore_point_dialog.html +146 -0
- pgsql/pgAdmin 4/docs/en_US/html/backup_and_restore.html +138 -0
- pgsql/pgAdmin 4/docs/en_US/html/backup_dialog.html +384 -0
- pgsql/pgAdmin 4/docs/en_US/html/backup_globals_dialog.html +157 -0
- pgsql/pgAdmin 4/docs/en_US/html/backup_server_dialog.html +292 -0
- pgsql/pgAdmin 4/docs/en_US/html/cast_dialog.html +197 -0
- pgsql/pgAdmin 4/docs/en_US/html/change_ownership.html +155 -0
- pgsql/pgAdmin 4/docs/en_US/html/change_password_dialog.html +164 -0
- pgsql/pgAdmin 4/docs/en_US/html/change_user_password.html +173 -0
- pgsql/pgAdmin 4/docs/en_US/html/check_dialog.html +180 -0
- pgsql/pgAdmin 4/docs/en_US/html/clear_saved_passwords.html +146 -0
- pgsql/pgAdmin 4/docs/en_US/html/cloud_aws_rds.html +189 -0
- pgsql/pgAdmin 4/docs/en_US/html/cloud_azure_database.html +205 -0
- pgsql/pgAdmin 4/docs/en_US/html/cloud_deployment.html +146 -0
- pgsql/pgAdmin 4/docs/en_US/html/cloud_edb_biganimal.html +193 -0
- pgsql/pgAdmin 4/docs/en_US/html/cloud_google_cloud_sql.html +204 -0
- pgsql/pgAdmin 4/docs/en_US/html/code_overview.html +343 -0
- pgsql/pgAdmin 4/docs/en_US/html/code_review.html +177 -0
- pgsql/pgAdmin 4/docs/en_US/html/code_snippets.html +733 -0
- pgsql/pgAdmin 4/docs/en_US/html/coding_standards.html +272 -0
- pgsql/pgAdmin 4/docs/en_US/html/collation_dialog.html +236 -0
- pgsql/pgAdmin 4/docs/en_US/html/column_dialog.html +286 -0
- pgsql/pgAdmin 4/docs/en_US/html/compound_trigger_dialog.html +203 -0
- pgsql/pgAdmin 4/docs/en_US/html/config_py.html +1140 -0
- pgsql/pgAdmin 4/docs/en_US/html/connect_error.html +182 -0
- pgsql/pgAdmin 4/docs/en_US/html/connect_to_server.html +170 -0
- pgsql/pgAdmin 4/docs/en_US/html/connecting.html +199 -0
- pgsql/pgAdmin 4/docs/en_US/html/container_deployment.html +582 -0
- pgsql/pgAdmin 4/docs/en_US/html/contributions.html +176 -0
- pgsql/pgAdmin 4/docs/en_US/html/database_dialog.html +255 -0
- pgsql/pgAdmin 4/docs/en_US/html/dbms_job.html +227 -0
- pgsql/pgAdmin 4/docs/en_US/html/dbms_job_scheduler.html +191 -0
- pgsql/pgAdmin 4/docs/en_US/html/dbms_program.html +198 -0
- pgsql/pgAdmin 4/docs/en_US/html/dbms_schedule.html +196 -0
- pgsql/pgAdmin 4/docs/en_US/html/debugger.html +278 -0
- pgsql/pgAdmin 4/docs/en_US/html/deployment.html +172 -0
- pgsql/pgAdmin 4/docs/en_US/html/desktop_deployment.html +298 -0
- pgsql/pgAdmin 4/docs/en_US/html/developer_tools.html +186 -0
- pgsql/pgAdmin 4/docs/en_US/html/domain_constraint_dialog.html +210 -0
- pgsql/pgAdmin 4/docs/en_US/html/domain_dialog.html +255 -0
- pgsql/pgAdmin 4/docs/en_US/html/editgrid.html +341 -0
- pgsql/pgAdmin 4/docs/en_US/html/erd_tool.html +481 -0
- pgsql/pgAdmin 4/docs/en_US/html/event_trigger_dialog.html +228 -0
- pgsql/pgAdmin 4/docs/en_US/html/exclusion_constraint_dialog.html +229 -0
- pgsql/pgAdmin 4/docs/en_US/html/extension_dialog.html +209 -0
- pgsql/pgAdmin 4/docs/en_US/html/external_database.html +183 -0
- pgsql/pgAdmin 4/docs/en_US/html/foreign_data_wrapper_dialog.html +240 -0
- pgsql/pgAdmin 4/docs/en_US/html/foreign_key_dialog.html +265 -0
- pgsql/pgAdmin 4/docs/en_US/html/foreign_server_dialog.html +230 -0
pgsql/pgAdmin 4/docs/en_US/html/.buildinfo
ADDED
|
@@ -0,0 +1,4 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Sphinx build info version 1
|
| 2 |
+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
| 3 |
+
config: b3c83bf398e7d0c10e7e3d8887ae2e8a
|
| 4 |
+
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
pgsql/pgAdmin 4/docs/en_US/html/add_restore_point_dialog.html
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Add Named Restore Point Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Change Password Dialog" href="change_password_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Management Basics" href="management_basics.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="change_password_dialog.html" title="Change Password Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="management_basics.html" title="Management Basics"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="management_basics.html" accesskey="U">Management Basics</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Add Named Restore Point Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="add-named-restore-point-dialog">
|
| 49 |
+
<span id="add-restore-point-dialog"></span><h1><span class="target" id="index-0"></span>Add Named Restore Point Dialog<a class="headerlink" href="#add-named-restore-point-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Add named restore point</em> dialog to take a named snapshot of the state
|
| 51 |
+
of the server for use in a recovery file. To create a named restore point, the
|
| 52 |
+
server’s postgresql.conf file must specify a <em>wal_level</em> value of <em>replica</em>,
|
| 53 |
+
<em>logical</em>, or <em>minimal</em>. You must be a database superuser to create a
|
| 54 |
+
restore point.</p>
|
| 55 |
+
<img alt="Restore point dialog" class="align-center" src="_images/add_restore_point.png" />
|
| 56 |
+
<p>When the <em>Restore point name</em> window launches, use the field <em>Enter the name of
|
| 57 |
+
the restore point to add</em> to provide a descriptive name for the restore point.</p>
|
| 58 |
+
<p>For more information about using a restore point as a recovery target, please
|
| 59 |
+
see the
|
| 60 |
+
<a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config-wal.html#RUNTIME-CONFIG-WAL-RECOVERY-TARGET">PostgreSQL documentation</a>.</p>
|
| 61 |
+
<ul class="simple">
|
| 62 |
+
<li><p>Click the <em>OK</em> button to save the restore point.</p></li>
|
| 63 |
+
<li><p>Click the <em>Cancel</em> button to exit without saving work.</p></li>
|
| 64 |
+
</ul>
|
| 65 |
+
</section>
|
| 66 |
+
|
| 67 |
+
|
| 68 |
+
<div class="clearer"></div>
|
| 69 |
+
</div>
|
| 70 |
+
</div>
|
| 71 |
+
</div>
|
| 72 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 73 |
+
<div class="sphinxsidebarwrapper">
|
| 74 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 75 |
+
<ul class="current">
|
| 76 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 77 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 78 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 79 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 80 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 81 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 82 |
+
<li class="toctree-l1 current"><a class="reference internal" href="management_basics.html">Management Basics</a><ul class="current">
|
| 83 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Add Named Restore Point Dialog</a></li>
|
| 84 |
+
<li class="toctree-l2"><a class="reference internal" href="change_password_dialog.html">Change Password Dialog</a></li>
|
| 85 |
+
<li class="toctree-l2"><a class="reference internal" href="grant_wizard.html">Grant Wizard</a></li>
|
| 86 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_data.html">Import/Export Data Dialog</a></li>
|
| 87 |
+
<li class="toctree-l2"><a class="reference internal" href="maintenance_dialog.html">Maintenance Dialog</a></li>
|
| 88 |
+
<li class="toctree-l2"><a class="reference internal" href="storage_manager.html">Storage Manager</a></li>
|
| 89 |
+
</ul>
|
| 90 |
+
</li>
|
| 91 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 92 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 93 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 94 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 95 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 96 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 97 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 98 |
+
</ul>
|
| 99 |
+
|
| 100 |
+
<search id="searchbox" style="display: none" role="search">
|
| 101 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 102 |
+
<div class="searchformwrapper">
|
| 103 |
+
<form class="search" action="search.html" method="get">
|
| 104 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 105 |
+
<input type="submit" value="Go" />
|
| 106 |
+
</form>
|
| 107 |
+
</div>
|
| 108 |
+
</search>
|
| 109 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 110 |
+
</div>
|
| 111 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 112 |
+
<span>«</span>
|
| 113 |
+
</div>
|
| 114 |
+
|
| 115 |
+
</div>
|
| 116 |
+
<div class="clearer"></div>
|
| 117 |
+
</div>
|
| 118 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 119 |
+
<h3>Navigation</h3>
|
| 120 |
+
<ul>
|
| 121 |
+
<li class="right" style="margin-right: 10px">
|
| 122 |
+
<a href="genindex.html" title="General Index"
|
| 123 |
+
>index</a></li>
|
| 124 |
+
<li class="right" >
|
| 125 |
+
<a href="change_password_dialog.html" title="Change Password Dialog"
|
| 126 |
+
>next</a> |</li>
|
| 127 |
+
<li class="right" >
|
| 128 |
+
<a href="management_basics.html" title="Management Basics"
|
| 129 |
+
>previous</a> |</li>
|
| 130 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 131 |
+
<li class="nav-item nav-item-1"><a href="management_basics.html" >Management Basics</a> »</li>
|
| 132 |
+
<li class="nav-item nav-item-this"><a href="">Add Named Restore Point Dialog</a></li>
|
| 133 |
+
</ul>
|
| 134 |
+
</div>
|
| 135 |
+
<div class="footer" role="contentinfo">
|
| 136 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 137 |
+
<ul>
|
| 138 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 139 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 140 |
+
<li class="right" ><a href="change_password_dialog.html" title="Change Password Dialog" accesskey="N">next</a> |</li>
|
| 141 |
+
<li class="right" ><a href="management_basics.html" title="Management Basics" accesskey="P">previous</a> |</li>
|
| 142 |
+
</ul>
|
| 143 |
+
</div>
|
| 144 |
+
</div>
|
| 145 |
+
</body>
|
| 146 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/backup_and_restore.html
ADDED
|
@@ -0,0 +1,138 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Backup and Restore — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Backup Dialog" href="backup_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Storage Manager" href="storage_manager.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="backup_dialog.html" title="Backup Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="storage_manager.html" title="Storage Manager"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-this"><a href="">Backup and Restore</a></li>
|
| 39 |
+
</ul>
|
| 40 |
+
</div>
|
| 41 |
+
|
| 42 |
+
<div class="document">
|
| 43 |
+
<div class="documentwrapper">
|
| 44 |
+
<div class="bodywrapper">
|
| 45 |
+
<div class="body" role="main">
|
| 46 |
+
|
| 47 |
+
<section id="backup-and-restore">
|
| 48 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Backup and Restore<a class="headerlink" href="#backup-and-restore" title="Link to this heading">¶</a></h1>
|
| 49 |
+
<p>A powerful, but user-friendly Backup and Restore tool provides an easy way to
|
| 50 |
+
use pg_dump, pg_dumpall, and pg_restore to take backups and create copies of
|
| 51 |
+
databases or database objects for use in a development environment.</p>
|
| 52 |
+
<div class="toctree-wrapper compound">
|
| 53 |
+
<ul>
|
| 54 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_dialog.html">Backup Dialog</a></li>
|
| 55 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_globals_dialog.html">Backup Globals Dialog</a></li>
|
| 56 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_server_dialog.html">Backup Server Dialog</a></li>
|
| 57 |
+
<li class="toctree-l1"><a class="reference internal" href="restore_dialog.html">Restore Dialog</a></li>
|
| 58 |
+
</ul>
|
| 59 |
+
</div>
|
| 60 |
+
</section>
|
| 61 |
+
|
| 62 |
+
|
| 63 |
+
<div class="clearer"></div>
|
| 64 |
+
</div>
|
| 65 |
+
</div>
|
| 66 |
+
</div>
|
| 67 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 68 |
+
<div class="sphinxsidebarwrapper">
|
| 69 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 70 |
+
<ul class="current">
|
| 71 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 72 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 73 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 74 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 75 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 76 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 77 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 78 |
+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Backup and Restore</a><ul>
|
| 79 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_dialog.html">Backup Dialog</a></li>
|
| 80 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_globals_dialog.html">Backup Globals Dialog</a></li>
|
| 81 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_server_dialog.html">Backup Server Dialog</a></li>
|
| 82 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_dialog.html">Restore Dialog</a></li>
|
| 83 |
+
</ul>
|
| 84 |
+
</li>
|
| 85 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 86 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 87 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 88 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 89 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 90 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 91 |
+
</ul>
|
| 92 |
+
|
| 93 |
+
<search id="searchbox" style="display: none" role="search">
|
| 94 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 95 |
+
<div class="searchformwrapper">
|
| 96 |
+
<form class="search" action="search.html" method="get">
|
| 97 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 98 |
+
<input type="submit" value="Go" />
|
| 99 |
+
</form>
|
| 100 |
+
</div>
|
| 101 |
+
</search>
|
| 102 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 103 |
+
</div>
|
| 104 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 105 |
+
<span>«</span>
|
| 106 |
+
</div>
|
| 107 |
+
|
| 108 |
+
</div>
|
| 109 |
+
<div class="clearer"></div>
|
| 110 |
+
</div>
|
| 111 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 112 |
+
<h3>Navigation</h3>
|
| 113 |
+
<ul>
|
| 114 |
+
<li class="right" style="margin-right: 10px">
|
| 115 |
+
<a href="genindex.html" title="General Index"
|
| 116 |
+
>index</a></li>
|
| 117 |
+
<li class="right" >
|
| 118 |
+
<a href="backup_dialog.html" title="Backup Dialog"
|
| 119 |
+
>next</a> |</li>
|
| 120 |
+
<li class="right" >
|
| 121 |
+
<a href="storage_manager.html" title="Storage Manager"
|
| 122 |
+
>previous</a> |</li>
|
| 123 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 124 |
+
<li class="nav-item nav-item-this"><a href="">Backup and Restore</a></li>
|
| 125 |
+
</ul>
|
| 126 |
+
</div>
|
| 127 |
+
<div class="footer" role="contentinfo">
|
| 128 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 129 |
+
<ul>
|
| 130 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 131 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 132 |
+
<li class="right" ><a href="backup_dialog.html" title="Backup Dialog" accesskey="N">next</a> |</li>
|
| 133 |
+
<li class="right" ><a href="storage_manager.html" title="Storage Manager" accesskey="P">previous</a> |</li>
|
| 134 |
+
</ul>
|
| 135 |
+
</div>
|
| 136 |
+
</div>
|
| 137 |
+
</body>
|
| 138 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/backup_dialog.html
ADDED
|
@@ -0,0 +1,384 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Backup Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Backup Globals Dialog" href="backup_globals_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Backup and Restore" href="backup_and_restore.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="backup_globals_dialog.html" title="Backup Globals Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="backup_and_restore.html" title="Backup and Restore"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="backup_and_restore.html" accesskey="U">Backup and Restore</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Backup Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="backup-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Backup Dialog<a class="headerlink" href="#backup-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p><em>pgAdmin</em> uses the <em>pg_dump</em> utility to provide an easy way to create a backup
|
| 51 |
+
in a plain-text or archived format. You can then use a client application (like
|
| 52 |
+
<em>psql</em> or the <em>Query Tool</em>) to restore a plain-text backup file, or use the
|
| 53 |
+
Postgres <em>pg_restore</em> utility to restore an archived backup. The <em>pg_dump</em>
|
| 54 |
+
utility must have read access to all database objects that you want to back up.</p>
|
| 55 |
+
<p>You can backup a single table, a schema, or a complete database. Select the name
|
| 56 |
+
of the backup source in the <em>pgAdmin</em> tree control, right click to open the
|
| 57 |
+
context menu, and select <em>Backup…</em> to open the <em>Backup</em> dialog. The name of
|
| 58 |
+
the object selected will appear in the dialog title bar.</p>
|
| 59 |
+
<img alt="Backup dialog general tab" class="align-center" src="_images/backup_general.png" />
|
| 60 |
+
<p>Use the fields in the <em>General</em> tab to specify parameters for the backup:</p>
|
| 61 |
+
<ul>
|
| 62 |
+
<li><p>Enter the name of the backup file in the <em>Filename</em> field. Optionally, select
|
| 63 |
+
the <em>Browser</em> icon (…) to the right to navigate into a directory and select
|
| 64 |
+
a file that will contain the archive.</p></li>
|
| 65 |
+
<li><p>Use the drop-down listbox in the <em>Format</em> field to select the format that is
|
| 66 |
+
best suited for your application. Each format has advantages and
|
| 67 |
+
disadvantages:</p>
|
| 68 |
+
<blockquote>
|
| 69 |
+
<div><ul class="simple">
|
| 70 |
+
<li><p>Select <em>Custom</em> to create a custom archive file that you can use with
|
| 71 |
+
<em>pg_restore</em> to create a copy of a database. Custom archive file formats
|
| 72 |
+
must be restored with <em>pg_restore</em>. This format offers the opportunity to
|
| 73 |
+
select which database objects to restore from the backup file. <em>Custom</em>
|
| 74 |
+
archive format is recommended for medium to large databases as it is
|
| 75 |
+
compressed by default.</p></li>
|
| 76 |
+
<li><p>Select <em>Tar</em> to generate a tar archive file that you can restore with
|
| 77 |
+
<em>pg_restore</em>. The tar format does not support compression.</p></li>
|
| 78 |
+
<li><p>Select <em>Plain</em> to create a plain-text script file. A plain-text script file
|
| 79 |
+
contains SQL statements and commands that you can execute at the <em>psql</em>
|
| 80 |
+
command line to recreate the database objects and load the table data. A
|
| 81 |
+
plain-text backup file can be edited in a text editor, if desired, before
|
| 82 |
+
using the <em>psql</em> program to restore database objects. <em>Plain</em> format is
|
| 83 |
+
normally recommended for smaller databases; script dumps are not
|
| 84 |
+
recommended for blobs. The SQL commands within the script will reconstruct
|
| 85 |
+
the database to the last saved state of the database. A plain-text script
|
| 86 |
+
can be used to reconstruct the database on another machine, or (with
|
| 87 |
+
modifications) on other architectures.</p></li>
|
| 88 |
+
<li><p>Select <em>Directory</em> to generate a directory-format archive suitable for use
|
| 89 |
+
with <em>pg_restore</em>. This file format creates a directory with one file for
|
| 90 |
+
each table and blob being dumped, plus a <em>Table of Contents</em> file
|
| 91 |
+
describing the dumped objects in a machine-readable format that
|
| 92 |
+
<em>pg_restore</em> can read. This format is compressed by default.</p></li>
|
| 93 |
+
</ul>
|
| 94 |
+
</div></blockquote>
|
| 95 |
+
</li>
|
| 96 |
+
<li><p>Use the <em>Compression Ratio</em> field to select a compression level for the
|
| 97 |
+
backup. Specify a value of zero to mean use no compression; specify a maximum
|
| 98 |
+
compression value of 9. Please note that tar archives do not support
|
| 99 |
+
compression.</p></li>
|
| 100 |
+
<li><p>Use the <em>Encoding</em> drop-down listbox to select the character encoding method
|
| 101 |
+
that should be used for the archive.</p></li>
|
| 102 |
+
<li><p>Use the <em>Number of Jobs</em> field (when applicable) to specify the number of
|
| 103 |
+
tables that will be dumped simultaneously in a parallel backup.</p></li>
|
| 104 |
+
<li><p>Use the dropdown listbox next to <em>Rolename</em> to specify the role that owns the
|
| 105 |
+
backup.</p></li>
|
| 106 |
+
</ul>
|
| 107 |
+
<p>Click the <em>Data Options</em> tab to continue. Use the fields in the <em>Data Options</em>
|
| 108 |
+
tab to provide options related to data or pgAdmin objects that correspond to <em>pg_dump</em>.</p>
|
| 109 |
+
<img alt="Sections option on backup dialog" class="align-center" src="_images/backup_sections.png" />
|
| 110 |
+
<ul>
|
| 111 |
+
<li><p>Move switches in the <strong>Sections</strong> field box to select a portion of the object
|
| 112 |
+
that will be backed up.</p>
|
| 113 |
+
<blockquote>
|
| 114 |
+
<div><ul class="simple">
|
| 115 |
+
<li><p>Move the switch next to <em>Pre-data</em> towards right position to include all
|
| 116 |
+
data definition items not included in the data or post-data item lists.</p></li>
|
| 117 |
+
<li><p>Move the switch next to <em>Data</em> towards right position to backup actual table
|
| 118 |
+
data, large-object contents, and sequence values.</p></li>
|
| 119 |
+
<li><p>Move the switch next to <em>Post-data</em> towards right position to include
|
| 120 |
+
definitions of indexes, triggers, rules, and constraints other than
|
| 121 |
+
validated check constraints.</p></li>
|
| 122 |
+
</ul>
|
| 123 |
+
</div></blockquote>
|
| 124 |
+
</li>
|
| 125 |
+
</ul>
|
| 126 |
+
<img alt="Type of objects option on backup dialog" class="align-center" src="_images/backup_objects.png" />
|
| 127 |
+
<ul>
|
| 128 |
+
<li><p>Move switches in the <strong>Type of objects</strong> field box to specify details about
|
| 129 |
+
the type of objects that will be backed up.</p>
|
| 130 |
+
<blockquote>
|
| 131 |
+
<div><ul class="simple">
|
| 132 |
+
<li><p>Move the switch next to <em>Only data</em> towards right position to limit the back
|
| 133 |
+
up to data.</p></li>
|
| 134 |
+
<li><p>Move the switch next to <em>Only schemas</em> to limit the back up to schema-level
|
| 135 |
+
database objects.</p></li>
|
| 136 |
+
<li><p>Move the switch next to <em>Blobs</em> towards left position to exclude large
|
| 137 |
+
objects in the backup.</p></li>
|
| 138 |
+
</ul>
|
| 139 |
+
</div></blockquote>
|
| 140 |
+
</li>
|
| 141 |
+
</ul>
|
| 142 |
+
<img alt="Do not save option on backup dialog" class="align-center" src="_images/backup_do_not_save.png" />
|
| 143 |
+
<ul>
|
| 144 |
+
<li><p>Move switches in the <strong>Do not save</strong> field box to select the objects that will
|
| 145 |
+
not be included in the backup.</p>
|
| 146 |
+
<blockquote>
|
| 147 |
+
<div><ul class="simple">
|
| 148 |
+
<li><p>Move the switch next to <em>Owner</em> towards right position to exclude commands
|
| 149 |
+
that set object ownership.</p></li>
|
| 150 |
+
<li><p>Move the switch next to <em>Privileges</em> towards right position to exclude
|
| 151 |
+
commands that create access privileges.</p></li>
|
| 152 |
+
<li><p>Move the switch next to <em>Tablespaces</em> towards right position to exclude
|
| 153 |
+
tablespaces.</p></li>
|
| 154 |
+
<li><p>Move the switch next to <em>Unlogged table data</em> towards right position to
|
| 155 |
+
exclude the contents of unlogged tables.</p></li>
|
| 156 |
+
<li><p>Move the switch next to <em>Comments</em> towards right position to exclude
|
| 157 |
+
commands that set the comments. <strong>Note:</strong> This option is visible only for
|
| 158 |
+
database server greater than or equal to 11.</p></li>
|
| 159 |
+
<li><p>Move the switch next to <em>Publications</em> towards right position to exclude
|
| 160 |
+
publications.</p></li>
|
| 161 |
+
<li><p>Move the switch next to <em>Subscriptions</em> towards right position to exclude
|
| 162 |
+
subscriptions.</p></li>
|
| 163 |
+
<li><p>Move the switch next to <em>Security labels</em> towards right position to exclude
|
| 164 |
+
Security labels.</p></li>
|
| 165 |
+
<li><p>Move the switch next to <em>Toast compressions</em> towards right position to exclude
|
| 166 |
+
Toast compressions. <strong>Note:</strong> This option is visible only for
|
| 167 |
+
database server greater than or equal to 14.</p></li>
|
| 168 |
+
<li><p>Move the switch next to <em>Table access methods</em> towards right position to exclude
|
| 169 |
+
Table access methods. <strong>Note:</strong> This option is visible only for
|
| 170 |
+
database server greater than or equal to 15.</p></li>
|
| 171 |
+
</ul>
|
| 172 |
+
</div></blockquote>
|
| 173 |
+
</li>
|
| 174 |
+
</ul>
|
| 175 |
+
<img alt="Queries option on backup dialog" class="align-center" src="_images/backup_queries.png" />
|
| 176 |
+
<p>Click the <em>Query Options</em> tab to continue. Use these additional fields to specify
|
| 177 |
+
the type of statements that should be included in the backup.</p>
|
| 178 |
+
<blockquote>
|
| 179 |
+
<div><ul class="simple">
|
| 180 |
+
<li><p>Move the switch next to <em>Use INSERT commands</em> towards right position to
|
| 181 |
+
dump the data in the form of INSERT statements rather than using a COPY
|
| 182 |
+
command. Please note: this may make restoration from backup slow.</p></li>
|
| 183 |
+
<li><p>Use the <em>Maximum rows per INSERT command</em> field to controls the maximum
|
| 184 |
+
number of rows per INSERT command. <strong>Note:</strong> This option is visible only for
|
| 185 |
+
database server greater than or equal to 12.</p></li>
|
| 186 |
+
<li><p>Move the switch next to <em>On conflict do nothing to INSERT command</em> towards
|
| 187 |
+
right position to add ON CONFLICT DO NOTHING to INSERT command.
|
| 188 |
+
This option is not valid unless <em>Use INSERT commands</em>, <em>Use Column INSERTS</em>
|
| 189 |
+
or <em>Maximum rows per INSERT command</em> is also specified.
|
| 190 |
+
<strong>Note:</strong> This option is visible only for database server greater than or
|
| 191 |
+
equal to 12.</p></li>
|
| 192 |
+
<li><p>Move the switch next to <em>Include CREATE DATABASE statement</em> towards right
|
| 193 |
+
position to include a command in the backup that creates a new database
|
| 194 |
+
when restoring the backup.</p></li>
|
| 195 |
+
<li><p>Move the switch next to <em>Include DROP DATABASE statement</em> towards right
|
| 196 |
+
position to include a command in the backup that will drop any existing
|
| 197 |
+
database object with the same name before recreating the object during a
|
| 198 |
+
backup.</p></li>
|
| 199 |
+
<li><p>Move the switch next to <em>Include IF EXISTS clause</em> towards right
|
| 200 |
+
position to add an IF EXISTS clause to drop databases and other objects.
|
| 201 |
+
This option is not valid unless <em>Include DROP DATABASE statement</em> is also set.</p></li>
|
| 202 |
+
</ul>
|
| 203 |
+
</div></blockquote>
|
| 204 |
+
<img alt="Backup dialog tables section" class="align-center" src="_images/backup_table.png" />
|
| 205 |
+
<p>Click the <em>Table Options</em> tab to continue. Use the fields in the <em>Table Options</em>
|
| 206 |
+
tab related to tables that should be included in the backup.</p>
|
| 207 |
+
<blockquote>
|
| 208 |
+
<div><ul class="simple">
|
| 209 |
+
<li><p>Move the switch next to <em>Use Column INSERTS</em> towards right position to dump
|
| 210 |
+
the data in the form of INSERT statements and include explicit column
|
| 211 |
+
names. Please note: this may make restoration from backup slow.</p></li>
|
| 212 |
+
<li><p>Move the switch next to <em>Load via partition root</em> towards right position,
|
| 213 |
+
so when dumping a COPY or INSERT statement for a partitioned table, target
|
| 214 |
+
the root of the partitioning hierarchy which contains it rather than the
|
| 215 |
+
partition itself. <strong>Note:</strong> This option is visible only for database server
|
| 216 |
+
greater than or equal to 11.</p></li>
|
| 217 |
+
<li><p>Move the switch next to <em>Enable row security</em> towards right position to
|
| 218 |
+
set row_security to on instead, allowing the user to dump the parts of the
|
| 219 |
+
contents of the table that they have access to. This option is relevant
|
| 220 |
+
only when dumping the contents of a table which has row security.</p></li>
|
| 221 |
+
<li><p>Use the <em>Include table(s) and Children</em> field to dump the tables and any partitions
|
| 222 |
+
or inheritance child tables of the tables matching the pattern.
|
| 223 |
+
<strong>Note:</strong> This option is visible only for database server greater than or
|
| 224 |
+
equal to 16.</p></li>
|
| 225 |
+
<li><p>The Exclude patterns field is utilized to exclude patterns in the following manner:</p></li>
|
| 226 |
+
<li><p>Use the <em>Table(s)</em> field to not dump the tables matching the
|
| 227 |
+
pattern. Multiple patterns can be given separated by space.</p></li>
|
| 228 |
+
<li><p>Use the <em>Table(s) data</em> field to not dump data for any tables
|
| 229 |
+
matching the pattern. Multiple patterns can be given separated by
|
| 230 |
+
spaces.</p></li>
|
| 231 |
+
<li><p>Use the <em>Table(s) and children</em> field to not dump the tables and any
|
| 232 |
+
partitions or inheritance child tables of the tables matching the pattern.
|
| 233 |
+
<strong>Note:</strong> This option is visible only for database server greater than or
|
| 234 |
+
equal to 16.</p></li>
|
| 235 |
+
<li><p>Use the <em>Table(s) data and children</em> field to not dump data for the
|
| 236 |
+
tables and any partitions or inheritance child tables of the tables matching
|
| 237 |
+
the table pattern. <strong>Note:</strong> This option is visible only for database server
|
| 238 |
+
greater than or equal to 16.</p></li>
|
| 239 |
+
</ul>
|
| 240 |
+
</div></blockquote>
|
| 241 |
+
<p>Click the <em>Options</em> tab to continue. Use the fields in the <em>Options</em>
|
| 242 |
+
tab to provide other backup options.</p>
|
| 243 |
+
<img alt="Disable option on backup dialog" class="align-center" src="_images/backup_disable.png" />
|
| 244 |
+
<ul>
|
| 245 |
+
<li><p>Move switches in the <strong>Disable</strong> field box to specify the type of statements
|
| 246 |
+
that should be excluded from the backup.</p>
|
| 247 |
+
<blockquote>
|
| 248 |
+
<div><ul class="simple">
|
| 249 |
+
<li><p>Move the switch next to <em>Triggers</em> (active when creating a data-only backup)
|
| 250 |
+
towards right position to include commands that will disable triggers on the
|
| 251 |
+
target table while the data is being loaded.</p></li>
|
| 252 |
+
<li><p>Move the switch next to <em>$ quoting</em> towards right position to enable dollar
|
| 253 |
+
quoting within function bodies; if disabled, the function body will be
|
| 254 |
+
quoted using SQL standard string syntax.</p></li>
|
| 255 |
+
</ul>
|
| 256 |
+
</div></blockquote>
|
| 257 |
+
</li>
|
| 258 |
+
</ul>
|
| 259 |
+
<img alt="Miscellaneous option on backup dialog" class="align-center" src="_images/backup_miscellaneous.png" />
|
| 260 |
+
<ul>
|
| 261 |
+
<li><p>Move switches in the <strong>Miscellaneous</strong> field box to specify miscellaneous
|
| 262 |
+
backup options.</p>
|
| 263 |
+
<blockquote>
|
| 264 |
+
<div><ul class="simple">
|
| 265 |
+
<li><p>Move the switch next to <em>Verbose messages</em> towards left position to instruct
|
| 266 |
+
<em>pg_dump</em> to exclude verbose messages.</p></li>
|
| 267 |
+
<li><p>Move the switch next to <em>Force double quotes on identifiers</em> towards right
|
| 268 |
+
position to force the quoting of all identifiers.</p></li>
|
| 269 |
+
<li><p>Move the switch next to <em>Use SET SESSION AUTHORIZATION</em> towards right
|
| 270 |
+
position to include a statement that will use a SET SESSION AUTHORIZATION
|
| 271 |
+
command to determine object ownership (instead of an ALTER OWNER command).</p></li>
|
| 272 |
+
<li><p>Use the <em>Exclude schema</em> field to not dump schemas whose name matches
|
| 273 |
+
pattern.</p></li>
|
| 274 |
+
<li><p>Use the <em>Extra float digits</em> field to use the specified value when dumping
|
| 275 |
+
floating-point data, instead of the maximum available precision.</p></li>
|
| 276 |
+
<li><p>Use the <em>Lock wait timeout</em> field to do not wait forever to acquire shared
|
| 277 |
+
table locks at the beginning of the dump. Instead, fail if unable to lock a
|
| 278 |
+
table within the specified timeout.</p></li>
|
| 279 |
+
</ul>
|
| 280 |
+
</div></blockquote>
|
| 281 |
+
</li>
|
| 282 |
+
</ul>
|
| 283 |
+
<p>Click the <em>Objects</em> tab to continue.</p>
|
| 284 |
+
<img alt="Select objects in backup dialog" class="align-center" src="_images/backup_object_selection.png" />
|
| 285 |
+
<ul class="simple">
|
| 286 |
+
<li><dl class="simple">
|
| 287 |
+
<dt>Select the objects from tree to take backup of selected objects only.</dt><dd><ul>
|
| 288 |
+
<li><p>If Schema is selected then it will take the backup of that selected schema only.</p></li>
|
| 289 |
+
<li><p>If any Table, View, Materialized View, Sequences, or Foreign Table is selected then it will take the backup of those selected objects.</p></li>
|
| 290 |
+
</ul>
|
| 291 |
+
</dd>
|
| 292 |
+
</dl>
|
| 293 |
+
</li>
|
| 294 |
+
</ul>
|
| 295 |
+
<p>When you’ve specified the details that will be incorporated into the pg_dump
|
| 296 |
+
command:</p>
|
| 297 |
+
<ul class="simple">
|
| 298 |
+
<li><p>Click the <em>Backup</em> button to build and execute a command that builds a backup
|
| 299 |
+
based on your selections on the <em>Backup</em> dialog.</p></li>
|
| 300 |
+
<li><p>Click the <em>Cancel</em> button to exit without saving work.</p></li>
|
| 301 |
+
</ul>
|
| 302 |
+
<p>pgAdmin will run the backup process in background. You can view all the background
|
| 303 |
+
process with there running status and logs on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a>
|
| 304 |
+
tab</p>
|
| 305 |
+
</section>
|
| 306 |
+
|
| 307 |
+
|
| 308 |
+
<div class="clearer"></div>
|
| 309 |
+
</div>
|
| 310 |
+
</div>
|
| 311 |
+
</div>
|
| 312 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 313 |
+
<div class="sphinxsidebarwrapper">
|
| 314 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 315 |
+
<ul class="current">
|
| 316 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 317 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 318 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 319 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 320 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 321 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 322 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 323 |
+
<li class="toctree-l1 current"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a><ul class="current">
|
| 324 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Backup Dialog</a></li>
|
| 325 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_globals_dialog.html">Backup Globals Dialog</a></li>
|
| 326 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_server_dialog.html">Backup Server Dialog</a></li>
|
| 327 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_dialog.html">Restore Dialog</a></li>
|
| 328 |
+
</ul>
|
| 329 |
+
</li>
|
| 330 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 331 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 332 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 333 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 334 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 335 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 336 |
+
</ul>
|
| 337 |
+
|
| 338 |
+
<search id="searchbox" style="display: none" role="search">
|
| 339 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 340 |
+
<div class="searchformwrapper">
|
| 341 |
+
<form class="search" action="search.html" method="get">
|
| 342 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 343 |
+
<input type="submit" value="Go" />
|
| 344 |
+
</form>
|
| 345 |
+
</div>
|
| 346 |
+
</search>
|
| 347 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 348 |
+
</div>
|
| 349 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 350 |
+
<span>«</span>
|
| 351 |
+
</div>
|
| 352 |
+
|
| 353 |
+
</div>
|
| 354 |
+
<div class="clearer"></div>
|
| 355 |
+
</div>
|
| 356 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 357 |
+
<h3>Navigation</h3>
|
| 358 |
+
<ul>
|
| 359 |
+
<li class="right" style="margin-right: 10px">
|
| 360 |
+
<a href="genindex.html" title="General Index"
|
| 361 |
+
>index</a></li>
|
| 362 |
+
<li class="right" >
|
| 363 |
+
<a href="backup_globals_dialog.html" title="Backup Globals Dialog"
|
| 364 |
+
>next</a> |</li>
|
| 365 |
+
<li class="right" >
|
| 366 |
+
<a href="backup_and_restore.html" title="Backup and Restore"
|
| 367 |
+
>previous</a> |</li>
|
| 368 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 369 |
+
<li class="nav-item nav-item-1"><a href="backup_and_restore.html" >Backup and Restore</a> »</li>
|
| 370 |
+
<li class="nav-item nav-item-this"><a href="">Backup Dialog</a></li>
|
| 371 |
+
</ul>
|
| 372 |
+
</div>
|
| 373 |
+
<div class="footer" role="contentinfo">
|
| 374 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 375 |
+
<ul>
|
| 376 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 377 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 378 |
+
<li class="right" ><a href="backup_globals_dialog.html" title="Backup Globals Dialog" accesskey="N">next</a> |</li>
|
| 379 |
+
<li class="right" ><a href="backup_and_restore.html" title="Backup and Restore" accesskey="P">previous</a> |</li>
|
| 380 |
+
</ul>
|
| 381 |
+
</div>
|
| 382 |
+
</div>
|
| 383 |
+
</body>
|
| 384 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/backup_globals_dialog.html
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Backup Globals Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Backup Server Dialog" href="backup_server_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Backup Dialog" href="backup_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="backup_server_dialog.html" title="Backup Server Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="backup_dialog.html" title="Backup Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="backup_and_restore.html" accesskey="U">Backup and Restore</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Backup Globals Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="backup-globals-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Backup Globals Dialog<a class="headerlink" href="#backup-globals-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Backup Globals</em> dialog to create a plain-text script that recreates all
|
| 51 |
+
of the database objects within a cluster, and the global objects that are shared
|
| 52 |
+
by those databases. Global objects include tablespaces, roles, and object
|
| 53 |
+
properties. You can use the pgAdmin <em>Query Tool</em> to play back a plain-text
|
| 54 |
+
script, and recreate the objects in the backup.</p>
|
| 55 |
+
<img alt="Backup globals dialog" class="align-center" src="_images/backup_globals_general.png" />
|
| 56 |
+
<p>Use the fields in the <em>General</em> tab to specify the following:</p>
|
| 57 |
+
<ul class="simple">
|
| 58 |
+
<li><p>Enter the name of the backup file in the <em>Filename</em> field. Optionally, select
|
| 59 |
+
the <em>Browser</em> icon (ellipsis) to the right to navigate into a directory and
|
| 60 |
+
select a file that will contain the archive.</p></li>
|
| 61 |
+
<li><p>Use the drop-down listbox next to <em>Role name</em> to specify a role with
|
| 62 |
+
connection privileges on the selected server. The role will be used for
|
| 63 |
+
authentication during the backup.</p></li>
|
| 64 |
+
</ul>
|
| 65 |
+
<p>Move switches in the <strong>Miscellaneous</strong> field box to specify the type of
|
| 66 |
+
statements that should be included in the backup.</p>
|
| 67 |
+
<ul class="simple">
|
| 68 |
+
<li><p>Move the <em>Verbose messages</em> switch to the <em>No</em> position to exclude status
|
| 69 |
+
messages from the backup. The default is <em>Yes</em>.</p></li>
|
| 70 |
+
<li><p>Move the <em>Force double quote on identifiers</em> switch to the <em>Yes</em> position to
|
| 71 |
+
name identifiers without changing case. The default is <em>No</em>.</p></li>
|
| 72 |
+
</ul>
|
| 73 |
+
<p>Click the <em>Backup</em> button to build and execute a command based on your
|
| 74 |
+
selections; click the <em>Cancel</em> button to exit without saving work.</p>
|
| 75 |
+
<p>pgAdmin will run the backup process in background. You can view all the background
|
| 76 |
+
process with there running status and logs on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a>
|
| 77 |
+
tab</p>
|
| 78 |
+
</section>
|
| 79 |
+
|
| 80 |
+
|
| 81 |
+
<div class="clearer"></div>
|
| 82 |
+
</div>
|
| 83 |
+
</div>
|
| 84 |
+
</div>
|
| 85 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 86 |
+
<div class="sphinxsidebarwrapper">
|
| 87 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 88 |
+
<ul class="current">
|
| 89 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 90 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 91 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 92 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 93 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 94 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 95 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 96 |
+
<li class="toctree-l1 current"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a><ul class="current">
|
| 97 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_dialog.html">Backup Dialog</a></li>
|
| 98 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Backup Globals Dialog</a></li>
|
| 99 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_server_dialog.html">Backup Server Dialog</a></li>
|
| 100 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_dialog.html">Restore Dialog</a></li>
|
| 101 |
+
</ul>
|
| 102 |
+
</li>
|
| 103 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 104 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 105 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 107 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 108 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 109 |
+
</ul>
|
| 110 |
+
|
| 111 |
+
<search id="searchbox" style="display: none" role="search">
|
| 112 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 113 |
+
<div class="searchformwrapper">
|
| 114 |
+
<form class="search" action="search.html" method="get">
|
| 115 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 116 |
+
<input type="submit" value="Go" />
|
| 117 |
+
</form>
|
| 118 |
+
</div>
|
| 119 |
+
</search>
|
| 120 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 121 |
+
</div>
|
| 122 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 123 |
+
<span>«</span>
|
| 124 |
+
</div>
|
| 125 |
+
|
| 126 |
+
</div>
|
| 127 |
+
<div class="clearer"></div>
|
| 128 |
+
</div>
|
| 129 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 130 |
+
<h3>Navigation</h3>
|
| 131 |
+
<ul>
|
| 132 |
+
<li class="right" style="margin-right: 10px">
|
| 133 |
+
<a href="genindex.html" title="General Index"
|
| 134 |
+
>index</a></li>
|
| 135 |
+
<li class="right" >
|
| 136 |
+
<a href="backup_server_dialog.html" title="Backup Server Dialog"
|
| 137 |
+
>next</a> |</li>
|
| 138 |
+
<li class="right" >
|
| 139 |
+
<a href="backup_dialog.html" title="Backup Dialog"
|
| 140 |
+
>previous</a> |</li>
|
| 141 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 142 |
+
<li class="nav-item nav-item-1"><a href="backup_and_restore.html" >Backup and Restore</a> »</li>
|
| 143 |
+
<li class="nav-item nav-item-this"><a href="">Backup Globals Dialog</a></li>
|
| 144 |
+
</ul>
|
| 145 |
+
</div>
|
| 146 |
+
<div class="footer" role="contentinfo">
|
| 147 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 148 |
+
<ul>
|
| 149 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 150 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 151 |
+
<li class="right" ><a href="backup_server_dialog.html" title="Backup Server Dialog" accesskey="N">next</a> |</li>
|
| 152 |
+
<li class="right" ><a href="backup_dialog.html" title="Backup Dialog" accesskey="P">previous</a> |</li>
|
| 153 |
+
</ul>
|
| 154 |
+
</div>
|
| 155 |
+
</div>
|
| 156 |
+
</body>
|
| 157 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/backup_server_dialog.html
ADDED
|
@@ -0,0 +1,292 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Backup Server Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Restore Dialog" href="restore_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Backup Globals Dialog" href="backup_globals_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="restore_dialog.html" title="Restore Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="backup_globals_dialog.html" title="Backup Globals Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="backup_and_restore.html" accesskey="U">Backup and Restore</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Backup Server Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="backup-server-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Backup Server Dialog<a class="headerlink" href="#backup-server-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Backup Server</em> dialog to create a plain-text script that will recreate
|
| 51 |
+
the selected server. You can use the pgAdmin <em>Query Tool</em> to play back a
|
| 52 |
+
plain-text script, and recreate the server.</p>
|
| 53 |
+
<img alt="Backup server dialog" class="align-center" src="_images/backup_server_general.png" />
|
| 54 |
+
<p>Use the fields in the <em>General</em> tab to specify the following:</p>
|
| 55 |
+
<ul class="simple">
|
| 56 |
+
<li><p>Enter the name of the backup file in the <em>Filename</em> field. Optionally, select
|
| 57 |
+
the <em>Browser</em> icon (ellipsis) to the right to navigate into a directory and
|
| 58 |
+
select a file that will contain the archive.</p></li>
|
| 59 |
+
<li><p>Use the <em>Encoding</em> drop-down listbox to select the character encoding method
|
| 60 |
+
that should be used for the archive. <strong>Note:</strong> This option is visible only for
|
| 61 |
+
database server greater than or equal to 11.</p></li>
|
| 62 |
+
<li><p>Use the drop-down listbox next to <em>Role name</em> to specify a role with
|
| 63 |
+
connection privileges on the selected server. The role will be used for
|
| 64 |
+
authentication during the backup.</p></li>
|
| 65 |
+
</ul>
|
| 66 |
+
<p>Click the <em>Data Options</em> tab to continue. Use the fields in the <em>Data Options</em>
|
| 67 |
+
tab to provide options related to data or pgAdmin objects that correspond to <em>pg_dumpall</em>.</p>
|
| 68 |
+
<img alt="Type of objects option on backup server dialog" class="align-center" src="_images/backup_server_objects.png" />
|
| 69 |
+
<ul>
|
| 70 |
+
<li><p>Move switches in the <strong>Type of objects</strong> field box to specify details about
|
| 71 |
+
the type of objects that will be backed up.</p>
|
| 72 |
+
<blockquote>
|
| 73 |
+
<div><ul class="simple">
|
| 74 |
+
<li><p>Move the switch next to <em>Only data</em> towards right position to limit the back
|
| 75 |
+
up to data.</p></li>
|
| 76 |
+
<li><p>Move the switch next to <em>Only schemas</em> to limit the back up to schema-level
|
| 77 |
+
database objects.</p></li>
|
| 78 |
+
<li><p>Move the switch next to <em>Only tablespaces</em> to limit the back
|
| 79 |
+
up to tablespaces only.</p></li>
|
| 80 |
+
<li><p>Move the switch next to <em>Only roles</em> to limit the back up to roles only.</p></li>
|
| 81 |
+
</ul>
|
| 82 |
+
</div></blockquote>
|
| 83 |
+
</li>
|
| 84 |
+
</ul>
|
| 85 |
+
<img alt="Do not save option on backup server dialog" class="align-center" src="_images/backup_server_do_not_save.png" />
|
| 86 |
+
<ul>
|
| 87 |
+
<li><p>Move switches in the <strong>Do not save</strong> field box to select the objects that will
|
| 88 |
+
not be included in the backup.</p>
|
| 89 |
+
<blockquote>
|
| 90 |
+
<div><ul class="simple">
|
| 91 |
+
<li><p>Move the switch next to <em>Owner</em> towards right position to exclude commands
|
| 92 |
+
that set object ownership.</p></li>
|
| 93 |
+
<li><p>Move the switch next to <em>Role passwords</em> towards right position to exclude
|
| 94 |
+
passwords for roles.</p></li>
|
| 95 |
+
<li><p>Move the switch next to <em>Privileges</em> towards right position to exclude
|
| 96 |
+
commands that create access privileges.</p></li>
|
| 97 |
+
<li><p>Move the switch next to <em>Tablespaces</em> towards right position to exclude
|
| 98 |
+
tablespaces.</p></li>
|
| 99 |
+
<li><p>Move the switch next to <em>Unlogged table data</em> towards right position to
|
| 100 |
+
exclude the contents of unlogged tables.</p></li>
|
| 101 |
+
<li><p>Move the switch next to <em>Comments</em> towards right position to exclude
|
| 102 |
+
commands that set the comments. <strong>Note:</strong> This option is visible only for
|
| 103 |
+
database server greater than or equal to 11.</p></li>
|
| 104 |
+
<li><p>Move the switch next to <em>Publications</em> towards right position to exclude
|
| 105 |
+
publications.</p></li>
|
| 106 |
+
<li><p>Move the switch next to <em>Subscriptions</em> towards right position to exclude
|
| 107 |
+
subscriptions.</p></li>
|
| 108 |
+
<li><p>Move the switch next to <em>Security labels</em> towards right position to exclude
|
| 109 |
+
Security labels.</p></li>
|
| 110 |
+
<li><p>Move the switch next to <em>Toast compressions</em> towards right position to exclude
|
| 111 |
+
Toast compressions. <strong>Note:</strong> This option is visible only for
|
| 112 |
+
database server greater than or equal to 14.</p></li>
|
| 113 |
+
<li><p>Move the switch next to <em>Table access methods</em> towards right position to exclude
|
| 114 |
+
Table access methods. <strong>Note:</strong> This option is visible only for
|
| 115 |
+
database server greater than or equal to 15.</p></li>
|
| 116 |
+
</ul>
|
| 117 |
+
</div></blockquote>
|
| 118 |
+
</li>
|
| 119 |
+
</ul>
|
| 120 |
+
<img alt="Queries option on backup server dialog" class="align-center" src="_images/backup_server_queries.png" />
|
| 121 |
+
<p>Click the <em>Query Options</em> tab to continue. Use these additional fields to specify
|
| 122 |
+
the type of statements that should be included in the backup.</p>
|
| 123 |
+
<blockquote>
|
| 124 |
+
<div><ul class="simple">
|
| 125 |
+
<li><p>Move the switch next to <em>Use INSERT commands</em> towards right position to
|
| 126 |
+
dump the data in the form of INSERT statements rather than using a COPY
|
| 127 |
+
command. Please note: this may make restoration from backup slow.</p></li>
|
| 128 |
+
<li><p>Use the <em>Maximum rows per INSERT command</em> field to controls the maximum
|
| 129 |
+
number of rows per INSERT command. <strong>Note:</strong> This option is visible only for
|
| 130 |
+
database server greater than or equal to 12.</p></li>
|
| 131 |
+
<li><p>Move the switch next to <em>On conflict do nothing to INSERT command</em> towards
|
| 132 |
+
right position to add ON CONFLICT DO NOTHING to INSERT command.
|
| 133 |
+
This option is not valid unless <em>Use INSERT commands</em>, <em>Use Column INSERTS</em>
|
| 134 |
+
or <em>Maximum rows per INSERT command</em> is also specified.
|
| 135 |
+
<strong>Note:</strong> This option is visible only for database server greater than or
|
| 136 |
+
equal to 12.</p></li>
|
| 137 |
+
<li><p>Move the switch next to <em>Include DROP DATABASE statement</em> towards right
|
| 138 |
+
position to include a command in the backup that will drop any existing
|
| 139 |
+
database object with the same name before recreating the object during a
|
| 140 |
+
backup.</p></li>
|
| 141 |
+
<li><p>Move the switch next to <em>Include IF EXISTS clause</em> towards right
|
| 142 |
+
position to add an IF EXISTS clause to drop databases and other objects.
|
| 143 |
+
This option is not valid unless <em>Include DROP DATABASE statement</em> is also set.</p></li>
|
| 144 |
+
</ul>
|
| 145 |
+
</div></blockquote>
|
| 146 |
+
<img alt="Backup dialog tables section" class="align-center" src="_images/backup_server_table.png" />
|
| 147 |
+
<p>Click the <em>Table Options</em> tab to continue. Use the fields in the <em>Table Options</em>
|
| 148 |
+
tab related to tables that should be included in the backup.</p>
|
| 149 |
+
<blockquote>
|
| 150 |
+
<div><ul class="simple">
|
| 151 |
+
<li><p>Move the switch next to <em>Use Column INSERTS</em> towards right position to dump
|
| 152 |
+
the data in the form of INSERT statements and include explicit column
|
| 153 |
+
names. Please note: this may make restoration from backup slow.</p></li>
|
| 154 |
+
<li><p>Move the switch next to <em>Load via partition root</em> towards right position,
|
| 155 |
+
so when dumping a COPY or INSERT statement for a partitioned table, target
|
| 156 |
+
the root of the partitioning hierarchy which contains it rather than the
|
| 157 |
+
partition itself. <strong>Note:</strong> This option is visible only for database server
|
| 158 |
+
greater than or equal to 11.</p></li>
|
| 159 |
+
</ul>
|
| 160 |
+
</div></blockquote>
|
| 161 |
+
<p>Click the <em>Options</em> tab to continue. Use the fields in the <em>Options</em>
|
| 162 |
+
tab to provide other backup options.</p>
|
| 163 |
+
<img alt="Disable option on backup server dialog" class="align-center" src="_images/backup_server_disable.png" />
|
| 164 |
+
<ul>
|
| 165 |
+
<li><p>Move switches in the <strong>Disable</strong> field box to specify the type of statements
|
| 166 |
+
that should be excluded from the backup.</p>
|
| 167 |
+
<blockquote>
|
| 168 |
+
<div><ul class="simple">
|
| 169 |
+
<li><p>Move the switch next to <em>Triggers</em> (active when creating a data-only backup)
|
| 170 |
+
towards right position to include commands that will disable triggers on the
|
| 171 |
+
target table while the data is being loaded.</p></li>
|
| 172 |
+
<li><p>Move the switch next to <em>$ quoting</em> towards right position to enable dollar
|
| 173 |
+
quoting within function bodies; if disabled, the function body will be
|
| 174 |
+
quoted using SQL standard string syntax.</p></li>
|
| 175 |
+
</ul>
|
| 176 |
+
</div></blockquote>
|
| 177 |
+
</li>
|
| 178 |
+
</ul>
|
| 179 |
+
<img alt="Miscellaneous option on backup server dialog" class="align-center" src="_images/backup_server_miscellaneous.png" />
|
| 180 |
+
<ul>
|
| 181 |
+
<li><p>Move switches in the <strong>Miscellaneous</strong> field box to specify miscellaneous
|
| 182 |
+
backup options.</p>
|
| 183 |
+
<blockquote>
|
| 184 |
+
<div><ul class="simple">
|
| 185 |
+
<li><p>Move the switch next to <em>Verbose messages</em> towards left position to instruct
|
| 186 |
+
<em>pg_dumpall</em> to exclude verbose messages.</p></li>
|
| 187 |
+
<li><p>Move the switch next to <em>Force double quotes on identifiers</em> towards right
|
| 188 |
+
position to force the quoting of all identifiers.</p></li>
|
| 189 |
+
<li><p>Move the switch next to <em>Use SET SESSION AUTHORIZATION</em> towards right
|
| 190 |
+
position to include a statement that will use a SET SESSION AUTHORIZATION
|
| 191 |
+
command to determine object ownership (instead of an ALTER OWNER command).</p></li>
|
| 192 |
+
<li><p>Use the <em>Exclude database</em> field to not dump databases whose name matches
|
| 193 |
+
pattern.</p></li>
|
| 194 |
+
<li><p>Use the <em>Extra float digits</em> field to use the specified value when dumping
|
| 195 |
+
floating-point data, instead of the maximum available precision.</p></li>
|
| 196 |
+
<li><p>Use the <em>Lock wait timeout</em> field to do not wait forever to acquire shared
|
| 197 |
+
table locks at the beginning of the dump. Instead, fail if unable to lock a
|
| 198 |
+
table within the specified timeout.</p></li>
|
| 199 |
+
</ul>
|
| 200 |
+
</div></blockquote>
|
| 201 |
+
</li>
|
| 202 |
+
</ul>
|
| 203 |
+
<p>When you’ve specified the details that will be incorporated into the pg_dumpall
|
| 204 |
+
command:</p>
|
| 205 |
+
<ul class="simple">
|
| 206 |
+
<li><p>Click the <em>Backup</em> button to build and execute a command that builds a backup
|
| 207 |
+
based on your selections on the <em>Backup Server</em> dialog.</p></li>
|
| 208 |
+
<li><p>Click the <em>Cancel</em> button to exit without saving work.</p></li>
|
| 209 |
+
</ul>
|
| 210 |
+
<p>pgAdmin will run the backup process in background. You can view all the background
|
| 211 |
+
process with there running status and logs on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a>
|
| 212 |
+
tab</p>
|
| 213 |
+
</section>
|
| 214 |
+
|
| 215 |
+
|
| 216 |
+
<div class="clearer"></div>
|
| 217 |
+
</div>
|
| 218 |
+
</div>
|
| 219 |
+
</div>
|
| 220 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 221 |
+
<div class="sphinxsidebarwrapper">
|
| 222 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 223 |
+
<ul class="current">
|
| 224 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 225 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 226 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 227 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 228 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 229 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 230 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 231 |
+
<li class="toctree-l1 current"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a><ul class="current">
|
| 232 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_dialog.html">Backup Dialog</a></li>
|
| 233 |
+
<li class="toctree-l2"><a class="reference internal" href="backup_globals_dialog.html">Backup Globals Dialog</a></li>
|
| 234 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Backup Server Dialog</a></li>
|
| 235 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_dialog.html">Restore Dialog</a></li>
|
| 236 |
+
</ul>
|
| 237 |
+
</li>
|
| 238 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 239 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 240 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 241 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 242 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 243 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 244 |
+
</ul>
|
| 245 |
+
|
| 246 |
+
<search id="searchbox" style="display: none" role="search">
|
| 247 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 248 |
+
<div class="searchformwrapper">
|
| 249 |
+
<form class="search" action="search.html" method="get">
|
| 250 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 251 |
+
<input type="submit" value="Go" />
|
| 252 |
+
</form>
|
| 253 |
+
</div>
|
| 254 |
+
</search>
|
| 255 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 256 |
+
</div>
|
| 257 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 258 |
+
<span>«</span>
|
| 259 |
+
</div>
|
| 260 |
+
|
| 261 |
+
</div>
|
| 262 |
+
<div class="clearer"></div>
|
| 263 |
+
</div>
|
| 264 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 265 |
+
<h3>Navigation</h3>
|
| 266 |
+
<ul>
|
| 267 |
+
<li class="right" style="margin-right: 10px">
|
| 268 |
+
<a href="genindex.html" title="General Index"
|
| 269 |
+
>index</a></li>
|
| 270 |
+
<li class="right" >
|
| 271 |
+
<a href="restore_dialog.html" title="Restore Dialog"
|
| 272 |
+
>next</a> |</li>
|
| 273 |
+
<li class="right" >
|
| 274 |
+
<a href="backup_globals_dialog.html" title="Backup Globals Dialog"
|
| 275 |
+
>previous</a> |</li>
|
| 276 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 277 |
+
<li class="nav-item nav-item-1"><a href="backup_and_restore.html" >Backup and Restore</a> »</li>
|
| 278 |
+
<li class="nav-item nav-item-this"><a href="">Backup Server Dialog</a></li>
|
| 279 |
+
</ul>
|
| 280 |
+
</div>
|
| 281 |
+
<div class="footer" role="contentinfo">
|
| 282 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 283 |
+
<ul>
|
| 284 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 285 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 286 |
+
<li class="right" ><a href="restore_dialog.html" title="Restore Dialog" accesskey="N">next</a> |</li>
|
| 287 |
+
<li class="right" ><a href="backup_globals_dialog.html" title="Backup Globals Dialog" accesskey="P">previous</a> |</li>
|
| 288 |
+
</ul>
|
| 289 |
+
</div>
|
| 290 |
+
</div>
|
| 291 |
+
</body>
|
| 292 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/cast_dialog.html
ADDED
|
@@ -0,0 +1,197 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Cast Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Using EDB Job Scheduler" href="dbms_job_scheduler.html" />
|
| 23 |
+
<link rel="prev" title="Managing Database Objects" href="managing_database_objects.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="dbms_job_scheduler.html" title="Using EDB Job Scheduler"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="managing_database_objects.html" title="Managing Database Objects"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Cast Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="cast-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Cast Dialog<a class="headerlink" href="#cast-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Cast</em> dialog to define a cast. A cast specifies how to convert a value
|
| 51 |
+
from one data type to another.</p>
|
| 52 |
+
<p>The <em>Cast</em> dialog organizes the development of a cast through the following
|
| 53 |
+
dialog tabs: <em>General</em> and <em>Definition</em>. The <em>SQL</em> tab displays the SQL code
|
| 54 |
+
generated by dialog selections.</p>
|
| 55 |
+
<img alt="Cast dialog general tab" class="align-center" src="_images/cast_general.png" />
|
| 56 |
+
<p>Use the fields in the <em>General</em> tab to identify the cast:</p>
|
| 57 |
+
<ul class="simple">
|
| 58 |
+
<li><p>The <em>Name</em> field is disabled. The name that will be displayed in the
|
| 59 |
+
<em>pgAdmin</em> tree control is the <em>Source</em> type concatenated with the <em>Target</em>
|
| 60 |
+
type, and is generated automatically when you make selections on the <em>Cast</em>
|
| 61 |
+
dialog <em>Definition</em> tab.</p></li>
|
| 62 |
+
<li><p>Store notes about the cast in the <em>Comment</em> field.</p></li>
|
| 63 |
+
</ul>
|
| 64 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 65 |
+
<img alt="Cast dialog definition tab" class="align-center" src="_images/cast_definition.png" />
|
| 66 |
+
<p>Use the fields in the <em>Definition</em> tab to define parameters:</p>
|
| 67 |
+
<ul class="simple">
|
| 68 |
+
<li><p>Use the drop-down listbox next to <em>Source type</em> to select the name of the
|
| 69 |
+
source data type of the cast.</p></li>
|
| 70 |
+
<li><p>Use the drop-down listbox next to <em>Target type</em> to select the name of the
|
| 71 |
+
target data type of the cast.</p></li>
|
| 72 |
+
<li><p>Use the drop-down listbox next to <em>Function</em> to select the function used to
|
| 73 |
+
perform the cast. The function’s result data type must match the target type
|
| 74 |
+
of the cast.</p></li>
|
| 75 |
+
<li><p>Select <em>Context</em> toggle to <em>Implicit</em> if the cast is implicit.
|
| 76 |
+
By default, a cast can be invoked only by an explicit cast request. If the
|
| 77 |
+
cast is marked <em>Implicit</em> then it can be invoked implicitly in any context,
|
| 78 |
+
whether by assignment or internally in an expression.</p></li>
|
| 79 |
+
</ul>
|
| 80 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 81 |
+
<p>Your entries in the <em>Cast</em> dialog generate a SQL command (see an example below).
|
| 82 |
+
Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes to the
|
| 83 |
+
SQL command.</p>
|
| 84 |
+
<p><strong>Example</strong></p>
|
| 85 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 86 |
+
the <em>Cast</em> dialog:</p>
|
| 87 |
+
<img alt="Cast dialog sql tab" class="align-center" src="_images/cast_sql.png" />
|
| 88 |
+
<ul class="simple">
|
| 89 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 90 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 91 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 92 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 93 |
+
</ul>
|
| 94 |
+
</section>
|
| 95 |
+
|
| 96 |
+
|
| 97 |
+
<div class="clearer"></div>
|
| 98 |
+
</div>
|
| 99 |
+
</div>
|
| 100 |
+
</div>
|
| 101 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 102 |
+
<div class="sphinxsidebarwrapper">
|
| 103 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 104 |
+
<ul class="current">
|
| 105 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 107 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 108 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 109 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 110 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Cast Dialog</a></li>
|
| 111 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 112 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 113 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 114 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 115 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 116 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 117 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 118 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 132 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 138 |
+
</ul>
|
| 139 |
+
</li>
|
| 140 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 142 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 143 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 144 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 149 |
+
</ul>
|
| 150 |
+
|
| 151 |
+
<search id="searchbox" style="display: none" role="search">
|
| 152 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 153 |
+
<div class="searchformwrapper">
|
| 154 |
+
<form class="search" action="search.html" method="get">
|
| 155 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 156 |
+
<input type="submit" value="Go" />
|
| 157 |
+
</form>
|
| 158 |
+
</div>
|
| 159 |
+
</search>
|
| 160 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 161 |
+
</div>
|
| 162 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 163 |
+
<span>«</span>
|
| 164 |
+
</div>
|
| 165 |
+
|
| 166 |
+
</div>
|
| 167 |
+
<div class="clearer"></div>
|
| 168 |
+
</div>
|
| 169 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 170 |
+
<h3>Navigation</h3>
|
| 171 |
+
<ul>
|
| 172 |
+
<li class="right" style="margin-right: 10px">
|
| 173 |
+
<a href="genindex.html" title="General Index"
|
| 174 |
+
>index</a></li>
|
| 175 |
+
<li class="right" >
|
| 176 |
+
<a href="dbms_job_scheduler.html" title="Using EDB Job Scheduler"
|
| 177 |
+
>next</a> |</li>
|
| 178 |
+
<li class="right" >
|
| 179 |
+
<a href="managing_database_objects.html" title="Managing Database Objects"
|
| 180 |
+
>previous</a> |</li>
|
| 181 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 182 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 183 |
+
<li class="nav-item nav-item-this"><a href="">Cast Dialog</a></li>
|
| 184 |
+
</ul>
|
| 185 |
+
</div>
|
| 186 |
+
<div class="footer" role="contentinfo">
|
| 187 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 188 |
+
<ul>
|
| 189 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 190 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 191 |
+
<li class="right" ><a href="dbms_job_scheduler.html" title="Using EDB Job Scheduler" accesskey="N">next</a> |</li>
|
| 192 |
+
<li class="right" ><a href="managing_database_objects.html" title="Managing Database Objects" accesskey="P">previous</a> |</li>
|
| 193 |
+
</ul>
|
| 194 |
+
</div>
|
| 195 |
+
</div>
|
| 196 |
+
</body>
|
| 197 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/change_ownership.html
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Change Ownership Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Change User Password Dialog" href="change_user_password.html" />
|
| 23 |
+
<link rel="prev" title="User Management Dialog" href="user_management.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="change_user_password.html" title="Change User Password Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="user_management.html" title="User Management Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" accesskey="U">Getting Started</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Change Ownership Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="change-ownership-dialog">
|
| 49 |
+
<span id="change-ownership"></span><h1><span class="target" id="index-0"></span>Change Ownership Dialog<a class="headerlink" href="#change-ownership-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Change Ownership</em> dialog to change the ownership of the shared servers.
|
| 51 |
+
This dialog will appear if a user has been deleted from
|
| 52 |
+
<a class="reference internal" href="user_management.html#user-management"><span class="std std-ref">User Management</span></a> and owned some shared servers.</p>
|
| 53 |
+
<p>Choose the user who will own the shared servers from the drop-down.</p>
|
| 54 |
+
<img alt="Change ownership dialog" class="align-center" src="_images/change_ownership.png" />
|
| 55 |
+
<p>Click the <em>Change</em> button to change the ownership.</p>
|
| 56 |
+
<p>The shared servers owned by the user will be deleted if the user is not
|
| 57 |
+
selected from the drop-down.</p>
|
| 58 |
+
<img alt="Change ownership dialog" class="align-center" src="_images/change_ownership_info.png" />
|
| 59 |
+
<p>Click the <em>Change</em> button to change the ownership; click <em>Close</em> to
|
| 60 |
+
exit the dialog.</p>
|
| 61 |
+
</section>
|
| 62 |
+
|
| 63 |
+
|
| 64 |
+
<div class="clearer"></div>
|
| 65 |
+
</div>
|
| 66 |
+
</div>
|
| 67 |
+
</div>
|
| 68 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 69 |
+
<div class="sphinxsidebarwrapper">
|
| 70 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 71 |
+
<ul class="current">
|
| 72 |
+
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| 73 |
+
<li class="toctree-l2"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
| 74 |
+
<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| 75 |
+
<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| 76 |
+
<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| 77 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Change Ownership Dialog</a></li>
|
| 78 |
+
<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
|
| 79 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| 80 |
+
<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| 81 |
+
<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| 82 |
+
<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| 83 |
+
<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| 84 |
+
<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| 85 |
+
<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| 86 |
+
<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| 87 |
+
<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| 88 |
+
<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| 89 |
+
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| 90 |
+
<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| 91 |
+
<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| 92 |
+
</ul>
|
| 93 |
+
</li>
|
| 94 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 95 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 96 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 97 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 98 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 99 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 100 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 101 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 102 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 103 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 104 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 105 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 107 |
+
</ul>
|
| 108 |
+
|
| 109 |
+
<search id="searchbox" style="display: none" role="search">
|
| 110 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 111 |
+
<div class="searchformwrapper">
|
| 112 |
+
<form class="search" action="search.html" method="get">
|
| 113 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 114 |
+
<input type="submit" value="Go" />
|
| 115 |
+
</form>
|
| 116 |
+
</div>
|
| 117 |
+
</search>
|
| 118 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 119 |
+
</div>
|
| 120 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 121 |
+
<span>«</span>
|
| 122 |
+
</div>
|
| 123 |
+
|
| 124 |
+
</div>
|
| 125 |
+
<div class="clearer"></div>
|
| 126 |
+
</div>
|
| 127 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 128 |
+
<h3>Navigation</h3>
|
| 129 |
+
<ul>
|
| 130 |
+
<li class="right" style="margin-right: 10px">
|
| 131 |
+
<a href="genindex.html" title="General Index"
|
| 132 |
+
>index</a></li>
|
| 133 |
+
<li class="right" >
|
| 134 |
+
<a href="change_user_password.html" title="Change User Password Dialog"
|
| 135 |
+
>next</a> |</li>
|
| 136 |
+
<li class="right" >
|
| 137 |
+
<a href="user_management.html" title="User Management Dialog"
|
| 138 |
+
>previous</a> |</li>
|
| 139 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 140 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 141 |
+
<li class="nav-item nav-item-this"><a href="">Change Ownership Dialog</a></li>
|
| 142 |
+
</ul>
|
| 143 |
+
</div>
|
| 144 |
+
<div class="footer" role="contentinfo">
|
| 145 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 146 |
+
<ul>
|
| 147 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 148 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 149 |
+
<li class="right" ><a href="change_user_password.html" title="Change User Password Dialog" accesskey="N">next</a> |</li>
|
| 150 |
+
<li class="right" ><a href="user_management.html" title="User Management Dialog" accesskey="P">previous</a> |</li>
|
| 151 |
+
</ul>
|
| 152 |
+
</div>
|
| 153 |
+
</div>
|
| 154 |
+
</body>
|
| 155 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/change_password_dialog.html
ADDED
|
@@ -0,0 +1,164 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Change Password Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Grant Wizard" href="grant_wizard.html" />
|
| 23 |
+
<link rel="prev" title="Add Named Restore Point Dialog" href="add_restore_point_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="grant_wizard.html" title="Grant Wizard"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="add_restore_point_dialog.html" title="Add Named Restore Point Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="management_basics.html" accesskey="U">Management Basics</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Change Password Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="change-password-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Change Password Dialog<a class="headerlink" href="#change-password-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>It is a good policy to routinely change your password to protect data, even in
|
| 51 |
+
what you may consider a ‘safe’ environment. In the workplace, failure to apply
|
| 52 |
+
an appropriate password policy could leave you in breach of Data Protection
|
| 53 |
+
laws.</p>
|
| 54 |
+
<p>Please consider the following guidelines when selecting a password:</p>
|
| 55 |
+
<ul class="simple">
|
| 56 |
+
<li><p>Ensure that your password is an adequate length; 6 characters should be the
|
| 57 |
+
absolute minimum number of characters in the password.</p></li>
|
| 58 |
+
<li><p>The minimum password length is set by default to six characters. This value
|
| 59 |
+
can be changed by setting the <em>PASSWORD_LENGTH_MIN</em> option to desired length
|
| 60 |
+
in pgAdmin configuration; see <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">The config.py File</span></a> for more information.</p></li>
|
| 61 |
+
<li><p>Ensure that your password is not open to dictionary attacks. Use a mixture of
|
| 62 |
+
upper and lower case letters and numerics, and avoid words or names. Consider
|
| 63 |
+
using the first letter from each word in a phrase that you will remember
|
| 64 |
+
easily but is an unfamiliar acronym.</p></li>
|
| 65 |
+
<li><p>Ensure that your password is changed regularly; at minimum, change it every
|
| 66 |
+
ninety days.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
<p>The guidelines above should be considered a starting point: They are not a
|
| 69 |
+
comprehensive list and they <strong>will not guarantee security</strong>.</p>
|
| 70 |
+
<img alt="Change database password dialog" class="align-center" src="_images/password.png" />
|
| 71 |
+
<p>Use the <em>Change Password</em> dialog to change your password:</p>
|
| 72 |
+
<ul class="simple">
|
| 73 |
+
<li><p>The name displayed in the <em>User</em> field is the role for which you are modifying
|
| 74 |
+
the password; it is the role that is associated with the server connection
|
| 75 |
+
that is highlighted in the tree control.</p></li>
|
| 76 |
+
<li><p>Enter the password associated with the role in the <em>Current Password</em> field.</p></li>
|
| 77 |
+
<li><p>Enter the desired password for in the <em>New Password</em> field.</p></li>
|
| 78 |
+
<li><p>Re-enter the new password in the <em>Confirm Password</em> field.</p></li>
|
| 79 |
+
</ul>
|
| 80 |
+
<p>Click the <em>Save</em> button to change your password.</p>
|
| 81 |
+
<p>Click the <em>Close</em> button to exit without changing your password.</p>
|
| 82 |
+
<p>Click the <em>Reset</em> button to reset the values.</p>
|
| 83 |
+
</section>
|
| 84 |
+
|
| 85 |
+
|
| 86 |
+
<div class="clearer"></div>
|
| 87 |
+
</div>
|
| 88 |
+
</div>
|
| 89 |
+
</div>
|
| 90 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 91 |
+
<div class="sphinxsidebarwrapper">
|
| 92 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 93 |
+
<ul class="current">
|
| 94 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 95 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 96 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 97 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 98 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 99 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 100 |
+
<li class="toctree-l1 current"><a class="reference internal" href="management_basics.html">Management Basics</a><ul class="current">
|
| 101 |
+
<li class="toctree-l2"><a class="reference internal" href="add_restore_point_dialog.html">Add Named Restore Point Dialog</a></li>
|
| 102 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Change Password Dialog</a></li>
|
| 103 |
+
<li class="toctree-l2"><a class="reference internal" href="grant_wizard.html">Grant Wizard</a></li>
|
| 104 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_data.html">Import/Export Data Dialog</a></li>
|
| 105 |
+
<li class="toctree-l2"><a class="reference internal" href="maintenance_dialog.html">Maintenance Dialog</a></li>
|
| 106 |
+
<li class="toctree-l2"><a class="reference internal" href="storage_manager.html">Storage Manager</a></li>
|
| 107 |
+
</ul>
|
| 108 |
+
</li>
|
| 109 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 110 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 111 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 113 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 114 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 115 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 116 |
+
</ul>
|
| 117 |
+
|
| 118 |
+
<search id="searchbox" style="display: none" role="search">
|
| 119 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 120 |
+
<div class="searchformwrapper">
|
| 121 |
+
<form class="search" action="search.html" method="get">
|
| 122 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 123 |
+
<input type="submit" value="Go" />
|
| 124 |
+
</form>
|
| 125 |
+
</div>
|
| 126 |
+
</search>
|
| 127 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 128 |
+
</div>
|
| 129 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 130 |
+
<span>«</span>
|
| 131 |
+
</div>
|
| 132 |
+
|
| 133 |
+
</div>
|
| 134 |
+
<div class="clearer"></div>
|
| 135 |
+
</div>
|
| 136 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 137 |
+
<h3>Navigation</h3>
|
| 138 |
+
<ul>
|
| 139 |
+
<li class="right" style="margin-right: 10px">
|
| 140 |
+
<a href="genindex.html" title="General Index"
|
| 141 |
+
>index</a></li>
|
| 142 |
+
<li class="right" >
|
| 143 |
+
<a href="grant_wizard.html" title="Grant Wizard"
|
| 144 |
+
>next</a> |</li>
|
| 145 |
+
<li class="right" >
|
| 146 |
+
<a href="add_restore_point_dialog.html" title="Add Named Restore Point Dialog"
|
| 147 |
+
>previous</a> |</li>
|
| 148 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 149 |
+
<li class="nav-item nav-item-1"><a href="management_basics.html" >Management Basics</a> »</li>
|
| 150 |
+
<li class="nav-item nav-item-this"><a href="">Change Password Dialog</a></li>
|
| 151 |
+
</ul>
|
| 152 |
+
</div>
|
| 153 |
+
<div class="footer" role="contentinfo">
|
| 154 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 155 |
+
<ul>
|
| 156 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 157 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 158 |
+
<li class="right" ><a href="grant_wizard.html" title="Grant Wizard" accesskey="N">next</a> |</li>
|
| 159 |
+
<li class="right" ><a href="add_restore_point_dialog.html" title="Add Named Restore Point Dialog" accesskey="P">previous</a> |</li>
|
| 160 |
+
</ul>
|
| 161 |
+
</div>
|
| 162 |
+
</div>
|
| 163 |
+
</body>
|
| 164 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/change_user_password.html
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Change User Password Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Lock/Restore Account" href="restore_locked_user.html" />
|
| 23 |
+
<link rel="prev" title="Change Ownership Dialog" href="change_ownership.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="restore_locked_user.html" title="Lock/Restore Account"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="change_ownership.html" title="Change Ownership Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" accesskey="U">Getting Started</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Change User Password Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="change-user-password-dialog">
|
| 49 |
+
<span id="change-user-password"></span><h1><span class="target" id="index-0"></span>Change User Password Dialog<a class="headerlink" href="#change-user-password-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>It is a good policy to routinely change your password to protect data, even in
|
| 51 |
+
what you may consider a ‘safe’ environment. In the workplace, failure to apply
|
| 52 |
+
an appropriate password policy could leave you in breach of Data Protection
|
| 53 |
+
laws.</p>
|
| 54 |
+
<p>Please consider the following guidelines when selecting a password:</p>
|
| 55 |
+
<ul class="simple">
|
| 56 |
+
<li><p>Ensure that your password is an adequate length; 6 characters should be the
|
| 57 |
+
absolute minimum number of characters in the password.</p></li>
|
| 58 |
+
<li><p>The minimum password length is set by default to six characters. This value
|
| 59 |
+
can be changed by setting the <em>PASSWORD_LENGTH_MIN</em> option to desired length
|
| 60 |
+
in pgAdmin configuration; see <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">The config.py File</span></a> for more information.</p></li>
|
| 61 |
+
<li><p>Ensure that your password is not open to dictionary attacks. Use a mixture of
|
| 62 |
+
upper and lower case letters and numerics, and avoid words or names. Consider
|
| 63 |
+
using the first letter from each word in a phrase that you will remember
|
| 64 |
+
easily but is an unfamiliar acronym.</p></li>
|
| 65 |
+
<li><p>Ensure that your password is changed regularly; at minimum, change it every
|
| 66 |
+
ninety days.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
<p>The guidelines above should be considered a starting point: They are not a
|
| 69 |
+
comprehensive list and they <strong>will not guarantee security</strong>.</p>
|
| 70 |
+
<img alt="Change current user password dialog" class="align-center" src="_images/change_user_password.png" />
|
| 71 |
+
<p>Use the <em>Change Password</em> dialog to change your password:</p>
|
| 72 |
+
<ul class="simple">
|
| 73 |
+
<li><p>Enter your existing password in the <em>Current Password</em> field.</p></li>
|
| 74 |
+
<li><p>Enter the desired password for in the <em>New Password</em> field.</p></li>
|
| 75 |
+
<li><p>Re-enter the new password in the <em>Confirm Password</em> field.</p></li>
|
| 76 |
+
</ul>
|
| 77 |
+
<p>Click the <em>Change Password</em> button to change your password; click <em>Close</em> to
|
| 78 |
+
exit the dialog.</p>
|
| 79 |
+
</section>
|
| 80 |
+
|
| 81 |
+
|
| 82 |
+
<div class="clearer"></div>
|
| 83 |
+
</div>
|
| 84 |
+
</div>
|
| 85 |
+
</div>
|
| 86 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 87 |
+
<div class="sphinxsidebarwrapper">
|
| 88 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 89 |
+
<ul class="current">
|
| 90 |
+
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| 91 |
+
<li class="toctree-l2"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
| 92 |
+
<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| 93 |
+
<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| 94 |
+
<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| 95 |
+
<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
|
| 96 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Change User Password Dialog</a></li>
|
| 97 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| 98 |
+
<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| 99 |
+
<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| 100 |
+
<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| 101 |
+
<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| 102 |
+
<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| 103 |
+
<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| 104 |
+
<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| 105 |
+
<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| 106 |
+
<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| 107 |
+
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| 108 |
+
<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| 109 |
+
<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| 110 |
+
</ul>
|
| 111 |
+
</li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 113 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 114 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 115 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 116 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 119 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 120 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 121 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 122 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 123 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 124 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 125 |
+
</ul>
|
| 126 |
+
|
| 127 |
+
<search id="searchbox" style="display: none" role="search">
|
| 128 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 129 |
+
<div class="searchformwrapper">
|
| 130 |
+
<form class="search" action="search.html" method="get">
|
| 131 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 132 |
+
<input type="submit" value="Go" />
|
| 133 |
+
</form>
|
| 134 |
+
</div>
|
| 135 |
+
</search>
|
| 136 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 137 |
+
</div>
|
| 138 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 139 |
+
<span>«</span>
|
| 140 |
+
</div>
|
| 141 |
+
|
| 142 |
+
</div>
|
| 143 |
+
<div class="clearer"></div>
|
| 144 |
+
</div>
|
| 145 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 146 |
+
<h3>Navigation</h3>
|
| 147 |
+
<ul>
|
| 148 |
+
<li class="right" style="margin-right: 10px">
|
| 149 |
+
<a href="genindex.html" title="General Index"
|
| 150 |
+
>index</a></li>
|
| 151 |
+
<li class="right" >
|
| 152 |
+
<a href="restore_locked_user.html" title="Lock/Restore Account"
|
| 153 |
+
>next</a> |</li>
|
| 154 |
+
<li class="right" >
|
| 155 |
+
<a href="change_ownership.html" title="Change Ownership Dialog"
|
| 156 |
+
>previous</a> |</li>
|
| 157 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 158 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 159 |
+
<li class="nav-item nav-item-this"><a href="">Change User Password Dialog</a></li>
|
| 160 |
+
</ul>
|
| 161 |
+
</div>
|
| 162 |
+
<div class="footer" role="contentinfo">
|
| 163 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 164 |
+
<ul>
|
| 165 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 166 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 167 |
+
<li class="right" ><a href="restore_locked_user.html" title="Lock/Restore Account" accesskey="N">next</a> |</li>
|
| 168 |
+
<li class="right" ><a href="change_ownership.html" title="Change Ownership Dialog" accesskey="P">previous</a> |</li>
|
| 169 |
+
</ul>
|
| 170 |
+
</div>
|
| 171 |
+
</div>
|
| 172 |
+
</body>
|
| 173 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/check_dialog.html
ADDED
|
@@ -0,0 +1,180 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Check Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Column Dialog" href="column_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Creating or Modifying a Table" href="modifying_tables.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="column_dialog.html" title="Column Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="modifying_tables.html" title="Creating or Modifying a Table"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" accesskey="U">Creating or Modifying a Table</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Check Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="check-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Check Dialog<a class="headerlink" href="#check-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Check</em> dialog to define or modify a check constraint. A check
|
| 51 |
+
constraint specifies an expression that produces a Boolean result that new or
|
| 52 |
+
updated rows must satisfy for an insert or update operation to succeed.</p>
|
| 53 |
+
<p>The <em>Check</em> dialog organizes the development of a check constraint through the
|
| 54 |
+
<em>General</em> and <em>Definition</em> tabs. The <em>SQL</em> tab displays the SQL code generated
|
| 55 |
+
by dialog selections.</p>
|
| 56 |
+
<img alt="Check dialog general tab" class="align-center" src="_images/check_general.png" />
|
| 57 |
+
<p>Use the fields in the <em>General</em> tab to identify the check constraint:</p>
|
| 58 |
+
<ul class="simple">
|
| 59 |
+
<li><p>Use the <em>Name</em> field to provide a descriptive name for the check constraint
|
| 60 |
+
that will be displayed in the <em>pgAdmin</em> tree control. With PostgreSQL 9.5
|
| 61 |
+
forward, when a table has multiple check constraints, they will be tested for
|
| 62 |
+
each row in alphabetical order by name and after NOT NULL constraints.</p></li>
|
| 63 |
+
<li><p>Store notes about the check constraint in the <em>Comment</em> field.</p></li>
|
| 64 |
+
</ul>
|
| 65 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 66 |
+
<img alt="Check dialog definition tab" class="align-center" src="_images/check_definition.png" />
|
| 67 |
+
<p>Use the fields in the <em>Definition</em> tab to define the check constraint:</p>
|
| 68 |
+
<ul class="simple">
|
| 69 |
+
<li><p>Provide the expression that a row must satisfy in the <em>Check</em> field.</p></li>
|
| 70 |
+
<li><p>Move the <em>No Inherit?</em> switch to the <em>Yes</em> position to specify that this
|
| 71 |
+
constraint is not automatically inherited by a table’s children. The default
|
| 72 |
+
is <em>No</em>, meaning that the constraint will be inherited by any children.</p></li>
|
| 73 |
+
<li><p>Move the <em>Don’t validate?</em> switch to the <em>No</em> position to skip validation of
|
| 74 |
+
existing data; the constraint may not hold for all rows in the table. The
|
| 75 |
+
default is <em>Yes</em>.</p></li>
|
| 76 |
+
</ul>
|
| 77 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 78 |
+
<p>Your entries in the <em>Check</em> dialog generate a SQL command (see an example
|
| 79 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 80 |
+
to the SQL command.</p>
|
| 81 |
+
<p><strong>Example</strong></p>
|
| 82 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 83 |
+
the <em>Check</em> dialog:</p>
|
| 84 |
+
<img alt="Check dialog sql tab" class="align-center" src="_images/check_sql.png" />
|
| 85 |
+
<p>The example shown demonstrates creating a check constraint named <em>jobhist_date_chk</em>
|
| 86 |
+
on the <em>startdate</em> column of the <em>jobhist</em> table.</p>
|
| 87 |
+
<ul class="simple">
|
| 88 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 89 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 90 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 91 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 92 |
+
</ul>
|
| 93 |
+
</section>
|
| 94 |
+
|
| 95 |
+
|
| 96 |
+
<div class="clearer"></div>
|
| 97 |
+
</div>
|
| 98 |
+
</div>
|
| 99 |
+
</div>
|
| 100 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 101 |
+
<div class="sphinxsidebarwrapper">
|
| 102 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 103 |
+
<ul class="current">
|
| 104 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 105 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 107 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 108 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 109 |
+
<li class="toctree-l1 current"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a><ul class="current">
|
| 110 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Check Dialog</a></li>
|
| 111 |
+
<li class="toctree-l2"><a class="reference internal" href="column_dialog.html">Column Dialog</a></li>
|
| 112 |
+
<li class="toctree-l2"><a class="reference internal" href="compound_trigger_dialog.html">Compound Trigger Dialog</a></li>
|
| 113 |
+
<li class="toctree-l2"><a class="reference internal" href="exclusion_constraint_dialog.html">Exclusion Constraint Dialog</a></li>
|
| 114 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_key_dialog.html">Foreign key Dialog</a></li>
|
| 115 |
+
<li class="toctree-l2"><a class="reference internal" href="index_dialog.html">Index Dialog</a></li>
|
| 116 |
+
<li class="toctree-l2"><a class="reference internal" href="primary_key_dialog.html">Primary key Dialog</a></li>
|
| 117 |
+
<li class="toctree-l2"><a class="reference internal" href="rls_policy_dialog.html">RLS Policy Dialog</a></li>
|
| 118 |
+
<li class="toctree-l2"><a class="reference internal" href="rule_dialog.html">Rule Dialog</a></li>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="table_dialog.html">Table Dialog</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_dialog.html">Trigger Dialog</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="unique_constraint_dialog.html">Unique Constraint Dialog</a></li>
|
| 122 |
+
</ul>
|
| 123 |
+
</li>
|
| 124 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 125 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 126 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 127 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 128 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 129 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 130 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 131 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 132 |
+
</ul>
|
| 133 |
+
|
| 134 |
+
<search id="searchbox" style="display: none" role="search">
|
| 135 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 136 |
+
<div class="searchformwrapper">
|
| 137 |
+
<form class="search" action="search.html" method="get">
|
| 138 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 139 |
+
<input type="submit" value="Go" />
|
| 140 |
+
</form>
|
| 141 |
+
</div>
|
| 142 |
+
</search>
|
| 143 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 144 |
+
</div>
|
| 145 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 146 |
+
<span>«</span>
|
| 147 |
+
</div>
|
| 148 |
+
|
| 149 |
+
</div>
|
| 150 |
+
<div class="clearer"></div>
|
| 151 |
+
</div>
|
| 152 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 153 |
+
<h3>Navigation</h3>
|
| 154 |
+
<ul>
|
| 155 |
+
<li class="right" style="margin-right: 10px">
|
| 156 |
+
<a href="genindex.html" title="General Index"
|
| 157 |
+
>index</a></li>
|
| 158 |
+
<li class="right" >
|
| 159 |
+
<a href="column_dialog.html" title="Column Dialog"
|
| 160 |
+
>next</a> |</li>
|
| 161 |
+
<li class="right" >
|
| 162 |
+
<a href="modifying_tables.html" title="Creating or Modifying a Table"
|
| 163 |
+
>previous</a> |</li>
|
| 164 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 165 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" >Creating or Modifying a Table</a> »</li>
|
| 166 |
+
<li class="nav-item nav-item-this"><a href="">Check Dialog</a></li>
|
| 167 |
+
</ul>
|
| 168 |
+
</div>
|
| 169 |
+
<div class="footer" role="contentinfo">
|
| 170 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 171 |
+
<ul>
|
| 172 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 173 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 174 |
+
<li class="right" ><a href="column_dialog.html" title="Column Dialog" accesskey="N">next</a> |</li>
|
| 175 |
+
<li class="right" ><a href="modifying_tables.html" title="Creating or Modifying a Table" accesskey="P">previous</a> |</li>
|
| 176 |
+
</ul>
|
| 177 |
+
</div>
|
| 178 |
+
</div>
|
| 179 |
+
</body>
|
| 180 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/clear_saved_passwords.html
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Clear Saved Passwords — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="PostgreSQL Cloud Deployment" href="cloud_deployment.html" />
|
| 23 |
+
<link rel="prev" title="Server Dialog" href="server_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="cloud_deployment.html" title="PostgreSQL Cloud Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="server_dialog.html" title="Server Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="server_dialog.html" accesskey="U">Server Dialog</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">Clear Saved Passwords</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="clear-saved-passwords">
|
| 50 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Clear Saved Passwords<a class="headerlink" href="#clear-saved-passwords" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>Use <em>Clear Saved Password</em> functionality to clear the saved password for the
|
| 52 |
+
database server.</p>
|
| 53 |
+
<img alt="_images/clear_saved_password.png" class="align-center" src="_images/clear_saved_password.png" />
|
| 54 |
+
<p><em>Clear Saved Password</em> shows in the context menu for the selected server as well
|
| 55 |
+
as under the <em>Object</em> menu on the top menu bar.</p>
|
| 56 |
+
<p>Use <em>Clear SSH Tunnel Password</em> functionality to clear the saved password of SSH
|
| 57 |
+
Tunnel to connect to the database server.</p>
|
| 58 |
+
<img alt="_images/clear_tunnel_password.png" class="align-center" src="_images/clear_tunnel_password.png" />
|
| 59 |
+
<p><em>Clear SSH Tunnel Password</em> shows in the context menu for the selected server as
|
| 60 |
+
well as under the <em>Object</em> menu on the top menu bar.</p>
|
| 61 |
+
<p><strong>Note:</strong> It will be enabled/visible when the password for the selected database
|
| 62 |
+
server is already saved.</p>
|
| 63 |
+
</section>
|
| 64 |
+
|
| 65 |
+
|
| 66 |
+
<div class="clearer"></div>
|
| 67 |
+
</div>
|
| 68 |
+
</div>
|
| 69 |
+
</div>
|
| 70 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 71 |
+
<div class="sphinxsidebarwrapper">
|
| 72 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 73 |
+
<ul class="current">
|
| 74 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 75 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 76 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 77 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 78 |
+
<li class="toctree-l2 current"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 79 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 80 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 81 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 82 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 83 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 84 |
+
</ul>
|
| 85 |
+
</li>
|
| 86 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 87 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 88 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 89 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 90 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 91 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 92 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 93 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 94 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 95 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 96 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 97 |
+
</ul>
|
| 98 |
+
|
| 99 |
+
<search id="searchbox" style="display: none" role="search">
|
| 100 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 101 |
+
<div class="searchformwrapper">
|
| 102 |
+
<form class="search" action="search.html" method="get">
|
| 103 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 104 |
+
<input type="submit" value="Go" />
|
| 105 |
+
</form>
|
| 106 |
+
</div>
|
| 107 |
+
</search>
|
| 108 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 109 |
+
</div>
|
| 110 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 111 |
+
<span>«</span>
|
| 112 |
+
</div>
|
| 113 |
+
|
| 114 |
+
</div>
|
| 115 |
+
<div class="clearer"></div>
|
| 116 |
+
</div>
|
| 117 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 118 |
+
<h3>Navigation</h3>
|
| 119 |
+
<ul>
|
| 120 |
+
<li class="right" style="margin-right: 10px">
|
| 121 |
+
<a href="genindex.html" title="General Index"
|
| 122 |
+
>index</a></li>
|
| 123 |
+
<li class="right" >
|
| 124 |
+
<a href="cloud_deployment.html" title="PostgreSQL Cloud Deployment"
|
| 125 |
+
>next</a> |</li>
|
| 126 |
+
<li class="right" >
|
| 127 |
+
<a href="server_dialog.html" title="Server Dialog"
|
| 128 |
+
>previous</a> |</li>
|
| 129 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 130 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 131 |
+
<li class="nav-item nav-item-2"><a href="server_dialog.html" >Server Dialog</a> »</li>
|
| 132 |
+
<li class="nav-item nav-item-this"><a href="">Clear Saved Passwords</a></li>
|
| 133 |
+
</ul>
|
| 134 |
+
</div>
|
| 135 |
+
<div class="footer" role="contentinfo">
|
| 136 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 137 |
+
<ul>
|
| 138 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 139 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 140 |
+
<li class="right" ><a href="cloud_deployment.html" title="PostgreSQL Cloud Deployment" accesskey="N">next</a> |</li>
|
| 141 |
+
<li class="right" ><a href="server_dialog.html" title="Server Dialog" accesskey="P">previous</a> |</li>
|
| 142 |
+
</ul>
|
| 143 |
+
</div>
|
| 144 |
+
</div>
|
| 145 |
+
</body>
|
| 146 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/cloud_aws_rds.html
ADDED
|
@@ -0,0 +1,189 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Amazon RDS Cloud Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="EDB BigAnimal Cloud Deployment" href="cloud_edb_biganimal.html" />
|
| 23 |
+
<link rel="prev" title="PostgreSQL Cloud Deployment" href="cloud_deployment.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="cloud_edb_biganimal.html" title="EDB BigAnimal Cloud Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="cloud_deployment.html" title="PostgreSQL Cloud Deployment"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" accesskey="U">PostgreSQL Cloud Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">Amazon RDS Cloud Deployment</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="amazon-rds-cloud-deployment">
|
| 50 |
+
<span id="cloud-aws-rds"></span><h1><span class="target" id="index-0"></span>Amazon RDS Cloud Deployment<a class="headerlink" href="#amazon-rds-cloud-deployment" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>To deploy a PostgreSQL server on the Amazon cloud, follow the below steps.</p>
|
| 52 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_provider_for_postgresql.png" />
|
| 53 |
+
<p>Once you launch the tool, select the Amazon RDS option.
|
| 54 |
+
Click on the <em>Next</em> button to proceed further.</p>
|
| 55 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_aws_credentials.png" />
|
| 56 |
+
<p>In the Credentials dialog, provide the region in which you want to deploy the
|
| 57 |
+
instance along with the <em>AWS access key</em> and <em>AWS secret access key</em>.
|
| 58 |
+
Provide <em>AWS session token</em> only if your AWS session is temporary.</p>
|
| 59 |
+
<p>To proceed further, click on the next button. Before going further, pgAdmin
|
| 60 |
+
will validate your credentials.</p>
|
| 61 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_aws_instance.png" />
|
| 62 |
+
<p>Use the fields from the Instance Specification tab to specify the Instance
|
| 63 |
+
details.</p>
|
| 64 |
+
<ul class="simple">
|
| 65 |
+
<li><p>Use the <em>Instance name</em> field to add an instance name for the PostgreSQL
|
| 66 |
+
server; the name specified will be displayed in the <em>Object Explorer</em> too.</p></li>
|
| 67 |
+
<li><p>Use the <em>Public IP</em> field to specify the IP Address range for permitting the
|
| 68 |
+
inbound traffic.</p></li>
|
| 69 |
+
<li><p>Use the <em>Database version</em> field to specify the PostgreSQL version to deploy.</p></li>
|
| 70 |
+
<li><p>Use the <em>Instance class</em> field to allocate the computational, network, and
|
| 71 |
+
memory capacity required by planned workload of this DB instance.</p></li>
|
| 72 |
+
<li><p>Use the <em>Instance type</em> field to select the instance type.</p></li>
|
| 73 |
+
<li><p>Use the <em>Storage type</em> field to select the instance storage type. Three
|
| 74 |
+
options are available. General Purpose (SSD) storage, Provisioned IOPS (SSD)
|
| 75 |
+
and Magnetic storage.</p></li>
|
| 76 |
+
<li><p>Use the <em>Allocated storage</em> field to specify the storage capacity in GiB.</p></li>
|
| 77 |
+
<li><p>Use the <em>Provisioned IOPS</em> in case of Provisioned IOPS (SSD) storage type.</p></li>
|
| 78 |
+
<li><p>Use the <em>High Availability</em> option to specify High Availability
|
| 79 |
+
option. This option creates a standby in a different Availability Zone(AZ).</p></li>
|
| 80 |
+
</ul>
|
| 81 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_aws_database.png" />
|
| 82 |
+
<p>Use the fields from the Database Details tab to specify the Instance details.</p>
|
| 83 |
+
<ul class="simple">
|
| 84 |
+
<li><p>Use the drop-down list box in the <em>Server group</em> field to select the parent
|
| 85 |
+
node for the server; the server will be displayed in the <em>Object Explorer</em>
|
| 86 |
+
within the specified group.</p></li>
|
| 87 |
+
<li><p>Use the <em>Database name</em> field to add the database name for the PostgreSQL
|
| 88 |
+
server.</p></li>
|
| 89 |
+
<li><p>Use the <em>Username</em> field to specify the name of a role that will be used when
|
| 90 |
+
authenticating with the server.</p></li>
|
| 91 |
+
<li><p>Use the <em>Password</em> field to provide a password that will be supplied when
|
| 92 |
+
authenticating with the server.</p></li>
|
| 93 |
+
<li><p>Use the <em>Confirm password</em> field to repeat the password.</p></li>
|
| 94 |
+
<li><p>Enter the listener port number of the server host in the <em>Port</em> field.</p></li>
|
| 95 |
+
</ul>
|
| 96 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_aws_review.png" />
|
| 97 |
+
<p>At the end, review the Instance details that you provided. Click on Finish
|
| 98 |
+
button to deploy the instance on Amazon RDS.</p>
|
| 99 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_deployment_tree.png" />
|
| 100 |
+
<p>Once you click on the finish, one background process will start which will
|
| 101 |
+
deploy the instance in the cloud and monitor the progress of the deployment.
|
| 102 |
+
You can view all the background process with there running status and logs
|
| 103 |
+
on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a> tab</p>
|
| 104 |
+
<p>The Server will be added to the tree with the cloud deployment icon. Once the
|
| 105 |
+
deployment is done, the server details will be updated.</p>
|
| 106 |
+
</section>
|
| 107 |
+
|
| 108 |
+
|
| 109 |
+
<div class="clearer"></div>
|
| 110 |
+
</div>
|
| 111 |
+
</div>
|
| 112 |
+
</div>
|
| 113 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 114 |
+
<div class="sphinxsidebarwrapper">
|
| 115 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 116 |
+
<ul class="current">
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 119 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 122 |
+
<li class="toctree-l2 current"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 127 |
+
</ul>
|
| 128 |
+
</li>
|
| 129 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 130 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 131 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 132 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 133 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 135 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 136 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 137 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 139 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 140 |
+
</ul>
|
| 141 |
+
|
| 142 |
+
<search id="searchbox" style="display: none" role="search">
|
| 143 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 144 |
+
<div class="searchformwrapper">
|
| 145 |
+
<form class="search" action="search.html" method="get">
|
| 146 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 147 |
+
<input type="submit" value="Go" />
|
| 148 |
+
</form>
|
| 149 |
+
</div>
|
| 150 |
+
</search>
|
| 151 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 152 |
+
</div>
|
| 153 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 154 |
+
<span>«</span>
|
| 155 |
+
</div>
|
| 156 |
+
|
| 157 |
+
</div>
|
| 158 |
+
<div class="clearer"></div>
|
| 159 |
+
</div>
|
| 160 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 161 |
+
<h3>Navigation</h3>
|
| 162 |
+
<ul>
|
| 163 |
+
<li class="right" style="margin-right: 10px">
|
| 164 |
+
<a href="genindex.html" title="General Index"
|
| 165 |
+
>index</a></li>
|
| 166 |
+
<li class="right" >
|
| 167 |
+
<a href="cloud_edb_biganimal.html" title="EDB BigAnimal Cloud Deployment"
|
| 168 |
+
>next</a> |</li>
|
| 169 |
+
<li class="right" >
|
| 170 |
+
<a href="cloud_deployment.html" title="PostgreSQL Cloud Deployment"
|
| 171 |
+
>previous</a> |</li>
|
| 172 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 173 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 174 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" >PostgreSQL Cloud Deployment</a> »</li>
|
| 175 |
+
<li class="nav-item nav-item-this"><a href="">Amazon RDS Cloud Deployment</a></li>
|
| 176 |
+
</ul>
|
| 177 |
+
</div>
|
| 178 |
+
<div class="footer" role="contentinfo">
|
| 179 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 180 |
+
<ul>
|
| 181 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 182 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 183 |
+
<li class="right" ><a href="cloud_edb_biganimal.html" title="EDB BigAnimal Cloud Deployment" accesskey="N">next</a> |</li>
|
| 184 |
+
<li class="right" ><a href="cloud_deployment.html" title="PostgreSQL Cloud Deployment" accesskey="P">previous</a> |</li>
|
| 185 |
+
</ul>
|
| 186 |
+
</div>
|
| 187 |
+
</div>
|
| 188 |
+
</body>
|
| 189 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/cloud_azure_database.html
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Azure Database Cloud Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Google Cloud SQL Deployment" href="cloud_google_cloud_sql.html" />
|
| 23 |
+
<link rel="prev" title="EDB BigAnimal Cloud Deployment" href="cloud_edb_biganimal.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="cloud_google_cloud_sql.html" title="Google Cloud SQL Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="cloud_edb_biganimal.html" title="EDB BigAnimal Cloud Deployment"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" accesskey="U">PostgreSQL Cloud Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">Azure Database Cloud Deployment</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="azure-database-cloud-deployment">
|
| 50 |
+
<h1><span class="target" id="index-0"></span>Azure Database Cloud Deployment<a class="headerlink" href="#azure-database-cloud-deployment" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>To deploy a PostgreSQL server on the Azure Database, follow the below steps.</p>
|
| 52 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_provider_for_postgresql.png" />
|
| 53 |
+
<p>Once you launch the tool, select the Azure Database option.
|
| 54 |
+
Click on the <em>Next</em> button to proceed further.</p>
|
| 55 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_azure_credentials.png" />
|
| 56 |
+
<p>In the Credentials dialog, select authentication method either interactive
|
| 57 |
+
browser or Azure CLI. Azure CLI will use the currently logged in identity
|
| 58 |
+
through the Azure CLI on the local machine. Interactive Browser will
|
| 59 |
+
open a browser window to authenticate a user interactively.</p>
|
| 60 |
+
<p>Use the <em>Azure tenant</em> id to specify Azure tenant ID against which user
|
| 61 |
+
is authenticated.</p>
|
| 62 |
+
<p>Clicking the <em>Click here to authenticate yourself to Microsoft Azure</em>
|
| 63 |
+
button, user will be redirected to the Microsoft Azure authentication page in a
|
| 64 |
+
new browser tab if the Interactive Browser option is selected.
|
| 65 |
+
Azure CLI authentication can be used only in Desktop mode.</p>
|
| 66 |
+
<p>Once authentication is completed, click on the next button to proceed.</p>
|
| 67 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_azure_instance.png" />
|
| 68 |
+
<p>Use the fields from the Instance Specification tab to specify the Instance
|
| 69 |
+
details.</p>
|
| 70 |
+
<ul class="simple">
|
| 71 |
+
<li><p>Use the <em>Cluster name</em> field to add a name for the PostgreSQL
|
| 72 |
+
server; the name specified will be displayed in the <em>Object Explorer</em> too.</p></li>
|
| 73 |
+
<li><p>Select a subscription from the <em>Subscription</em> options which are populated based
|
| 74 |
+
on user access levels in Azure portal.</p></li>
|
| 75 |
+
<li><p>Select the resource group from <em>Resource Group</em> dropdown under which the
|
| 76 |
+
PostgreSQL instance will be created.</p></li>
|
| 77 |
+
<li><p>Select the location to deploy PostgreSQL instance from <em>Location</em>
|
| 78 |
+
options.</p></li>
|
| 79 |
+
<li><p>Select the availability zone in specified region to deploy PostgreSQL
|
| 80 |
+
instance from <em>Availability zone</em> options.</p></li>
|
| 81 |
+
<li><p>Use <em>Database version</em> options to specify PostgreSQL database version.</p></li>
|
| 82 |
+
<li><p>Use the <em>Instance class</em> field to allocate the computational, network, and
|
| 83 |
+
memory capacity required by planned workload of this DB instance.</p></li>
|
| 84 |
+
<li><p>Use the <em>Instance type</em> field to select the instance type.</p></li>
|
| 85 |
+
<li><p>Use the <em>Storage size</em> option to specify the storage capacity.</p></li>
|
| 86 |
+
</ul>
|
| 87 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_azure_network.png" />
|
| 88 |
+
<ul class="simple">
|
| 89 |
+
<li><p>Use the <em>Public IP</em> field to specify the List of IP Addresses or range of
|
| 90 |
+
IP Addresses (start IP Address - end IP address) from which inbound traffic
|
| 91 |
+
should be accepted. Add multiple IP addresses/ranges separated with commas,
|
| 92 |
+
for example: “192.168.0.50, 192.168.0.100 - 192.168.0.200”</p></li>
|
| 93 |
+
<li><p>Use <em>Zone redundant high availability</em> option to specify High Availability
|
| 94 |
+
option. Zone redundant high availability deploys a standby replica in a
|
| 95 |
+
different zone.
|
| 96 |
+
The Burstable instance type does not support high availability.</p></li>
|
| 97 |
+
</ul>
|
| 98 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_azure_database.png" />
|
| 99 |
+
<p>Use the fields from the Database Details tab to specify the PostgreSQL database details.</p>
|
| 100 |
+
<ul class="simple">
|
| 101 |
+
<li><p>Use the drop-down list in the <em>pgAdmin server group</em> field to select the parent
|
| 102 |
+
node for the server; the server will be displayed in the <em>Object Explorer</em>
|
| 103 |
+
within the specified group.</p></li>
|
| 104 |
+
<li><p>Use the <em>Admin username</em> field to add the database name for the PostgreSQL
|
| 105 |
+
server.</p></li>
|
| 106 |
+
<li><p>Use the <em>Password</em> field to provide a password that will be supplied when
|
| 107 |
+
authenticating with the server.</p></li>
|
| 108 |
+
<li><p>Use the <em>Confirm password</em> field to repeat the password.</p></li>
|
| 109 |
+
</ul>
|
| 110 |
+
<p>Click on the next button to proceed.</p>
|
| 111 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_azure_review.png" />
|
| 112 |
+
<p>At the end, review the instance details that you provided. Click on Finish
|
| 113 |
+
button to deploy the instance on Azure Database.</p>
|
| 114 |
+
<p>Once you click on the finish, one background process will start which will
|
| 115 |
+
deploy the instance in the cloud and monitor the progress of the deployment.
|
| 116 |
+
You can view all the background process with there running status and logs
|
| 117 |
+
on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a> tab</p>
|
| 118 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_azure_bg_process_watcher.png" />
|
| 119 |
+
<p>The Server will be added to the tree with the cloud deployment icon. Once the
|
| 120 |
+
deployment is done, the server details will be updated.</p>
|
| 121 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_deployment_tree.png" />
|
| 122 |
+
</section>
|
| 123 |
+
|
| 124 |
+
|
| 125 |
+
<div class="clearer"></div>
|
| 126 |
+
</div>
|
| 127 |
+
</div>
|
| 128 |
+
</div>
|
| 129 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 130 |
+
<div class="sphinxsidebarwrapper">
|
| 131 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 132 |
+
<ul class="current">
|
| 133 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 135 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 138 |
+
<li class="toctree-l2 current"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 139 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 140 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 142 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 143 |
+
</ul>
|
| 144 |
+
</li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 149 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 150 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 151 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 152 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 153 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 154 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 155 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 156 |
+
</ul>
|
| 157 |
+
|
| 158 |
+
<search id="searchbox" style="display: none" role="search">
|
| 159 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 160 |
+
<div class="searchformwrapper">
|
| 161 |
+
<form class="search" action="search.html" method="get">
|
| 162 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 163 |
+
<input type="submit" value="Go" />
|
| 164 |
+
</form>
|
| 165 |
+
</div>
|
| 166 |
+
</search>
|
| 167 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 168 |
+
</div>
|
| 169 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 170 |
+
<span>«</span>
|
| 171 |
+
</div>
|
| 172 |
+
|
| 173 |
+
</div>
|
| 174 |
+
<div class="clearer"></div>
|
| 175 |
+
</div>
|
| 176 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 177 |
+
<h3>Navigation</h3>
|
| 178 |
+
<ul>
|
| 179 |
+
<li class="right" style="margin-right: 10px">
|
| 180 |
+
<a href="genindex.html" title="General Index"
|
| 181 |
+
>index</a></li>
|
| 182 |
+
<li class="right" >
|
| 183 |
+
<a href="cloud_google_cloud_sql.html" title="Google Cloud SQL Deployment"
|
| 184 |
+
>next</a> |</li>
|
| 185 |
+
<li class="right" >
|
| 186 |
+
<a href="cloud_edb_biganimal.html" title="EDB BigAnimal Cloud Deployment"
|
| 187 |
+
>previous</a> |</li>
|
| 188 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 189 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 190 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" >PostgreSQL Cloud Deployment</a> »</li>
|
| 191 |
+
<li class="nav-item nav-item-this"><a href="">Azure Database Cloud Deployment</a></li>
|
| 192 |
+
</ul>
|
| 193 |
+
</div>
|
| 194 |
+
<div class="footer" role="contentinfo">
|
| 195 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 196 |
+
<ul>
|
| 197 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 198 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 199 |
+
<li class="right" ><a href="cloud_google_cloud_sql.html" title="Google Cloud SQL Deployment" accesskey="N">next</a> |</li>
|
| 200 |
+
<li class="right" ><a href="cloud_edb_biganimal.html" title="EDB BigAnimal Cloud Deployment" accesskey="P">previous</a> |</li>
|
| 201 |
+
</ul>
|
| 202 |
+
</div>
|
| 203 |
+
</div>
|
| 204 |
+
</body>
|
| 205 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/cloud_deployment.html
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>PostgreSQL Cloud Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Amazon RDS Cloud Deployment" href="cloud_aws_rds.html" />
|
| 23 |
+
<link rel="prev" title="Clear Saved Passwords" href="clear_saved_passwords.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="cloud_aws_rds.html" title="Amazon RDS Cloud Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="clear_saved_passwords.html" title="Clear Saved Passwords"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" accesskey="U">Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">PostgreSQL Cloud Deployment</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="postgresql-cloud-deployment">
|
| 49 |
+
<span id="cloud-deployment"></span><h1><span class="target" id="index-0"></span>PostgreSQL Cloud Deployment<a class="headerlink" href="#postgresql-cloud-deployment" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>A PostgreSQL server can be deployed on the Amazon, EDB BigAnimal, Azure,
|
| 51 |
+
Google cloud using this module. In future more cloud provider options will
|
| 52 |
+
be available.</p>
|
| 53 |
+
<p>To launch the <em>Cloud Deployment…</em> tool, right click on the <em>Server Group</em> or
|
| 54 |
+
<em>Server</em> of the tree control, and select <em>Deploy a Cloud Instance</em> from the
|
| 55 |
+
<em>Register</em> menu.</p>
|
| 56 |
+
<div class="toctree-wrapper compound">
|
| 57 |
+
<ul>
|
| 58 |
+
<li class="toctree-l1"><a class="reference internal" href="cloud_aws_rds.html">Amazon RDS Cloud Deployment</a></li>
|
| 59 |
+
<li class="toctree-l1"><a class="reference internal" href="cloud_edb_biganimal.html">EDB BigAnimal Cloud Deployment</a></li>
|
| 60 |
+
<li class="toctree-l1"><a class="reference internal" href="cloud_azure_database.html">Azure Database Cloud Deployment</a></li>
|
| 61 |
+
<li class="toctree-l1"><a class="reference internal" href="cloud_google_cloud_sql.html">Google Cloud SQL Deployment</a></li>
|
| 62 |
+
</ul>
|
| 63 |
+
</div>
|
| 64 |
+
</section>
|
| 65 |
+
|
| 66 |
+
|
| 67 |
+
<div class="clearer"></div>
|
| 68 |
+
</div>
|
| 69 |
+
</div>
|
| 70 |
+
</div>
|
| 71 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 72 |
+
<div class="sphinxsidebarwrapper">
|
| 73 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 74 |
+
<ul class="current">
|
| 75 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 76 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 77 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 78 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 79 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 80 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">PostgreSQL Cloud Deployment</a></li>
|
| 81 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 82 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 83 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 84 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 85 |
+
</ul>
|
| 86 |
+
</li>
|
| 87 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 88 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 89 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 90 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 91 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 92 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 93 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 94 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 95 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 96 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 97 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 98 |
+
</ul>
|
| 99 |
+
|
| 100 |
+
<search id="searchbox" style="display: none" role="search">
|
| 101 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 102 |
+
<div class="searchformwrapper">
|
| 103 |
+
<form class="search" action="search.html" method="get">
|
| 104 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 105 |
+
<input type="submit" value="Go" />
|
| 106 |
+
</form>
|
| 107 |
+
</div>
|
| 108 |
+
</search>
|
| 109 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 110 |
+
</div>
|
| 111 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 112 |
+
<span>«</span>
|
| 113 |
+
</div>
|
| 114 |
+
|
| 115 |
+
</div>
|
| 116 |
+
<div class="clearer"></div>
|
| 117 |
+
</div>
|
| 118 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 119 |
+
<h3>Navigation</h3>
|
| 120 |
+
<ul>
|
| 121 |
+
<li class="right" style="margin-right: 10px">
|
| 122 |
+
<a href="genindex.html" title="General Index"
|
| 123 |
+
>index</a></li>
|
| 124 |
+
<li class="right" >
|
| 125 |
+
<a href="cloud_aws_rds.html" title="Amazon RDS Cloud Deployment"
|
| 126 |
+
>next</a> |</li>
|
| 127 |
+
<li class="right" >
|
| 128 |
+
<a href="clear_saved_passwords.html" title="Clear Saved Passwords"
|
| 129 |
+
>previous</a> |</li>
|
| 130 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 131 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 132 |
+
<li class="nav-item nav-item-this"><a href="">PostgreSQL Cloud Deployment</a></li>
|
| 133 |
+
</ul>
|
| 134 |
+
</div>
|
| 135 |
+
<div class="footer" role="contentinfo">
|
| 136 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 137 |
+
<ul>
|
| 138 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 139 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 140 |
+
<li class="right" ><a href="cloud_aws_rds.html" title="Amazon RDS Cloud Deployment" accesskey="N">next</a> |</li>
|
| 141 |
+
<li class="right" ><a href="clear_saved_passwords.html" title="Clear Saved Passwords" accesskey="P">previous</a> |</li>
|
| 142 |
+
</ul>
|
| 143 |
+
</div>
|
| 144 |
+
</div>
|
| 145 |
+
</body>
|
| 146 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/cloud_edb_biganimal.html
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>EDB BigAnimal Cloud Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Azure Database Cloud Deployment" href="cloud_azure_database.html" />
|
| 23 |
+
<link rel="prev" title="Amazon RDS Cloud Deployment" href="cloud_aws_rds.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="cloud_azure_database.html" title="Azure Database Cloud Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="cloud_aws_rds.html" title="Amazon RDS Cloud Deployment"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" accesskey="U">PostgreSQL Cloud Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">EDB BigAnimal Cloud Deployment</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="edb-biganimal-cloud-deployment">
|
| 50 |
+
<span id="cloud-edb-biganimal"></span><h1><span class="target" id="index-0"></span>EDB BigAnimal Cloud Deployment<a class="headerlink" href="#edb-biganimal-cloud-deployment" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>To deploy a PostgreSQL server on the EDB BigAnimal cloud, follow the below steps.</p>
|
| 52 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_provider_for_postgresql.png" />
|
| 53 |
+
<p>Once you launch the tool, select the EDB BigAnimal option.
|
| 54 |
+
Click on the <em>Next</em> button to proceed further.</p>
|
| 55 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_biganimal_credentials.png" />
|
| 56 |
+
<p>The next steps is to authenticate the user to EDB BigAninal.
|
| 57 |
+
Click the given button to authenticate, by clicking the button, the user
|
| 58 |
+
will be redirected to the new tab for the verification.
|
| 59 |
+
Once you confirm the one time code, the pgAdmin will automatically detect it
|
| 60 |
+
and the next button will be enabled. To proceed further, click on the next button.</p>
|
| 61 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_biganimal_cluster.png" />
|
| 62 |
+
<ul class="simple">
|
| 63 |
+
<li><p>Use the <em>Project</em> field to choose a project in your Biganimal account.</p></li>
|
| 64 |
+
<li><p>Use the <em>Cluster type</em> field to choose a cluster type.</p></li>
|
| 65 |
+
<li><p>Use the <em>No. of Standby Replicas</em> field to specify the replicas if you have selected the High Availability cluster.</p></li>
|
| 66 |
+
<li><p>Use the <em>Cluster provider</em> field to choose the provider.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_biganimal_instance.png" />
|
| 69 |
+
<p>Use the fields from the Instance Specification tab to specify the Instance
|
| 70 |
+
details.</p>
|
| 71 |
+
<ul class="simple">
|
| 72 |
+
<li><p>Use the <em>Cluster name</em> field to add a cluster name for the PostgreSQL
|
| 73 |
+
server; the name specified will be displayed in the <em>Object Explorer</em> too.</p></li>
|
| 74 |
+
<li><p>Use the <em>Region</em> field to select the region.</p></li>
|
| 75 |
+
<li><p>Use the <em>Public IP range</em> field to specify the IP Address range for permitting the
|
| 76 |
+
inbound traffic. Leave it blank for 0.0.0.0/0</p></li>
|
| 77 |
+
<li><p>Use the <em>Instance type</em> field to select the instance type.</p></li>
|
| 78 |
+
<li><p>Use the <em>Instance series</em> field to select the instance series.</p></li>
|
| 79 |
+
<li><p>Use the <em>Instance size</em> field to allocate the computational, network, and
|
| 80 |
+
memory capacity required by planned workload of this DB instance.</p></li>
|
| 81 |
+
<li><p>Use the <em>Volume type</em> field to select the instance storage type.</p></li>
|
| 82 |
+
<li><p>Use the <em>Volume properties</em> field to specify the storage capacity. This field is specific to Azure.</p></li>
|
| 83 |
+
<li><p>Use the <em>Volume size</em> field to specify the storage size. This field is specific to AWS.</p></li>
|
| 84 |
+
<li><p>Use the <em>Volume IOPS</em> field to specify the storage IOPS. This field is specific to AWS.</p></li>
|
| 85 |
+
<li><p>Use the <em>Disk throughput</em> field to specify the disk throughput. This field is specific to AWS.</p></li>
|
| 86 |
+
</ul>
|
| 87 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_biganimal_database.png" />
|
| 88 |
+
<p>Use the fields from the Database Details tab to specify the Instance details.</p>
|
| 89 |
+
<ul class="simple">
|
| 90 |
+
<li><p>Use the drop-down list box in the <em>Server group</em> field to select the parent
|
| 91 |
+
node for the server; the server will be displayed in the <em>Object Explorer</em>
|
| 92 |
+
within the specified group.</p></li>
|
| 93 |
+
<li><p>Use the <em>Database type</em> field to specify the PostgreSQL
|
| 94 |
+
type, EnterpriseDB PostgreSQL Advanced Server or PostgreSQL.</p></li>
|
| 95 |
+
<li><p>Use the <em>PostgreSQL version</em> field to select the database version.</p></li>
|
| 96 |
+
<li><p>Use the <em>Database Password</em> field to provide a password that will be supplied when
|
| 97 |
+
authenticating with the server.</p></li>
|
| 98 |
+
<li><p>Use the <em>Confirm password</em> field to repeat the password.</p></li>
|
| 99 |
+
</ul>
|
| 100 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_biganimal_review.png" />
|
| 101 |
+
<p>At the end, review the Cluster details that you provided. Click on Finish
|
| 102 |
+
button to deploy the instance on EDB BigAnimal.</p>
|
| 103 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_deployment_tree.png" />
|
| 104 |
+
<p>Once you click on the finish, one background process will start which will
|
| 105 |
+
deploy the instance in the cloud and monitor the progress of the deployment.
|
| 106 |
+
You can view all the background process with there running status and logs
|
| 107 |
+
on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a> tab</p>
|
| 108 |
+
<p>The Server will be added to the tree with the cloud deployment icon. Once the
|
| 109 |
+
deployment is done, the server details will be updated.</p>
|
| 110 |
+
</section>
|
| 111 |
+
|
| 112 |
+
|
| 113 |
+
<div class="clearer"></div>
|
| 114 |
+
</div>
|
| 115 |
+
</div>
|
| 116 |
+
</div>
|
| 117 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 118 |
+
<div class="sphinxsidebarwrapper">
|
| 119 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 120 |
+
<ul class="current">
|
| 121 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 122 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 123 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2 current"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 131 |
+
</ul>
|
| 132 |
+
</li>
|
| 133 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 135 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 136 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 137 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 139 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 140 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 142 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 143 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 144 |
+
</ul>
|
| 145 |
+
|
| 146 |
+
<search id="searchbox" style="display: none" role="search">
|
| 147 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 148 |
+
<div class="searchformwrapper">
|
| 149 |
+
<form class="search" action="search.html" method="get">
|
| 150 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 151 |
+
<input type="submit" value="Go" />
|
| 152 |
+
</form>
|
| 153 |
+
</div>
|
| 154 |
+
</search>
|
| 155 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 156 |
+
</div>
|
| 157 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 158 |
+
<span>«</span>
|
| 159 |
+
</div>
|
| 160 |
+
|
| 161 |
+
</div>
|
| 162 |
+
<div class="clearer"></div>
|
| 163 |
+
</div>
|
| 164 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 165 |
+
<h3>Navigation</h3>
|
| 166 |
+
<ul>
|
| 167 |
+
<li class="right" style="margin-right: 10px">
|
| 168 |
+
<a href="genindex.html" title="General Index"
|
| 169 |
+
>index</a></li>
|
| 170 |
+
<li class="right" >
|
| 171 |
+
<a href="cloud_azure_database.html" title="Azure Database Cloud Deployment"
|
| 172 |
+
>next</a> |</li>
|
| 173 |
+
<li class="right" >
|
| 174 |
+
<a href="cloud_aws_rds.html" title="Amazon RDS Cloud Deployment"
|
| 175 |
+
>previous</a> |</li>
|
| 176 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 177 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 178 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" >PostgreSQL Cloud Deployment</a> »</li>
|
| 179 |
+
<li class="nav-item nav-item-this"><a href="">EDB BigAnimal Cloud Deployment</a></li>
|
| 180 |
+
</ul>
|
| 181 |
+
</div>
|
| 182 |
+
<div class="footer" role="contentinfo">
|
| 183 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 184 |
+
<ul>
|
| 185 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 186 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 187 |
+
<li class="right" ><a href="cloud_azure_database.html" title="Azure Database Cloud Deployment" accesskey="N">next</a> |</li>
|
| 188 |
+
<li class="right" ><a href="cloud_aws_rds.html" title="Amazon RDS Cloud Deployment" accesskey="P">previous</a> |</li>
|
| 189 |
+
</ul>
|
| 190 |
+
</div>
|
| 191 |
+
</div>
|
| 192 |
+
</body>
|
| 193 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/cloud_google_cloud_sql.html
ADDED
|
@@ -0,0 +1,204 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Google Cloud SQL Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Master Password" href="master_password.html" />
|
| 23 |
+
<link rel="prev" title="Azure Database Cloud Deployment" href="cloud_azure_database.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="master_password.html" title="Master Password"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="cloud_azure_database.html" title="Azure Database Cloud Deployment"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" accesskey="U">PostgreSQL Cloud Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">Google Cloud SQL Deployment</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="google-cloud-sql-deployment">
|
| 50 |
+
<h1><span class="target" id="index-0"></span>Google Cloud SQL Deployment<a class="headerlink" href="#google-cloud-sql-deployment" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>To deploy a PostgreSQL server on the Google Cloud SQL, follow the below steps.</p>
|
| 52 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_provider_for_postgresql.png" />
|
| 53 |
+
<p>Once you launch the tool, select the Google Cloud SQL option.
|
| 54 |
+
Click on the <em>Next</em> button to proceed further.</p>
|
| 55 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_google_credentials.png" />
|
| 56 |
+
<p>In the Credentials dialog, select client secret file to authenticate
|
| 57 |
+
using google.You can download a client secret which is json formatted file
|
| 58 |
+
from google cloud console once OAuth2 client ID is created.</p>
|
| 59 |
+
<div class="admonition note">
|
| 60 |
+
<p class="admonition-title">Note</p>
|
| 61 |
+
<p>While creating client OAuth client ID, select Desktop App as application type.
|
| 62 |
+
Refer <a class="reference external" href="https://support.google.com/cloud/answer/6158849?hl=en/">this</a> link for creating client secret.</p>
|
| 63 |
+
</div>
|
| 64 |
+
<p>Clicking the <em>Click here to authenticate yourself to Google</em>
|
| 65 |
+
button, user will be redirected to the Google authentication page in a
|
| 66 |
+
new browser tab.</p>
|
| 67 |
+
<p>Once authentication is completed, click on the next button to proceed.</p>
|
| 68 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_google_instance.png" />
|
| 69 |
+
<p>Use the fields from the Instance Specification tab to specify the Instance
|
| 70 |
+
details.</p>
|
| 71 |
+
<ul class="simple">
|
| 72 |
+
<li><p>Use the <em>Cluster name</em> field to add a name for the PostgreSQL
|
| 73 |
+
server; the name specified will be displayed in the <em>Object Explorer</em> too.</p></li>
|
| 74 |
+
<li><p>Select the project from <em>project</em> dropdown under which the
|
| 75 |
+
PostgreSQL instance will be created.</p></li>
|
| 76 |
+
<li><p>Select the location to deploy PostgreSQL instance from <em>Location</em>
|
| 77 |
+
options.</p></li>
|
| 78 |
+
<li><p>Select the availability zone in specified region to deploy PostgreSQL
|
| 79 |
+
instance from <em>Availability zone</em> options.</p></li>
|
| 80 |
+
<li><p>Use <em>Database version</em> options to specify PostgreSQL database version.</p></li>
|
| 81 |
+
<li><p>Use the <em>Instance class</em> field to allocate the computational and
|
| 82 |
+
memory capacity required by planned workload of this DB instance.</p></li>
|
| 83 |
+
<li><p>Use the <em>Instance type</em> field to select the instance type.</p></li>
|
| 84 |
+
<li><p>Specify storage type by selecting option from <em>Storage type</em>.</p></li>
|
| 85 |
+
<li><p>Use the <em>Storage capacity</em> option to specify the storage capacity.</p></li>
|
| 86 |
+
</ul>
|
| 87 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_google_network.png" />
|
| 88 |
+
<ul class="simple">
|
| 89 |
+
<li><p>Use the <em>Public IP</em> field to specify the list of IP address range
|
| 90 |
+
for allowed inbound traffic, for example: 127.0.0.1/32. Add multiple
|
| 91 |
+
IP addresses/ranges separated with commas.</p></li>
|
| 92 |
+
<li><p>Use the <em>High Availability</em> option to specify High Availability
|
| 93 |
+
option. This option creates a standby in a select Secondary
|
| 94 |
+
Availability Zone.</p></li>
|
| 95 |
+
<li><p>Select the secondary availability zone for high availability
|
| 96 |
+
from <em>Secondary Availability zone</em> options.</p></li>
|
| 97 |
+
</ul>
|
| 98 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_google_database.png" />
|
| 99 |
+
<p>Use the fields from the Database Details tab to specify the PostgreSQL database details.</p>
|
| 100 |
+
<ul class="simple">
|
| 101 |
+
<li><p>Use the drop-down list in the <em>pgAdmin server group</em> field to select the parent
|
| 102 |
+
node for the server; the server will be displayed in the <em>Object Explorer</em>
|
| 103 |
+
within the specified group.</p></li>
|
| 104 |
+
<li><p>Admin username field will be default to postgres.
|
| 105 |
+
server.</p></li>
|
| 106 |
+
<li><p>Use the <em>Password</em> field to provide a password that will be supplied when
|
| 107 |
+
authenticating with the server.</p></li>
|
| 108 |
+
<li><p>Use the <em>Confirm password</em> field to repeat the password.</p></li>
|
| 109 |
+
</ul>
|
| 110 |
+
<p>Click on the next button to proceed.</p>
|
| 111 |
+
<img alt="Cloud Deployment" class="align-center" src="_images/cloud_google_review.png" />
|
| 112 |
+
<p>At the end, review the instance details that you provided. Click on Finish
|
| 113 |
+
button to deploy the instance on Azure PostgreSQL.</p>
|
| 114 |
+
<p>Once you click on the finish, one background process will start which will
|
| 115 |
+
deploy the instance in the cloud and monitor the progress of the deployment.
|
| 116 |
+
You can view all the background process with there running status and logs
|
| 117 |
+
on the <a class="reference internal" href="processes.html#processes"><span class="std std-ref">Processes</span></a> tab</p>
|
| 118 |
+
<p>The Server will be added to the tree with the cloud deployment icon. Once the
|
| 119 |
+
deployment is done, the server details will be updated.</p>
|
| 120 |
+
<img alt="Cloud Deployment Provider" class="align-center" src="_images/cloud_google_deployment_tree.png" />
|
| 121 |
+
</section>
|
| 122 |
+
|
| 123 |
+
|
| 124 |
+
<div class="clearer"></div>
|
| 125 |
+
</div>
|
| 126 |
+
</div>
|
| 127 |
+
</div>
|
| 128 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 129 |
+
<div class="sphinxsidebarwrapper">
|
| 130 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 131 |
+
<ul class="current">
|
| 132 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 133 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 134 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2 current"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 138 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 139 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 140 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 142 |
+
</ul>
|
| 143 |
+
</li>
|
| 144 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 149 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 150 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 151 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 152 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 153 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 154 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 155 |
+
</ul>
|
| 156 |
+
|
| 157 |
+
<search id="searchbox" style="display: none" role="search">
|
| 158 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 159 |
+
<div class="searchformwrapper">
|
| 160 |
+
<form class="search" action="search.html" method="get">
|
| 161 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 162 |
+
<input type="submit" value="Go" />
|
| 163 |
+
</form>
|
| 164 |
+
</div>
|
| 165 |
+
</search>
|
| 166 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 167 |
+
</div>
|
| 168 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 169 |
+
<span>«</span>
|
| 170 |
+
</div>
|
| 171 |
+
|
| 172 |
+
</div>
|
| 173 |
+
<div class="clearer"></div>
|
| 174 |
+
</div>
|
| 175 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 176 |
+
<h3>Navigation</h3>
|
| 177 |
+
<ul>
|
| 178 |
+
<li class="right" style="margin-right: 10px">
|
| 179 |
+
<a href="genindex.html" title="General Index"
|
| 180 |
+
>index</a></li>
|
| 181 |
+
<li class="right" >
|
| 182 |
+
<a href="master_password.html" title="Master Password"
|
| 183 |
+
>next</a> |</li>
|
| 184 |
+
<li class="right" >
|
| 185 |
+
<a href="cloud_azure_database.html" title="Azure Database Cloud Deployment"
|
| 186 |
+
>previous</a> |</li>
|
| 187 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 188 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 189 |
+
<li class="nav-item nav-item-2"><a href="cloud_deployment.html" >PostgreSQL Cloud Deployment</a> »</li>
|
| 190 |
+
<li class="nav-item nav-item-this"><a href="">Google Cloud SQL Deployment</a></li>
|
| 191 |
+
</ul>
|
| 192 |
+
</div>
|
| 193 |
+
<div class="footer" role="contentinfo">
|
| 194 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 195 |
+
<ul>
|
| 196 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 197 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 198 |
+
<li class="right" ><a href="master_password.html" title="Master Password" accesskey="N">next</a> |</li>
|
| 199 |
+
<li class="right" ><a href="cloud_azure_database.html" title="Azure Database Cloud Deployment" accesskey="P">previous</a> |</li>
|
| 200 |
+
</ul>
|
| 201 |
+
</div>
|
| 202 |
+
</div>
|
| 203 |
+
</body>
|
| 204 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/code_overview.html
ADDED
|
@@ -0,0 +1,343 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Code Overview — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Coding Standards" href="coding_standards.html" />
|
| 23 |
+
<link rel="prev" title="Submitting Pull Requests" href="submitting_pull_requests.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="coding_standards.html" title="Coding Standards"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="submitting_pull_requests.html" title="Submitting Pull Requests"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" accesskey="U">pgAdmin Project Contributions</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Code Overview</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="code-overview">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Code Overview<a class="headerlink" href="#code-overview" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>The bulk of pgAdmin is a Python web application written using the Flask framework
|
| 51 |
+
on the backend, and HTML5 with CSS3,ReactJS on the front end. A
|
| 52 |
+
desktop runtime is also included for users that prefer a desktop application to
|
| 53 |
+
a web application, which is written using NWjs (Node Webkit).</p>
|
| 54 |
+
<section id="runtime">
|
| 55 |
+
<h2>Runtime<a class="headerlink" href="#runtime" title="Link to this heading">¶</a></h2>
|
| 56 |
+
<p>The runtime is based on NWjs which integrates a browser and the Python server
|
| 57 |
+
creating a standalone application. The source code can be found in the
|
| 58 |
+
<strong>/runtime</strong> directory in the source tree.</p>
|
| 59 |
+
</section>
|
| 60 |
+
<section id="web-application">
|
| 61 |
+
<h2>Web Application<a class="headerlink" href="#web-application" title="Link to this heading">¶</a></h2>
|
| 62 |
+
<p>The web application forms the bulk of pgAdmin and can be found in the <strong>/web</strong>
|
| 63 |
+
directory in the source tree. The main file is <strong>pgAdmin4.py</strong> which can be used
|
| 64 |
+
to run the built-in standalone web server, or as a WSGI application for production
|
| 65 |
+
use.</p>
|
| 66 |
+
<section id="configuration">
|
| 67 |
+
<h3>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h3>
|
| 68 |
+
<p>The core application configuration is found in <strong>config.py</strong>. This file includes
|
| 69 |
+
all configurable settings for the application, along with descriptions of their
|
| 70 |
+
use. It is essential that various settings are configured prior to deployment on
|
| 71 |
+
a web server; these can be overridden in <strong>config_local.py</strong> or
|
| 72 |
+
<strong>config_system.py</strong> (see the <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">config.py</span></a> documentation) to
|
| 73 |
+
avoid modifying the main configuration file.</p>
|
| 74 |
+
</section>
|
| 75 |
+
<section id="user-settings">
|
| 76 |
+
<h3>User Settings<a class="headerlink" href="#user-settings" title="Link to this heading">¶</a></h3>
|
| 77 |
+
<p>When running in desktop mode, pgAdmin has a single, default user account that is
|
| 78 |
+
used for the desktop user. When running in server mode, there may be unlimited
|
| 79 |
+
users who are required to login prior to using the application. pgAdmin utilised
|
| 80 |
+
the <strong>Flask-Security</strong> module to manage application security and users, and
|
| 81 |
+
provides options for self-service password reset and password changes etc.</p>
|
| 82 |
+
<p>Whether in desktop or server mode, each user’s settings are stored in a SQLite
|
| 83 |
+
OR external database which is also used to store the user accounts. This is initially
|
| 84 |
+
created using the <strong>setup.py</strong> script which will create the database file and
|
| 85 |
+
schema within it, and add the first user account (with administrative
|
| 86 |
+
privileges) and a default server group for them. A <strong>settings</strong> table is also
|
| 87 |
+
used to store user configuration settings in a key-value fashion. Although not
|
| 88 |
+
required, setting keys (or names) are typically formatted using forward slashes
|
| 89 |
+
to artificially namespace values, much like the pgAdmin 3 settings files on Linux
|
| 90 |
+
or Mac.</p>
|
| 91 |
+
<p>Note that the local configuration must be setup prior to <strong>setup.py</strong> being run.
|
| 92 |
+
The local configuration will determine how the script sets up the database,
|
| 93 |
+
particularly with regard to desktop vs. server mode.</p>
|
| 94 |
+
</section>
|
| 95 |
+
</section>
|
| 96 |
+
<section id="pgadmin-core">
|
| 97 |
+
<h2>pgAdmin Core<a class="headerlink" href="#pgadmin-core" title="Link to this heading">¶</a></h2>
|
| 98 |
+
<p>The heart of pgAdmin is the <strong>pgadmin</strong> package. This contains the globally
|
| 99 |
+
available HTML templates used by the Jinja engine, as well as any global static
|
| 100 |
+
files such as images, Javascript and CSS files that are used in multiple modules.</p>
|
| 101 |
+
<p>The work of the package is handled in it’s constructor, <strong>__init__.py</strong>. This
|
| 102 |
+
is responsible for setting up logging and authentication, dynamically loading
|
| 103 |
+
other modules, and a few other tasks.</p>
|
| 104 |
+
</section>
|
| 105 |
+
<section id="modules">
|
| 106 |
+
<h2>Modules<a class="headerlink" href="#modules" title="Link to this heading">¶</a></h2>
|
| 107 |
+
<p>Units of functionality are added to pgAdmin through the addition of modules.
|
| 108 |
+
Theses are Python object instance of classes, inherits the
|
| 109 |
+
PgAdminModule class (a Flask Blueprint implementation), found in
|
| 110 |
+
<strong>web/pgadmin/utils.py</strong>. It provide various hook points for other modules
|
| 111 |
+
to utilise (primarily the default module - the browser).</p>
|
| 112 |
+
<p>To be recognised as a module, a Python package must be created. This must:</p>
|
| 113 |
+
<ol class="arabic simple">
|
| 114 |
+
<li><p>Be placed within the <strong>web/pgadmin/</strong> directory, and</p></li>
|
| 115 |
+
<li><p>Implements pgadmin.utils.PgAdminModule class</p></li>
|
| 116 |
+
<li><p>An instance variable (generally - named <strong>blueprint</strong>) representing that
|
| 117 |
+
particular class in that package.</p></li>
|
| 118 |
+
</ol>
|
| 119 |
+
<p>Each module may define a <strong>template</strong> and <strong>static</strong> directory for the Blueprint
|
| 120 |
+
that it implements. To avoid name collisions, templates should be stored under
|
| 121 |
+
a directory within the specified template directory, named after the module itself.
|
| 122 |
+
For example, the <strong>browser</strong> module stores it’s templates in
|
| 123 |
+
<strong>web/pgadmin/browser/templates/browser/</strong>. This does not apply to static files
|
| 124 |
+
which may omit the second module name.</p>
|
| 125 |
+
<p>In addition to defining the Blueprint, the <strong>views</strong> module is typically
|
| 126 |
+
responsible for defining all the views that will be rendered in response to
|
| 127 |
+
client requests, we must provide a REST API url(s) for these views. These must
|
| 128 |
+
include appropriate route and security decorators. Take a look at the NodeView
|
| 129 |
+
class, which uses the same approach as Flask’s MethodView, it can be found in
|
| 130 |
+
<strong>web/pgadmin/browser/utils.py</strong>. This specific class is used by browser nodes
|
| 131 |
+
for creating REST API url(s) for different operation on them. i.e. list, create,
|
| 132 |
+
update, delete, fetch children, get
|
| 133 |
+
statistics/reversed SQL/dependencies/dependents list for that node, etc. We can
|
| 134 |
+
use the same class for other purpose too. You just need to inherit that class,
|
| 135 |
+
and overload the member variables operations, parent_ids, ids, node_type, and
|
| 136 |
+
then register it as node view with PgAdminModule instance.</p>
|
| 137 |
+
<p>Most pgAdmin modules will also implement the <strong>hooks</strong> provided by the
|
| 138 |
+
PgAdminModule class. This is responsible for providing hook points to integrate
|
| 139 |
+
the module into the rest of the application - for example, a hook might tell
|
| 140 |
+
the caller what CSS files need to be included on the rendered page, or what menu
|
| 141 |
+
options to include and what they should do. Hook points need not exist if they
|
| 142 |
+
are not required. It is the responsibility of the caller to ensure they are
|
| 143 |
+
present before attempting to utilise them.</p>
|
| 144 |
+
<p>Hooks currently implemented are:</p>
|
| 145 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyModule</span><span class="p">(</span><span class="n">PgAdminModule</span><span class="p">):</span>
|
| 146 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 147 |
+
<span class="sd"> This is class implements the pgadmin.utils.PgAdminModule, and</span>
|
| 148 |
+
<span class="sd"> implements the hooks</span>
|
| 149 |
+
<span class="sd"> """</span>
|
| 150 |
+
|
| 151 |
+
<span class="o">...</span>
|
| 152 |
+
|
| 153 |
+
<span class="k">def</span> <span class="nf">get_own_stylesheets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 154 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 155 |
+
<span class="sd"> Returns:</span>
|
| 156 |
+
<span class="sd"> list: the stylesheets used by this module, not including any</span>
|
| 157 |
+
<span class="sd"> stylesheet needed by the submodules.</span>
|
| 158 |
+
<span class="sd"> """</span>
|
| 159 |
+
<span class="k">return</span> <span class="p">[</span><span class="n">url_for</span><span class="p">(</span><span class="s1">'static'</span><span class="p">,</span> <span class="s1">'css/mymodule.css'</span><span class="p">)]</span>
|
| 160 |
+
|
| 161 |
+
<span class="k">def</span> <span class="nf">get_own_javascripts</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 162 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 163 |
+
<span class="sd"> Returns:</span>
|
| 164 |
+
<span class="sd"> list of dict:</span>
|
| 165 |
+
<span class="sd"> - contains the name (representation for this javascript</span>
|
| 166 |
+
<span class="sd"> module), path (url for it without .js suffix), deps (array of</span>
|
| 167 |
+
<span class="sd"> dependents), exports window object by the javascript module,</span>
|
| 168 |
+
<span class="sd"> and when (would you like to load this javascript), etc</span>
|
| 169 |
+
<span class="sd"> information for this module, not including any script needed</span>
|
| 170 |
+
<span class="sd"> by submodules.</span>
|
| 171 |
+
<span class="sd"> """</span>
|
| 172 |
+
<span class="k">return</span> <span class="p">[</span>
|
| 173 |
+
<span class="p">{</span>
|
| 174 |
+
<span class="s1">'name'</span><span class="p">:</span> <span class="s1">'pgadmin.extension.mymodule'</span><span class="p">,</span>
|
| 175 |
+
<span class="s1">'path'</span><span class="p">:</span> <span class="n">url_for</span><span class="p">(</span><span class="s1">'static'</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s1">'js/mymodule'</span><span class="p">),</span>
|
| 176 |
+
<span class="s1">'exports'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 177 |
+
<span class="s1">'when'</span><span class="p">:</span> <span class="s1">'server'</span>
|
| 178 |
+
<span class="p">}</span>
|
| 179 |
+
<span class="p">]</span>
|
| 180 |
+
|
| 181 |
+
<span class="k">def</span> <span class="nf">get_own_menuitems</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 182 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 183 |
+
<span class="sd"> Returns:</span>
|
| 184 |
+
<span class="sd"> dict: the menuitems for this module, not including</span>
|
| 185 |
+
<span class="sd"> any needed from the submodules.</span>
|
| 186 |
+
<span class="sd"> """</span>
|
| 187 |
+
<span class="k">return</span> <span class="p">{</span>
|
| 188 |
+
<span class="s1">'help_items'</span><span class="p">:</span> <span class="p">[</span>
|
| 189 |
+
<span class="n">MenuItem</span><span class="p">(</span>
|
| 190 |
+
<span class="n">name</span><span class="o">=</span><span class="s1">'mnu_mymodule_help'</span><span class="p">,</span>
|
| 191 |
+
<span class="n">priority</span><span class="o">=</span><span class="mi">999</span><span class="p">,</span>
|
| 192 |
+
<span class="c1"># We need to create javascript, which registers itself</span>
|
| 193 |
+
<span class="c1"># as module</span>
|
| 194 |
+
<span class="n">module</span><span class="o">=</span><span class="s2">"pgAdmin.MyModule"</span><span class="p">,</span>
|
| 195 |
+
<span class="n">callback</span><span class="o">=</span><span class="s1">'about_show'</span><span class="p">,</span>
|
| 196 |
+
<span class="n">icon</span><span class="o">=</span><span class="s1">'fa fa-info-circle'</span><span class="p">,</span>
|
| 197 |
+
<span class="n">label</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span><span class="s1">'About MyModule'</span>
|
| 198 |
+
<span class="p">)</span>
|
| 199 |
+
<span class="p">]</span>
|
| 200 |
+
<span class="p">}</span>
|
| 201 |
+
<span class="k">def</span> <span class="nf">get_panels</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 202 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 203 |
+
<span class="sd"> Returns:</span>
|
| 204 |
+
<span class="sd"> list: a list of panel objects to add implemented in javascript</span>
|
| 205 |
+
<span class="sd"> module</span>
|
| 206 |
+
<span class="sd"> """</span>
|
| 207 |
+
<span class="k">return</span> <span class="p">[]</span>
|
| 208 |
+
<span class="o">...</span>
|
| 209 |
+
|
| 210 |
+
|
| 211 |
+
|
| 212 |
+
<span class="n">blueprint</span> <span class="o">=</span> <span class="n">MyModule</span><span class="p">(</span><span class="s1">'mymodule'</span><span class="p">,</span> <span class="vm">__name__</span><span class="p">,</span> <span class="n">static_url_path</span><span class="o">=</span><span class="s1">'/static'</span><span class="p">)</span>
|
| 213 |
+
</pre></div>
|
| 214 |
+
</div>
|
| 215 |
+
<p>pgAdmin Modules may include any additional Python modules that are required to
|
| 216 |
+
fulfill their purpose, as required. They may also reference other dynamically
|
| 217 |
+
loaded modules, but must use the defined hook points and fail gracefully in the
|
| 218 |
+
event that a particular module is not present.</p>
|
| 219 |
+
</section>
|
| 220 |
+
<section id="nodes">
|
| 221 |
+
<h2>Nodes<a class="headerlink" href="#nodes" title="Link to this heading">¶</a></h2>
|
| 222 |
+
<p>Nodes are very similar to modules, it represents an individual node or,
|
| 223 |
+
collection object on the object explorer treeview. To recognised as a node module, a
|
| 224 |
+
Python package (along with javascript modules) must be created. This must:</p>
|
| 225 |
+
<ol class="arabic simple">
|
| 226 |
+
<li><p>Be placed within the <strong>web/pgadmin/browser/</strong> directory, and</p></li>
|
| 227 |
+
<li><p>Implements the BrowserPluginModule, and registers the node view, which
|
| 228 |
+
exposes required the REST APIs</p></li>
|
| 229 |
+
<li><p>An instance of the class object</p></li>
|
| 230 |
+
</ol>
|
| 231 |
+
</section>
|
| 232 |
+
<section id="front-end">
|
| 233 |
+
<h2>Front End<a class="headerlink" href="#front-end" title="Link to this heading">¶</a></h2>
|
| 234 |
+
<p>pgAdmin uses javascript extensively for the front-end implementation. It uses
|
| 235 |
+
require.js to allow the lazy loading (or, say load only when required),
|
| 236 |
+
ReactJS with CSS and MaterialUI for UI look and feel. We have
|
| 237 |
+
divided each module in small chunks as much as possible. Not all javascript
|
| 238 |
+
modules are required to be loaded (i.e. loading a javascript module for
|
| 239 |
+
database will make sense only when a server node is loaded completely.) Please
|
| 240 |
+
look at the javascript files node.js, browser.js, menu.js, panel.js, etc for
|
| 241 |
+
better understanding of the code.</p>
|
| 242 |
+
</section>
|
| 243 |
+
</section>
|
| 244 |
+
|
| 245 |
+
|
| 246 |
+
<div class="clearer"></div>
|
| 247 |
+
</div>
|
| 248 |
+
</div>
|
| 249 |
+
</div>
|
| 250 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 251 |
+
<div class="sphinxsidebarwrapper">
|
| 252 |
+
<div>
|
| 253 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 254 |
+
<ul>
|
| 255 |
+
<li><a class="reference internal" href="#">Code Overview</a><ul>
|
| 256 |
+
<li><a class="reference internal" href="#runtime">Runtime</a></li>
|
| 257 |
+
<li><a class="reference internal" href="#web-application">Web Application</a><ul>
|
| 258 |
+
<li><a class="reference internal" href="#configuration">Configuration</a></li>
|
| 259 |
+
<li><a class="reference internal" href="#user-settings">User Settings</a></li>
|
| 260 |
+
</ul>
|
| 261 |
+
</li>
|
| 262 |
+
<li><a class="reference internal" href="#pgadmin-core">pgAdmin Core</a></li>
|
| 263 |
+
<li><a class="reference internal" href="#modules">Modules</a></li>
|
| 264 |
+
<li><a class="reference internal" href="#nodes">Nodes</a></li>
|
| 265 |
+
<li><a class="reference internal" href="#front-end">Front End</a></li>
|
| 266 |
+
</ul>
|
| 267 |
+
</li>
|
| 268 |
+
</ul>
|
| 269 |
+
|
| 270 |
+
</div>
|
| 271 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 272 |
+
<ul class="current">
|
| 273 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 274 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 275 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 276 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 277 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 278 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 279 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 280 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 281 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 282 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 283 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 284 |
+
<li class="toctree-l1 current"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a><ul class="current">
|
| 285 |
+
<li class="toctree-l2"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
|
| 286 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Code Overview</a></li>
|
| 287 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html">Coding Standards</a></li>
|
| 288 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html">Code Snippets</a></li>
|
| 289 |
+
<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
|
| 290 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
|
| 291 |
+
</ul>
|
| 292 |
+
</li>
|
| 293 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 294 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 295 |
+
</ul>
|
| 296 |
+
|
| 297 |
+
<search id="searchbox" style="display: none" role="search">
|
| 298 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 299 |
+
<div class="searchformwrapper">
|
| 300 |
+
<form class="search" action="search.html" method="get">
|
| 301 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 302 |
+
<input type="submit" value="Go" />
|
| 303 |
+
</form>
|
| 304 |
+
</div>
|
| 305 |
+
</search>
|
| 306 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 307 |
+
</div>
|
| 308 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 309 |
+
<span>«</span>
|
| 310 |
+
</div>
|
| 311 |
+
|
| 312 |
+
</div>
|
| 313 |
+
<div class="clearer"></div>
|
| 314 |
+
</div>
|
| 315 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 316 |
+
<h3>Navigation</h3>
|
| 317 |
+
<ul>
|
| 318 |
+
<li class="right" style="margin-right: 10px">
|
| 319 |
+
<a href="genindex.html" title="General Index"
|
| 320 |
+
>index</a></li>
|
| 321 |
+
<li class="right" >
|
| 322 |
+
<a href="coding_standards.html" title="Coding Standards"
|
| 323 |
+
>next</a> |</li>
|
| 324 |
+
<li class="right" >
|
| 325 |
+
<a href="submitting_pull_requests.html" title="Submitting Pull Requests"
|
| 326 |
+
>previous</a> |</li>
|
| 327 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 328 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" >pgAdmin Project Contributions</a> »</li>
|
| 329 |
+
<li class="nav-item nav-item-this"><a href="">Code Overview</a></li>
|
| 330 |
+
</ul>
|
| 331 |
+
</div>
|
| 332 |
+
<div class="footer" role="contentinfo">
|
| 333 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 334 |
+
<ul>
|
| 335 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 336 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 337 |
+
<li class="right" ><a href="coding_standards.html" title="Coding Standards" accesskey="N">next</a> |</li>
|
| 338 |
+
<li class="right" ><a href="submitting_pull_requests.html" title="Submitting Pull Requests" accesskey="P">previous</a> |</li>
|
| 339 |
+
</ul>
|
| 340 |
+
</div>
|
| 341 |
+
</div>
|
| 342 |
+
</body>
|
| 343 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/code_review.html
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Code Review Notes — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Translations" href="translations.html" />
|
| 23 |
+
<link rel="prev" title="Code Snippets" href="code_snippets.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="translations.html" title="Translations"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="code_snippets.html" title="Code Snippets"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" accesskey="U">pgAdmin Project Contributions</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Code Review Notes</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="code-review-notes">
|
| 49 |
+
<span id="code-review"></span><h1><span class="target" id="index-0"></span>Code Review Notes<a class="headerlink" href="#code-review-notes" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>This document lists a number of standard items that will be checked during the
|
| 51 |
+
review process for any changes submitted for inclusion in pgAdmin.</p>
|
| 52 |
+
<ul>
|
| 53 |
+
<li><p>Ensure all code follows the pgAdmin <a class="reference internal" href="coding_standards.html"><span class="doc">Coding Standards</span></a>.</p></li>
|
| 54 |
+
<li><p>Ensure all code has unit test coverage and API/feature test coverage where
|
| 55 |
+
appropriate.</p></li>
|
| 56 |
+
<li><p>Copyright years must be correct and properly formatted (to make it easy to make
|
| 57 |
+
bulk updates every year). The start date should always be 2013, and the end year
|
| 58 |
+
the current year, e.g.</p>
|
| 59 |
+
<blockquote>
|
| 60 |
+
<div><p>Copyright (C) 2013 - 2024, The pgAdmin Development Team</p>
|
| 61 |
+
</div></blockquote>
|
| 62 |
+
</li>
|
| 63 |
+
<li><p>Ensure there’s a blank line immediately following any copyright headers.</p></li>
|
| 64 |
+
<li><p>Include PyDoc comments for functions, classes and modules. Node modules should
|
| 65 |
+
be “””Implements the XXXX node”””.</p></li>
|
| 66 |
+
<li><p>Ensure that any generated SQL does not have any leading or trailing blank lines
|
| 67 |
+
and consistently uses 4 space indents for nice formatting.</p></li>
|
| 68 |
+
<li><p>Don’t special-case any Slony objects. pgAdmin 4 will have no direct knowledge
|
| 69 |
+
of Slony, unlike pgAdmin 3.</p></li>
|
| 70 |
+
<li><p>If you copy/paste modules, please ensure any comments are properly updated.</p></li>
|
| 71 |
+
<li><p>Read all comments, and ensure they make sense and provide useful commentary on
|
| 72 |
+
the code.</p></li>
|
| 73 |
+
<li><p>Ensure that field labels both use PostgreSQL parlance, but also are descriptive.
|
| 74 |
+
A good example is the “Init” field on an FTS Template - Init is the PG term, but
|
| 75 |
+
adding the word “Function” after it makes it much more descriptive.</p></li>
|
| 76 |
+
<li><p>Re-use code whereever possible, but factor it out into a suitably central
|
| 77 |
+
location - don’t copy and paste it unless modifications are required!</p></li>
|
| 78 |
+
<li><p>Format code nicely to make it readable. Break up logical chunks of code with
|
| 79 |
+
blank lines, and comment well to describe what different sections of code are
|
| 80 |
+
for or pertain to.</p></li>
|
| 81 |
+
<li><p>Ensure that form validation works correctly and is consistent with other
|
| 82 |
+
dialogues in the way errors are displayed.</p></li>
|
| 83 |
+
<li><p>On dialogues with Schema or Owner fields, pre-set the default values to the
|
| 84 |
+
current schema/user as appropriate. In general, if there are common or sensible
|
| 85 |
+
default values available, put them in the fields for the user.</p></li>
|
| 86 |
+
<li><p>1 Pull Request == 1 feature. If you need to fix/update existing
|
| 87 |
+
infrastructure in your change, it’s usually easier if it’s in a separate
|
| 88 |
+
Pull Request. Pull Requests containing multiple new features or unrelated
|
| 89 |
+
changes are likely to be rejected.</p></li>
|
| 90 |
+
<li><p>Ensure the change is fully functional, and works! If you wish to send a
|
| 91 |
+
work in progress (WIP) change that is not intended for commit, instead of
|
| 92 |
+
submitting a Pull Request, send either as a link to a repository fork or a
|
| 93 |
+
patch to the <a class="reference external" href="mailto:pgadmin-hackers%40postgresql.org">pgadmin-hackers<span>@</span>postgresql<span>.</span>org</a> mailing list, clearly stating
|
| 94 |
+
that it’s a WIP, and noting what does or does not yet work.</p></li>
|
| 95 |
+
</ul>
|
| 96 |
+
</section>
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
<div class="clearer"></div>
|
| 100 |
+
</div>
|
| 101 |
+
</div>
|
| 102 |
+
</div>
|
| 103 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 104 |
+
<div class="sphinxsidebarwrapper">
|
| 105 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 106 |
+
<ul class="current">
|
| 107 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 108 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 109 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 110 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 111 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 113 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 114 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 115 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 116 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 118 |
+
<li class="toctree-l1 current"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a><ul class="current">
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html">Code Overview</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html">Coding Standards</a></li>
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html">Code Snippets</a></li>
|
| 123 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Code Review Notes</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
|
| 125 |
+
</ul>
|
| 126 |
+
</li>
|
| 127 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 128 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 129 |
+
</ul>
|
| 130 |
+
|
| 131 |
+
<search id="searchbox" style="display: none" role="search">
|
| 132 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 133 |
+
<div class="searchformwrapper">
|
| 134 |
+
<form class="search" action="search.html" method="get">
|
| 135 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 136 |
+
<input type="submit" value="Go" />
|
| 137 |
+
</form>
|
| 138 |
+
</div>
|
| 139 |
+
</search>
|
| 140 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 141 |
+
</div>
|
| 142 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 143 |
+
<span>«</span>
|
| 144 |
+
</div>
|
| 145 |
+
|
| 146 |
+
</div>
|
| 147 |
+
<div class="clearer"></div>
|
| 148 |
+
</div>
|
| 149 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 150 |
+
<h3>Navigation</h3>
|
| 151 |
+
<ul>
|
| 152 |
+
<li class="right" style="margin-right: 10px">
|
| 153 |
+
<a href="genindex.html" title="General Index"
|
| 154 |
+
>index</a></li>
|
| 155 |
+
<li class="right" >
|
| 156 |
+
<a href="translations.html" title="Translations"
|
| 157 |
+
>next</a> |</li>
|
| 158 |
+
<li class="right" >
|
| 159 |
+
<a href="code_snippets.html" title="Code Snippets"
|
| 160 |
+
>previous</a> |</li>
|
| 161 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 162 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" >pgAdmin Project Contributions</a> »</li>
|
| 163 |
+
<li class="nav-item nav-item-this"><a href="">Code Review Notes</a></li>
|
| 164 |
+
</ul>
|
| 165 |
+
</div>
|
| 166 |
+
<div class="footer" role="contentinfo">
|
| 167 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 168 |
+
<ul>
|
| 169 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 170 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 171 |
+
<li class="right" ><a href="translations.html" title="Translations" accesskey="N">next</a> |</li>
|
| 172 |
+
<li class="right" ><a href="code_snippets.html" title="Code Snippets" accesskey="P">previous</a> |</li>
|
| 173 |
+
</ul>
|
| 174 |
+
</div>
|
| 175 |
+
</div>
|
| 176 |
+
</body>
|
| 177 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/code_snippets.html
ADDED
|
@@ -0,0 +1,733 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Code Snippets — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Code Review Notes" href="code_review.html" />
|
| 23 |
+
<link rel="prev" title="Coding Standards" href="coding_standards.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="code_review.html" title="Code Review Notes"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="coding_standards.html" title="Coding Standards"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" accesskey="U">pgAdmin Project Contributions</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Code Snippets</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="code-snippets">
|
| 49 |
+
<h1>Code Snippets<a class="headerlink" href="#code-snippets" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>This document contains code for some of the important classes, listed as
|
| 51 |
+
below:</p>
|
| 52 |
+
<ul class="simple">
|
| 53 |
+
<li><p><a class="reference internal" href="#pgadminmodule">PgAdminModule</a></p></li>
|
| 54 |
+
<li><p><a class="reference internal" href="#nodeview">NodeView</a></p></li>
|
| 55 |
+
<li><p><a class="reference internal" href="#basedriver">BaseDriver</a></p></li>
|
| 56 |
+
<li><p><a class="reference internal" href="#baseconnection">BaseConnection</a></p></li>
|
| 57 |
+
</ul>
|
| 58 |
+
<section id="pgadminmodule">
|
| 59 |
+
<span id="id1"></span><h2>PgAdminModule<a class="headerlink" href="#pgadminmodule" title="Link to this heading">¶</a></h2>
|
| 60 |
+
<p>PgAdminModule is inherited from Flask.Blueprint module.
|
| 61 |
+
This module defines a set of methods, properties and attributes,
|
| 62 |
+
that every module should implement.</p>
|
| 63 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">PgAdminModule</span><span class="p">(</span><span class="n">Blueprint</span><span class="p">):</span>
|
| 64 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 65 |
+
<span class="sd"> Base class for every PgAdmin Module.</span>
|
| 66 |
+
|
| 67 |
+
<span class="sd"> This class defines a set of method and attributes that</span>
|
| 68 |
+
<span class="sd"> every module should implement.</span>
|
| 69 |
+
<span class="sd"> """</span>
|
| 70 |
+
|
| 71 |
+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">import_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 72 |
+
<span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">'url_prefix'</span><span class="p">,</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">name</span><span class="p">)</span>
|
| 73 |
+
<span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">'template_folder'</span><span class="p">,</span> <span class="s1">'templates'</span><span class="p">)</span>
|
| 74 |
+
<span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">'static_folder'</span><span class="p">,</span> <span class="s1">'static'</span><span class="p">)</span>
|
| 75 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">submodules</span> <span class="o">=</span> <span class="p">[]</span>
|
| 76 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">parentmodules</span> <span class="o">=</span> <span class="p">[]</span>
|
| 77 |
+
|
| 78 |
+
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">import_name</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
| 79 |
+
|
| 80 |
+
<span class="k">def</span> <span class="nf">register_preferences</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 81 |
+
<span class="c1"># To be implemented by child classes</span>
|
| 82 |
+
<span class="k">pass</span>
|
| 83 |
+
|
| 84 |
+
<span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">):</span>
|
| 85 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 86 |
+
<span class="sd"> Override the default register function to automagically register</span>
|
| 87 |
+
<span class="sd"> sub-modules at once.</span>
|
| 88 |
+
<span class="sd"> """</span>
|
| 89 |
+
|
| 90 |
+
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
|
| 91 |
+
|
| 92 |
+
<span class="k">def</span> <span class="nf">create_module_preference</span><span class="p">():</span>
|
| 93 |
+
<span class="c1"># Create preference for each module by default</span>
|
| 94 |
+
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'LABEL'</span><span class="p">):</span>
|
| 95 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">preference</span> <span class="o">=</span> <span class="n">Preferences</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">LABEL</span><span class="p">)</span>
|
| 96 |
+
<span class="k">else</span><span class="p">:</span>
|
| 97 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">preference</span> <span class="o">=</span> <span class="n">Preferences</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
| 98 |
+
|
| 99 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">register_preferences</span><span class="p">()</span>
|
| 100 |
+
|
| 101 |
+
<span class="c1"># Create and register the module preference object and preferences for</span>
|
| 102 |
+
<span class="c1"># it just before starting app</span>
|
| 103 |
+
<span class="n">app</span><span class="o">.</span><span class="n">register_before_app_start</span><span class="p">(</span><span class="n">create_module_preference</span><span class="p">)</span>
|
| 104 |
+
|
| 105 |
+
<span class="k">for</span> <span class="n">module</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">submodules</span><span class="p">:</span>
|
| 106 |
+
<span class="n">module</span><span class="o">.</span><span class="n">parentmodules</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
| 107 |
+
<span class="k">if</span> <span class="n">app</span><span class="o">.</span><span class="n">blueprints</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">module</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
| 108 |
+
<span class="n">app</span><span class="o">.</span><span class="n">register_blueprint</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
|
| 109 |
+
<span class="n">app</span><span class="o">.</span><span class="n">register_logout_hook</span><span class="p">(</span><span class="n">module</span><span class="p">)</span>
|
| 110 |
+
|
| 111 |
+
<span class="k">def</span> <span class="nf">get_own_messages</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 112 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 113 |
+
<span class="sd"> Returns:</span>
|
| 114 |
+
<span class="sd"> dict: the i18n messages used by this module, not including any</span>
|
| 115 |
+
<span class="sd"> messages needed by the submodules.</span>
|
| 116 |
+
<span class="sd"> """</span>
|
| 117 |
+
<span class="k">return</span> <span class="nb">dict</span><span class="p">()</span>
|
| 118 |
+
|
| 119 |
+
<span class="k">def</span> <span class="nf">get_own_menuitems</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 120 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 121 |
+
<span class="sd"> Returns:</span>
|
| 122 |
+
<span class="sd"> dict: the menuitems for this module, not including</span>
|
| 123 |
+
<span class="sd"> any needed from the submodules.</span>
|
| 124 |
+
<span class="sd"> """</span>
|
| 125 |
+
<span class="k">return</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span>
|
| 126 |
+
|
| 127 |
+
<span class="k">def</span> <span class="nf">get_exposed_url_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 128 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 129 |
+
<span class="sd"> Returns:</span>
|
| 130 |
+
<span class="sd"> list: a list of url endpoints exposed to the client.</span>
|
| 131 |
+
<span class="sd"> """</span>
|
| 132 |
+
<span class="k">return</span> <span class="p">[]</span>
|
| 133 |
+
|
| 134 |
+
<span class="nd">@property</span>
|
| 135 |
+
<span class="k">def</span> <span class="nf">messages</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 136 |
+
<span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_own_messages</span><span class="p">()</span>
|
| 137 |
+
|
| 138 |
+
<span class="k">for</span> <span class="n">module</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">submodules</span><span class="p">:</span>
|
| 139 |
+
<span class="n">res</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">module</span><span class="o">.</span><span class="n">messages</span><span class="p">)</span>
|
| 140 |
+
<span class="k">return</span> <span class="n">res</span>
|
| 141 |
+
|
| 142 |
+
<span class="nd">@property</span>
|
| 143 |
+
<span class="k">def</span> <span class="nf">menu_items</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 144 |
+
<span class="n">menu_items</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_own_menuitems</span><span class="p">()</span>
|
| 145 |
+
<span class="k">for</span> <span class="n">module</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">submodules</span><span class="p">:</span>
|
| 146 |
+
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">module</span><span class="o">.</span><span class="n">menu_items</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
| 147 |
+
<span class="n">menu_items</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
| 148 |
+
<span class="n">menu_items</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">key</span><span class="p">,</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">attrgetter</span><span class="p">(</span><span class="s1">'priority'</span><span class="p">)))</span>
|
| 149 |
+
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">menu_items</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
|
| 150 |
+
<span class="k">return</span> <span class="n">menu_items</span>
|
| 151 |
+
|
| 152 |
+
<span class="nd">@property</span>
|
| 153 |
+
<span class="k">def</span> <span class="nf">exposed_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 154 |
+
<span class="n">res</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_exposed_url_endpoints</span><span class="p">()</span>
|
| 155 |
+
|
| 156 |
+
<span class="k">for</span> <span class="n">module</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">submodules</span><span class="p">:</span>
|
| 157 |
+
<span class="n">res</span> <span class="o">+=</span> <span class="n">module</span><span class="o">.</span><span class="n">exposed_endpoints</span>
|
| 158 |
+
|
| 159 |
+
<span class="k">return</span> <span class="n">res</span>
|
| 160 |
+
</pre></div>
|
| 161 |
+
</div>
|
| 162 |
+
</section>
|
| 163 |
+
<section id="nodeview">
|
| 164 |
+
<span id="id2"></span><h2>NodeView<a class="headerlink" href="#nodeview" title="Link to this heading">¶</a></h2>
|
| 165 |
+
<p>The NodeView class exposes basic REST APIs for different operations used by
|
| 166 |
+
the pgAdmin Browser. The basic idea has been taken from <a class="reference external" href="http://flask.pocoo.org/docs/1.0/api/#flask.views.MethodView">Flask’s MethodView</a> class. Because
|
| 167 |
+
we need a lot more operations (not, just CRUD), we can not use it directly.</p>
|
| 168 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">NodeView</span><span class="p">(</span><span class="n">View</span><span class="p">,</span> <span class="n">metaclass</span><span class="o">=</span><span class="nb">type</span><span class="p">(</span><span class="n">MethodView</span><span class="p">)):</span>
|
| 169 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 170 |
+
<span class="sd"> A PostgreSQL Object has so many operaions/functions apart from CRUD</span>
|
| 171 |
+
<span class="sd"> (Create, Read, Update, Delete):</span>
|
| 172 |
+
<span class="sd"> i.e.</span>
|
| 173 |
+
<span class="sd"> - Reversed Engineered SQL</span>
|
| 174 |
+
<span class="sd"> - Modified Query for parameter while editing object attributes</span>
|
| 175 |
+
<span class="sd"> i.e. ALTER TABLE ...</span>
|
| 176 |
+
<span class="sd"> - Statistics of the objects</span>
|
| 177 |
+
<span class="sd"> - List of dependents</span>
|
| 178 |
+
<span class="sd"> - List of dependencies</span>
|
| 179 |
+
<span class="sd"> - Listing of the children object types for the certain node</span>
|
| 180 |
+
<span class="sd"> It will used by the browser tree to get the children nodes</span>
|
| 181 |
+
|
| 182 |
+
<span class="sd"> This class can be inherited to achieve the diffrent routes for each of the</span>
|
| 183 |
+
<span class="sd"> object types/collections.</span>
|
| 184 |
+
|
| 185 |
+
<span class="sd"> OPERATION | URL | HTTP Method | Method</span>
|
| 186 |
+
<span class="sd"> ---------------+-----------------------------+-------------+--------------</span>
|
| 187 |
+
<span class="sd"> List | /obj/[Parent URL]/ | GET | list</span>
|
| 188 |
+
<span class="sd"> Properties | /obj/[Parent URL]/id | GET | properties</span>
|
| 189 |
+
<span class="sd"> Create | /obj/[Parent URL]/ | POST | create</span>
|
| 190 |
+
<span class="sd"> Delete | /obj/[Parent URL]/id | DELETE | delete</span>
|
| 191 |
+
<span class="sd"> Update | /obj/[Parent URL]/id | PUT | update</span>
|
| 192 |
+
|
| 193 |
+
<span class="sd"> SQL (Reversed | /sql/[Parent URL]/id | GET | sql</span>
|
| 194 |
+
<span class="sd"> Engineering) |</span>
|
| 195 |
+
<span class="sd"> SQL (Modified | /msql/[Parent URL]/id | GET | modified_sql</span>
|
| 196 |
+
<span class="sd"> Properties) |</span>
|
| 197 |
+
|
| 198 |
+
<span class="sd"> Statistics | /stats/[Parent URL]/id | GET | statistics</span>
|
| 199 |
+
<span class="sd"> Dependencies | /dependency/[Parent URL]/id | GET | dependencies</span>
|
| 200 |
+
<span class="sd"> Dependents | /dependent/[Parent URL]/id | GET | dependents</span>
|
| 201 |
+
|
| 202 |
+
<span class="sd"> Nodes | /nodes/[Parent URL]/ | GET | nodes</span>
|
| 203 |
+
<span class="sd"> Current Node | /nodes/[Parent URL]/id | GET | node</span>
|
| 204 |
+
|
| 205 |
+
<span class="sd"> Children | /children/[Parent URL]/id | GET | children</span>
|
| 206 |
+
|
| 207 |
+
<span class="sd"> NOTE:</span>
|
| 208 |
+
<span class="sd"> Parent URL can be seen as the path to identify the particular node.</span>
|
| 209 |
+
|
| 210 |
+
<span class="sd"> i.e.</span>
|
| 211 |
+
<span class="sd"> In order to identify the TABLE object, we need server -> database -> schema</span>
|
| 212 |
+
<span class="sd"> information.</span>
|
| 213 |
+
<span class="sd"> """</span>
|
| 214 |
+
<span class="n">operations</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">({</span>
|
| 215 |
+
<span class="s1">'obj'</span><span class="p">:</span> <span class="p">[</span>
|
| 216 |
+
<span class="p">{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'properties'</span><span class="p">,</span> <span class="s1">'delete'</span><span class="p">:</span> <span class="s1">'delete'</span><span class="p">,</span> <span class="s1">'put'</span><span class="p">:</span> <span class="s1">'update'</span><span class="p">},</span>
|
| 217 |
+
<span class="p">{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'list'</span><span class="p">,</span> <span class="s1">'post'</span><span class="p">:</span> <span class="s1">'create'</span><span class="p">}</span>
|
| 218 |
+
<span class="p">],</span>
|
| 219 |
+
<span class="s1">'nodes'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'node'</span><span class="p">},</span> <span class="p">{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'nodes'</span><span class="p">}],</span>
|
| 220 |
+
<span class="s1">'sql'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'sql'</span><span class="p">}],</span>
|
| 221 |
+
<span class="s1">'msql'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'modified_sql'</span><span class="p">}],</span>
|
| 222 |
+
<span class="s1">'stats'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'statistics'</span><span class="p">}],</span>
|
| 223 |
+
<span class="s1">'dependency'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'dependencies'</span><span class="p">}],</span>
|
| 224 |
+
<span class="s1">'dependent'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'dependents'</span><span class="p">}],</span>
|
| 225 |
+
<span class="s1">'children'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'get'</span><span class="p">:</span> <span class="s1">'children'</span><span class="p">}]</span>
|
| 226 |
+
<span class="p">})</span>
|
| 227 |
+
|
| 228 |
+
<span class="nd">@classmethod</span>
|
| 229 |
+
<span class="k">def</span> <span class="nf">generate_ops</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
| 230 |
+
<span class="n">cmds</span> <span class="o">=</span> <span class="p">[]</span>
|
| 231 |
+
<span class="k">for</span> <span class="n">op</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">operations</span><span class="p">:</span>
|
| 232 |
+
<span class="n">idx</span> <span class="o">=</span> <span class="mi">0</span>
|
| 233 |
+
<span class="k">for</span> <span class="n">ops</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="n">op</span><span class="p">]:</span>
|
| 234 |
+
<span class="n">meths</span> <span class="o">=</span> <span class="p">[]</span>
|
| 235 |
+
<span class="k">for</span> <span class="n">meth</span> <span class="ow">in</span> <span class="n">ops</span><span class="p">:</span>
|
| 236 |
+
<span class="n">meths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">meth</span><span class="o">.</span><span class="n">upper</span><span class="p">())</span>
|
| 237 |
+
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">meths</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
|
| 238 |
+
<span class="n">cmds</span><span class="o">.</span><span class="n">append</span><span class="p">({</span>
|
| 239 |
+
<span class="s1">'cmd'</span><span class="p">:</span> <span class="n">op</span><span class="p">,</span> <span class="s1">'req'</span><span class="p">:</span> <span class="p">(</span><span class="n">idx</span> <span class="o">==</span> <span class="mi">0</span><span class="p">),</span>
|
| 240 |
+
<span class="s1">'with_id'</span><span class="p">:</span> <span class="p">(</span><span class="n">idx</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">),</span> <span class="s1">'methods'</span><span class="p">:</span> <span class="n">meths</span>
|
| 241 |
+
<span class="p">})</span>
|
| 242 |
+
<span class="n">idx</span> <span class="o">+=</span> <span class="mi">1</span>
|
| 243 |
+
<span class="k">return</span> <span class="n">cmds</span>
|
| 244 |
+
|
| 245 |
+
<span class="c1"># Inherited class needs to modify these parameters</span>
|
| 246 |
+
<span class="n">node_type</span> <span class="o">=</span> <span class="kc">None</span>
|
| 247 |
+
<span class="c1"># Inherited class needs to modify these parameters</span>
|
| 248 |
+
<span class="n">node_label</span> <span class="o">=</span> <span class="kc">None</span>
|
| 249 |
+
<span class="c1"># This must be an array object with attributes (type and id)</span>
|
| 250 |
+
<span class="n">parent_ids</span> <span class="o">=</span> <span class="p">[]</span>
|
| 251 |
+
<span class="c1"># This must be an array object with attributes (type and id)</span>
|
| 252 |
+
<span class="n">ids</span> <span class="o">=</span> <span class="p">[]</span>
|
| 253 |
+
|
| 254 |
+
<span class="nd">@classmethod</span>
|
| 255 |
+
<span class="k">def</span> <span class="nf">get_node_urls</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
| 256 |
+
<span class="k">assert</span> <span class="bp">cls</span><span class="o">.</span><span class="n">node_type</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">,</span> \
|
| 257 |
+
<span class="s2">"Please set the node_type for this class (</span><span class="si">{0}</span><span class="s2">)"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
| 258 |
+
<span class="nb">str</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span>
|
| 259 |
+
<span class="n">common_url</span> <span class="o">=</span> <span class="s1">'/'</span>
|
| 260 |
+
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">parent_ids</span><span class="p">:</span>
|
| 261 |
+
<span class="n">common_url</span> <span class="o">+=</span> <span class="s1">'<</span><span class="si">{0}</span><span class="s1">:</span><span class="si">{1}</span><span class="s1">>/'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">p</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]),</span> <span class="nb">str</span><span class="p">(</span><span class="n">p</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]))</span>
|
| 262 |
+
|
| 263 |
+
<span class="n">id_url</span> <span class="o">=</span> <span class="kc">None</span>
|
| 264 |
+
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">ids</span><span class="p">:</span>
|
| 265 |
+
<span class="n">id_url</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{0}</span><span class="s1"><</span><span class="si">{1}</span><span class="s1">:</span><span class="si">{2}</span><span class="s1">>'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
| 266 |
+
<span class="n">common_url</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">id_url</span> <span class="k">else</span> <span class="n">id_url</span><span class="p">,</span>
|
| 267 |
+
<span class="n">p</span><span class="p">[</span><span class="s1">'type'</span><span class="p">],</span> <span class="n">p</span><span class="p">[</span><span class="s1">'id'</span><span class="p">])</span>
|
| 268 |
+
|
| 269 |
+
<span class="k">return</span> <span class="n">id_url</span><span class="p">,</span> <span class="n">common_url</span>
|
| 270 |
+
|
| 271 |
+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 272 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">cmd</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">'cmd'</span><span class="p">]</span>
|
| 273 |
+
|
| 274 |
+
<span class="c1"># Check the existance of all the required arguments from parent_ids</span>
|
| 275 |
+
<span class="c1"># and return combination of has parent arguments, and has id arguments</span>
|
| 276 |
+
<span class="k">def</span> <span class="nf">check_args</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 277 |
+
<span class="n">has_id</span> <span class="o">=</span> <span class="n">has_args</span> <span class="o">=</span> <span class="kc">True</span>
|
| 278 |
+
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parent_ids</span><span class="p">:</span>
|
| 279 |
+
<span class="k">if</span> <span class="n">p</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
|
| 280 |
+
<span class="n">has_args</span> <span class="o">=</span> <span class="kc">False</span>
|
| 281 |
+
<span class="k">break</span>
|
| 282 |
+
|
| 283 |
+
<span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">ids</span><span class="p">:</span>
|
| 284 |
+
<span class="k">if</span> <span class="n">p</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">kwargs</span><span class="p">:</span>
|
| 285 |
+
<span class="n">has_id</span> <span class="o">=</span> <span class="kc">False</span>
|
| 286 |
+
<span class="k">break</span>
|
| 287 |
+
|
| 288 |
+
<span class="k">return</span> <span class="n">has_args</span><span class="p">,</span> <span class="n">has_id</span> <span class="ow">and</span> <span class="n">has_args</span>
|
| 289 |
+
|
| 290 |
+
<span class="k">def</span> <span class="nf">dispatch_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 291 |
+
<span class="n">http_method</span> <span class="o">=</span> <span class="n">flask</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
| 292 |
+
<span class="k">if</span> <span class="n">http_method</span> <span class="o">==</span> <span class="s1">'head'</span><span class="p">:</span>
|
| 293 |
+
<span class="n">http_method</span> <span class="o">=</span> <span class="s1">'get'</span>
|
| 294 |
+
|
| 295 |
+
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmd</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">,</span> \
|
| 296 |
+
<span class="s1">'Unimplemented command (</span><span class="si">{0}</span><span class="s1">) for </span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
| 297 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">,</span>
|
| 298 |
+
<span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
|
| 299 |
+
<span class="p">)</span>
|
| 300 |
+
|
| 301 |
+
<span class="n">has_args</span><span class="p">,</span> <span class="n">has_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_args</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
| 302 |
+
|
| 303 |
+
<span class="k">assert</span> <span class="p">(</span>
|
| 304 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">cmd</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span> <span class="ow">and</span>
|
| 305 |
+
<span class="p">(</span><span class="n">has_id</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">])</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">and</span>
|
| 306 |
+
<span class="n">http_method</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">0</span><span class="p">])</span> <span class="ow">or</span>
|
| 307 |
+
<span class="p">(</span><span class="ow">not</span> <span class="n">has_id</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">])</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span>
|
| 308 |
+
<span class="n">http_method</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">1</span><span class="p">])</span> <span class="ow">or</span>
|
| 309 |
+
<span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">])</span> <span class="o">></span> <span class="mi">2</span> <span class="ow">and</span>
|
| 310 |
+
<span class="n">http_method</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">2</span><span class="p">])</span>
|
| 311 |
+
<span class="p">),</span> \
|
| 312 |
+
<span class="s1">'Unimplemented method (</span><span class="si">{0}</span><span class="s1">) for command (</span><span class="si">{1}</span><span class="s1">), which </span><span class="si">{2}</span><span class="s1"> '</span> \
|
| 313 |
+
<span class="s1">'an id'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">http_method</span><span class="p">,</span>
|
| 314 |
+
<span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">,</span>
|
| 315 |
+
<span class="s1">'requires'</span> <span class="k">if</span> <span class="n">has_id</span> <span class="k">else</span> <span class="s1">'does not require'</span><span class="p">)</span>
|
| 316 |
+
<span class="n">meth</span> <span class="o">=</span> <span class="kc">None</span>
|
| 317 |
+
<span class="k">if</span> <span class="n">has_id</span><span class="p">:</span>
|
| 318 |
+
<span class="n">meth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="n">http_method</span><span class="p">]</span>
|
| 319 |
+
<span class="k">elif</span> <span class="n">has_args</span> <span class="ow">and</span> <span class="n">http_method</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">1</span><span class="p">]:</span>
|
| 320 |
+
<span class="n">meth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">1</span><span class="p">][</span><span class="n">http_method</span><span class="p">]</span>
|
| 321 |
+
<span class="k">else</span><span class="p">:</span>
|
| 322 |
+
<span class="n">meth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">operations</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">cmd</span><span class="p">][</span><span class="mi">2</span><span class="p">][</span><span class="n">http_method</span><span class="p">]</span>
|
| 323 |
+
|
| 324 |
+
<span class="n">method</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">meth</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
| 325 |
+
|
| 326 |
+
<span class="k">if</span> <span class="n">method</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
| 327 |
+
<span class="k">return</span> <span class="n">make_json_response</span><span class="p">(</span>
|
| 328 |
+
<span class="n">status</span><span class="o">=</span><span class="mi">406</span><span class="p">,</span>
|
| 329 |
+
<span class="n">success</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
| 330 |
+
<span class="n">errormsg</span><span class="o">=</span><span class="n">gettext</span><span class="p">(</span>
|
| 331 |
+
<span class="s1">'Unimplemented method (</span><span class="si">{0}</span><span class="s1">) for this url (</span><span class="si">{1}</span><span class="s1">)'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
| 332 |
+
<span class="n">meth</span><span class="p">,</span> <span class="n">flask</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">path</span>
|
| 333 |
+
<span class="p">)</span>
|
| 334 |
+
<span class="p">)</span>
|
| 335 |
+
|
| 336 |
+
<span class="k">return</span> <span class="n">method</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
| 337 |
+
|
| 338 |
+
<span class="nd">@classmethod</span>
|
| 339 |
+
<span class="k">def</span> <span class="nf">register_node_view</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">blueprint</span><span class="p">):</span>
|
| 340 |
+
<span class="bp">cls</span><span class="o">.</span><span class="n">blueprint</span> <span class="o">=</span> <span class="n">blueprint</span>
|
| 341 |
+
<span class="n">id_url</span><span class="p">,</span> <span class="n">url</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">get_node_urls</span><span class="p">()</span>
|
| 342 |
+
|
| 343 |
+
<span class="n">commands</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">generate_ops</span><span class="p">()</span>
|
| 344 |
+
|
| 345 |
+
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">commands</span><span class="p">:</span>
|
| 346 |
+
<span class="n">cmd</span> <span class="o">=</span> <span class="n">c</span><span class="p">[</span><span class="s1">'cmd'</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">)</span>
|
| 347 |
+
<span class="k">if</span> <span class="n">c</span><span class="p">[</span><span class="s1">'with_id'</span><span class="p">]:</span>
|
| 348 |
+
<span class="n">blueprint</span><span class="o">.</span><span class="n">add_url_rule</span><span class="p">(</span>
|
| 349 |
+
<span class="s1">'/</span><span class="si">{0}{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
| 350 |
+
<span class="n">c</span><span class="p">[</span><span class="s1">'cmd'</span><span class="p">],</span> <span class="n">id_url</span> <span class="k">if</span> <span class="n">c</span><span class="p">[</span><span class="s1">'req'</span><span class="p">]</span> <span class="k">else</span> <span class="n">url</span>
|
| 351 |
+
<span class="p">),</span>
|
| 352 |
+
<span class="n">view_func</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">as_view</span><span class="p">(</span>
|
| 353 |
+
<span class="s1">'</span><span class="si">{0}{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
| 354 |
+
<span class="n">cmd</span><span class="p">,</span> <span class="s1">'_id'</span> <span class="k">if</span> <span class="n">c</span><span class="p">[</span><span class="s1">'req'</span><span class="p">]</span> <span class="k">else</span> <span class="s1">''</span>
|
| 355 |
+
<span class="p">),</span>
|
| 356 |
+
<span class="n">cmd</span><span class="o">=</span><span class="n">c</span><span class="p">[</span><span class="s1">'cmd'</span><span class="p">]</span>
|
| 357 |
+
<span class="p">),</span>
|
| 358 |
+
<span class="n">methods</span><span class="o">=</span><span class="n">c</span><span class="p">[</span><span class="s1">'methods'</span><span class="p">]</span>
|
| 359 |
+
<span class="p">)</span>
|
| 360 |
+
<span class="k">else</span><span class="p">:</span>
|
| 361 |
+
<span class="n">blueprint</span><span class="o">.</span><span class="n">add_url_rule</span><span class="p">(</span>
|
| 362 |
+
<span class="s1">'/</span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">c</span><span class="p">[</span><span class="s1">'cmd'</span><span class="p">]),</span>
|
| 363 |
+
<span class="n">view_func</span><span class="o">=</span><span class="bp">cls</span><span class="o">.</span><span class="n">as_view</span><span class="p">(</span>
|
| 364 |
+
<span class="n">cmd</span><span class="p">,</span> <span class="n">cmd</span><span class="o">=</span><span class="n">c</span><span class="p">[</span><span class="s1">'cmd'</span><span class="p">]</span>
|
| 365 |
+
<span class="p">),</span>
|
| 366 |
+
<span class="n">methods</span><span class="o">=</span><span class="n">c</span><span class="p">[</span><span class="s1">'methods'</span><span class="p">]</span>
|
| 367 |
+
<span class="p">)</span>
|
| 368 |
+
|
| 369 |
+
<span class="k">def</span> <span class="nf">children</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 370 |
+
<span class="w"> </span><span class="sd">"""Build a list of treeview nodes from the child nodes."""</span>
|
| 371 |
+
<span class="n">children</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_children_nodes</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
| 372 |
+
|
| 373 |
+
<span class="c1"># Return sorted nodes based on label</span>
|
| 374 |
+
<span class="k">return</span> <span class="n">make_json_response</span><span class="p">(</span>
|
| 375 |
+
<span class="n">data</span><span class="o">=</span><span class="nb">sorted</span><span class="p">(</span>
|
| 376 |
+
<span class="n">children</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">c</span><span class="p">:</span> <span class="n">c</span><span class="p">[</span><span class="s1">'label'</span><span class="p">]</span>
|
| 377 |
+
<span class="p">)</span>
|
| 378 |
+
<span class="p">)</span>
|
| 379 |
+
|
| 380 |
+
<span class="k">def</span> <span class="nf">get_children_nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 381 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 382 |
+
<span class="sd"> Returns the list of children nodes for the current nodes. Override this</span>
|
| 383 |
+
<span class="sd"> function for special cases only.</span>
|
| 384 |
+
|
| 385 |
+
<span class="sd"> :param args:</span>
|
| 386 |
+
<span class="sd"> :param kwargs: Parameters to generate the correct set of tree node.</span>
|
| 387 |
+
<span class="sd"> :return: List of the children nodes</span>
|
| 388 |
+
<span class="sd"> """</span>
|
| 389 |
+
<span class="n">children</span> <span class="o">=</span> <span class="p">[]</span>
|
| 390 |
+
|
| 391 |
+
<span class="k">for</span> <span class="n">module</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span><span class="o">.</span><span class="n">submodules</span><span class="p">:</span>
|
| 392 |
+
<span class="n">children</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">module</span><span class="o">.</span><span class="n">get_nodes</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">))</span>
|
| 393 |
+
|
| 394 |
+
<span class="k">return</span> <span class="n">children</span>
|
| 395 |
+
</pre></div>
|
| 396 |
+
</div>
|
| 397 |
+
</section>
|
| 398 |
+
<section id="basedriver">
|
| 399 |
+
<span id="id3"></span><h2>BaseDriver<a class="headerlink" href="#basedriver" title="Link to this heading">¶</a></h2>
|
| 400 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">BaseDriver</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">DriverRegistry</span><span class="p">):</span>
|
| 401 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 402 |
+
<span class="sd"> class BaseDriver():</span>
|
| 403 |
+
|
| 404 |
+
<span class="sd"> This is a base class for different server types.</span>
|
| 405 |
+
<span class="sd"> Inherit this class to implement different type of database driver</span>
|
| 406 |
+
<span class="sd"> implementation.</span>
|
| 407 |
+
|
| 408 |
+
<span class="sd"> (For PostgreSQL/EDB Postgres Advanced Server, we will be using psycopg)</span>
|
| 409 |
+
|
| 410 |
+
<span class="sd"> Abstract Properties:</span>
|
| 411 |
+
<span class="sd"> -------- ----------</span>
|
| 412 |
+
<span class="sd"> * Version (string):</span>
|
| 413 |
+
<span class="sd"> Current version string for the database server</span>
|
| 414 |
+
|
| 415 |
+
<span class="sd"> * libpq_version (string):</span>
|
| 416 |
+
<span class="sd"> Current version string for the used libpq library</span>
|
| 417 |
+
|
| 418 |
+
<span class="sd"> Abstract Methods:</span>
|
| 419 |
+
<span class="sd"> -------- -------</span>
|
| 420 |
+
<span class="sd"> * get_connection(*args, **kwargs)</span>
|
| 421 |
+
<span class="sd"> - It should return a Connection class object, which may/may not be</span>
|
| 422 |
+
<span class="sd"> connected to the database server.</span>
|
| 423 |
+
|
| 424 |
+
<span class="sd"> * release_connection(*args, **kwargs)</span>
|
| 425 |
+
<span class="sd"> - Implement the connection release logic</span>
|
| 426 |
+
|
| 427 |
+
<span class="sd"> * gc()</span>
|
| 428 |
+
<span class="sd"> - Implement this function to release the connections assigned in the</span>
|
| 429 |
+
<span class="sd"> session, which has not been pinged from more than the idle timeout</span>
|
| 430 |
+
<span class="sd"> configuration.</span>
|
| 431 |
+
<span class="sd"> """</span>
|
| 432 |
+
|
| 433 |
+
<span class="nd">@property</span>
|
| 434 |
+
<span class="nd">@abstractmethod</span>
|
| 435 |
+
<span class="k">def</span> <span class="nf">version</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
| 436 |
+
<span class="k">pass</span>
|
| 437 |
+
|
| 438 |
+
<span class="nd">@property</span>
|
| 439 |
+
<span class="nd">@abstractmethod</span>
|
| 440 |
+
<span class="k">def</span> <span class="nf">libpq_version</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
| 441 |
+
<span class="k">pass</span>
|
| 442 |
+
|
| 443 |
+
<span class="nd">@abstractmethod</span>
|
| 444 |
+
<span class="k">def</span> <span class="nf">get_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 445 |
+
<span class="k">pass</span>
|
| 446 |
+
|
| 447 |
+
<span class="nd">@abstractmethod</span>
|
| 448 |
+
<span class="k">def</span> <span class="nf">release_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 449 |
+
<span class="k">pass</span>
|
| 450 |
+
|
| 451 |
+
<span class="nd">@abstractmethod</span>
|
| 452 |
+
<span class="k">def</span> <span class="nf">gc_timeout</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 453 |
+
<span class="k">pass</span>
|
| 454 |
+
</pre></div>
|
| 455 |
+
</div>
|
| 456 |
+
</section>
|
| 457 |
+
<section id="baseconnection">
|
| 458 |
+
<span id="id4"></span><h2>BaseConnection<a class="headerlink" href="#baseconnection" title="Link to this heading">¶</a></h2>
|
| 459 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">BaseConnection</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
| 460 |
+
<span class="w"> </span><span class="sd">"""</span>
|
| 461 |
+
<span class="sd"> class BaseConnection()</span>
|
| 462 |
+
|
| 463 |
+
<span class="sd"> It is a base class for database connection. A different connection</span>
|
| 464 |
+
<span class="sd"> drive must implement this to expose abstract methods for this server.</span>
|
| 465 |
+
|
| 466 |
+
<span class="sd"> General idea is to create a wrapper around the actual driver</span>
|
| 467 |
+
<span class="sd"> implementation. It will be instantiated by the driver factory</span>
|
| 468 |
+
<span class="sd"> basically. And, they should not be instantiated directly.</span>
|
| 469 |
+
|
| 470 |
+
|
| 471 |
+
<span class="sd"> Abstract Methods:</span>
|
| 472 |
+
<span class="sd"> -------- -------</span>
|
| 473 |
+
<span class="sd"> * connect(**kwargs)</span>
|
| 474 |
+
<span class="sd"> - Define this method to connect the server using that particular driver</span>
|
| 475 |
+
<span class="sd"> implementation.</span>
|
| 476 |
+
|
| 477 |
+
<span class="sd"> * execute_scalar(query, params, formatted_exception_msg)</span>
|
| 478 |
+
<span class="sd"> - Implement this method to execute the given query and returns single</span>
|
| 479 |
+
<span class="sd"> datum result.</span>
|
| 480 |
+
|
| 481 |
+
<span class="sd"> * execute_async(query, params, formatted_exception_msg)</span>
|
| 482 |
+
<span class="sd"> - Implement this method to execute the given query asynchronously and</span>
|
| 483 |
+
<span class="sd"> returns result.</span>
|
| 484 |
+
|
| 485 |
+
<span class="sd"> * execute_void(query, params, formatted_exception_msg)</span>
|
| 486 |
+
<span class="sd"> - Implement this method to execute the given query with no result.</span>
|
| 487 |
+
|
| 488 |
+
<span class="sd"> * execute_2darray(query, params, formatted_exception_msg)</span>
|
| 489 |
+
<span class="sd"> - Implement this method to execute the given query and returns the result</span>
|
| 490 |
+
<span class="sd"> as a 2 dimensional array.</span>
|
| 491 |
+
|
| 492 |
+
<span class="sd"> * execute_dict(query, params, formatted_exception_msg)</span>
|
| 493 |
+
<span class="sd"> - Implement this method to execute the given query and returns the result</span>
|
| 494 |
+
<span class="sd"> as an array of dict (column name -> value) format.</span>
|
| 495 |
+
|
| 496 |
+
<span class="sd"> * def async_fetchmany_2darray(records=-1, formatted_exception_msg=False):</span>
|
| 497 |
+
<span class="sd"> - Implement this method to retrieve result of asynchronous connection and</span>
|
| 498 |
+
<span class="sd"> polling with no_result flag set to True.</span>
|
| 499 |
+
<span class="sd"> This returns the result as a 2 dimensional array.</span>
|
| 500 |
+
<span class="sd"> If records is -1 then fetchmany will behave as fetchall.</span>
|
| 501 |
+
|
| 502 |
+
<span class="sd"> * connected()</span>
|
| 503 |
+
<span class="sd"> - Implement this method to get the status of the connection. It should</span>
|
| 504 |
+
<span class="sd"> return True for connected, otherwise False</span>
|
| 505 |
+
|
| 506 |
+
<span class="sd"> * reset()</span>
|
| 507 |
+
<span class="sd"> - Implement this method to reconnect the database server (if possible)</span>
|
| 508 |
+
|
| 509 |
+
<span class="sd"> * transaction_status()</span>
|
| 510 |
+
<span class="sd"> - Implement this method to get the transaction status for this</span>
|
| 511 |
+
<span class="sd"> connection. Range of return values different for each driver type.</span>
|
| 512 |
+
|
| 513 |
+
<span class="sd"> * ping()</span>
|
| 514 |
+
<span class="sd"> - Implement this method to ping the server. There are times, a connection</span>
|
| 515 |
+
<span class="sd"> has been lost, but - the connection driver does not know about it. This</span>
|
| 516 |
+
<span class="sd"> can be helpful to figure out the actual reason for query failure.</span>
|
| 517 |
+
|
| 518 |
+
<span class="sd"> * _release()</span>
|
| 519 |
+
<span class="sd"> - Implement this method to release the connection object. This should not</span>
|
| 520 |
+
<span class="sd"> be directly called using the connection object itself.</span>
|
| 521 |
+
|
| 522 |
+
<span class="sd"> NOTE: Please use BaseDriver.release_connection(...) for releasing the</span>
|
| 523 |
+
<span class="sd"> connection object for better memory management, and connection pool</span>
|
| 524 |
+
<span class="sd"> management.</span>
|
| 525 |
+
|
| 526 |
+
<span class="sd"> * _wait(conn)</span>
|
| 527 |
+
<span class="sd"> - Implement this method to wait for asynchronous connection to finish the</span>
|
| 528 |
+
<span class="sd"> execution, hence - it must be a blocking call.</span>
|
| 529 |
+
|
| 530 |
+
<span class="sd"> * _wait_timeout(conn, time)</span>
|
| 531 |
+
<span class="sd"> - Implement this method to wait for asynchronous connection with timeout.</span>
|
| 532 |
+
<span class="sd"> This must be a non blocking call.</span>
|
| 533 |
+
|
| 534 |
+
<span class="sd"> * poll(formatted_exception_msg, no_result)</span>
|
| 535 |
+
<span class="sd"> - Implement this method to poll the data of query running on asynchronous</span>
|
| 536 |
+
<span class="sd"> connection.</span>
|
| 537 |
+
|
| 538 |
+
<span class="sd"> * cancel_transaction(conn_id, did=None)</span>
|
| 539 |
+
<span class="sd"> - Implement this method to cancel the running transaction.</span>
|
| 540 |
+
|
| 541 |
+
<span class="sd"> * messages()</span>
|
| 542 |
+
<span class="sd"> - Implement this method to return the list of the messages/notices from</span>
|
| 543 |
+
<span class="sd"> the database server.</span>
|
| 544 |
+
|
| 545 |
+
<span class="sd"> * rows_affected()</span>
|
| 546 |
+
<span class="sd"> - Implement this method to get the rows affected by the last command</span>
|
| 547 |
+
<span class="sd"> executed on the server.</span>
|
| 548 |
+
<span class="sd"> """</span>
|
| 549 |
+
|
| 550 |
+
<span class="n">ASYNC_OK</span> <span class="o">=</span> <span class="mi">1</span>
|
| 551 |
+
<span class="n">ASYNC_READ_TIMEOUT</span> <span class="o">=</span> <span class="mi">2</span>
|
| 552 |
+
<span class="n">ASYNC_WRITE_TIMEOUT</span> <span class="o">=</span> <span class="mi">3</span>
|
| 553 |
+
<span class="n">ASYNC_NOT_CONNECTED</span> <span class="o">=</span> <span class="mi">4</span>
|
| 554 |
+
<span class="n">ASYNC_EXECUTION_ABORTED</span> <span class="o">=</span> <span class="mi">5</span>
|
| 555 |
+
<span class="n">ASYNC_TIMEOUT</span> <span class="o">=</span> <span class="mf">0.2</span>
|
| 556 |
+
<span class="n">ASYNC_WAIT_TIMEOUT</span> <span class="o">=</span> <span class="mi">2</span>
|
| 557 |
+
<span class="n">ASYNC_NOTICE_MAXLENGTH</span> <span class="o">=</span> <span class="mi">100000</span>
|
| 558 |
+
|
| 559 |
+
<span class="nd">@abstractmethod</span>
|
| 560 |
+
<span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
| 561 |
+
<span class="k">pass</span>
|
| 562 |
+
|
| 563 |
+
<span class="nd">@abstractmethod</span>
|
| 564 |
+
<span class="k">def</span> <span class="nf">execute_scalar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
| 565 |
+
<span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
| 566 |
+
<span class="k">pass</span>
|
| 567 |
+
|
| 568 |
+
<span class="nd">@abstractmethod</span>
|
| 569 |
+
<span class="k">def</span> <span class="nf">execute_async</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
| 570 |
+
<span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
| 571 |
+
<span class="k">pass</span>
|
| 572 |
+
|
| 573 |
+
<span class="nd">@abstractmethod</span>
|
| 574 |
+
<span class="k">def</span> <span class="nf">execute_void</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
| 575 |
+
<span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
| 576 |
+
<span class="k">pass</span>
|
| 577 |
+
|
| 578 |
+
<span class="nd">@abstractmethod</span>
|
| 579 |
+
<span class="k">def</span> <span class="nf">execute_2darray</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
| 580 |
+
<span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
| 581 |
+
<span class="k">pass</span>
|
| 582 |
+
|
| 583 |
+
<span class="nd">@abstractmethod</span>
|
| 584 |
+
<span class="k">def</span> <span class="nf">execute_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
| 585 |
+
<span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
| 586 |
+
<span class="k">pass</span>
|
| 587 |
+
|
| 588 |
+
<span class="nd">@abstractmethod</span>
|
| 589 |
+
<span class="k">def</span> <span class="nf">async_fetchmany_2darray</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">records</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span>
|
| 590 |
+
<span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
| 591 |
+
<span class="k">pass</span>
|
| 592 |
+
|
| 593 |
+
<span class="nd">@abstractmethod</span>
|
| 594 |
+
<span class="k">def</span> <span class="nf">connected</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 595 |
+
<span class="k">pass</span>
|
| 596 |
+
|
| 597 |
+
<span class="nd">@abstractmethod</span>
|
| 598 |
+
<span class="k">def</span> <span class="nf">reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 599 |
+
<span class="k">pass</span>
|
| 600 |
+
|
| 601 |
+
<span class="nd">@abstractmethod</span>
|
| 602 |
+
<span class="k">def</span> <span class="nf">transaction_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 603 |
+
<span class="k">pass</span>
|
| 604 |
+
|
| 605 |
+
<span class="nd">@abstractmethod</span>
|
| 606 |
+
<span class="k">def</span> <span class="nf">ping</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 607 |
+
<span class="k">pass</span>
|
| 608 |
+
|
| 609 |
+
<span class="nd">@abstractmethod</span>
|
| 610 |
+
<span class="k">def</span> <span class="nf">_release</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 611 |
+
<span class="k">pass</span>
|
| 612 |
+
|
| 613 |
+
<span class="nd">@abstractmethod</span>
|
| 614 |
+
<span class="k">def</span> <span class="nf">_wait</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
|
| 615 |
+
<span class="k">pass</span>
|
| 616 |
+
|
| 617 |
+
<span class="nd">@abstractmethod</span>
|
| 618 |
+
<span class="k">def</span> <span class="nf">_wait_timeout</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">,</span> <span class="n">time</span><span class="p">):</span>
|
| 619 |
+
<span class="k">pass</span>
|
| 620 |
+
|
| 621 |
+
<span class="nd">@abstractmethod</span>
|
| 622 |
+
<span class="k">def</span> <span class="nf">poll</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">formatted_exception_msg</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">no_result</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
| 623 |
+
<span class="k">pass</span>
|
| 624 |
+
|
| 625 |
+
<span class="nd">@abstractmethod</span>
|
| 626 |
+
<span class="k">def</span> <span class="nf">status_message</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 627 |
+
<span class="k">pass</span>
|
| 628 |
+
|
| 629 |
+
<span class="nd">@abstractmethod</span>
|
| 630 |
+
<span class="k">def</span> <span class="nf">rows_affected</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
| 631 |
+
<span class="k">pass</span>
|
| 632 |
+
|
| 633 |
+
<span class="nd">@abstractmethod</span>
|
| 634 |
+
<span class="k">def</span> <span class="nf">cancel_transaction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn_id</span><span class="p">,</span> <span class="n">did</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
| 635 |
+
<span class="k">pass</span>
|
| 636 |
+
</pre></div>
|
| 637 |
+
</div>
|
| 638 |
+
</section>
|
| 639 |
+
</section>
|
| 640 |
+
|
| 641 |
+
|
| 642 |
+
<div class="clearer"></div>
|
| 643 |
+
</div>
|
| 644 |
+
</div>
|
| 645 |
+
</div>
|
| 646 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 647 |
+
<div class="sphinxsidebarwrapper">
|
| 648 |
+
<div>
|
| 649 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 650 |
+
<ul>
|
| 651 |
+
<li><a class="reference internal" href="#">Code Snippets</a><ul>
|
| 652 |
+
<li><a class="reference internal" href="#pgadminmodule">PgAdminModule</a></li>
|
| 653 |
+
<li><a class="reference internal" href="#nodeview">NodeView</a></li>
|
| 654 |
+
<li><a class="reference internal" href="#basedriver">BaseDriver</a></li>
|
| 655 |
+
<li><a class="reference internal" href="#baseconnection">BaseConnection</a></li>
|
| 656 |
+
</ul>
|
| 657 |
+
</li>
|
| 658 |
+
</ul>
|
| 659 |
+
|
| 660 |
+
</div>
|
| 661 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 662 |
+
<ul class="current">
|
| 663 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 664 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 665 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 666 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 667 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 668 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 669 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 670 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 671 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 672 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 673 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 674 |
+
<li class="toctree-l1 current"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a><ul class="current">
|
| 675 |
+
<li class="toctree-l2"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
|
| 676 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html">Code Overview</a></li>
|
| 677 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html">Coding Standards</a></li>
|
| 678 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Code Snippets</a></li>
|
| 679 |
+
<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
|
| 680 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
|
| 681 |
+
</ul>
|
| 682 |
+
</li>
|
| 683 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 684 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 685 |
+
</ul>
|
| 686 |
+
|
| 687 |
+
<search id="searchbox" style="display: none" role="search">
|
| 688 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 689 |
+
<div class="searchformwrapper">
|
| 690 |
+
<form class="search" action="search.html" method="get">
|
| 691 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 692 |
+
<input type="submit" value="Go" />
|
| 693 |
+
</form>
|
| 694 |
+
</div>
|
| 695 |
+
</search>
|
| 696 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 697 |
+
</div>
|
| 698 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 699 |
+
<span>«</span>
|
| 700 |
+
</div>
|
| 701 |
+
|
| 702 |
+
</div>
|
| 703 |
+
<div class="clearer"></div>
|
| 704 |
+
</div>
|
| 705 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 706 |
+
<h3>Navigation</h3>
|
| 707 |
+
<ul>
|
| 708 |
+
<li class="right" style="margin-right: 10px">
|
| 709 |
+
<a href="genindex.html" title="General Index"
|
| 710 |
+
>index</a></li>
|
| 711 |
+
<li class="right" >
|
| 712 |
+
<a href="code_review.html" title="Code Review Notes"
|
| 713 |
+
>next</a> |</li>
|
| 714 |
+
<li class="right" >
|
| 715 |
+
<a href="coding_standards.html" title="Coding Standards"
|
| 716 |
+
>previous</a> |</li>
|
| 717 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 718 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" >pgAdmin Project Contributions</a> »</li>
|
| 719 |
+
<li class="nav-item nav-item-this"><a href="">Code Snippets</a></li>
|
| 720 |
+
</ul>
|
| 721 |
+
</div>
|
| 722 |
+
<div class="footer" role="contentinfo">
|
| 723 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 724 |
+
<ul>
|
| 725 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 726 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 727 |
+
<li class="right" ><a href="code_review.html" title="Code Review Notes" accesskey="N">next</a> |</li>
|
| 728 |
+
<li class="right" ><a href="coding_standards.html" title="Coding Standards" accesskey="P">previous</a> |</li>
|
| 729 |
+
</ul>
|
| 730 |
+
</div>
|
| 731 |
+
</div>
|
| 732 |
+
</body>
|
| 733 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/coding_standards.html
ADDED
|
@@ -0,0 +1,272 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Coding Standards — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Code Snippets" href="code_snippets.html" />
|
| 23 |
+
<link rel="prev" title="Code Overview" href="code_overview.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="code_snippets.html" title="Code Snippets"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="code_overview.html" title="Code Overview"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" accesskey="U">pgAdmin Project Contributions</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Coding Standards</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="coding-standards">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Coding Standards<a class="headerlink" href="#coding-standards" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>pgAdmin uses multiple technologies and multiple languages, each of which have
|
| 51 |
+
their own coding standards.</p>
|
| 52 |
+
<section id="general">
|
| 53 |
+
<h2>General<a class="headerlink" href="#general" title="Link to this heading">¶</a></h2>
|
| 54 |
+
<p>In all languages, indentations should be made with 4 spaces, and excessively long
|
| 55 |
+
lines wrapped where appropriate to ensure they can be read on smaller displays
|
| 56 |
+
(80 characters is used in many places, but this is not a required maximum size
|
| 57 |
+
as it’s quite wasteful on modern displays). Typically lines should not be longer
|
| 58 |
+
than 120 characters.</p>
|
| 59 |
+
<p>Comments should be included in all code where required to explain its
|
| 60 |
+
purpose or how it works if not obvious from a quick review of the code itself.</p>
|
| 61 |
+
</section>
|
| 62 |
+
<section id="css-3">
|
| 63 |
+
<h2>CSS 3<a class="headerlink" href="#css-3" title="Link to this heading">¶</a></h2>
|
| 64 |
+
<p>CSS3 is used for styling and layout throughout the application.</p>
|
| 65 |
+
<p>Most custom styling comes from individual modules which may advertise static
|
| 66 |
+
stylesheets to be included in the module that is loading them via hooks.</p>
|
| 67 |
+
<p>Styling overrides (for example, to alter the look and feel) will
|
| 68 |
+
typically be found in the <strong>overrides.css</strong> file in the main static file
|
| 69 |
+
directory for the application.</p>
|
| 70 |
+
<p>Styling should never be applied inline in HTML, always through an external
|
| 71 |
+
stylesheet, which should contain comments as appropriate to explain the usage
|
| 72 |
+
or purpose for the style.</p>
|
| 73 |
+
<p>Styles should be specified clearly, one per line. For example:</p>
|
| 74 |
+
<div class="highlight-css notranslate"><div class="highlight"><pre><span></span><span class="c">/* iFrames should have no border */</span>
|
| 75 |
+
<span class="nt">iframe</span><span class="w"> </span><span class="p">{</span>
|
| 76 |
+
<span class="w"> </span><span class="k">border-width</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
|
| 77 |
+
<span class="p">}</span>
|
| 78 |
+
|
| 79 |
+
<span class="c">/* Ensure the codemirror editor displays full height gutters when resized */</span>
|
| 80 |
+
<span class="p">.</span><span class="nc">CodeMirror</span><span class="o">,</span><span class="w"> </span><span class="p">.</span><span class="nc">CodeMirror-gutters</span><span class="w"> </span><span class="p">{</span>
|
| 81 |
+
<span class="w"> </span><span class="k">height</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="kt">%</span><span class="w"> </span><span class="cp">!important</span><span class="p">;</span>
|
| 82 |
+
<span class="p">}</span>
|
| 83 |
+
</pre></div>
|
| 84 |
+
</div>
|
| 85 |
+
<p>All stylesheets must be CSS3 compliant.</p>
|
| 86 |
+
</section>
|
| 87 |
+
<section id="html-5">
|
| 88 |
+
<h2>HTML 5<a class="headerlink" href="#html-5" title="Link to this heading">¶</a></h2>
|
| 89 |
+
<p>HTML 5 is used for page structure throughout the application, in most cases
|
| 90 |
+
being rendered from templates by the Jinja2 template engine in Flask.</p>
|
| 91 |
+
<p>All HTML must be HTML 5 compliant.</p>
|
| 92 |
+
</section>
|
| 93 |
+
<section id="javascript">
|
| 94 |
+
<h2>Javascript<a class="headerlink" href="#javascript" title="Link to this heading">¶</a></h2>
|
| 95 |
+
<p>Client-side code is written in Javascript using ReactJS and various plugins.
|
| 96 |
+
Whilst much of the code is rendered from static files, there is also code that
|
| 97 |
+
is rendered from templates using Jinja2 (often to inject the users settings) or
|
| 98 |
+
constructed on the fly from module hooks.</p>
|
| 99 |
+
<p>A typical Javascript function might be formatted like this (this snipped is from
|
| 100 |
+
a template):</p>
|
| 101 |
+
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="c1">// Delete a server group</span>
|
| 102 |
+
<span class="kd">function</span><span class="w"> </span><span class="nx">delete_server_group</span><span class="p">(</span><span class="nx">item</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
| 103 |
+
<span class="w"> </span><span class="nx">alertify</span><span class="p">.</span><span class="nx">confirm</span><span class="p">(</span>
|
| 104 |
+
<span class="w"> </span><span class="s1">'Delete server group?'</span><span class="p">,</span>
|
| 105 |
+
<span class="w"> </span><span class="s1">'Are you sure you wish to delete the server group "{0}"?'</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="s1">'{0}'</span><span class="p">,</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">getLabel</span><span class="p">(</span><span class="nx">item</span><span class="p">)),</span>
|
| 106 |
+
<span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
| 107 |
+
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">getId</span><span class="p">(</span><span class="nx">item</span><span class="p">)</span>
|
| 108 |
+
<span class="w"> </span><span class="nx">$</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="s2">"{{ url_for('NODE-server-group.delete') }}"</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">id</span><span class="o">:</span><span class="w"> </span><span class="nx">id</span><span class="w"> </span><span class="p">})</span>
|
| 109 |
+
<span class="w"> </span><span class="p">.</span><span class="nx">done</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">data</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
| 110 |
+
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">success</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
| 111 |
+
<span class="w"> </span><span class="nx">report_error</span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">errormsg</span><span class="p">,</span><span class="w"> </span><span class="nx">data</span><span class="p">.</span><span class="nx">info</span><span class="p">);</span>
|
| 112 |
+
<span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
|
| 113 |
+
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">next</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
|
| 114 |
+
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="nx">prev</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">prev</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
|
| 115 |
+
<span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">remove</span><span class="p">(</span><span class="nx">item</span><span class="p">);</span>
|
| 116 |
+
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">next</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
| 117 |
+
<span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="nx">next</span><span class="p">);</span>
|
| 118 |
+
<span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">prev</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
| 119 |
+
<span class="w"> </span><span class="nx">tree</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="nx">prev</span><span class="p">);</span>
|
| 120 |
+
<span class="w"> </span><span class="p">}</span>
|
| 121 |
+
<span class="w"> </span><span class="p">}</span>
|
| 122 |
+
<span class="w"> </span><span class="p">}</span>
|
| 123 |
+
<span class="w"> </span><span class="p">)</span>
|
| 124 |
+
<span class="w"> </span><span class="p">},</span>
|
| 125 |
+
<span class="w"> </span><span class="kc">null</span>
|
| 126 |
+
<span class="w"> </span><span class="p">)</span>
|
| 127 |
+
<span class="p">}</span>
|
| 128 |
+
</pre></div>
|
| 129 |
+
</div>
|
| 130 |
+
<p>Note the use of a descriptive function name, using the underscore character to
|
| 131 |
+
separate words in all lower case, and short but descriptive lower case variable
|
| 132 |
+
names.</p>
|
| 133 |
+
<div class="admonition note">
|
| 134 |
+
<p class="admonition-title">Note</p>
|
| 135 |
+
<p>From version 3.0 onwards, new or refactored code should be written using
|
| 136 |
+
ES6 features and conventions.</p>
|
| 137 |
+
</div>
|
| 138 |
+
</section>
|
| 139 |
+
<section id="python">
|
| 140 |
+
<h2>Python<a class="headerlink" href="#python" title="Link to this heading">¶</a></h2>
|
| 141 |
+
<p>Python is used for the backend web server. All code must be compatible with
|
| 142 |
+
Python 2.7 and should include PyDoc comments whilst following the official
|
| 143 |
+
Python coding standards defined in
|
| 144 |
+
<a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP 8</a>. An example function along
|
| 145 |
+
with the required file header is shown below:</p>
|
| 146 |
+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">##########################################################################</span>
|
| 147 |
+
<span class="c1">#</span>
|
| 148 |
+
<span class="c1"># pgAdmin 4 - PostgreSQL Tools</span>
|
| 149 |
+
<span class="c1">#</span>
|
| 150 |
+
<span class="c1"># Copyright (C) 2013 - 2024, The pgAdmin Development Team</span>
|
| 151 |
+
<span class="c1"># This software is released under the PostgreSQL Licence</span>
|
| 152 |
+
<span class="c1">#</span>
|
| 153 |
+
<span class="c1">##########################################################################</span>
|
| 154 |
+
|
| 155 |
+
<span class="sd">"""Integration hooks for server groups."""</span>
|
| 156 |
+
|
| 157 |
+
<span class="kn">from</span> <span class="nn">flask</span> <span class="kn">import</span> <span class="n">render_template</span><span class="p">,</span> <span class="n">url_for</span>
|
| 158 |
+
<span class="kn">from</span> <span class="nn">flask.ext.security</span> <span class="kn">import</span> <span class="n">current_user</span>
|
| 159 |
+
|
| 160 |
+
<span class="kn">from</span> <span class="nn">pgadmin.settings.settings_model</span> <span class="kn">import</span> <span class="n">db</span><span class="p">,</span> <span class="n">ServerGroup</span>
|
| 161 |
+
|
| 162 |
+
<span class="k">def</span> <span class="nf">get_nodes</span><span class="p">():</span>
|
| 163 |
+
<span class="w"> </span><span class="sd">"""Return a JSON document listing the server groups for the user"""</span>
|
| 164 |
+
<span class="n">groups</span> <span class="o">=</span> <span class="n">ServerGroup</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">filter_by</span><span class="p">(</span><span class="n">user_id</span><span class="o">=</span><span class="n">current_user</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
|
| 165 |
+
|
| 166 |
+
<span class="n">value</span> <span class="o">=</span> <span class="s1">''</span>
|
| 167 |
+
<span class="k">for</span> <span class="n">group</span> <span class="ow">in</span> <span class="n">groups</span><span class="p">:</span>
|
| 168 |
+
<span class="n">value</span> <span class="o">+=</span> <span class="s1">'{"id":</span><span class="si">%d</span><span class="s1">,"label":"</span><span class="si">%s</span><span class="s1">","icon":"icon-server-group","inode":true},'</span> \
|
| 169 |
+
<span class="o">%</span> <span class="p">(</span><span class="n">group</span><span class="o">.</span><span class="n">id</span><span class="p">,</span> <span class="n">group</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
| 170 |
+
|
| 171 |
+
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
| 172 |
+
|
| 173 |
+
<span class="k">return</span> <span class="n">value</span>
|
| 174 |
+
</pre></div>
|
| 175 |
+
</div>
|
| 176 |
+
</section>
|
| 177 |
+
</section>
|
| 178 |
+
|
| 179 |
+
|
| 180 |
+
<div class="clearer"></div>
|
| 181 |
+
</div>
|
| 182 |
+
</div>
|
| 183 |
+
</div>
|
| 184 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 185 |
+
<div class="sphinxsidebarwrapper">
|
| 186 |
+
<div>
|
| 187 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 188 |
+
<ul>
|
| 189 |
+
<li><a class="reference internal" href="#">Coding Standards</a><ul>
|
| 190 |
+
<li><a class="reference internal" href="#general">General</a></li>
|
| 191 |
+
<li><a class="reference internal" href="#css-3">CSS 3</a></li>
|
| 192 |
+
<li><a class="reference internal" href="#html-5">HTML 5</a></li>
|
| 193 |
+
<li><a class="reference internal" href="#javascript">Javascript</a></li>
|
| 194 |
+
<li><a class="reference internal" href="#python">Python</a></li>
|
| 195 |
+
</ul>
|
| 196 |
+
</li>
|
| 197 |
+
</ul>
|
| 198 |
+
|
| 199 |
+
</div>
|
| 200 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 201 |
+
<ul class="current">
|
| 202 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 203 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 204 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 205 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 206 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 207 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 208 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 209 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 210 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 211 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 212 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 213 |
+
<li class="toctree-l1 current"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a><ul class="current">
|
| 214 |
+
<li class="toctree-l2"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
|
| 215 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html">Code Overview</a></li>
|
| 216 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Coding Standards</a></li>
|
| 217 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html">Code Snippets</a></li>
|
| 218 |
+
<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
|
| 219 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
|
| 220 |
+
</ul>
|
| 221 |
+
</li>
|
| 222 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 223 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 224 |
+
</ul>
|
| 225 |
+
|
| 226 |
+
<search id="searchbox" style="display: none" role="search">
|
| 227 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 228 |
+
<div class="searchformwrapper">
|
| 229 |
+
<form class="search" action="search.html" method="get">
|
| 230 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 231 |
+
<input type="submit" value="Go" />
|
| 232 |
+
</form>
|
| 233 |
+
</div>
|
| 234 |
+
</search>
|
| 235 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 236 |
+
</div>
|
| 237 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 238 |
+
<span>«</span>
|
| 239 |
+
</div>
|
| 240 |
+
|
| 241 |
+
</div>
|
| 242 |
+
<div class="clearer"></div>
|
| 243 |
+
</div>
|
| 244 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 245 |
+
<h3>Navigation</h3>
|
| 246 |
+
<ul>
|
| 247 |
+
<li class="right" style="margin-right: 10px">
|
| 248 |
+
<a href="genindex.html" title="General Index"
|
| 249 |
+
>index</a></li>
|
| 250 |
+
<li class="right" >
|
| 251 |
+
<a href="code_snippets.html" title="Code Snippets"
|
| 252 |
+
>next</a> |</li>
|
| 253 |
+
<li class="right" >
|
| 254 |
+
<a href="code_overview.html" title="Code Overview"
|
| 255 |
+
>previous</a> |</li>
|
| 256 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 257 |
+
<li class="nav-item nav-item-1"><a href="contributions.html" >pgAdmin Project Contributions</a> »</li>
|
| 258 |
+
<li class="nav-item nav-item-this"><a href="">Coding Standards</a></li>
|
| 259 |
+
</ul>
|
| 260 |
+
</div>
|
| 261 |
+
<div class="footer" role="contentinfo">
|
| 262 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 263 |
+
<ul>
|
| 264 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 265 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 266 |
+
<li class="right" ><a href="code_snippets.html" title="Code Snippets" accesskey="N">next</a> |</li>
|
| 267 |
+
<li class="right" ><a href="code_overview.html" title="Code Overview" accesskey="P">previous</a> |</li>
|
| 268 |
+
</ul>
|
| 269 |
+
</div>
|
| 270 |
+
</div>
|
| 271 |
+
</body>
|
| 272 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/collation_dialog.html
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Collation Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Domain Dialog" href="domain_dialog.html" />
|
| 23 |
+
<link rel="prev" title="DBMS Schedule" href="dbms_schedule.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="domain_dialog.html" title="Domain Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="dbms_schedule.html" title="DBMS Schedule"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Collation Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="collation-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Collation Dialog<a class="headerlink" href="#collation-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Collation</em> dialog to define a collation. A collation is an SQL schema
|
| 51 |
+
object that maps a SQL name to operating system locales. To create a collation,
|
| 52 |
+
you must have a CREATE privilege on the destination schema.</p>
|
| 53 |
+
<p>The <em>Collation</em> dialog organizes the development of a collation through the
|
| 54 |
+
following dialog tabs: <em>General</em> and <em>Definition</em>. The <em>SQL</em> tab displays the
|
| 55 |
+
SQL code generated by dialog selections.</p>
|
| 56 |
+
<img alt="Collation dialog general tab" class="align-center" src="_images/collation_general.png" />
|
| 57 |
+
<p>Use the fields in the <em>General</em> tab to identify the collation:</p>
|
| 58 |
+
<ul class="simple">
|
| 59 |
+
<li><p>Use the <em>Name</em> field to provide a name for the collation. The collation name
|
| 60 |
+
must be unique within a schema. The name will be displayed in the <em>pgAdmin</em>
|
| 61 |
+
tree control.</p></li>
|
| 62 |
+
<li><p>Select the name of the owner from the drop-down listbox in the <em>Owner</em> field.</p></li>
|
| 63 |
+
<li><p>Select the name of the schema in which the collation will reside from the
|
| 64 |
+
drop-down listbox in the <em>Schema</em> field.</p></li>
|
| 65 |
+
<li><p>Store notes about the collation in the <em>Comment</em> field.</p></li>
|
| 66 |
+
</ul>
|
| 67 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 68 |
+
<img alt="Collation dialog definition tab" class="align-center" src="_images/collation_definition.png" />
|
| 69 |
+
<p>Use the fields in the <em>Definition</em> tab to specify the operating system locale
|
| 70 |
+
settings:</p>
|
| 71 |
+
<ul class="simple">
|
| 72 |
+
<li><p>Use the drop-down listbox next to <em>Copy collation</em> to select the name of an
|
| 73 |
+
existing collation to copy. The new collation will have the same properties
|
| 74 |
+
as the existing one, but will be an independent object. If you choose to copy
|
| 75 |
+
an existing collation, you cannot modify the collation properties displayed on
|
| 76 |
+
this tab.</p></li>
|
| 77 |
+
<li><p>Use the <em>Locale</em> field to specify a locale; a locale specifies language and
|
| 78 |
+
language formatting characteristics. If you specify this, you cannot specify
|
| 79 |
+
either of the following parameters. To view a list of locales supported by
|
| 80 |
+
your Linux system use the command <em>locale -a</em>.</p></li>
|
| 81 |
+
<li><p>Use the <em>LC_COLLATE</em> field to specify a locale with specified string sort
|
| 82 |
+
order. The locale must be applicable to the current database encoding. (See
|
| 83 |
+
CREATE DATABASE for details.)</p></li>
|
| 84 |
+
<li><p>Use the <em>LC_CTYPE</em> field to specify a locale with specified character
|
| 85 |
+
classification. The locale must be applicable to the current database encoding.
|
| 86 |
+
(See CREATE DATABASE for details.)</p></li>
|
| 87 |
+
<li><p>Use the drop-down listbox next to <em>Locale Provider</em> to select a locale services associated
|
| 88 |
+
with the collation. Possible values are: icu, libc. libc is the default.</p></li>
|
| 89 |
+
<li><p>Move the switch next to <em>Deterministic</em> to <em>YES</em> to specify whether the collation should use
|
| 90 |
+
deterministic comparisons. By default, this option is set to true. In a
|
| 91 |
+
deterministic comparison, strings that are not byte-wise equal are considered
|
| 92 |
+
unequal, even if they are considered logically equal in the comparison.</p></li>
|
| 93 |
+
<li><p>Use the <em>Rules</em> field to specify a rules for customizing the behavior of the collation.
|
| 94 |
+
It includes considerations such as character ordering, case sensitivity, and accent
|
| 95 |
+
sensitivity.</p></li>
|
| 96 |
+
<li><p>Use the <em>Version</em> field to specify version string to store with the collation object.</p></li>
|
| 97 |
+
</ul>
|
| 98 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 99 |
+
<p>Your entries in the <em>Collation</em> dialog generate a SQL command (see an example b
|
| 100 |
+
elow). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 101 |
+
to the SQL command.</p>
|
| 102 |
+
<section id="example">
|
| 103 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 104 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 105 |
+
the <em>Collation</em> dialog:</p>
|
| 106 |
+
<img alt="Collation dialog sql tab" class="align-center" src="_images/collation_sql.png" />
|
| 107 |
+
<p>The example shown demonstrates creating a collation named <em>french</em> that uses the
|
| 108 |
+
rules specified for the locale, <em>fr-BI-x-icu. The collation is owned by
|
| 109 |
+
*postgres</em>.</p>
|
| 110 |
+
<ul>
|
| 111 |
+
<li><p>Click the <em>Info</em> button (i) to access online help. For more information about
|
| 112 |
+
setting a locale, see Chapter 22.1 Locale Support of the PostgreSQL core
|
| 113 |
+
documentation:</p>
|
| 114 |
+
<blockquote>
|
| 115 |
+
<div><p><a class="reference external" href="https://www.postgresql.org/docs/current/locale.html">https://www.postgresql.org/docs/current/locale.html</a></p>
|
| 116 |
+
</div></blockquote>
|
| 117 |
+
</li>
|
| 118 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 119 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 120 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 121 |
+
</ul>
|
| 122 |
+
</section>
|
| 123 |
+
</section>
|
| 124 |
+
|
| 125 |
+
|
| 126 |
+
<div class="clearer"></div>
|
| 127 |
+
</div>
|
| 128 |
+
</div>
|
| 129 |
+
</div>
|
| 130 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 131 |
+
<div class="sphinxsidebarwrapper">
|
| 132 |
+
<div>
|
| 133 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 134 |
+
<ul>
|
| 135 |
+
<li><a class="reference internal" href="#">Collation Dialog</a><ul>
|
| 136 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 137 |
+
</ul>
|
| 138 |
+
</li>
|
| 139 |
+
</ul>
|
| 140 |
+
|
| 141 |
+
</div>
|
| 142 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 143 |
+
<ul class="current">
|
| 144 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 148 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 149 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 150 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 151 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Collation Dialog</a></li>
|
| 152 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 153 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 154 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 155 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 156 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 157 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 158 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 159 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 160 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 161 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 162 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 163 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 164 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 165 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 166 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 167 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 168 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 169 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 170 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 171 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 172 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 173 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 174 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 175 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 176 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 177 |
+
</ul>
|
| 178 |
+
</li>
|
| 179 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 180 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 181 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 182 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 183 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 184 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 185 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 186 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 187 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 188 |
+
</ul>
|
| 189 |
+
|
| 190 |
+
<search id="searchbox" style="display: none" role="search">
|
| 191 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 192 |
+
<div class="searchformwrapper">
|
| 193 |
+
<form class="search" action="search.html" method="get">
|
| 194 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 195 |
+
<input type="submit" value="Go" />
|
| 196 |
+
</form>
|
| 197 |
+
</div>
|
| 198 |
+
</search>
|
| 199 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 200 |
+
</div>
|
| 201 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 202 |
+
<span>«</span>
|
| 203 |
+
</div>
|
| 204 |
+
|
| 205 |
+
</div>
|
| 206 |
+
<div class="clearer"></div>
|
| 207 |
+
</div>
|
| 208 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 209 |
+
<h3>Navigation</h3>
|
| 210 |
+
<ul>
|
| 211 |
+
<li class="right" style="margin-right: 10px">
|
| 212 |
+
<a href="genindex.html" title="General Index"
|
| 213 |
+
>index</a></li>
|
| 214 |
+
<li class="right" >
|
| 215 |
+
<a href="domain_dialog.html" title="Domain Dialog"
|
| 216 |
+
>next</a> |</li>
|
| 217 |
+
<li class="right" >
|
| 218 |
+
<a href="dbms_schedule.html" title="DBMS Schedule"
|
| 219 |
+
>previous</a> |</li>
|
| 220 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 221 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 222 |
+
<li class="nav-item nav-item-this"><a href="">Collation Dialog</a></li>
|
| 223 |
+
</ul>
|
| 224 |
+
</div>
|
| 225 |
+
<div class="footer" role="contentinfo">
|
| 226 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 227 |
+
<ul>
|
| 228 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 229 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 230 |
+
<li class="right" ><a href="domain_dialog.html" title="Domain Dialog" accesskey="N">next</a> |</li>
|
| 231 |
+
<li class="right" ><a href="dbms_schedule.html" title="DBMS Schedule" accesskey="P">previous</a> |</li>
|
| 232 |
+
</ul>
|
| 233 |
+
</div>
|
| 234 |
+
</div>
|
| 235 |
+
</body>
|
| 236 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/column_dialog.html
ADDED
|
@@ -0,0 +1,286 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Column Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Compound Trigger Dialog" href="compound_trigger_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Check Dialog" href="check_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="compound_trigger_dialog.html" title="Compound Trigger Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="check_dialog.html" title="Check Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" accesskey="U">Creating or Modifying a Table</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Column Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="column-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Column Dialog<a class="headerlink" href="#column-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Column</em> dialog to add a column to an existing table or modify a column
|
| 51 |
+
definition.</p>
|
| 52 |
+
<p>The <em>Column</em> dialog organizes the development of a column through the following
|
| 53 |
+
dialog tabs: <em>General</em>, <em>Definition</em>, and <em>Security</em>. The <em>SQL</em> tab displays the
|
| 54 |
+
SQL code generated by dialog selections.</p>
|
| 55 |
+
<img alt="Column dialog general tab" class="align-center" src="_images/column_general.png" />
|
| 56 |
+
<p>Use the fields in the <em>General</em> tab to identify the column:</p>
|
| 57 |
+
<ul class="simple">
|
| 58 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the column. The name will
|
| 59 |
+
be displayed in the <em>pgAdmin</em> tree control. This field is required.</p></li>
|
| 60 |
+
<li><p>Store notes about the column in the <em>Comment</em> field.</p></li>
|
| 61 |
+
</ul>
|
| 62 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 63 |
+
<img alt="Column dialog definition tab" class="align-center" src="_images/column_definition.png" />
|
| 64 |
+
<p>Use the fields in the <em>Definition</em> tab to add parameters for the column. (Fields
|
| 65 |
+
are disabled if inapplicable.)</p>
|
| 66 |
+
<ul class="simple">
|
| 67 |
+
<li><p>Use the drop-down listbox next to <em>Data Type</em> to select a data type for the
|
| 68 |
+
column. For more information on the data types that are supported by
|
| 69 |
+
PostgreSQL, refer to Chapter 8 of the Postgres core documentation. This field
|
| 70 |
+
is required.</p></li>
|
| 71 |
+
<li><p>Use the <em>Length/Precision</em> and <em>Scale</em> fields to specify the maximum number of
|
| 72 |
+
significant digits in a numeric value, or the maximum number of characters in
|
| 73 |
+
a text value.</p></li>
|
| 74 |
+
<li><p>Use the drop-down listbox next to <em>Collation</em> to apply a collation setting to
|
| 75 |
+
the column.</p></li>
|
| 76 |
+
<li><p>Use the drop-down listbox next to <em>Compression</em> to set the compression method
|
| 77 |
+
for the column. Compression is supported only for variable-width data types,
|
| 78 |
+
and is used only when the column’s storage mode is main or extended. This
|
| 79 |
+
option is available from v14 and above.</p></li>
|
| 80 |
+
<li><p>Use the drop-down listbox next to <em>Storage</em> to set the storage mode for the
|
| 81 |
+
column. This option is available from v16 and above.</p></li>
|
| 82 |
+
</ul>
|
| 83 |
+
<p>Click the <em>Constraints</em> tab to continue.</p>
|
| 84 |
+
<img alt="Column dialog constraints tab" class="align-center" src="_images/column_constraints.png" />
|
| 85 |
+
<p>Use the fields in the <em>Constraints</em> tab to specify constraints for the column.
|
| 86 |
+
(Fields are disabled if inapplicable.)</p>
|
| 87 |
+
<ul class="simple">
|
| 88 |
+
<li><p>Use the <em>Default Value</em> field to specify a default data value.</p></li>
|
| 89 |
+
<li><p>Move the <em>Not Null</em> switch to the <em>Yes</em> position to specify the column may not
|
| 90 |
+
contain null values. The default is <em>No</em>.</p></li>
|
| 91 |
+
<li><p>Use the <em>Type</em> field to specify the column type (NONE/IDENTITY/GENERATED).
|
| 92 |
+
The default is <em>NONE</em>.</p></li>
|
| 93 |
+
</ul>
|
| 94 |
+
<p>Click the <em>IDENTITY</em> type to create Identity column.</p>
|
| 95 |
+
<img alt="Column dialog constraints tab" class="align-center" src="_images/column_constraint_identity.png" />
|
| 96 |
+
<p>Use the following fields to create <em>IDENTITY</em> column. Identity columns are
|
| 97 |
+
applicable for PG/EPAS version 10 and above.</p>
|
| 98 |
+
<ul class="simple">
|
| 99 |
+
<li><p>Use the <em>Identity</em> field to specify ALWAYS or BY DEFAULT. This clause is
|
| 100 |
+
used to determine how the sequence value is given precedence over a
|
| 101 |
+
user-specified value in an INSERT statement.</p></li>
|
| 102 |
+
<li><p>Use the <em>Increment</em> field to specify which value is added to the current
|
| 103 |
+
sequence value to create a new value.</p></li>
|
| 104 |
+
<li><p>Provide a value in the <em>Start</em> field to specify the beginning value of the
|
| 105 |
+
sequence. The default starting value is MINVALUE for ascending sequences and
|
| 106 |
+
MAXVALUE for descending ones.</p></li>
|
| 107 |
+
<li><p>Provide a value in the <em>Minimum</em> field to specify the minimum value a sequence
|
| 108 |
+
can generate. If this clause is not supplied or NO MINVALUE is specified,
|
| 109 |
+
then defaults will be used. The defaults are 1 and -263-1 for ascending and
|
| 110 |
+
descending sequences, respectively.</p></li>
|
| 111 |
+
<li><p>Provide a value in the <em>Maximum</em> field to specify the maximum value for the
|
| 112 |
+
sequence. If this clause is not supplied or NO MAXVALUE is specified, then
|
| 113 |
+
default values will be used. The defaults are 263-1 and -1 for ascending and
|
| 114 |
+
descending sequences, respectively.</p></li>
|
| 115 |
+
<li><p>Provide a value in the <em>Cache</em> field to specify how many sequence numbers are
|
| 116 |
+
to be preallocated and stored in memory for faster access. The minimum value
|
| 117 |
+
is 1 (only one value can be generated at a time, i.e., no cache), and this is
|
| 118 |
+
also the default.</p></li>
|
| 119 |
+
<li><p>Move the <em>Cycled</em> switch to the <em>Yes</em> position to allow the sequence to wrap
|
| 120 |
+
around when the MAXVALUE or the MINVALUE has been reached by an ascending or
|
| 121 |
+
descending sequence respectively. If the limit is reached, the next number
|
| 122 |
+
generated will be the MINVALUE or MAXVALUE, respectively. The default is <em>No</em>.</p></li>
|
| 123 |
+
</ul>
|
| 124 |
+
<p>Click the <em>GENERATED</em> type to create Generated column.</p>
|
| 125 |
+
<img alt="Column dialog constraints tab" class="align-center" src="_images/column_constraint_generated.png" />
|
| 126 |
+
<p>Use the following fields to create <em>GENERATED</em> column. Generated columns are
|
| 127 |
+
applicable for PG/EPAS version 12 and above.</p>
|
| 128 |
+
<ul class="simple">
|
| 129 |
+
<li><p>Use the <em>Expression</em> field to specify the generation expression. It can
|
| 130 |
+
refer to other columns in the table, but not other generated columns.
|
| 131 |
+
Any functions and operators used must be immutable. References to other
|
| 132 |
+
tables are not allowed.</p></li>
|
| 133 |
+
</ul>
|
| 134 |
+
<p>Click the <em>Variables</em> tab to continue.</p>
|
| 135 |
+
<img alt="Column dialog variables tab" class="align-center" src="_images/column_variables.png" />
|
| 136 |
+
<p>Use the <em>Variables</em> tab to specify the number of distinct values that may be
|
| 137 |
+
present in the column; this value overrides estimates made by the ANALYZE
|
| 138 |
+
command. Click the <em>Add</em> icon (+) to add a <em>Name</em>/<em>Value</em> pair:</p>
|
| 139 |
+
<ul>
|
| 140 |
+
<li><p>Select the name of the variable from the drop-down listbox in the <em>Name</em> field.</p>
|
| 141 |
+
<blockquote>
|
| 142 |
+
<div><ul class="simple">
|
| 143 |
+
<li><p>Select <em>n_distinct</em> to specify the number of distinct values for the column.</p></li>
|
| 144 |
+
<li><p>Select <em>n_distinct_inherited</em> to specify the number of distinct values
|
| 145 |
+
for the table and its children.</p></li>
|
| 146 |
+
</ul>
|
| 147 |
+
</div></blockquote>
|
| 148 |
+
</li>
|
| 149 |
+
<li><p>Specify the number of distinct values in the <em>Value</em> field. For more
|
| 150 |
+
information, see the documentation for
|
| 151 |
+
<a class="reference external" href="https://www.postgresql.org/docs/current/sql-altertable.html">ALTER TABLE</a>.</p></li>
|
| 152 |
+
</ul>
|
| 153 |
+
<p>Click the <em>Add</em> icon (+) to specify each additional <em>Name</em>/<em>Value</em> pair; to
|
| 154 |
+
discard a variable, click the trash icon to the left of the row and confirm
|
| 155 |
+
deletion in the <em>Delete Row</em> popup.</p>
|
| 156 |
+
<p>Click the <em>Security</em> tab to continue.</p>
|
| 157 |
+
<img alt="Column dialog security tab" class="align-center" src="_images/column_security.png" />
|
| 158 |
+
<p>Use the <em>Security</em> tab to assign attributes and define security labels. Click
|
| 159 |
+
the <em>Add</em> icon (+) to add each security label selection:</p>
|
| 160 |
+
<ul class="simple">
|
| 161 |
+
<li><p>Specify a security label provider in the <em>Provider</em> field. The named provider
|
| 162 |
+
must be loaded and must consent to the proposed labeling operation.</p></li>
|
| 163 |
+
<li><p>Specify a a security label in the <em>Security Label</em> field. The meaning of a
|
| 164 |
+
given label is at the discretion of the label provider. PostgreSQL places no
|
| 165 |
+
restrictions on whether or how a label provider must interpret security
|
| 166 |
+
labels; it merely provides a mechanism for storing them.</p></li>
|
| 167 |
+
</ul>
|
| 168 |
+
<p>Click the <em>Add</em> icon (+) to assign additional security labels; to discard a
|
| 169 |
+
security label, click the trash icon to the left of the row and confirm deletion
|
| 170 |
+
in the <em>Delete Row</em> popup.</p>
|
| 171 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 172 |
+
<p>Your entries in the <em>Column</em> dialog generate a SQL command (see an example
|
| 173 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 174 |
+
to the SQL command.</p>
|
| 175 |
+
<section id="example">
|
| 176 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 177 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 178 |
+
the <em>Column</em> dialog:</p>
|
| 179 |
+
<img alt="Column dialog sql tab" class="align-center" src="_images/column_sql.png" />
|
| 180 |
+
<p>The example shown demonstrates creating a column named <em>sal</em> in the table
|
| 181 |
+
named <em>jobhist</em>.</p>
|
| 182 |
+
<ul class="simple">
|
| 183 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 184 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 185 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 186 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 187 |
+
</ul>
|
| 188 |
+
</section>
|
| 189 |
+
</section>
|
| 190 |
+
|
| 191 |
+
|
| 192 |
+
<div class="clearer"></div>
|
| 193 |
+
</div>
|
| 194 |
+
</div>
|
| 195 |
+
</div>
|
| 196 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 197 |
+
<div class="sphinxsidebarwrapper">
|
| 198 |
+
<div>
|
| 199 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 200 |
+
<ul>
|
| 201 |
+
<li><a class="reference internal" href="#">Column Dialog</a><ul>
|
| 202 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 203 |
+
</ul>
|
| 204 |
+
</li>
|
| 205 |
+
</ul>
|
| 206 |
+
|
| 207 |
+
</div>
|
| 208 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 209 |
+
<ul class="current">
|
| 210 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 211 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 212 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 213 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 214 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 215 |
+
<li class="toctree-l1 current"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a><ul class="current">
|
| 216 |
+
<li class="toctree-l2"><a class="reference internal" href="check_dialog.html">Check Dialog</a></li>
|
| 217 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Column Dialog</a></li>
|
| 218 |
+
<li class="toctree-l2"><a class="reference internal" href="compound_trigger_dialog.html">Compound Trigger Dialog</a></li>
|
| 219 |
+
<li class="toctree-l2"><a class="reference internal" href="exclusion_constraint_dialog.html">Exclusion Constraint Dialog</a></li>
|
| 220 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_key_dialog.html">Foreign key Dialog</a></li>
|
| 221 |
+
<li class="toctree-l2"><a class="reference internal" href="index_dialog.html">Index Dialog</a></li>
|
| 222 |
+
<li class="toctree-l2"><a class="reference internal" href="primary_key_dialog.html">Primary key Dialog</a></li>
|
| 223 |
+
<li class="toctree-l2"><a class="reference internal" href="rls_policy_dialog.html">RLS Policy Dialog</a></li>
|
| 224 |
+
<li class="toctree-l2"><a class="reference internal" href="rule_dialog.html">Rule Dialog</a></li>
|
| 225 |
+
<li class="toctree-l2"><a class="reference internal" href="table_dialog.html">Table Dialog</a></li>
|
| 226 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_dialog.html">Trigger Dialog</a></li>
|
| 227 |
+
<li class="toctree-l2"><a class="reference internal" href="unique_constraint_dialog.html">Unique Constraint Dialog</a></li>
|
| 228 |
+
</ul>
|
| 229 |
+
</li>
|
| 230 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 231 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 232 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 233 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 234 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 235 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 236 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 237 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 238 |
+
</ul>
|
| 239 |
+
|
| 240 |
+
<search id="searchbox" style="display: none" role="search">
|
| 241 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 242 |
+
<div class="searchformwrapper">
|
| 243 |
+
<form class="search" action="search.html" method="get">
|
| 244 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 245 |
+
<input type="submit" value="Go" />
|
| 246 |
+
</form>
|
| 247 |
+
</div>
|
| 248 |
+
</search>
|
| 249 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 250 |
+
</div>
|
| 251 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 252 |
+
<span>«</span>
|
| 253 |
+
</div>
|
| 254 |
+
|
| 255 |
+
</div>
|
| 256 |
+
<div class="clearer"></div>
|
| 257 |
+
</div>
|
| 258 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 259 |
+
<h3>Navigation</h3>
|
| 260 |
+
<ul>
|
| 261 |
+
<li class="right" style="margin-right: 10px">
|
| 262 |
+
<a href="genindex.html" title="General Index"
|
| 263 |
+
>index</a></li>
|
| 264 |
+
<li class="right" >
|
| 265 |
+
<a href="compound_trigger_dialog.html" title="Compound Trigger Dialog"
|
| 266 |
+
>next</a> |</li>
|
| 267 |
+
<li class="right" >
|
| 268 |
+
<a href="check_dialog.html" title="Check Dialog"
|
| 269 |
+
>previous</a> |</li>
|
| 270 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 271 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" >Creating or Modifying a Table</a> »</li>
|
| 272 |
+
<li class="nav-item nav-item-this"><a href="">Column Dialog</a></li>
|
| 273 |
+
</ul>
|
| 274 |
+
</div>
|
| 275 |
+
<div class="footer" role="contentinfo">
|
| 276 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 277 |
+
<ul>
|
| 278 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 279 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 280 |
+
<li class="right" ><a href="compound_trigger_dialog.html" title="Compound Trigger Dialog" accesskey="N">next</a> |</li>
|
| 281 |
+
<li class="right" ><a href="check_dialog.html" title="Check Dialog" accesskey="P">previous</a> |</li>
|
| 282 |
+
</ul>
|
| 283 |
+
</div>
|
| 284 |
+
</div>
|
| 285 |
+
</body>
|
| 286 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/compound_trigger_dialog.html
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Compound Trigger Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Exclusion Constraint Dialog" href="exclusion_constraint_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Column Dialog" href="column_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="exclusion_constraint_dialog.html" title="Exclusion Constraint Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="column_dialog.html" title="Column Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" accesskey="U">Creating or Modifying a Table</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Compound Trigger Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="compound-trigger-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Compound Trigger Dialog<a class="headerlink" href="#compound-trigger-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Compound Trigger</em> dialog to create a compound trigger or modify an
|
| 51 |
+
existing compound trigger. <em>Compound Trigger</em> is supported only for EPAS server
|
| 52 |
+
12 and above. A compound trigger executes a specified code when certain events
|
| 53 |
+
occur.</p>
|
| 54 |
+
<p>The <em>Compound Trigger</em> dialog organizes the development of a compound trigger
|
| 55 |
+
through the following dialog tabs: <em>General</em>, <em>Events</em>, and <em>Code</em>. The <em>SQL</em>
|
| 56 |
+
tab displays the SQL code generated by dialog selections.</p>
|
| 57 |
+
<img alt="Compound Trigger dialog general tab" class="align-center" src="_images/compound_trigger_general.png" />
|
| 58 |
+
<p>Use the fields in the <em>General</em> tab to identify the compound trigger:</p>
|
| 59 |
+
<ul class="simple">
|
| 60 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the compound trigger. This
|
| 61 |
+
must be distinct from the name of any other compound trigger for the same table.
|
| 62 |
+
The name will be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 63 |
+
<li><p>Store notes about the compound trigger in the <em>Comment</em> field.</p></li>
|
| 64 |
+
</ul>
|
| 65 |
+
<img alt="Trigger enabled in dialog tab" class="align-center" src="_images/compound_trigger_general_enabled.png" />
|
| 66 |
+
<ul class="simple">
|
| 67 |
+
<li><p><em>Trigger enabled</em> field is available in compound trigger dialog once the trigger is created.
|
| 68 |
+
You can select one of the four options available.</p></li>
|
| 69 |
+
</ul>
|
| 70 |
+
<p>Click the <em>Events</em> tab to continue.</p>
|
| 71 |
+
<img alt="Compound Trigger dialog events tab" class="align-center" src="_images/compound_trigger_events.png" />
|
| 72 |
+
<p>Use the fields in the <em>Events</em> tab to specify how and when the compound trigger fires:</p>
|
| 73 |
+
<ul class="simple">
|
| 74 |
+
<li><p>Select the type of event(s) that will invoke the compound trigger; to select
|
| 75 |
+
an event type, move the switch next to the event to the <em>YES</em> position.
|
| 76 |
+
The supported event types are <em>INSERT</em>, <em>UPDATE</em>, <em>DELETE</em> and <em>TRUNCATE</em>.
|
| 77 |
+
Views cannot have TRUNCATE triggers.</p></li>
|
| 78 |
+
<li><p>Use the <em>When</em> field to provide a boolean condition that will invoke the
|
| 79 |
+
compound trigger.</p></li>
|
| 80 |
+
<li><p>If defining a column-specific compound trigger, use the <em>Columns</em> field to
|
| 81 |
+
specify the columns or columns that are the target of the compound trigger.</p></li>
|
| 82 |
+
</ul>
|
| 83 |
+
<p>Click the <em>Code</em> tab to continue.</p>
|
| 84 |
+
<img alt="Compound Trigger dialog code tab" class="align-center" src="_images/compound_trigger_code.png" />
|
| 85 |
+
<p>Use the <em>Code</em> field to specify the code for the five timing events
|
| 86 |
+
<em>BEFORE STATEMENT</em>, <em>AFTER STATEMENT</em>, <em>BEFORE EACH ROW</em>, <em>AFTER EACH ROW</em>,
|
| 87 |
+
<em>INSTEAD OF EACH ROW</em> that will be invoked when the compound trigger fires.
|
| 88 |
+
Basic template is provided with place holders.</p>
|
| 89 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 90 |
+
<p>Your entries in the <em>Compound Trigger</em> dialog generate a SQL command (see an example
|
| 91 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 92 |
+
to the SQL command.</p>
|
| 93 |
+
<section id="example">
|
| 94 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 95 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 96 |
+
the <em>Compound Trigger</em> dialog:</p>
|
| 97 |
+
<img alt="Compound Trigger dialog sql tab" class="align-center" src="_images/compound_trigger_sql.png" />
|
| 98 |
+
<p>The example demonstrates creating a compound trigger named <em>test_ct</em>.</p>
|
| 99 |
+
<ul class="simple">
|
| 100 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 101 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 102 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 103 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 104 |
+
</ul>
|
| 105 |
+
</section>
|
| 106 |
+
</section>
|
| 107 |
+
|
| 108 |
+
|
| 109 |
+
<div class="clearer"></div>
|
| 110 |
+
</div>
|
| 111 |
+
</div>
|
| 112 |
+
</div>
|
| 113 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 114 |
+
<div class="sphinxsidebarwrapper">
|
| 115 |
+
<div>
|
| 116 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 117 |
+
<ul>
|
| 118 |
+
<li><a class="reference internal" href="#">Compound Trigger Dialog</a><ul>
|
| 119 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 120 |
+
</ul>
|
| 121 |
+
</li>
|
| 122 |
+
</ul>
|
| 123 |
+
|
| 124 |
+
</div>
|
| 125 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 126 |
+
<ul class="current">
|
| 127 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 128 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 129 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 130 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 131 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 132 |
+
<li class="toctree-l1 current"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a><ul class="current">
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="check_dialog.html">Check Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="column_dialog.html">Column Dialog</a></li>
|
| 135 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Compound Trigger Dialog</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="exclusion_constraint_dialog.html">Exclusion Constraint Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_key_dialog.html">Foreign key Dialog</a></li>
|
| 138 |
+
<li class="toctree-l2"><a class="reference internal" href="index_dialog.html">Index Dialog</a></li>
|
| 139 |
+
<li class="toctree-l2"><a class="reference internal" href="primary_key_dialog.html">Primary key Dialog</a></li>
|
| 140 |
+
<li class="toctree-l2"><a class="reference internal" href="rls_policy_dialog.html">RLS Policy Dialog</a></li>
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="rule_dialog.html">Rule Dialog</a></li>
|
| 142 |
+
<li class="toctree-l2"><a class="reference internal" href="table_dialog.html">Table Dialog</a></li>
|
| 143 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_dialog.html">Trigger Dialog</a></li>
|
| 144 |
+
<li class="toctree-l2"><a class="reference internal" href="unique_constraint_dialog.html">Unique Constraint Dialog</a></li>
|
| 145 |
+
</ul>
|
| 146 |
+
</li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 149 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 150 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 151 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 152 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 153 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 154 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 155 |
+
</ul>
|
| 156 |
+
|
| 157 |
+
<search id="searchbox" style="display: none" role="search">
|
| 158 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 159 |
+
<div class="searchformwrapper">
|
| 160 |
+
<form class="search" action="search.html" method="get">
|
| 161 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 162 |
+
<input type="submit" value="Go" />
|
| 163 |
+
</form>
|
| 164 |
+
</div>
|
| 165 |
+
</search>
|
| 166 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 167 |
+
</div>
|
| 168 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 169 |
+
<span>«</span>
|
| 170 |
+
</div>
|
| 171 |
+
|
| 172 |
+
</div>
|
| 173 |
+
<div class="clearer"></div>
|
| 174 |
+
</div>
|
| 175 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 176 |
+
<h3>Navigation</h3>
|
| 177 |
+
<ul>
|
| 178 |
+
<li class="right" style="margin-right: 10px">
|
| 179 |
+
<a href="genindex.html" title="General Index"
|
| 180 |
+
>index</a></li>
|
| 181 |
+
<li class="right" >
|
| 182 |
+
<a href="exclusion_constraint_dialog.html" title="Exclusion Constraint Dialog"
|
| 183 |
+
>next</a> |</li>
|
| 184 |
+
<li class="right" >
|
| 185 |
+
<a href="column_dialog.html" title="Column Dialog"
|
| 186 |
+
>previous</a> |</li>
|
| 187 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 188 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" >Creating or Modifying a Table</a> »</li>
|
| 189 |
+
<li class="nav-item nav-item-this"><a href="">Compound Trigger Dialog</a></li>
|
| 190 |
+
</ul>
|
| 191 |
+
</div>
|
| 192 |
+
<div class="footer" role="contentinfo">
|
| 193 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 194 |
+
<ul>
|
| 195 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 196 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 197 |
+
<li class="right" ><a href="exclusion_constraint_dialog.html" title="Exclusion Constraint Dialog" accesskey="N">next</a> |</li>
|
| 198 |
+
<li class="right" ><a href="column_dialog.html" title="Column Dialog" accesskey="P">previous</a> |</li>
|
| 199 |
+
</ul>
|
| 200 |
+
</div>
|
| 201 |
+
</div>
|
| 202 |
+
</body>
|
| 203 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/config_py.html
ADDED
|
@@ -0,0 +1,1140 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>The config.py File — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Desktop Deployment" href="desktop_deployment.html" />
|
| 23 |
+
<link rel="prev" title="Deployment" href="deployment.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="desktop_deployment.html" title="Desktop Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="deployment.html" title="Deployment"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="deployment.html" accesskey="U">Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">The config.py File</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="the-config-py-file">
|
| 50 |
+
<span id="config-py"></span><h1><span class="target" id="index-0"></span>The config.py File<a class="headerlink" href="#the-config-py-file" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>There are multiple configuration files that are read at startup by pgAdmin. These
|
| 52 |
+
files are used for configuration options that:</p>
|
| 53 |
+
<ul class="simple">
|
| 54 |
+
<li><p>may be required to be set prior to startup of pgAdmin as they control how
|
| 55 |
+
the application will operate.</p></li>
|
| 56 |
+
<li><p>system administrators may wish to control across an organisation to enforce
|
| 57 |
+
security policies.</p></li>
|
| 58 |
+
<li><p>are so rarely or unlikely to be changed that it doesn’t
|
| 59 |
+
make sense to allow them to be changed through the user interface.</p></li>
|
| 60 |
+
</ul>
|
| 61 |
+
<p>The configuration files are as follows:</p>
|
| 62 |
+
<ul>
|
| 63 |
+
<li><p><code class="docutils literal notranslate"><span class="pre">config.py</span></code>: This is the main configuration file, and should not be modified.
|
| 64 |
+
It can be used as a reference for configuration settings, that may be overridden
|
| 65 |
+
in one of the following files.</p></li>
|
| 66 |
+
<li><p><code class="docutils literal notranslate"><span class="pre">config_distro.py</span></code>: This file is read after <code class="docutils literal notranslate"><span class="pre">config.py</span></code> and is intended for
|
| 67 |
+
packagers to change any settings that are required for their pgAdmin distribution.
|
| 68 |
+
This may typically include certain paths and file locations. This file is optional,
|
| 69 |
+
and may be created by packagers in the same directory as <code class="docutils literal notranslate"><span class="pre">config.py</span></code> if
|
| 70 |
+
needed.</p></li>
|
| 71 |
+
<li><p><code class="docutils literal notranslate"><span class="pre">config_local.py</span></code>: This file is read after <code class="docutils literal notranslate"><span class="pre">config_distro.py</span></code> and is intended
|
| 72 |
+
for the owner of the installation to change any default or packaging specific settings
|
| 73 |
+
that they may wish to adjust to meet local preferences or standards.This file is optional,
|
| 74 |
+
and may be created by users in the same directory as <code class="docutils literal notranslate"><span class="pre">config.py</span></code> if
|
| 75 |
+
needed.</p></li>
|
| 76 |
+
<li><p><code class="docutils literal notranslate"><span class="pre">config_system.py</span></code>: This file is read after <code class="docutils literal notranslate"><span class="pre">config_local.py</span></code> and is
|
| 77 |
+
intended for system administrators to include settings that are configured
|
| 78 |
+
system-wide from a secure location that users cannot normally modify and that
|
| 79 |
+
is outside of the pgAdmin installation. The location for this file varies
|
| 80 |
+
based on the platform, and only needs to be created if desired.</p>
|
| 81 |
+
<table class="docutils align-default">
|
| 82 |
+
<thead>
|
| 83 |
+
<tr class="row-odd"><th class="head"><p><strong>Platform</strong></p></th>
|
| 84 |
+
<th class="head"><p><strong>File Location</strong></p></th>
|
| 85 |
+
</tr>
|
| 86 |
+
</thead>
|
| 87 |
+
<tbody>
|
| 88 |
+
<tr class="row-even"><td><p>Linux</p></td>
|
| 89 |
+
<td><p>/etc/pgadmin/config_system.py</p></td>
|
| 90 |
+
</tr>
|
| 91 |
+
<tr class="row-odd"><td><p>macOS</p></td>
|
| 92 |
+
<td><p>/Library/Preferences/pgadmin/config_system.py</p></td>
|
| 93 |
+
</tr>
|
| 94 |
+
<tr class="row-even"><td><p>Windows</p></td>
|
| 95 |
+
<td><p>%CommonProgramFiles%\pgadmin\config_system.py</p></td>
|
| 96 |
+
</tr>
|
| 97 |
+
</tbody>
|
| 98 |
+
</table>
|
| 99 |
+
</li>
|
| 100 |
+
</ul>
|
| 101 |
+
<div class="admonition note">
|
| 102 |
+
<p class="admonition-title">Note</p>
|
| 103 |
+
<p>If the SERVER_MODE or DATA_DIR settings are changed in
|
| 104 |
+
<code class="docutils literal notranslate"><span class="pre">config_distro.py</span></code>, <code class="docutils literal notranslate"><span class="pre">config_local.py</span></code>, or <code class="docutils literal notranslate"><span class="pre">config_system.py</span></code>
|
| 105 |
+
LOG_FILE, SQLITE_PATH, SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR,
|
| 106 |
+
and AZURE_CREDENTIAL_CACHE_DIR values will be set based on DATA_DIR unless
|
| 107 |
+
values are explicitly overridden for any of the variable in any of the
|
| 108 |
+
above file.</p>
|
| 109 |
+
</div>
|
| 110 |
+
<p>The default <code class="docutils literal notranslate"><span class="pre">config.py</span></code> file is shown below for reference:</p>
|
| 111 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># -*- coding: utf-8 -*-</span>
|
| 112 |
+
|
| 113 |
+
<span class="c1">##########################################################################</span>
|
| 114 |
+
<span class="c1">#</span>
|
| 115 |
+
<span class="c1"># pgAdmin 4 - PostgreSQL Tools</span>
|
| 116 |
+
<span class="c1">#</span>
|
| 117 |
+
<span class="c1"># Copyright (C) 2013 - 2024, The pgAdmin Development Team</span>
|
| 118 |
+
<span class="c1"># This software is released under the PostgreSQL Licence</span>
|
| 119 |
+
<span class="c1">#</span>
|
| 120 |
+
<span class="c1"># config.py - Core application configuration settings</span>
|
| 121 |
+
<span class="c1">#</span>
|
| 122 |
+
<span class="c1">##########################################################################</span>
|
| 123 |
+
|
| 124 |
+
<span class="kn">import</span> <span class="nn">builtins</span>
|
| 125 |
+
<span class="kn">import</span> <span class="nn">logging</span>
|
| 126 |
+
<span class="kn">import</span> <span class="nn">os</span>
|
| 127 |
+
<span class="kn">import</span> <span class="nn">sys</span>
|
| 128 |
+
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">OrderedDict</span>
|
| 129 |
+
|
| 130 |
+
<span class="c1"># We need to include the root directory in sys.path to ensure that we can</span>
|
| 131 |
+
<span class="c1"># find everything we need when running in the standalone runtime.</span>
|
| 132 |
+
<span class="n">root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
|
| 133 |
+
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="n">root</span><span class="p">:</span>
|
| 134 |
+
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">root</span><span class="p">)</span>
|
| 135 |
+
|
| 136 |
+
<span class="c1"># The config database connection pool size.</span>
|
| 137 |
+
<span class="c1"># Setting this to 0 will remove any limit.</span>
|
| 138 |
+
<span class="n">CONFIG_DATABASE_CONNECTION_POOL_SIZE</span> <span class="o">=</span> <span class="mi">5</span>
|
| 139 |
+
<span class="c1"># The number of connections allowed to overflow beyond</span>
|
| 140 |
+
<span class="c1"># the connection pool size.</span>
|
| 141 |
+
<span class="n">CONFIG_DATABASE_CONNECTION_MAX_OVERFLOW</span> <span class="o">=</span> <span class="mi">100</span>
|
| 142 |
+
|
| 143 |
+
<span class="kn">from</span> <span class="nn">pgadmin.utils</span> <span class="kn">import</span> <span class="n">env</span><span class="p">,</span> <span class="n">IS_WIN</span><span class="p">,</span> <span class="n">fs_short_path</span>
|
| 144 |
+
<span class="kn">from</span> <span class="nn">version</span> <span class="kn">import</span> <span class="n">APP_VERSION</span><span class="p">,</span> <span class="n">APP_RELEASE</span><span class="p">,</span> <span class="n">APP_REVISION</span><span class="p">,</span> <span class="n">APP_SUFFIX</span><span class="p">,</span> \
|
| 145 |
+
<span class="n">APP_VERSION_INT</span>
|
| 146 |
+
<span class="kn">from</span> <span class="nn">branding</span> <span class="kn">import</span> <span class="n">APP_NAME</span><span class="p">,</span> <span class="n">APP_ICON</span><span class="p">,</span> <span class="n">APP_COPYRIGHT</span><span class="p">,</span> <span class="n">APP_PATH</span><span class="p">,</span> \
|
| 147 |
+
<span class="n">APP_WIN_PATH</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span><span class="p">,</span> <span class="n">APP_DEFAULT_EMAIL</span>
|
| 148 |
+
|
| 149 |
+
<span class="c1">##########################################################################</span>
|
| 150 |
+
<span class="c1"># Misc stuff</span>
|
| 151 |
+
<span class="c1">##########################################################################</span>
|
| 152 |
+
|
| 153 |
+
<span class="c1"># Path to the online help.</span>
|
| 154 |
+
<span class="n">HELP_PATH</span> <span class="o">=</span> <span class="s1">'../../../docs/en_US/_build/html/'</span>
|
| 155 |
+
|
| 156 |
+
<span class="c1"># Languages we support in the UI</span>
|
| 157 |
+
<span class="n">LANGUAGES</span> <span class="o">=</span> <span class="p">{</span>
|
| 158 |
+
<span class="s1">'en'</span><span class="p">:</span> <span class="s1">'English'</span><span class="p">,</span>
|
| 159 |
+
<span class="s1">'zh'</span><span class="p">:</span> <span class="s1">'Chinese (Simplified)'</span><span class="p">,</span>
|
| 160 |
+
<span class="s1">'cs'</span><span class="p">:</span> <span class="s1">'Czech'</span><span class="p">,</span>
|
| 161 |
+
<span class="s1">'fr'</span><span class="p">:</span> <span class="s1">'French'</span><span class="p">,</span>
|
| 162 |
+
<span class="s1">'de'</span><span class="p">:</span> <span class="s1">'German'</span><span class="p">,</span>
|
| 163 |
+
<span class="s1">'id'</span><span class="p">:</span> <span class="s1">'Indonesian'</span><span class="p">,</span>
|
| 164 |
+
<span class="s1">'it'</span><span class="p">:</span> <span class="s1">'Italian'</span><span class="p">,</span>
|
| 165 |
+
<span class="s1">'ja'</span><span class="p">:</span> <span class="s1">'Japanese'</span><span class="p">,</span>
|
| 166 |
+
<span class="s1">'ko'</span><span class="p">:</span> <span class="s1">'Korean'</span><span class="p">,</span>
|
| 167 |
+
<span class="s1">'pl'</span><span class="p">:</span> <span class="s1">'Polish'</span><span class="p">,</span>
|
| 168 |
+
<span class="s1">'pt_BR'</span><span class="p">:</span> <span class="s1">'Portuguese (Brazilian)'</span><span class="p">,</span>
|
| 169 |
+
<span class="s1">'ru'</span><span class="p">:</span> <span class="s1">'Russian'</span><span class="p">,</span>
|
| 170 |
+
<span class="s1">'es'</span><span class="p">:</span> <span class="s1">'Spanish'</span><span class="p">,</span>
|
| 171 |
+
<span class="p">}</span>
|
| 172 |
+
|
| 173 |
+
<span class="c1"># DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!</span>
|
| 174 |
+
<span class="c1"># List of modules to skip when dynamically loading</span>
|
| 175 |
+
<span class="n">MODULE_BLACKLIST</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'test'</span><span class="p">]</span>
|
| 176 |
+
|
| 177 |
+
<span class="c1"># DO NOT CHANGE UNLESS YOU KNOW WHAT YOU ARE DOING!</span>
|
| 178 |
+
<span class="c1"># List of treeview browser nodes to skip when dynamically loading</span>
|
| 179 |
+
<span class="n">NODE_BLACKLIST</span> <span class="o">=</span> <span class="p">[]</span>
|
| 180 |
+
|
| 181 |
+
<span class="c1">##########################################################################</span>
|
| 182 |
+
<span class="c1"># Server settings</span>
|
| 183 |
+
<span class="c1">##########################################################################</span>
|
| 184 |
+
|
| 185 |
+
<span class="c1"># The server mode determines whether or not we're running on a web server</span>
|
| 186 |
+
<span class="c1"># requiring user authentication, or desktop mode which uses an automatic</span>
|
| 187 |
+
<span class="c1"># default login.</span>
|
| 188 |
+
<span class="c1">#</span>
|
| 189 |
+
<span class="c1"># DO NOT DISABLE SERVER MODE IF RUNNING ON A WEBSERVER!!</span>
|
| 190 |
+
<span class="c1">#</span>
|
| 191 |
+
<span class="c1"># We only set SERVER_MODE if it's not already set. That's to allow the</span>
|
| 192 |
+
<span class="c1"># runtime to force it to False.</span>
|
| 193 |
+
<span class="c1">#</span>
|
| 194 |
+
<span class="c1"># NOTE: If you change the value of SERVER_MODE or DATA_DIR in an included</span>
|
| 195 |
+
<span class="c1"># config file, you may also need to redefine any values below that are</span>
|
| 196 |
+
<span class="c1"># derived from it, notably various paths such as LOG_FILE, SQLITE_PATH,</span>
|
| 197 |
+
<span class="c1"># SESSION_DB_PATH, STORAGE_DIR, KERBEROS_CCACHE_DIR, and</span>
|
| 198 |
+
<span class="c1"># AZURE_CREDENTIAL_CACHE_DIR</span>
|
| 199 |
+
|
| 200 |
+
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">builtins</span><span class="p">,</span> <span class="s1">'SERVER_MODE'</span><span class="p">))</span> <span class="ow">or</span> <span class="n">builtins</span><span class="o">.</span><span class="n">SERVER_MODE</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
| 201 |
+
<span class="n">SERVER_MODE</span> <span class="o">=</span> <span class="kc">True</span>
|
| 202 |
+
<span class="k">else</span><span class="p">:</span>
|
| 203 |
+
<span class="n">SERVER_MODE</span> <span class="o">=</span> <span class="n">builtins</span><span class="o">.</span><span class="n">SERVER_MODE</span>
|
| 204 |
+
|
| 205 |
+
<span class="c1"># HTTP headers to search for CSRF token when it is not provided in the form.</span>
|
| 206 |
+
<span class="c1"># Default is ['X-CSRFToken', 'X-CSRF-Token']</span>
|
| 207 |
+
<span class="n">WTF_CSRF_HEADERS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'X-pgA-CSRFToken'</span><span class="p">]</span>
|
| 208 |
+
|
| 209 |
+
<span class="c1"># User ID (email address) to use for the default user in desktop mode.</span>
|
| 210 |
+
<span class="c1"># The default should be fine here, as it's not exposed in the app.</span>
|
| 211 |
+
<span class="n">DESKTOP_USER</span> <span class="o">=</span> <span class="n">APP_DEFAULT_EMAIL</span>
|
| 212 |
+
|
| 213 |
+
<span class="c1"># This option allows the user to host the application on a LAN</span>
|
| 214 |
+
<span class="c1"># Default hosting is on localhost (DEFAULT_SERVER='localhost').</span>
|
| 215 |
+
<span class="c1"># To host pgAdmin4 over LAN set DEFAULT_SERVER='0.0.0.0' (or a specific</span>
|
| 216 |
+
<span class="c1"># adaptor address.</span>
|
| 217 |
+
<span class="c1">#</span>
|
| 218 |
+
<span class="c1"># NOTE: This is NOT recommended for production use, only for debugging</span>
|
| 219 |
+
<span class="c1"># or testing. Production installations should be run as a WSGI application</span>
|
| 220 |
+
<span class="c1"># behind Apache HTTPD.</span>
|
| 221 |
+
<span class="n">DEFAULT_SERVER</span> <span class="o">=</span> <span class="s1">'127.0.0.1'</span>
|
| 222 |
+
|
| 223 |
+
<span class="c1"># The default port on which the app server will listen if not set in the</span>
|
| 224 |
+
<span class="c1"># environment by the runtime</span>
|
| 225 |
+
<span class="n">DEFAULT_SERVER_PORT</span> <span class="o">=</span> <span class="mi">5050</span>
|
| 226 |
+
|
| 227 |
+
<span class="c1"># This param is used to override the default web server information about</span>
|
| 228 |
+
<span class="c1"># the web technology and the frameworks being used in the application</span>
|
| 229 |
+
<span class="c1"># An attacker could use this information to fingerprint underlying operating</span>
|
| 230 |
+
<span class="c1"># system and research known exploits for the specific version of</span>
|
| 231 |
+
<span class="c1"># software in use</span>
|
| 232 |
+
<span class="n">WEB_SERVER</span> <span class="o">=</span> <span class="s1">'Python'</span>
|
| 233 |
+
|
| 234 |
+
<span class="c1"># Enable X-Frame-Option protection.</span>
|
| 235 |
+
<span class="c1"># Set to one of "SAMEORIGIN", "ALLOW-FROM origin" or "" to disable.</span>
|
| 236 |
+
<span class="c1"># Note that "DENY" is NOT supported (and will be silently ignored).</span>
|
| 237 |
+
<span class="c1"># See https://tools.ietf.org/html/rfc7034 for more info.</span>
|
| 238 |
+
<span class="n">X_FRAME_OPTIONS</span> <span class="o">=</span> <span class="s2">"SAMEORIGIN"</span>
|
| 239 |
+
|
| 240 |
+
<span class="c1"># The Content-Security-Policy header allows you to restrict how resources</span>
|
| 241 |
+
<span class="c1"># such as JavaScript, CSS, or pretty much anything that the browser loads.</span>
|
| 242 |
+
<span class="c1"># see https://content-security-policy.com/#source_list for more info</span>
|
| 243 |
+
<span class="c1"># e.g. "default-src https: data: 'unsafe-inline' 'unsafe-eval';"</span>
|
| 244 |
+
<span class="n">CONTENT_SECURITY_POLICY</span> <span class="o">=</span> <span class="s2">"default-src ws: http: data: blob: 'unsafe-inline'"</span> \
|
| 245 |
+
<span class="s2">" 'unsafe-eval';"</span>
|
| 246 |
+
|
| 247 |
+
<span class="c1"># STRICT_TRANSPORT_SECURITY_ENABLED when set to True will set the</span>
|
| 248 |
+
<span class="c1"># Strict-Transport-Security header</span>
|
| 249 |
+
<span class="n">STRICT_TRANSPORT_SECURITY_ENABLED</span> <span class="o">=</span> <span class="kc">False</span>
|
| 250 |
+
|
| 251 |
+
<span class="c1"># The Strict-Transport-Security header tells the browser to convert all HTTP</span>
|
| 252 |
+
<span class="c1"># requests to HTTPS, preventing man-in-the-middle (MITM) attacks.</span>
|
| 253 |
+
<span class="c1"># e.g. 'max-age=31536000; includeSubDomains'</span>
|
| 254 |
+
<span class="n">STRICT_TRANSPORT_SECURITY</span> <span class="o">=</span> <span class="s2">"max-age=31536000; includeSubDomains"</span>
|
| 255 |
+
|
| 256 |
+
<span class="c1"># The X-Content-Type-Options header forces the browser to honor the response</span>
|
| 257 |
+
<span class="c1"># content type instead of trying to detect it, which can be abused to</span>
|
| 258 |
+
<span class="c1"># generate a cross-site scripting (XSS) attack.</span>
|
| 259 |
+
<span class="c1"># e.g. nosniff</span>
|
| 260 |
+
<span class="n">X_CONTENT_TYPE_OPTIONS</span> <span class="o">=</span> <span class="s2">"nosniff"</span>
|
| 261 |
+
|
| 262 |
+
<span class="c1"># The browser will try to prevent reflected XSS attacks by not loading the</span>
|
| 263 |
+
<span class="c1"># page if the request contains something that looks like JavaScript and the</span>
|
| 264 |
+
<span class="c1"># response contains the same data. e.g. '1; mode=block'</span>
|
| 265 |
+
<span class="n">X_XSS_PROTECTION</span> <span class="o">=</span> <span class="s2">"1; mode=block"</span>
|
| 266 |
+
|
| 267 |
+
<span class="c1"># This param is used to validate ALLOWED_HOSTS for the application</span>
|
| 268 |
+
<span class="c1"># This will be used to avoid Host Header Injection attack</span>
|
| 269 |
+
<span class="c1"># ALLOWED_HOSTS = ['225.0.0.0/8', '226.0.0.0/7', '228.0.0.0/6']</span>
|
| 270 |
+
<span class="c1"># ALLOWED_HOSTS = ['127.0.0.1', '192.168.0.1']</span>
|
| 271 |
+
<span class="c1"># if ALLOWED_HOSTS= [] then it will accept all ips (and application will be</span>
|
| 272 |
+
<span class="c1"># vulnerable to Host Header Injection attack)</span>
|
| 273 |
+
<span class="n">ALLOWED_HOSTS</span> <span class="o">=</span> <span class="p">[]</span>
|
| 274 |
+
|
| 275 |
+
<span class="c1"># Hashing algorithm used for password storage</span>
|
| 276 |
+
<span class="n">SECURITY_PASSWORD_HASH</span> <span class="o">=</span> <span class="s1">'pbkdf2_sha512'</span>
|
| 277 |
+
|
| 278 |
+
<span class="c1"># Minimum password length</span>
|
| 279 |
+
<span class="n">PASSWORD_LENGTH_MIN</span> <span class="o">=</span> <span class="mi">6</span>
|
| 280 |
+
|
| 281 |
+
<span class="c1"># Reverse Proxy parameters</span>
|
| 282 |
+
<span class="c1"># You must tell the middleware how many proxies set each header</span>
|
| 283 |
+
<span class="c1"># so it knows what values to trust.</span>
|
| 284 |
+
<span class="c1"># See https://tinyurl.com/yyg7r9av</span>
|
| 285 |
+
<span class="c1"># for more information.</span>
|
| 286 |
+
|
| 287 |
+
<span class="c1"># Number of values to trust for X-Forwarded-For</span>
|
| 288 |
+
<span class="n">PROXY_X_FOR_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
| 289 |
+
|
| 290 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Proto.</span>
|
| 291 |
+
<span class="n">PROXY_X_PROTO_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
| 292 |
+
|
| 293 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Host.</span>
|
| 294 |
+
<span class="n">PROXY_X_HOST_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
| 295 |
+
|
| 296 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Port.</span>
|
| 297 |
+
<span class="n">PROXY_X_PORT_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
| 298 |
+
|
| 299 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Prefix.</span>
|
| 300 |
+
<span class="n">PROXY_X_PREFIX_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
| 301 |
+
|
| 302 |
+
<span class="c1"># NOTE: CSRF_SESSION_KEY, SECRET_KEY and SECURITY_PASSWORD_SALT are no</span>
|
| 303 |
+
<span class="c1"># longer part of the main configuration, but are stored in the</span>
|
| 304 |
+
<span class="c1"># configuration databases 'keys' table and are auto-generated.</span>
|
| 305 |
+
|
| 306 |
+
<span class="c1"># COMPRESSION</span>
|
| 307 |
+
<span class="n">COMPRESS_MIMETYPES</span> <span class="o">=</span> <span class="p">[</span>
|
| 308 |
+
<span class="s1">'text/html'</span><span class="p">,</span> <span class="s1">'text/css'</span><span class="p">,</span> <span class="s1">'text/xml'</span><span class="p">,</span> <span class="s1">'text/javascript'</span><span class="p">,</span>
|
| 309 |
+
<span class="s1">'application/json'</span><span class="p">,</span> <span class="s1">'application/javascript'</span>
|
| 310 |
+
<span class="p">]</span>
|
| 311 |
+
<span class="n">COMPRESS_LEVEL</span> <span class="o">=</span> <span class="mi">9</span>
|
| 312 |
+
<span class="n">COMPRESS_MIN_SIZE</span> <span class="o">=</span> <span class="mi">500</span>
|
| 313 |
+
|
| 314 |
+
<span class="c1"># Set the cache control max age for static files in flask to 1 year</span>
|
| 315 |
+
<span class="n">SEND_FILE_MAX_AGE_DEFAULT</span> <span class="o">=</span> <span class="mi">31556952</span>
|
| 316 |
+
|
| 317 |
+
<span class="c1"># This will be added to static urls as url parameter with value as</span>
|
| 318 |
+
<span class="c1"># APP_VERSION_INT for cache busting on version upgrade. If the value is set as</span>
|
| 319 |
+
<span class="c1"># None or empty string then it will not be added.</span>
|
| 320 |
+
<span class="c1"># eg - http:localhost:5050/pgadmin.css?intver=3.13</span>
|
| 321 |
+
<span class="n">APP_VERSION_PARAM</span> <span class="o">=</span> <span class="s1">'ver'</span>
|
| 322 |
+
|
| 323 |
+
<span class="c1"># Add the internal version param to below extensions only</span>
|
| 324 |
+
<span class="n">APP_VERSION_EXTN</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.css'</span><span class="p">,</span> <span class="s1">'.js'</span><span class="p">,</span> <span class="s1">'.html'</span><span class="p">,</span> <span class="s1">'.svg'</span><span class="p">,</span> <span class="s1">'.png'</span><span class="p">,</span> <span class="s1">'.gif'</span><span class="p">,</span> <span class="s1">'.ico'</span><span class="p">)</span>
|
| 325 |
+
|
| 326 |
+
<span class="c1"># Data directory for storage of config settings etc. This shouldn't normally</span>
|
| 327 |
+
<span class="c1"># need to be changed - it's here as various other settings depend on it.</span>
|
| 328 |
+
<span class="c1"># On Windows, we always store data in %APPDATA%\$(APP_WIN_PATH). On other</span>
|
| 329 |
+
<span class="c1"># platforms, if we're in server mode we use /var/lib/$(APP_PATH),</span>
|
| 330 |
+
<span class="c1"># otherwise ~/.$(APP_PATH)</span>
|
| 331 |
+
<span class="k">if</span> <span class="n">IS_WIN</span><span class="p">:</span>
|
| 332 |
+
<span class="c1"># Use the short path on windows</span>
|
| 333 |
+
<span class="n">DATA_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span>
|
| 334 |
+
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fs_short_path</span><span class="p">(</span><span class="n">env</span><span class="p">(</span><span class="s1">'APPDATA'</span><span class="p">)),</span> <span class="n">APP_WIN_PATH</span><span class="p">)</span>
|
| 335 |
+
<span class="p">)</span>
|
| 336 |
+
<span class="k">else</span><span class="p">:</span>
|
| 337 |
+
<span class="k">if</span> <span class="n">SERVER_MODE</span><span class="p">:</span>
|
| 338 |
+
<span class="n">DATA_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">'/var/lib/'</span><span class="p">,</span> <span class="n">APP_PATH</span><span class="p">)</span>
|
| 339 |
+
<span class="k">else</span><span class="p">:</span>
|
| 340 |
+
<span class="n">DATA_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span>
|
| 341 |
+
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="s1">'~/'</span> <span class="o">+</span> <span class="s1">'.'</span> <span class="o">+</span> <span class="n">APP_PATH</span> <span class="o">+</span> <span class="s1">'/'</span><span class="p">)</span>
|
| 342 |
+
<span class="p">)</span>
|
| 343 |
+
|
| 344 |
+
<span class="c1"># An optional login banner to show security warnings/disclaimers etc. at</span>
|
| 345 |
+
<span class="c1"># login and password recovery etc. HTML may be included for basic formatting,</span>
|
| 346 |
+
<span class="c1"># For example:</span>
|
| 347 |
+
<span class="c1"># LOGIN_BANNER = "<h4>Authorised Users Only!</h4>" \</span>
|
| 348 |
+
<span class="c1"># "Unauthorised use is strictly forbidden."</span>
|
| 349 |
+
<span class="n">LOGIN_BANNER</span> <span class="o">=</span> <span class="s2">""</span>
|
| 350 |
+
|
| 351 |
+
<span class="c1">##########################################################################</span>
|
| 352 |
+
<span class="c1"># Log settings</span>
|
| 353 |
+
<span class="c1">##########################################################################</span>
|
| 354 |
+
|
| 355 |
+
<span class="c1"># Debug mode?</span>
|
| 356 |
+
<span class="n">DEBUG</span> <span class="o">=</span> <span class="kc">False</span>
|
| 357 |
+
|
| 358 |
+
<span class="c1"># Application log level - one of:</span>
|
| 359 |
+
<span class="c1"># CRITICAL 50</span>
|
| 360 |
+
<span class="c1"># ERROR 40</span>
|
| 361 |
+
<span class="c1"># WARNING 30</span>
|
| 362 |
+
<span class="c1"># SQL 25</span>
|
| 363 |
+
<span class="c1"># INFO 20</span>
|
| 364 |
+
<span class="c1"># DEBUG 10</span>
|
| 365 |
+
<span class="c1"># NOTSET 0</span>
|
| 366 |
+
<span class="n">CONSOLE_LOG_LEVEL</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span>
|
| 367 |
+
<span class="n">FILE_LOG_LEVEL</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">WARNING</span>
|
| 368 |
+
|
| 369 |
+
<span class="c1"># Log format.</span>
|
| 370 |
+
<span class="n">JSON_LOGGER</span> <span class="o">=</span> <span class="kc">False</span>
|
| 371 |
+
<span class="n">CONSOLE_LOG_FORMAT_JSON</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">([</span>
|
| 372 |
+
<span class="p">(</span><span class="s2">"time"</span><span class="p">,</span> <span class="s2">"asctime"</span><span class="p">),</span>
|
| 373 |
+
<span class="p">(</span><span class="s2">"message"</span><span class="p">,</span> <span class="s2">"message"</span><span class="p">),</span>
|
| 374 |
+
<span class="p">(</span><span class="s2">"level"</span><span class="p">,</span> <span class="s2">"levelname"</span><span class="p">)</span>
|
| 375 |
+
<span class="p">])</span>
|
| 376 |
+
|
| 377 |
+
<span class="n">FILE_LOG_FORMAT_JSON</span> <span class="o">=</span> <span class="n">OrderedDict</span><span class="p">([</span>
|
| 378 |
+
<span class="p">(</span><span class="s2">"time"</span><span class="p">,</span> <span class="s2">"asctime"</span><span class="p">),</span>
|
| 379 |
+
<span class="p">(</span><span class="s2">"message"</span><span class="p">,</span> <span class="s2">"message"</span><span class="p">),</span>
|
| 380 |
+
<span class="p">(</span><span class="s2">"level"</span><span class="p">,</span> <span class="s2">"levelname"</span><span class="p">)</span>
|
| 381 |
+
<span class="p">])</span>
|
| 382 |
+
|
| 383 |
+
|
| 384 |
+
<span class="n">CONSOLE_LOG_FORMAT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1">: </span><span class="si">%(levelname)s</span><span class="se">\t</span><span class="si">%(name)s</span><span class="s1">:</span><span class="se">\t</span><span class="si">%(message)s</span><span class="s1">'</span>
|
| 385 |
+
<span class="n">FILE_LOG_FORMAT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%(asctime)s</span><span class="s1">: </span><span class="si">%(levelname)s</span><span class="se">\t</span><span class="si">%(name)s</span><span class="s1">:</span><span class="se">\t</span><span class="si">%(message)s</span><span class="s1">'</span>
|
| 386 |
+
|
| 387 |
+
<span class="c1"># Log file name. This goes in the data directory, except on non-Windows</span>
|
| 388 |
+
<span class="c1"># platforms in server mode.</span>
|
| 389 |
+
<span class="k">if</span> <span class="n">SERVER_MODE</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">IS_WIN</span><span class="p">:</span>
|
| 390 |
+
<span class="n">LOG_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">'/var/log'</span><span class="p">,</span> <span class="n">APP_PATH</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span> <span class="o">+</span> <span class="s1">'.log'</span><span class="p">)</span>
|
| 391 |
+
<span class="k">else</span><span class="p">:</span>
|
| 392 |
+
<span class="n">LOG_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span> <span class="o">+</span> <span class="s1">'.log'</span><span class="p">)</span>
|
| 393 |
+
|
| 394 |
+
<span class="c1"># Log rotation setting</span>
|
| 395 |
+
<span class="c1"># Log file will be rotated considering values for LOG_ROTATION_SIZE</span>
|
| 396 |
+
<span class="c1"># & LOG_ROTATION_AGE. Rotated file will be named in format</span>
|
| 397 |
+
<span class="c1"># - LOG_FILE.Y-m-d_H-M-S</span>
|
| 398 |
+
<span class="n">LOG_ROTATION_SIZE</span> <span class="o">=</span> <span class="mi">10</span> <span class="c1"># In MBs</span>
|
| 399 |
+
<span class="n">LOG_ROTATION_AGE</span> <span class="o">=</span> <span class="mi">1440</span> <span class="c1"># In minutes</span>
|
| 400 |
+
<span class="n">LOG_ROTATION_MAX_LOG_FILES</span> <span class="o">=</span> <span class="mi">90</span> <span class="c1"># Maximum number of backups to retain</span>
|
| 401 |
+
<span class="c1">##########################################################################</span>
|
| 402 |
+
<span class="c1"># Server Connection Driver Settings</span>
|
| 403 |
+
<span class="c1">##########################################################################</span>
|
| 404 |
+
|
| 405 |
+
<span class="c1"># The default driver used for making connection with PostgreSQL</span>
|
| 406 |
+
<span class="n">PG_DEFAULT_DRIVER</span> <span class="o">=</span> <span class="s1">'psycopg3'</span>
|
| 407 |
+
|
| 408 |
+
<span class="c1"># Maximum allowed idle time in minutes before which releasing the connection</span>
|
| 409 |
+
<span class="c1"># for the particular session. (in minutes)</span>
|
| 410 |
+
<span class="n">MAX_SESSION_IDLE_TIME</span> <span class="o">=</span> <span class="mi">60</span>
|
| 411 |
+
|
| 412 |
+
<span class="c1">##########################################################################</span>
|
| 413 |
+
<span class="c1"># External Database Settings</span>
|
| 414 |
+
<span class="c1">#</span>
|
| 415 |
+
<span class="c1"># All configuration settings are stored by default in the SQLite database.</span>
|
| 416 |
+
<span class="c1"># In order to use external databases like PostgreSQL sets the value of</span>
|
| 417 |
+
<span class="c1"># CONFIG_DATABASE_URI like below:</span>
|
| 418 |
+
<span class="c1"># dialect+driver://username:password@host:port/database</span>
|
| 419 |
+
<span class="c1">#</span>
|
| 420 |
+
<span class="c1"># PostgreSQL:</span>
|
| 421 |
+
<span class="c1"># postgresql://username:password@host:port/database</span>
|
| 422 |
+
<span class="c1"># Specify Schema Name</span>
|
| 423 |
+
<span class="c1"># postgresql://username:password@host:port/database?options=-csearch_path=pgadmin</span>
|
| 424 |
+
<span class="c1"># Using PGPASS file</span>
|
| 425 |
+
<span class="c1"># postgresql://username@host:port?options=-csearch_path=pgadmin</span>
|
| 426 |
+
<span class="c1">##########################################################################</span>
|
| 427 |
+
<span class="n">CONFIG_DATABASE_URI</span> <span class="o">=</span> <span class="s1">''</span>
|
| 428 |
+
|
| 429 |
+
<span class="c1">##########################################################################</span>
|
| 430 |
+
<span class="c1"># User account and settings storage</span>
|
| 431 |
+
<span class="c1">##########################################################################</span>
|
| 432 |
+
|
| 433 |
+
<span class="c1"># The default path to the SQLite database used to store user accounts and</span>
|
| 434 |
+
<span class="c1"># settings. This default places the file in the same directory as this</span>
|
| 435 |
+
<span class="c1"># config file, but generates an absolute path for use througout the app.</span>
|
| 436 |
+
<span class="n">SQLITE_PATH</span> <span class="o">=</span> <span class="n">env</span><span class="p">(</span><span class="s1">'SQLITE_PATH'</span><span class="p">)</span> <span class="ow">or</span> \
|
| 437 |
+
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="n">APP_SHORT_NAME</span> <span class="o">+</span> <span class="s1">'.db'</span><span class="p">)</span>
|
| 438 |
+
|
| 439 |
+
<span class="c1"># SQLITE_TIMEOUT will define how long to wait before throwing the error -</span>
|
| 440 |
+
<span class="c1"># OperationError due to database lock. On slower system, you may need to change</span>
|
| 441 |
+
<span class="c1"># this to some higher value.</span>
|
| 442 |
+
<span class="c1"># (Default: 500 milliseconds)</span>
|
| 443 |
+
<span class="n">SQLITE_TIMEOUT</span> <span class="o">=</span> <span class="mi">500</span>
|
| 444 |
+
|
| 445 |
+
<span class="c1"># Allow database connection passwords to be saved if the user chooses.</span>
|
| 446 |
+
<span class="c1"># Set to False to disable password saving.</span>
|
| 447 |
+
<span class="n">ALLOW_SAVE_PASSWORD</span> <span class="o">=</span> <span class="kc">True</span>
|
| 448 |
+
|
| 449 |
+
<span class="c1"># Maximum number of history queries stored per user/server/database</span>
|
| 450 |
+
<span class="n">MAX_QUERY_HIST_STORED</span> <span class="o">=</span> <span class="mi">20</span>
|
| 451 |
+
|
| 452 |
+
<span class="c1">##########################################################################</span>
|
| 453 |
+
<span class="c1"># Server-side session storage path</span>
|
| 454 |
+
<span class="c1">#</span>
|
| 455 |
+
<span class="c1"># SESSION_DB_PATH (Default: $HOME/.pgadmin4/sessions)</span>
|
| 456 |
+
<span class="c1">##########################################################################</span>
|
| 457 |
+
<span class="c1">#</span>
|
| 458 |
+
<span class="c1"># We use SQLite for server-side session storage. There will be one</span>
|
| 459 |
+
<span class="c1"># SQLite database object per session created.</span>
|
| 460 |
+
<span class="c1">#</span>
|
| 461 |
+
<span class="c1"># Specify the path used to store your session objects.</span>
|
| 462 |
+
<span class="c1">#</span>
|
| 463 |
+
<span class="c1"># If the specified directory does not exist, the setup script will create</span>
|
| 464 |
+
<span class="c1"># it with permission mode 700 to keep the session database secure.</span>
|
| 465 |
+
<span class="c1">#</span>
|
| 466 |
+
<span class="c1"># On certain systems, you can use shared memory (tmpfs) for maximum</span>
|
| 467 |
+
<span class="c1"># scalability, for example, on Ubuntu:</span>
|
| 468 |
+
<span class="c1">#</span>
|
| 469 |
+
<span class="c1"># SESSION_DB_PATH = '/run/shm/pgAdmin4_session'</span>
|
| 470 |
+
<span class="c1">#</span>
|
| 471 |
+
<span class="c1">##########################################################################</span>
|
| 472 |
+
<span class="n">SESSION_DB_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'sessions'</span><span class="p">)</span>
|
| 473 |
+
|
| 474 |
+
<span class="n">SESSION_COOKIE_NAME</span> <span class="o">=</span> <span class="s1">'pga4_session'</span>
|
| 475 |
+
|
| 476 |
+
<span class="c1">##########################################################################</span>
|
| 477 |
+
<span class="c1"># Mail server settings</span>
|
| 478 |
+
<span class="c1">##########################################################################</span>
|
| 479 |
+
|
| 480 |
+
<span class="c1"># These settings are used when running in web server mode for confirming</span>
|
| 481 |
+
<span class="c1"># and resetting passwords etc.</span>
|
| 482 |
+
<span class="c1"># See: http://pythonhosted.org/Flask-Mail/ for more info</span>
|
| 483 |
+
<span class="n">MAIL_SERVER</span> <span class="o">=</span> <span class="s1">'localhost'</span>
|
| 484 |
+
<span class="n">MAIL_PORT</span> <span class="o">=</span> <span class="mi">25</span>
|
| 485 |
+
<span class="n">MAIL_USE_SSL</span> <span class="o">=</span> <span class="kc">False</span>
|
| 486 |
+
<span class="n">MAIL_USE_TLS</span> <span class="o">=</span> <span class="kc">False</span>
|
| 487 |
+
<span class="n">MAIL_USERNAME</span> <span class="o">=</span> <span class="s1">''</span>
|
| 488 |
+
<span class="n">MAIL_PASSWORD</span> <span class="o">=</span> <span class="s1">''</span>
|
| 489 |
+
<span class="n">MAIL_DEBUG</span> <span class="o">=</span> <span class="kc">False</span>
|
| 490 |
+
|
| 491 |
+
<span class="c1"># Flask-Security overrides Flask-Mail's MAIL_DEFAULT_SENDER setting, so</span>
|
| 492 |
+
<span class="c1"># that should be set as such:</span>
|
| 493 |
+
<span class="n">SECURITY_EMAIL_SENDER</span> <span class="o">=</span> <span class="s1">'no-reply@localhost'</span>
|
| 494 |
+
|
| 495 |
+
<span class="c1">##########################################################################</span>
|
| 496 |
+
<span class="c1"># Mail content settings</span>
|
| 497 |
+
<span class="c1">##########################################################################</span>
|
| 498 |
+
|
| 499 |
+
<span class="c1"># These settings define the content of password reset emails</span>
|
| 500 |
+
<span class="n">SECURITY_EMAIL_SUBJECT_PASSWORD_RESET</span> <span class="o">=</span> <span class="s2">"Password reset instructions for </span><span class="si">%s</span><span class="s2">"</span> \
|
| 501 |
+
<span class="o">%</span> <span class="n">APP_NAME</span>
|
| 502 |
+
<span class="n">SECURITY_EMAIL_SUBJECT_PASSWORD_NOTICE</span> <span class="o">=</span> <span class="s2">"Your </span><span class="si">%s</span><span class="s2"> password has been reset"</span> \
|
| 503 |
+
<span class="o">%</span> <span class="n">APP_NAME</span>
|
| 504 |
+
<span class="n">SECURITY_EMAIL_SUBJECT_PASSWORD_CHANGE_NOTICE</span> <span class="o">=</span> \
|
| 505 |
+
<span class="s2">"Your password for </span><span class="si">%s</span><span class="s2"> has been changed"</span> <span class="o">%</span> <span class="n">APP_NAME</span>
|
| 506 |
+
|
| 507 |
+
<span class="c1">##########################################################################</span>
|
| 508 |
+
<span class="c1"># Email address validation</span>
|
| 509 |
+
<span class="c1">##########################################################################</span>
|
| 510 |
+
<span class="n">CHECK_EMAIL_DELIVERABILITY</span> <span class="o">=</span> <span class="kc">False</span>
|
| 511 |
+
<span class="n">SECURITY_EMAIL_VALIDATOR_ARGS</span> <span class="o">=</span> \
|
| 512 |
+
<span class="p">{</span><span class="s2">"check_deliverability"</span><span class="p">:</span> <span class="n">CHECK_EMAIL_DELIVERABILITY</span><span class="p">}</span>
|
| 513 |
+
|
| 514 |
+
<span class="c1">##########################################################################</span>
|
| 515 |
+
<span class="c1"># Upgrade checks</span>
|
| 516 |
+
<span class="c1">##########################################################################</span>
|
| 517 |
+
|
| 518 |
+
<span class="c1"># Check for new versions of the application?</span>
|
| 519 |
+
<span class="n">UPGRADE_CHECK_ENABLED</span> <span class="o">=</span> <span class="kc">True</span>
|
| 520 |
+
|
| 521 |
+
<span class="c1"># Where should we get the data from?</span>
|
| 522 |
+
<span class="n">UPGRADE_CHECK_URL</span> <span class="o">=</span> <span class="s1">'https://www.pgadmin.org/versions.json'</span>
|
| 523 |
+
|
| 524 |
+
<span class="c1"># What key should we look at in the upgrade data file?</span>
|
| 525 |
+
<span class="n">UPGRADE_CHECK_KEY</span> <span class="o">=</span> <span class="s1">'pgadmin4'</span>
|
| 526 |
+
|
| 527 |
+
<span class="c1"># Which CA file should we use?</span>
|
| 528 |
+
<span class="c1"># Default to cacert.pem in the same directory as config.py et al.</span>
|
| 529 |
+
<span class="n">CA_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)),</span>
|
| 530 |
+
<span class="s2">"cacert.pem"</span><span class="p">)</span>
|
| 531 |
+
|
| 532 |
+
<span class="c1"># Check if the detected browser is supported</span>
|
| 533 |
+
<span class="n">CHECK_SUPPORTED_BROWSER</span> <span class="o">=</span> <span class="kc">True</span>
|
| 534 |
+
|
| 535 |
+
<span class="c1">##########################################################################</span>
|
| 536 |
+
<span class="c1"># Storage Manager storage url config settings</span>
|
| 537 |
+
<span class="c1"># If user sets STORAGE_DIR to empty it will show all volumes if platform</span>
|
| 538 |
+
<span class="c1"># is Windows, '/' if it is Linux, Mac or any other unix type system.</span>
|
| 539 |
+
|
| 540 |
+
<span class="c1"># For example:</span>
|
| 541 |
+
<span class="c1"># 1. STORAGE_DIR = get_drive("C") or get_drive() # return C:/ by default</span>
|
| 542 |
+
<span class="c1"># where C can be any drive character such as "D", "E", "G" etc</span>
|
| 543 |
+
<span class="c1"># 2. Set path manually like</span>
|
| 544 |
+
<span class="c1"># STORAGE_DIR = "/path/to/directory/"</span>
|
| 545 |
+
<span class="c1">##########################################################################</span>
|
| 546 |
+
<span class="n">STORAGE_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'storage'</span><span class="p">)</span>
|
| 547 |
+
|
| 548 |
+
<span class="c1">##########################################################################</span>
|
| 549 |
+
<span class="c1"># Default locations for binary utilities (pg_dump, pg_restore etc)</span>
|
| 550 |
+
<span class="c1">#</span>
|
| 551 |
+
<span class="c1"># These are intentionally left empty in the main config file, but are</span>
|
| 552 |
+
<span class="c1"># expected to be overridden by packagers in config_distro.py.</span>
|
| 553 |
+
<span class="c1">#</span>
|
| 554 |
+
<span class="c1"># A default location can be specified for each database driver ID, in</span>
|
| 555 |
+
<span class="c1"># a dictionary. Either an absolute or relative path can be specified.</span>
|
| 556 |
+
<span class="c1">#</span>
|
| 557 |
+
<span class="c1"># Version-specific defaults can also be specified, which will take priority</span>
|
| 558 |
+
<span class="c1"># over un-versioned paths.</span>
|
| 559 |
+
<span class="c1">#</span>
|
| 560 |
+
<span class="c1"># In cases where it may be difficult to know what the working directory</span>
|
| 561 |
+
<span class="c1"># is, "$DIR" can be specified. This will be replaced with the path to the</span>
|
| 562 |
+
<span class="c1"># top-level pgAdmin4.py file. For example, on macOS we might use:</span>
|
| 563 |
+
<span class="c1">#</span>
|
| 564 |
+
<span class="c1"># $DIR/../../SharedSupport</span>
|
| 565 |
+
<span class="c1">#</span>
|
| 566 |
+
<span class="c1">##########################################################################</span>
|
| 567 |
+
<span class="n">DEFAULT_BINARY_PATHS</span> <span class="o">=</span> <span class="p">{</span>
|
| 568 |
+
<span class="s2">"pg"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 569 |
+
<span class="s2">"pg-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 570 |
+
<span class="s2">"pg-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 571 |
+
<span class="s2">"pg-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 572 |
+
<span class="s2">"pg-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 573 |
+
<span class="s2">"pg-16"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 574 |
+
<span class="s2">"ppas"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 575 |
+
<span class="s2">"ppas-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 576 |
+
<span class="s2">"ppas-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 577 |
+
<span class="s2">"ppas-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 578 |
+
<span class="s2">"ppas-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 579 |
+
<span class="s2">"ppas-16"</span><span class="p">:</span> <span class="s2">""</span>
|
| 580 |
+
<span class="p">}</span>
|
| 581 |
+
|
| 582 |
+
<span class="c1">##########################################################################</span>
|
| 583 |
+
|
| 584 |
+
<span class="c1"># Admin can specify fixed binary paths to prevent users from changing.</span>
|
| 585 |
+
<span class="c1"># It will take precedence over DEFAULT_BINARY_PATHS.</span>
|
| 586 |
+
|
| 587 |
+
<span class="n">FIXED_BINARY_PATHS</span> <span class="o">=</span> <span class="p">{</span>
|
| 588 |
+
<span class="s2">"pg"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 589 |
+
<span class="s2">"pg-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 590 |
+
<span class="s2">"pg-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 591 |
+
<span class="s2">"pg-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 592 |
+
<span class="s2">"pg-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 593 |
+
<span class="s2">"pg-16"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 594 |
+
<span class="s2">"ppas"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 595 |
+
<span class="s2">"ppas-12"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 596 |
+
<span class="s2">"ppas-13"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 597 |
+
<span class="s2">"ppas-14"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 598 |
+
<span class="s2">"ppas-15"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
| 599 |
+
<span class="s2">"ppas-16"</span><span class="p">:</span> <span class="s2">""</span>
|
| 600 |
+
<span class="p">}</span>
|
| 601 |
+
|
| 602 |
+
<span class="c1">##########################################################################</span>
|
| 603 |
+
<span class="c1"># Test settings - used primarily by the regression suite, not for users</span>
|
| 604 |
+
<span class="c1">##########################################################################</span>
|
| 605 |
+
|
| 606 |
+
<span class="c1"># The default path for SQLite database for testing</span>
|
| 607 |
+
<span class="n">TEST_SQLITE_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'test_pgadmin4.db'</span><span class="p">)</span>
|
| 608 |
+
|
| 609 |
+
<span class="c1">##########################################################################</span>
|
| 610 |
+
<span class="c1"># Allows flask application to response to the each request asynchronously</span>
|
| 611 |
+
<span class="c1">##########################################################################</span>
|
| 612 |
+
<span class="n">THREADED_MODE</span> <span class="o">=</span> <span class="kc">True</span>
|
| 613 |
+
|
| 614 |
+
<span class="c1">##########################################################################</span>
|
| 615 |
+
<span class="c1"># Do not allow SQLALCHEMY to track modification as it is going to be</span>
|
| 616 |
+
<span class="c1"># deprecated in future</span>
|
| 617 |
+
<span class="c1">##########################################################################</span>
|
| 618 |
+
<span class="n">SQLALCHEMY_TRACK_MODIFICATIONS</span> <span class="o">=</span> <span class="kc">False</span>
|
| 619 |
+
|
| 620 |
+
<span class="c1">##########################################################################</span>
|
| 621 |
+
<span class="c1"># Number of records to fetch in one batch in query tool when query result</span>
|
| 622 |
+
<span class="c1"># set is large.</span>
|
| 623 |
+
<span class="c1">##########################################################################</span>
|
| 624 |
+
<span class="n">ON_DEMAND_RECORD_COUNT</span> <span class="o">=</span> <span class="mi">1000</span>
|
| 625 |
+
|
| 626 |
+
<span class="c1">##########################################################################</span>
|
| 627 |
+
<span class="c1"># Allow users to display Gravatar image for their username in Server mode</span>
|
| 628 |
+
<span class="c1">##########################################################################</span>
|
| 629 |
+
<span class="n">SHOW_GRAVATAR_IMAGE</span> <span class="o">=</span> <span class="kc">True</span>
|
| 630 |
+
|
| 631 |
+
<span class="c1">##########################################################################</span>
|
| 632 |
+
<span class="c1"># Set cookie path and options</span>
|
| 633 |
+
<span class="c1">##########################################################################</span>
|
| 634 |
+
<span class="n">COOKIE_DEFAULT_PATH</span> <span class="o">=</span> <span class="s1">'/'</span>
|
| 635 |
+
<span class="n">COOKIE_DEFAULT_DOMAIN</span> <span class="o">=</span> <span class="kc">None</span>
|
| 636 |
+
<span class="n">SESSION_COOKIE_DOMAIN</span> <span class="o">=</span> <span class="kc">None</span>
|
| 637 |
+
<span class="n">SESSION_COOKIE_SAMESITE</span> <span class="o">=</span> <span class="s1">'Lax'</span>
|
| 638 |
+
<span class="n">SESSION_COOKIE_SECURE</span> <span class="o">=</span> <span class="kc">False</span>
|
| 639 |
+
<span class="n">SESSION_COOKIE_HTTPONLY</span> <span class="o">=</span> <span class="kc">True</span>
|
| 640 |
+
|
| 641 |
+
<span class="c1">#########################################################################</span>
|
| 642 |
+
<span class="c1"># Skip storing session in files and cache for specific paths</span>
|
| 643 |
+
<span class="c1">#########################################################################</span>
|
| 644 |
+
<span class="n">SESSION_SKIP_PATHS</span> <span class="o">=</span> <span class="p">[</span>
|
| 645 |
+
<span class="s1">'/misc/ping'</span>
|
| 646 |
+
<span class="p">]</span>
|
| 647 |
+
|
| 648 |
+
<span class="c1">##########################################################################</span>
|
| 649 |
+
<span class="c1"># Session expiration support</span>
|
| 650 |
+
<span class="c1">##########################################################################</span>
|
| 651 |
+
<span class="c1"># SESSION_EXPIRATION_TIME is the interval in Days. Session will be</span>
|
| 652 |
+
<span class="c1"># expire after the specified number of *days*.</span>
|
| 653 |
+
<span class="n">SESSION_EXPIRATION_TIME</span> <span class="o">=</span> <span class="mi">1</span>
|
| 654 |
+
|
| 655 |
+
<span class="c1"># Make SESSION_EXPIRATION_TIME to 1 week in DESKTOP mode</span>
|
| 656 |
+
<span class="k">if</span> <span class="ow">not</span> <span class="n">SERVER_MODE</span><span class="p">:</span>
|
| 657 |
+
<span class="n">SESSION_EXPIRATION_TIME</span> <span class="o">=</span> <span class="mi">7</span>
|
| 658 |
+
|
| 659 |
+
<span class="c1"># CHECK_SESSION_FILES_INTERVAL is interval in Hours. Application will check</span>
|
| 660 |
+
<span class="c1"># the session files for cleanup after specified number of *hours*.</span>
|
| 661 |
+
<span class="n">CHECK_SESSION_FILES_INTERVAL</span> <span class="o">=</span> <span class="mi">24</span>
|
| 662 |
+
|
| 663 |
+
<span class="c1"># USER_INACTIVITY_TIMEOUT is interval in Seconds. If the pgAdmin screen is left</span>
|
| 664 |
+
<span class="c1"># unattended for <USER_INACTIVITY_TIMEOUT> seconds then the user will</span>
|
| 665 |
+
<span class="c1"># be logged out. When set to 0, the timeout will be disabled.</span>
|
| 666 |
+
<span class="c1"># If pgAdmin doesn't detect any activity in the time specified (in seconds),</span>
|
| 667 |
+
<span class="c1"># the user will be forcibly logged out from pgAdmin. Set to zero to disable</span>
|
| 668 |
+
<span class="c1"># the timeout.</span>
|
| 669 |
+
<span class="c1"># Note: This is applicable only for SERVER_MODE=True.</span>
|
| 670 |
+
<span class="n">USER_INACTIVITY_TIMEOUT</span> <span class="o">=</span> <span class="mi">0</span>
|
| 671 |
+
|
| 672 |
+
<span class="c1"># OVERRIDE_USER_INACTIVITY_TIMEOUT when set to True will override</span>
|
| 673 |
+
<span class="c1"># USER_INACTIVITY_TIMEOUT when long running queries in the Query Tool</span>
|
| 674 |
+
<span class="c1"># or Debugger are running. When the queries complete, the inactivity timer</span>
|
| 675 |
+
<span class="c1"># will restart in this case. If set to False, user inactivity may cause</span>
|
| 676 |
+
<span class="c1"># transactions or in-process debugging sessions to be aborted.</span>
|
| 677 |
+
<span class="n">OVERRIDE_USER_INACTIVITY_TIMEOUT</span> <span class="o">=</span> <span class="kc">True</span>
|
| 678 |
+
|
| 679 |
+
<span class="c1">##########################################################################</span>
|
| 680 |
+
<span class="c1"># SSH Tunneling supports only for Python 2.7 and 3.4+</span>
|
| 681 |
+
<span class="c1">##########################################################################</span>
|
| 682 |
+
<span class="n">SUPPORT_SSH_TUNNEL</span> <span class="o">=</span> <span class="kc">True</span>
|
| 683 |
+
<span class="c1"># Allow SSH Tunnel passwords to be saved if the user chooses.</span>
|
| 684 |
+
<span class="c1"># Set to False to disable password saving.</span>
|
| 685 |
+
<span class="n">ALLOW_SAVE_TUNNEL_PASSWORD</span> <span class="o">=</span> <span class="kc">False</span>
|
| 686 |
+
|
| 687 |
+
<span class="c1">##########################################################################</span>
|
| 688 |
+
<span class="c1"># Master password is used to encrypt/decrypt saved server passwords</span>
|
| 689 |
+
<span class="c1"># Applicable for desktop mode only</span>
|
| 690 |
+
<span class="c1">##########################################################################</span>
|
| 691 |
+
<span class="n">MASTER_PASSWORD_REQUIRED</span> <span class="o">=</span> <span class="kc">True</span>
|
| 692 |
+
|
| 693 |
+
<span class="c1">##########################################################################</span>
|
| 694 |
+
|
| 695 |
+
<span class="c1"># pgAdmin encrypts the database connection and ssh tunnel password using a</span>
|
| 696 |
+
<span class="c1"># master password or pgAdmin login password (for other authentication sources)</span>
|
| 697 |
+
<span class="c1"># before storing it in the pgAdmin configuration database.</span>
|
| 698 |
+
<span class="c1">#</span>
|
| 699 |
+
<span class="c1"># Below setting is used to allow the user to specify the path to a script</span>
|
| 700 |
+
<span class="c1"># or program that will return an encryption key which will be used to</span>
|
| 701 |
+
<span class="c1"># encrypt the passwords. This setting is used only in server mode when</span>
|
| 702 |
+
<span class="c1"># auth sources are oauth, Kerberos, and webserver.</span>
|
| 703 |
+
<span class="c1">#</span>
|
| 704 |
+
<span class="c1"># You can pass the current username as an argument to the external script</span>
|
| 705 |
+
<span class="c1"># by specifying %u in config value.</span>
|
| 706 |
+
<span class="c1"># E.g. - MASTER_PASSWORD_HOOK = '<PATH>/passwdgen_script.sh %u'</span>
|
| 707 |
+
<span class="c1">##########################################################################</span>
|
| 708 |
+
<span class="n">MASTER_PASSWORD_HOOK</span> <span class="o">=</span> <span class="kc">None</span>
|
| 709 |
+
|
| 710 |
+
<span class="c1">##########################################################################</span>
|
| 711 |
+
|
| 712 |
+
<span class="c1"># Allows pgAdmin4 to create session cookies based on IP address, so even</span>
|
| 713 |
+
<span class="c1"># if a cookie is stolen, the attacker will not be able to connect to the</span>
|
| 714 |
+
<span class="c1"># server using that stolen cookie.</span>
|
| 715 |
+
<span class="c1"># Note: This can cause problems when the server is deployed in dynamic IP</span>
|
| 716 |
+
<span class="c1"># address hosting environments, such as Kubernetes or behind load</span>
|
| 717 |
+
<span class="c1"># balancers. In such cases, this option should be set to False.</span>
|
| 718 |
+
<span class="c1">##########################################################################</span>
|
| 719 |
+
<span class="n">ENHANCED_COOKIE_PROTECTION</span> <span class="o">=</span> <span class="kc">True</span>
|
| 720 |
+
|
| 721 |
+
<span class="c1">##########################################################################</span>
|
| 722 |
+
<span class="c1"># External Authentication Sources</span>
|
| 723 |
+
<span class="c1">##########################################################################</span>
|
| 724 |
+
|
| 725 |
+
<span class="c1"># Default setting is internal</span>
|
| 726 |
+
<span class="c1"># External Supported Sources: ldap, kerberos, oauth2</span>
|
| 727 |
+
<span class="c1"># Multiple authentication can be achieved by setting this parameter to</span>
|
| 728 |
+
<span class="c1"># ['ldap', 'internal'] or ['oauth2', 'internal'] or</span>
|
| 729 |
+
<span class="c1"># ['webserver', 'internal'] etc.</span>
|
| 730 |
+
<span class="c1"># pgAdmin will authenticate the user with ldap/oauth2 whatever first in the</span>
|
| 731 |
+
<span class="c1"># list, in case of failure the second authentication option will be considered.</span>
|
| 732 |
+
|
| 733 |
+
<span class="n">AUTHENTICATION_SOURCES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'internal'</span><span class="p">]</span>
|
| 734 |
+
|
| 735 |
+
<span class="c1">##########################################################################</span>
|
| 736 |
+
<span class="c1"># MAX_LOGIN_ATTEMPTS which sets the number of failed login attempts that</span>
|
| 737 |
+
<span class="c1"># are allowed. If this value is exceeded the account is locked and can be</span>
|
| 738 |
+
<span class="c1"># reset by an administrator. By setting the variable to the value zero</span>
|
| 739 |
+
<span class="c1"># this feature is deactivated.</span>
|
| 740 |
+
<span class="c1">##########################################################################</span>
|
| 741 |
+
<span class="n">MAX_LOGIN_ATTEMPTS</span> <span class="o">=</span> <span class="mi">3</span>
|
| 742 |
+
|
| 743 |
+
<span class="c1">##########################################################################</span>
|
| 744 |
+
<span class="c1"># Only consider password to check the failed login attempts, email is</span>
|
| 745 |
+
<span class="c1"># excluded from this check</span>
|
| 746 |
+
<span class="n">LOGIN_ATTEMPT_FIELDS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'password'</span><span class="p">]</span>
|
| 747 |
+
<span class="c1">##########################################################################</span>
|
| 748 |
+
<span class="c1"># LDAP Configuration</span>
|
| 749 |
+
<span class="c1">##########################################################################</span>
|
| 750 |
+
|
| 751 |
+
<span class="c1"># After ldap authentication, user will be added into the SQLite database</span>
|
| 752 |
+
<span class="c1"># automatically, if set to True.</span>
|
| 753 |
+
<span class="c1"># Set it to False, if user should not be added automatically,</span>
|
| 754 |
+
<span class="c1"># in this case Admin has to add the user manually in the SQLite database.</span>
|
| 755 |
+
<span class="n">LDAP_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
| 756 |
+
|
| 757 |
+
<span class="c1"># Connection timeout</span>
|
| 758 |
+
<span class="n">LDAP_CONNECTION_TIMEOUT</span> <span class="o">=</span> <span class="mi">10</span>
|
| 759 |
+
|
| 760 |
+
<span class="c1"># Server connection details (REQUIRED)</span>
|
| 761 |
+
<span class="c1"># example: ldap://<ip-address>:<port> or ldap://<hostname>:<port></span>
|
| 762 |
+
<span class="n">LDAP_SERVER_URI</span> <span class="o">=</span> <span class="s1">'ldap://<ip-address>:<port>'</span>
|
| 763 |
+
|
| 764 |
+
<span class="c1"># The LDAP attribute containing user names. In OpenLDAP, this may be 'uid'</span>
|
| 765 |
+
<span class="c1"># whilst in AD, 'sAMAccountName' might be appropriate. (REQUIRED)</span>
|
| 766 |
+
<span class="n">LDAP_USERNAME_ATTRIBUTE</span> <span class="o">=</span> <span class="s1">'<User-id>'</span>
|
| 767 |
+
|
| 768 |
+
<span class="c1">##########################################################################</span>
|
| 769 |
+
<span class="c1"># 3 ways to configure LDAP as follows (Choose anyone):</span>
|
| 770 |
+
|
| 771 |
+
<span class="c1"># 1. Dedicated User binding</span>
|
| 772 |
+
|
| 773 |
+
<span class="c1"># LDAP Bind User DN Example: cn=username,dc=example,dc=com</span>
|
| 774 |
+
<span class="c1"># Set this parameter to allow the connection to bind using a dedicated user.</span>
|
| 775 |
+
<span class="c1"># After the connection is made, the pgadmin login user will be further</span>
|
| 776 |
+
<span class="c1"># authenticated by the username and password provided</span>
|
| 777 |
+
<span class="c1"># at the login screen.</span>
|
| 778 |
+
<span class="n">LDAP_BIND_USER</span> <span class="o">=</span> <span class="kc">None</span>
|
| 779 |
+
|
| 780 |
+
<span class="c1"># LDAP Bind User Password</span>
|
| 781 |
+
<span class="n">LDAP_BIND_PASSWORD</span> <span class="o">=</span> <span class="kc">None</span>
|
| 782 |
+
|
| 783 |
+
<span class="c1"># OR ####################</span>
|
| 784 |
+
<span class="c1"># 2. Anonymous Binding</span>
|
| 785 |
+
|
| 786 |
+
<span class="c1"># Set this parameter to allow the anonymous bind.</span>
|
| 787 |
+
<span class="c1"># After the connection is made, the pgadmin login user will be further</span>
|
| 788 |
+
<span class="c1"># authenticated by the username and password provided</span>
|
| 789 |
+
|
| 790 |
+
<span class="n">LDAP_ANONYMOUS_BIND</span> <span class="o">=</span> <span class="kc">False</span>
|
| 791 |
+
|
| 792 |
+
<span class="c1"># OR ####################</span>
|
| 793 |
+
<span class="c1"># 3. Bind as pgAdmin user</span>
|
| 794 |
+
|
| 795 |
+
<span class="c1"># BaseDN (REQUIRED)</span>
|
| 796 |
+
<span class="c1"># AD example:</span>
|
| 797 |
+
<span class="c1"># (&(objectClass=user)(memberof=CN=MYGROUP,CN=Users,dc=example,dc=com))</span>
|
| 798 |
+
<span class="c1"># OpenLDAP example: CN=Users,dc=example,dc=com</span>
|
| 799 |
+
<span class="n">LDAP_BASE_DN</span> <span class="o">=</span> <span class="s1">'<Base-DN>'</span>
|
| 800 |
+
|
| 801 |
+
<span class="c1"># Configure the bind format string</span>
|
| 802 |
+
<span class="c1"># Default: LDAP_BIND_FORMAT="</span>
|
| 803 |
+
<span class="c1"># {LDAP_USERNAME_ATTRIBUTE}={LDAP_USERNAME},{LDAP_BASE_DN}"</span>
|
| 804 |
+
<span class="c1"># The current available options are:</span>
|
| 805 |
+
<span class="c1"># LDAP_USERNAME_ATTRIBUTE, LDAP_USERNAME, LDAP_BASE_DN</span>
|
| 806 |
+
<span class="c1"># Example: LDAP_BIND_FORMAT="myldapuser@sales.example.com"</span>
|
| 807 |
+
<span class="c1"># LDAP_BIND_FORMAT="NET\\myldapuser"</span>
|
| 808 |
+
<span class="n">LDAP_BIND_FORMAT</span> <span class="o">=</span> <span class="s1">'</span><span class="si">{LDAP_USERNAME_ATTRIBUTE}</span><span class="s1">=</span><span class="si">{LDAP_USERNAME}</span><span class="s1">,</span><span class="si">{LDAP_BASE_DN}</span><span class="s1">'</span>
|
| 809 |
+
|
| 810 |
+
<span class="c1">##########################################################################</span>
|
| 811 |
+
|
| 812 |
+
<span class="c1"># Search ldap for further authentication (REQUIRED)</span>
|
| 813 |
+
<span class="c1"># It can be optional while bind as pgAdmin user</span>
|
| 814 |
+
<span class="n">LDAP_SEARCH_BASE_DN</span> <span class="o">=</span> <span class="s1">'<Search-Base-DN>'</span>
|
| 815 |
+
|
| 816 |
+
<span class="c1"># The LDAP attribute indicates whether the DN (Distinguished Names)</span>
|
| 817 |
+
<span class="c1"># are case sensitive or not</span>
|
| 818 |
+
<span class="n">LDAP_DN_CASE_SENSITIVE</span> <span class="o">=</span> <span class="kc">False</span>
|
| 819 |
+
|
| 820 |
+
<span class="c1"># Filter string for the user search.</span>
|
| 821 |
+
<span class="c1"># For OpenLDAP, '(cn=*)' may well be enough.</span>
|
| 822 |
+
<span class="c1"># For AD, you might use '(objectClass=user)' (REQUIRED)</span>
|
| 823 |
+
<span class="n">LDAP_SEARCH_FILTER</span> <span class="o">=</span> <span class="s1">'(objectclass=*)'</span>
|
| 824 |
+
|
| 825 |
+
<span class="c1"># Search scope for users (one of BASE, LEVEL or SUBTREE)</span>
|
| 826 |
+
<span class="n">LDAP_SEARCH_SCOPE</span> <span class="o">=</span> <span class="s1">'SUBTREE'</span>
|
| 827 |
+
|
| 828 |
+
<span class="c1"># Use TLS? If the URI scheme is ldaps://, this is ignored.</span>
|
| 829 |
+
<span class="n">LDAP_USE_STARTTLS</span> <span class="o">=</span> <span class="kc">False</span>
|
| 830 |
+
|
| 831 |
+
<span class="c1"># TLS/SSL certificates. Specify if required, otherwise leave empty</span>
|
| 832 |
+
<span class="n">LDAP_CA_CERT_FILE</span> <span class="o">=</span> <span class="s1">''</span>
|
| 833 |
+
<span class="n">LDAP_CERT_FILE</span> <span class="o">=</span> <span class="s1">''</span>
|
| 834 |
+
<span class="n">LDAP_KEY_FILE</span> <span class="o">=</span> <span class="s1">''</span>
|
| 835 |
+
|
| 836 |
+
<span class="c1">##########################################################################</span>
|
| 837 |
+
|
| 838 |
+
<span class="c1"># Some flaky LDAP servers returns malformed schema. If True, no exception</span>
|
| 839 |
+
<span class="c1"># will be raised and schema is thrown away but authentication will be done.</span>
|
| 840 |
+
<span class="c1"># This parameter should remain False, as recommended.</span>
|
| 841 |
+
<span class="n">LDAP_IGNORE_MALFORMED_SCHEMA</span> <span class="o">=</span> <span class="kc">False</span>
|
| 842 |
+
|
| 843 |
+
<span class="c1">##########################################################################</span>
|
| 844 |
+
<span class="c1"># Kerberos Configuration</span>
|
| 845 |
+
<span class="c1">##########################################################################</span>
|
| 846 |
+
|
| 847 |
+
<span class="n">KRB_APP_HOST_NAME</span> <span class="o">=</span> <span class="n">DEFAULT_SERVER</span>
|
| 848 |
+
|
| 849 |
+
<span class="c1"># If the default_keytab_name is not set in krb5.conf or</span>
|
| 850 |
+
<span class="c1"># the KRB_KTNAME environment variable is not set then, explicitly set</span>
|
| 851 |
+
<span class="c1"># the Keytab file</span>
|
| 852 |
+
|
| 853 |
+
<span class="n">KRB_KTNAME</span> <span class="o">=</span> <span class="s1">'<KRB5_KEYTAB_FILE>'</span>
|
| 854 |
+
|
| 855 |
+
<span class="c1"># After kerberos authentication, user will be added into the SQLite database</span>
|
| 856 |
+
<span class="c1"># automatically, if set to True.</span>
|
| 857 |
+
<span class="c1"># Set it to False, if user should not be added automatically,</span>
|
| 858 |
+
<span class="c1"># in this case Admin has to add the user manually in the SQLite database.</span>
|
| 859 |
+
|
| 860 |
+
<span class="n">KRB_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
| 861 |
+
|
| 862 |
+
<span class="n">KERBEROS_CCACHE_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'krbccache'</span><span class="p">)</span>
|
| 863 |
+
|
| 864 |
+
<span class="c1">#############################################################################</span>
|
| 865 |
+
<span class="c1"># Create local directory to store azure credential cache</span>
|
| 866 |
+
<span class="c1">#############################################################################</span>
|
| 867 |
+
|
| 868 |
+
<span class="n">AZURE_CREDENTIAL_CACHE_DIR</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">DATA_DIR</span><span class="p">,</span> <span class="s1">'azurecredentialcache'</span><span class="p">)</span>
|
| 869 |
+
|
| 870 |
+
<span class="c1">##########################################################################</span>
|
| 871 |
+
<span class="c1"># OAuth2 Configuration</span>
|
| 872 |
+
<span class="c1">##########################################################################</span>
|
| 873 |
+
|
| 874 |
+
<span class="c1"># Multiple OAUTH2 providers can be added in the list like [{...},{...}]</span>
|
| 875 |
+
<span class="c1"># All parameters are required</span>
|
| 876 |
+
|
| 877 |
+
<span class="n">OAUTH2_CONFIG</span> <span class="o">=</span> <span class="p">[</span>
|
| 878 |
+
<span class="p">{</span>
|
| 879 |
+
<span class="c1"># The name of the of the oauth provider, ex: github, google</span>
|
| 880 |
+
<span class="s1">'OAUTH2_NAME'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 881 |
+
<span class="c1"># The display name, ex: Google</span>
|
| 882 |
+
<span class="s1">'OAUTH2_DISPLAY_NAME'</span><span class="p">:</span> <span class="s1">'<Oauth2 Display Name>'</span><span class="p">,</span>
|
| 883 |
+
<span class="c1"># Oauth client id</span>
|
| 884 |
+
<span class="s1">'OAUTH2_CLIENT_ID'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 885 |
+
<span class="c1"># Oauth secret</span>
|
| 886 |
+
<span class="s1">'OAUTH2_CLIENT_SECRET'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 887 |
+
<span class="c1"># URL to generate a token,</span>
|
| 888 |
+
<span class="c1"># Ex: https://github.com/login/oauth/access_token</span>
|
| 889 |
+
<span class="s1">'OAUTH2_TOKEN_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 890 |
+
<span class="c1"># URL is used for authentication,</span>
|
| 891 |
+
<span class="c1"># Ex: https://github.com/login/oauth/authorize</span>
|
| 892 |
+
<span class="s1">'OAUTH2_AUTHORIZATION_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 893 |
+
<span class="c1"># server metadata url might optional for your provider</span>
|
| 894 |
+
<span class="s1">'OAUTH2_SERVER_METADATA_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 895 |
+
<span class="c1"># Oauth base url, ex: https://api.github.com/</span>
|
| 896 |
+
<span class="s1">'OAUTH2_API_BASE_URL'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 897 |
+
<span class="c1"># Name of the Endpoint, ex: user</span>
|
| 898 |
+
<span class="s1">'OAUTH2_USERINFO_ENDPOINT'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 899 |
+
<span class="c1"># Oauth scope, ex: 'openid email profile'</span>
|
| 900 |
+
<span class="c1"># Note that an 'email' claim is required in the resulting profile</span>
|
| 901 |
+
<span class="s1">'OAUTH2_SCOPE'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 902 |
+
<span class="c1"># The claim which is used for the username. If the value is empty the</span>
|
| 903 |
+
<span class="c1"># email is used as username, but if a value is provided,</span>
|
| 904 |
+
<span class="c1"># the claim has to exist.</span>
|
| 905 |
+
<span class="s1">'OAUTH2_USERNAME_CLAIM'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 906 |
+
<span class="c1"># Font-awesome icon, ex: fa-github</span>
|
| 907 |
+
<span class="s1">'OAUTH2_ICON'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 908 |
+
<span class="c1"># UI button colour, ex: #0000ff</span>
|
| 909 |
+
<span class="s1">'OAUTH2_BUTTON_COLOR'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 910 |
+
<span class="c1"># The additional claims to check on user ID Token or Userinfo response.</span>
|
| 911 |
+
<span class="c1"># This is useful to provide additional authorization checks</span>
|
| 912 |
+
<span class="c1"># before allowing access.</span>
|
| 913 |
+
<span class="c1"># Example for GitLab: allowing all maintainers teams, and a specific</span>
|
| 914 |
+
<span class="c1"># developers group to access pgadmin:</span>
|
| 915 |
+
<span class="c1"># 'OAUTH2_ADDITIONAL_CLAIMS': {</span>
|
| 916 |
+
<span class="c1"># 'https://gitlab.org/claims/groups/maintainer': [</span>
|
| 917 |
+
<span class="c1"># 'kuberheads/applications',</span>
|
| 918 |
+
<span class="c1"># 'kuberheads/dba',</span>
|
| 919 |
+
<span class="c1"># 'kuberheads/support'</span>
|
| 920 |
+
<span class="c1"># ],</span>
|
| 921 |
+
<span class="c1"># 'https://gitlab.org/claims/groups/developer': [</span>
|
| 922 |
+
<span class="c1"># 'kuberheads/applications/team01'</span>
|
| 923 |
+
<span class="c1"># ],</span>
|
| 924 |
+
<span class="c1"># }</span>
|
| 925 |
+
<span class="c1"># Example for AzureAD:</span>
|
| 926 |
+
<span class="c1"># 'OAUTH2_ADDITIONAL_CLAIMS': {</span>
|
| 927 |
+
<span class="c1"># 'groups': ["0760b6cf-170e-4a14-91b3-4b78e0739963"],</span>
|
| 928 |
+
<span class="c1"># 'wids': ["cf1c38e5-3621-4004-a7cb-879624dced7c"],</span>
|
| 929 |
+
<span class="c1"># }</span>
|
| 930 |
+
<span class="s1">'OAUTH2_ADDITIONAL_CLAIMS'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
| 931 |
+
<span class="c1"># Set this variable to False to disable SSL certificate verification</span>
|
| 932 |
+
<span class="c1"># for OAuth2 provider.</span>
|
| 933 |
+
<span class="c1"># This may need to set False, in case of self-signed certificates.</span>
|
| 934 |
+
<span class="c1"># Ref: https://github.com/psf/requests/issues/6071</span>
|
| 935 |
+
<span class="s1">'OAUTH2_SSL_CERT_VERIFICATION'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
| 936 |
+
<span class="c1"># set this variable to invalidate the session of the oauth2 provider</span>
|
| 937 |
+
<span class="c1"># Example for keycloak:</span>
|
| 938 |
+
<span class="c1"># 'OAUTH2_LOGOUT_URL':</span>
|
| 939 |
+
<span class="c1"># 'https://example.com/realms/master/protocol/openid-connect/logout?post_logout_redirect_uri={redirect_uri}&id_token_hint={id_token}'</span>
|
| 940 |
+
<span class="s1">'OAUTH2_LOGOUT_URL'</span><span class="p">:</span> <span class="kc">None</span>
|
| 941 |
+
<span class="p">}</span>
|
| 942 |
+
<span class="p">]</span>
|
| 943 |
+
|
| 944 |
+
<span class="c1"># After Oauth authentication, user will be added into the SQLite database</span>
|
| 945 |
+
<span class="c1"># automatically, if set to True.</span>
|
| 946 |
+
<span class="c1"># Set it to False, if user should not be added automatically,</span>
|
| 947 |
+
<span class="c1"># in this case Admin has to add the user manually in the SQLite database.</span>
|
| 948 |
+
|
| 949 |
+
<span class="n">OAUTH2_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
| 950 |
+
|
| 951 |
+
<span class="c1">##########################################################################</span>
|
| 952 |
+
<span class="c1"># Webserver Configuration</span>
|
| 953 |
+
<span class="c1">##########################################################################</span>
|
| 954 |
+
|
| 955 |
+
<span class="n">WEBSERVER_AUTO_CREATE_USER</span> <span class="o">=</span> <span class="kc">True</span>
|
| 956 |
+
|
| 957 |
+
<span class="c1"># REMOTE_USER variable will be used to check the environment variable</span>
|
| 958 |
+
<span class="c1"># is set or not first, if not available,</span>
|
| 959 |
+
<span class="c1"># request header will be checked for the same.</span>
|
| 960 |
+
<span class="c1"># Possible values: REMOTE_USER, HTTP_X_FORWARDED_USER, X-Forwarded-User</span>
|
| 961 |
+
|
| 962 |
+
<span class="n">WEBSERVER_REMOTE_USER</span> <span class="o">=</span> <span class="s1">'REMOTE_USER'</span>
|
| 963 |
+
|
| 964 |
+
<span class="c1">##########################################################################</span>
|
| 965 |
+
<span class="c1"># Two-factor Authentication Configuration</span>
|
| 966 |
+
<span class="c1">##########################################################################</span>
|
| 967 |
+
|
| 968 |
+
<span class="c1"># Set it to True, to enable the two-factor authentication</span>
|
| 969 |
+
<span class="n">MFA_ENABLED</span> <span class="o">=</span> <span class="kc">True</span>
|
| 970 |
+
|
| 971 |
+
<span class="c1"># Set it to True, to ask the users to register forcefully for the</span>
|
| 972 |
+
<span class="c1"># two-authentication methods on logged-in.</span>
|
| 973 |
+
<span class="n">MFA_FORCE_REGISTRATION</span> <span class="o">=</span> <span class="kc">False</span>
|
| 974 |
+
|
| 975 |
+
<span class="c1"># pgAdmin supports Two-factor authentication by either sending an one-time code</span>
|
| 976 |
+
<span class="c1"># to an email, or using the TOTP based application like Google Authenticator.</span>
|
| 977 |
+
<span class="n">MFA_SUPPORTED_METHODS</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"email"</span><span class="p">,</span> <span class="s2">"authenticator"</span><span class="p">]</span>
|
| 978 |
+
|
| 979 |
+
<span class="c1"># NOTE: Please set the 'Mail server settings' to use 'email' as two-factor</span>
|
| 980 |
+
<span class="c1"># authentication method.</span>
|
| 981 |
+
|
| 982 |
+
<span class="c1"># Subject for the email verification code</span>
|
| 983 |
+
<span class="c1"># Default: <APP_NAME> - Verification Code</span>
|
| 984 |
+
<span class="c1"># e.g. pgAdmin 4 - Verification Code</span>
|
| 985 |
+
<span class="n">MFA_EMAIL_SUBJECT</span> <span class="o">=</span> <span class="kc">None</span>
|
| 986 |
+
|
| 987 |
+
<span class="c1">##########################################################################</span>
|
| 988 |
+
<span class="c1"># PSQL tool settings</span>
|
| 989 |
+
<span class="c1">##########################################################################</span>
|
| 990 |
+
<span class="c1"># This will enable PSQL tool in pgAdmin when running in server mode.</span>
|
| 991 |
+
<span class="c1"># PSQL is always enabled in Desktop mode, however in server mode it is</span>
|
| 992 |
+
<span class="c1"># disabled by default because users can run arbitrary commands on the</span>
|
| 993 |
+
<span class="c1"># server through it.</span>
|
| 994 |
+
<span class="n">ENABLE_PSQL</span> <span class="o">=</span> <span class="kc">False</span>
|
| 995 |
+
|
| 996 |
+
<span class="c1">##########################################################################</span>
|
| 997 |
+
<span class="c1"># ENABLE_BINARY_PATH_BROWSING setting is used to enable the browse button</span>
|
| 998 |
+
<span class="c1"># while selecting binary path for the database server in server mode.</span>
|
| 999 |
+
<span class="c1"># In Desktop mode it is always enabled and setting is of no use.</span>
|
| 1000 |
+
<span class="c1">##########################################################################</span>
|
| 1001 |
+
<span class="n">ENABLE_BINARY_PATH_BROWSING</span> <span class="o">=</span> <span class="kc">False</span>
|
| 1002 |
+
|
| 1003 |
+
<span class="c1">##########################################################################</span>
|
| 1004 |
+
<span class="c1"># In server mode, the SHARED_STORAGE setting is used to enable shared storage.</span>
|
| 1005 |
+
<span class="c1"># Specify the name, path, and restricted_access values that should be shared</span>
|
| 1006 |
+
<span class="c1"># between users. When restricted_access is set to True, non-admin users cannot</span>
|
| 1007 |
+
<span class="c1"># upload/add, delete, or rename files/folders in shared storage, only admins</span>
|
| 1008 |
+
<span class="c1"># can do that. Users must provide the absolute path to the folder, and the name</span>
|
| 1009 |
+
<span class="c1"># can be anything they see on the user interface.</span>
|
| 1010 |
+
<span class="c1"># [{ 'name': 'Shared 1', 'path': '/shared_folder',</span>
|
| 1011 |
+
<span class="c1"># 'restricted_access': True/False}]</span>
|
| 1012 |
+
<span class="c1">##########################################################################</span>
|
| 1013 |
+
<span class="n">SHARED_STORAGE</span> <span class="o">=</span> <span class="p">[]</span>
|
| 1014 |
+
|
| 1015 |
+
<span class="c1">#############################################################################</span>
|
| 1016 |
+
<span class="c1"># AUTO_DISCOVER_SERVERS setting is used to enable the pgAdmin to discover the</span>
|
| 1017 |
+
<span class="c1"># database server automatically on the local machine.</span>
|
| 1018 |
+
<span class="c1"># When it is set to False, pgAdmin will not discover servers installed on</span>
|
| 1019 |
+
<span class="c1"># the local machine.</span>
|
| 1020 |
+
<span class="c1">#############################################################################</span>
|
| 1021 |
+
<span class="n">AUTO_DISCOVER_SERVERS</span> <span class="o">=</span> <span class="kc">True</span>
|
| 1022 |
+
|
| 1023 |
+
<span class="c1">#############################################################################</span>
|
| 1024 |
+
<span class="c1"># SERVER_HEARTBEAT_TIMEOUT is used to send the server heartbeat to server</span>
|
| 1025 |
+
<span class="c1"># from the client. This will resolve the orphan database issue once</span>
|
| 1026 |
+
<span class="c1"># browser tab is closed.</span>
|
| 1027 |
+
<span class="c1">#############################################################################</span>
|
| 1028 |
+
<span class="n">SERVER_HEARTBEAT_TIMEOUT</span> <span class="o">=</span> <span class="mi">30</span> <span class="c1"># In seconds</span>
|
| 1029 |
+
|
| 1030 |
+
<span class="c1">#############################################################################</span>
|
| 1031 |
+
<span class="c1"># ENABLE_SERVER_PASS_EXEC_CMD is used to enable/disable Password exec command</span>
|
| 1032 |
+
<span class="c1"># field in server properties. This is used to specify a shell command to be</span>
|
| 1033 |
+
<span class="c1"># executed to retrieve a password to be used for server authentication.</span>
|
| 1034 |
+
<span class="c1"># This setting is applicable only for server mode.</span>
|
| 1035 |
+
<span class="c1">#############################################################################</span>
|
| 1036 |
+
<span class="n">ENABLE_SERVER_PASS_EXEC_CMD</span> <span class="o">=</span> <span class="kc">False</span>
|
| 1037 |
+
|
| 1038 |
+
<span class="c1">#############################################################################</span>
|
| 1039 |
+
<span class="c1"># Patch the default config with custom config and other manipulations</span>
|
| 1040 |
+
<span class="c1">#############################################################################</span>
|
| 1041 |
+
<span class="kn">from</span> <span class="nn">pgadmin.evaluate_config</span> <span class="kn">import</span> <span class="n">evaluate_and_patch_config</span>
|
| 1042 |
+
<span class="nb">locals</span><span class="p">()</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">evaluate_and_patch_config</span><span class="p">(</span><span class="nb">locals</span><span class="p">()))</span>
|
| 1043 |
+
</pre></div>
|
| 1044 |
+
</div>
|
| 1045 |
+
</section>
|
| 1046 |
+
|
| 1047 |
+
|
| 1048 |
+
<div class="clearer"></div>
|
| 1049 |
+
</div>
|
| 1050 |
+
</div>
|
| 1051 |
+
</div>
|
| 1052 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 1053 |
+
<div class="sphinxsidebarwrapper">
|
| 1054 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 1055 |
+
<ul class="current">
|
| 1056 |
+
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| 1057 |
+
<li class="toctree-l2 current"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
| 1058 |
+
<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| 1059 |
+
<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| 1060 |
+
<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| 1061 |
+
<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
|
| 1062 |
+
<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
|
| 1063 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| 1064 |
+
<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| 1065 |
+
<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| 1066 |
+
<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| 1067 |
+
<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| 1068 |
+
<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| 1069 |
+
<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| 1070 |
+
<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| 1071 |
+
<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| 1072 |
+
<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| 1073 |
+
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| 1074 |
+
<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| 1075 |
+
<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| 1076 |
+
</ul>
|
| 1077 |
+
</li>
|
| 1078 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 1079 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 1080 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 1081 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 1082 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 1083 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 1084 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 1085 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 1086 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 1087 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 1088 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 1089 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 1090 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 1091 |
+
</ul>
|
| 1092 |
+
|
| 1093 |
+
<search id="searchbox" style="display: none" role="search">
|
| 1094 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 1095 |
+
<div class="searchformwrapper">
|
| 1096 |
+
<form class="search" action="search.html" method="get">
|
| 1097 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 1098 |
+
<input type="submit" value="Go" />
|
| 1099 |
+
</form>
|
| 1100 |
+
</div>
|
| 1101 |
+
</search>
|
| 1102 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 1103 |
+
</div>
|
| 1104 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 1105 |
+
<span>«</span>
|
| 1106 |
+
</div>
|
| 1107 |
+
|
| 1108 |
+
</div>
|
| 1109 |
+
<div class="clearer"></div>
|
| 1110 |
+
</div>
|
| 1111 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 1112 |
+
<h3>Navigation</h3>
|
| 1113 |
+
<ul>
|
| 1114 |
+
<li class="right" style="margin-right: 10px">
|
| 1115 |
+
<a href="genindex.html" title="General Index"
|
| 1116 |
+
>index</a></li>
|
| 1117 |
+
<li class="right" >
|
| 1118 |
+
<a href="desktop_deployment.html" title="Desktop Deployment"
|
| 1119 |
+
>next</a> |</li>
|
| 1120 |
+
<li class="right" >
|
| 1121 |
+
<a href="deployment.html" title="Deployment"
|
| 1122 |
+
>previous</a> |</li>
|
| 1123 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 1124 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 1125 |
+
<li class="nav-item nav-item-2"><a href="deployment.html" >Deployment</a> »</li>
|
| 1126 |
+
<li class="nav-item nav-item-this"><a href="">The config.py File</a></li>
|
| 1127 |
+
</ul>
|
| 1128 |
+
</div>
|
| 1129 |
+
<div class="footer" role="contentinfo">
|
| 1130 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 1131 |
+
<ul>
|
| 1132 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 1133 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 1134 |
+
<li class="right" ><a href="desktop_deployment.html" title="Desktop Deployment" accesskey="N">next</a> |</li>
|
| 1135 |
+
<li class="right" ><a href="deployment.html" title="Deployment" accesskey="P">previous</a> |</li>
|
| 1136 |
+
</ul>
|
| 1137 |
+
</div>
|
| 1138 |
+
</div>
|
| 1139 |
+
</body>
|
| 1140 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/connect_error.html
ADDED
|
@@ -0,0 +1,182 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Connection Error — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Import/Export Servers" href="import_export_servers.html" />
|
| 23 |
+
<link rel="prev" title="Connect to Server" href="connect_to_server.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="import_export_servers.html" title="Import/Export Servers"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="connect_to_server.html" title="Connect to Server"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" accesskey="U">Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Connection Error</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="connection-error">
|
| 49 |
+
<span id="connect-error"></span><h1><span class="target" id="index-0"></span>Connection Error<a class="headerlink" href="#connection-error" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>When connecting to a PostgreSQL server, you may get an error message. If you
|
| 51 |
+
encounter an error message, please review the message carefully; each error
|
| 52 |
+
message attempts to incorporate the information you’ll need to resolve the
|
| 53 |
+
problem. For more details about specific errors, please locate the error
|
| 54 |
+
message in the list below:</p>
|
| 55 |
+
<p><strong>Connection to the server has been lost</strong></p>
|
| 56 |
+
<img alt="Connection to the server has been lost" class="align-center" src="_images/ce_timeout.png" />
|
| 57 |
+
<p>This error message indicates that the connection attempt has taken longer than
|
| 58 |
+
the specified threshold; there may be a problem with the connection properties
|
| 59 |
+
provided on the <em>Server</em> dialog, network connectivity issues, or the server may
|
| 60 |
+
not be running.</p>
|
| 61 |
+
<p><strong>could not connect to Server: Connection refused</strong></p>
|
| 62 |
+
<img alt="Could not connect to server" class="align-center" src="_images/ce_not_running.png" />
|
| 63 |
+
<dl class="simple">
|
| 64 |
+
<dt>If pgAdmin displays this message, there are two possible reasons for this:</dt><dd><ul class="simple">
|
| 65 |
+
<li><p>the database server isn’t running - simply start it.</p></li>
|
| 66 |
+
<li><p>the server isn’t configured to accept TCP/IP requests on the address shown.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
</dd>
|
| 69 |
+
</dl>
|
| 70 |
+
<p>For security reasons, a PostgreSQL server “out of the box” doesn’t listen on
|
| 71 |
+
TCP/IP ports. Instead, it must be enabled to listen for TCP/IP requests. This
|
| 72 |
+
can be done by adding <strong>listen_addresses=’*’</strong>; this will make the server accept
|
| 73 |
+
connections on any IP interface.</p>
|
| 74 |
+
<p>For further information, please refer to the PostgreSQL documentation about
|
| 75 |
+
<a class="reference external" href="https://www.postgresql.org/docs/current/runtime-config.html">runtime configuration</a>.</p>
|
| 76 |
+
<p><strong>FATAL: no pg_hba.conf entry</strong></p>
|
| 77 |
+
<img alt="No pg_hba.conf entry" class="align-center" src="_images/ce_error_hba.png" />
|
| 78 |
+
<p>If pgAdmin displays this message when connecting, your server can be contacted
|
| 79 |
+
correctly over the network, but is not configured to accept your connection.
|
| 80 |
+
Your client has not been detected as a legal user for the database.</p>
|
| 81 |
+
<p>To connect to a server, the pg_hba.conf file on the database server must be
|
| 82 |
+
configured to accept connections from the host of the pgAdmin client. Modify
|
| 83 |
+
the pg_hba.conf file on the database server host, and add an entry in the form:</p>
|
| 84 |
+
<blockquote>
|
| 85 |
+
<div><ul class="simple">
|
| 86 |
+
<li><p><strong>host template1 postgres 192.168.0.0/24 md5</strong> for an IPV4 network</p></li>
|
| 87 |
+
<li><p><strong>host template1 postgres ::ffff:192.168.0.0/120 md5</strong> for an IPV6 network</p></li>
|
| 88 |
+
</ul>
|
| 89 |
+
</div></blockquote>
|
| 90 |
+
<p>For more information, please refer to the PostgreSQL documentation about
|
| 91 |
+
<a class="reference external" href="https://www.postgresql.org/docs/current/client-authentication.html">client authentication</a>.</p>
|
| 92 |
+
<p><strong>FATAL: password authentication failed</strong></p>
|
| 93 |
+
<img alt="Password authentication failed" class="align-center" src="_images/ce_password_failed.png" />
|
| 94 |
+
<p>The <em>password authentication failed for user</em> error message indicates there
|
| 95 |
+
may be a problem with the password you entered. Retry the password to confirm
|
| 96 |
+
you entered it correctly. If the error message returns, make sure that you have
|
| 97 |
+
the correct password, that you are authorized to access the server, and that
|
| 98 |
+
the access has been correctly configured in the server’s postgresql.conf
|
| 99 |
+
configuration file.</p>
|
| 100 |
+
</section>
|
| 101 |
+
|
| 102 |
+
|
| 103 |
+
<div class="clearer"></div>
|
| 104 |
+
</div>
|
| 105 |
+
</div>
|
| 106 |
+
</div>
|
| 107 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 108 |
+
<div class="sphinxsidebarwrapper">
|
| 109 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 110 |
+
<ul class="current">
|
| 111 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 113 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 114 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 115 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 116 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 117 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 118 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 119 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Connection Error</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 121 |
+
</ul>
|
| 122 |
+
</li>
|
| 123 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 124 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 125 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 126 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 127 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 128 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 129 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 130 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 131 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 132 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 133 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 134 |
+
</ul>
|
| 135 |
+
|
| 136 |
+
<search id="searchbox" style="display: none" role="search">
|
| 137 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 138 |
+
<div class="searchformwrapper">
|
| 139 |
+
<form class="search" action="search.html" method="get">
|
| 140 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 141 |
+
<input type="submit" value="Go" />
|
| 142 |
+
</form>
|
| 143 |
+
</div>
|
| 144 |
+
</search>
|
| 145 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 146 |
+
</div>
|
| 147 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 148 |
+
<span>«</span>
|
| 149 |
+
</div>
|
| 150 |
+
|
| 151 |
+
</div>
|
| 152 |
+
<div class="clearer"></div>
|
| 153 |
+
</div>
|
| 154 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 155 |
+
<h3>Navigation</h3>
|
| 156 |
+
<ul>
|
| 157 |
+
<li class="right" style="margin-right: 10px">
|
| 158 |
+
<a href="genindex.html" title="General Index"
|
| 159 |
+
>index</a></li>
|
| 160 |
+
<li class="right" >
|
| 161 |
+
<a href="import_export_servers.html" title="Import/Export Servers"
|
| 162 |
+
>next</a> |</li>
|
| 163 |
+
<li class="right" >
|
| 164 |
+
<a href="connect_to_server.html" title="Connect to Server"
|
| 165 |
+
>previous</a> |</li>
|
| 166 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 167 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 168 |
+
<li class="nav-item nav-item-this"><a href="">Connection Error</a></li>
|
| 169 |
+
</ul>
|
| 170 |
+
</div>
|
| 171 |
+
<div class="footer" role="contentinfo">
|
| 172 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 173 |
+
<ul>
|
| 174 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 175 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 176 |
+
<li class="right" ><a href="import_export_servers.html" title="Import/Export Servers" accesskey="N">next</a> |</li>
|
| 177 |
+
<li class="right" ><a href="connect_to_server.html" title="Connect to Server" accesskey="P">previous</a> |</li>
|
| 178 |
+
</ul>
|
| 179 |
+
</div>
|
| 180 |
+
</div>
|
| 181 |
+
</body>
|
| 182 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/connect_to_server.html
ADDED
|
@@ -0,0 +1,170 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Connect to Server — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Connection Error" href="connect_error.html" />
|
| 23 |
+
<link rel="prev" title="Master Password" href="master_password.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="connect_error.html" title="Connection Error"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="master_password.html" title="Master Password"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" accesskey="U">Connecting To A Server</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Connect to Server</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="connect-to-server">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Connect to Server<a class="headerlink" href="#connect-to-server" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Connect to Server</em> dialog to authenticate with a defined server and
|
| 51 |
+
access the objects stored on the server through the pgAdmin tree control. To
|
| 52 |
+
access the dialog, right click on the server name in the <em>pgAdmin</em> tree control,
|
| 53 |
+
and select <em>Connect Server…</em> from the context menu.</p>
|
| 54 |
+
<img alt="Connect to server dialog" src="_images/connect_to_server.png" />
|
| 55 |
+
<p>Provide authentication information for the selected server:</p>
|
| 56 |
+
<blockquote>
|
| 57 |
+
<div><ul class="simple">
|
| 58 |
+
<li><p>Use the <em>Password</em> field to provide the password of the user that is
|
| 59 |
+
associated with the defined server.</p></li>
|
| 60 |
+
<li><p>Check the box next to <em>Save Password</em> to instruct the server to save the
|
| 61 |
+
password for future connections; if you save the password, you will not be
|
| 62 |
+
prompted when reconnecting to the database server with this server
|
| 63 |
+
definition.</p></li>
|
| 64 |
+
</ul>
|
| 65 |
+
</div></blockquote>
|
| 66 |
+
<p>When using SSH Tunneling, the <em>Connect to Server</em> dialog will prompt for the SSH
|
| 67 |
+
Tunnel and Database server passwords if not already saved.</p>
|
| 68 |
+
<img alt="Connect to server dialog" src="_images/connect_to_tunneled_server.png" />
|
| 69 |
+
<p>Provide authentication information for the selected server:</p>
|
| 70 |
+
<blockquote>
|
| 71 |
+
<div><ul class="simple">
|
| 72 |
+
<li><p>Use the <em>Password</em> field to provide the password of the user that is
|
| 73 |
+
associated with the defined server.</p></li>
|
| 74 |
+
<li><p>Check the box next to respective <em>Save Password</em> to instruct the server to
|
| 75 |
+
save the password for future connections; if you save the password, you will
|
| 76 |
+
not be prompted when reconnecting to the database server with this server
|
| 77 |
+
definition.</p></li>
|
| 78 |
+
</ul>
|
| 79 |
+
</div></blockquote>
|
| 80 |
+
<p>The pgAdmin client displays a message in a green status bar in the lower right
|
| 81 |
+
corner when the server connects successfully.</p>
|
| 82 |
+
<p>If you receive an error message while attempting a connection, verify that your
|
| 83 |
+
network is allowing the pgAdmin host and the host of the database server to
|
| 84 |
+
communicate. For detailed information about a specific error message, please see
|
| 85 |
+
the <a class="reference internal" href="connect_error.html#connect-error"><span class="std std-ref">Connection Error</span></a> help page.</p>
|
| 86 |
+
<p>To review or modify connection details, right-click on the name of the server,
|
| 87 |
+
and select <em>Properties…</em> from the context menu.</p>
|
| 88 |
+
</section>
|
| 89 |
+
|
| 90 |
+
|
| 91 |
+
<div class="clearer"></div>
|
| 92 |
+
</div>
|
| 93 |
+
</div>
|
| 94 |
+
</div>
|
| 95 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 96 |
+
<div class="sphinxsidebarwrapper">
|
| 97 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 98 |
+
<ul class="current">
|
| 99 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 100 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 101 |
+
<li class="toctree-l1 current"><a class="reference internal" href="connecting.html">Connecting To A Server</a><ul class="current">
|
| 102 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 103 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 104 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 105 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 106 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Connect to Server</a></li>
|
| 107 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 108 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 109 |
+
</ul>
|
| 110 |
+
</li>
|
| 111 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 113 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 114 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 115 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 116 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 119 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 120 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 121 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 122 |
+
</ul>
|
| 123 |
+
|
| 124 |
+
<search id="searchbox" style="display: none" role="search">
|
| 125 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 126 |
+
<div class="searchformwrapper">
|
| 127 |
+
<form class="search" action="search.html" method="get">
|
| 128 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 129 |
+
<input type="submit" value="Go" />
|
| 130 |
+
</form>
|
| 131 |
+
</div>
|
| 132 |
+
</search>
|
| 133 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 134 |
+
</div>
|
| 135 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 136 |
+
<span>«</span>
|
| 137 |
+
</div>
|
| 138 |
+
|
| 139 |
+
</div>
|
| 140 |
+
<div class="clearer"></div>
|
| 141 |
+
</div>
|
| 142 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 143 |
+
<h3>Navigation</h3>
|
| 144 |
+
<ul>
|
| 145 |
+
<li class="right" style="margin-right: 10px">
|
| 146 |
+
<a href="genindex.html" title="General Index"
|
| 147 |
+
>index</a></li>
|
| 148 |
+
<li class="right" >
|
| 149 |
+
<a href="connect_error.html" title="Connection Error"
|
| 150 |
+
>next</a> |</li>
|
| 151 |
+
<li class="right" >
|
| 152 |
+
<a href="master_password.html" title="Master Password"
|
| 153 |
+
>previous</a> |</li>
|
| 154 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 155 |
+
<li class="nav-item nav-item-1"><a href="connecting.html" >Connecting To A Server</a> »</li>
|
| 156 |
+
<li class="nav-item nav-item-this"><a href="">Connect to Server</a></li>
|
| 157 |
+
</ul>
|
| 158 |
+
</div>
|
| 159 |
+
<div class="footer" role="contentinfo">
|
| 160 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 161 |
+
<ul>
|
| 162 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 163 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 164 |
+
<li class="right" ><a href="connect_error.html" title="Connection Error" accesskey="N">next</a> |</li>
|
| 165 |
+
<li class="right" ><a href="master_password.html" title="Master Password" accesskey="P">previous</a> |</li>
|
| 166 |
+
</ul>
|
| 167 |
+
</div>
|
| 168 |
+
</div>
|
| 169 |
+
</body>
|
| 170 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/connecting.html
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Connecting To A Server — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Server Group Dialog" href="server_group_dialog.html" />
|
| 23 |
+
<link rel="prev" title="External database for pgAdmin user settings" href="external_database.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="server_group_dialog.html" title="Server Group Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="external_database.html" title="External database for pgAdmin user settings"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-this"><a href="">Connecting To A Server</a></li>
|
| 39 |
+
</ul>
|
| 40 |
+
</div>
|
| 41 |
+
|
| 42 |
+
<div class="document">
|
| 43 |
+
<div class="documentwrapper">
|
| 44 |
+
<div class="bodywrapper">
|
| 45 |
+
<div class="body" role="main">
|
| 46 |
+
|
| 47 |
+
<section id="connecting-to-a-server">
|
| 48 |
+
<span id="connecting"></span><h1><span class="target" id="index-0"></span>Connecting To A Server<a class="headerlink" href="#connecting-to-a-server" title="Link to this heading">¶</a></h1>
|
| 49 |
+
<p>Before you can use the pgAdmin client to manage the objects that reside on your
|
| 50 |
+
Postgres server, you must define a connection to the server. You can
|
| 51 |
+
(optionally) use the <em>Server Group</em> dialog to create server groups to organize
|
| 52 |
+
the server connections within the tree control for easier management. To open
|
| 53 |
+
the <em>Server Group</em> dialog, right-click on the <em>Servers</em> node of the tree
|
| 54 |
+
control, and select <em>Server Group</em> from the <em>Create</em> menu.</p>
|
| 55 |
+
<div class="toctree-wrapper compound">
|
| 56 |
+
<ul>
|
| 57 |
+
<li class="toctree-l1"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 58 |
+
</ul>
|
| 59 |
+
</div>
|
| 60 |
+
<p>Use the fields on the <em>Server</em> dialog to define the connection properties for
|
| 61 |
+
each new server that you wish to manage with pgAdmin. To open the <em>Server</em>
|
| 62 |
+
dialog, right-click on the <em>Servers</em> node of the tree control, and select
|
| 63 |
+
<em>Server</em> from the <em>Register</em> menu.</p>
|
| 64 |
+
<div class="toctree-wrapper compound">
|
| 65 |
+
<ul>
|
| 66 |
+
<li class="toctree-l1"><a class="reference internal" href="server_dialog.html">Server Dialog</a><ul>
|
| 67 |
+
<li class="toctree-l2"><a class="reference internal" href="clear_saved_passwords.html">Clear Saved Passwords</a></li>
|
| 68 |
+
</ul>
|
| 69 |
+
</li>
|
| 70 |
+
</ul>
|
| 71 |
+
</div>
|
| 72 |
+
<p>Alternatively you can use the <em>Cloud Deployment</em> wizard to deploy a new
|
| 73 |
+
PostgreSQL instance in the cloud, and connect to it.</p>
|
| 74 |
+
<div class="toctree-wrapper compound">
|
| 75 |
+
<ul>
|
| 76 |
+
<li class="toctree-l1"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a><ul>
|
| 77 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_aws_rds.html">Amazon RDS Cloud Deployment</a></li>
|
| 78 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_edb_biganimal.html">EDB BigAnimal Cloud Deployment</a></li>
|
| 79 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_azure_database.html">Azure Database Cloud Deployment</a></li>
|
| 80 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_google_cloud_sql.html">Google Cloud SQL Deployment</a></li>
|
| 81 |
+
</ul>
|
| 82 |
+
</li>
|
| 83 |
+
</ul>
|
| 84 |
+
</div>
|
| 85 |
+
<p>A master password is required to secure and later unlock saved server passwords.
|
| 86 |
+
It is set by the user and can be disabled using config.</p>
|
| 87 |
+
<div class="toctree-wrapper compound">
|
| 88 |
+
<ul>
|
| 89 |
+
<li class="toctree-l1"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 90 |
+
</ul>
|
| 91 |
+
</div>
|
| 92 |
+
<p>After defining a server connection, right-click on the server name, and select
|
| 93 |
+
<em>Connect to server</em> to authenticate with the server, and start using pgAdmin to
|
| 94 |
+
manage objects that reside on the server.</p>
|
| 95 |
+
<div class="toctree-wrapper compound">
|
| 96 |
+
<ul>
|
| 97 |
+
<li class="toctree-l1"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 98 |
+
<li class="toctree-l1"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 99 |
+
</ul>
|
| 100 |
+
</div>
|
| 101 |
+
<p>Server definitions (and their groups) can be exported to a JSON file and
|
| 102 |
+
re-imported to the same or a different system to enable easy pre-configuration
|
| 103 |
+
of pgAdmin.</p>
|
| 104 |
+
<div class="toctree-wrapper compound">
|
| 105 |
+
<ul>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a><ul>
|
| 107 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html#using-pgadmin-4-gui">Using pgAdmin 4 GUI</a></li>
|
| 108 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html#using-setup-py-command-line-script">Using ‘setup.py’ command line script</a><ul>
|
| 109 |
+
<li class="toctree-l3"><a class="reference internal" href="import_export_servers.html#exporting-servers">Exporting Servers</a></li>
|
| 110 |
+
<li class="toctree-l3"><a class="reference internal" href="import_export_servers.html#importing-servers">Importing Servers</a></li>
|
| 111 |
+
<li class="toctree-l3"><a class="reference internal" href="import_export_servers.html#json-format">JSON format</a></li>
|
| 112 |
+
</ul>
|
| 113 |
+
</li>
|
| 114 |
+
</ul>
|
| 115 |
+
</li>
|
| 116 |
+
</ul>
|
| 117 |
+
</div>
|
| 118 |
+
</section>
|
| 119 |
+
|
| 120 |
+
|
| 121 |
+
<div class="clearer"></div>
|
| 122 |
+
</div>
|
| 123 |
+
</div>
|
| 124 |
+
</div>
|
| 125 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 126 |
+
<div class="sphinxsidebarwrapper">
|
| 127 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 128 |
+
<ul class="current">
|
| 129 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 130 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 131 |
+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Connecting To A Server</a><ul>
|
| 132 |
+
<li class="toctree-l2"><a class="reference internal" href="server_group_dialog.html">Server Group Dialog</a></li>
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="server_dialog.html">Server Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="cloud_deployment.html">PostgreSQL Cloud Deployment</a></li>
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="master_password.html">Master Password</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_to_server.html">Connect to Server</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="connect_error.html">Connection Error</a></li>
|
| 138 |
+
<li class="toctree-l2"><a class="reference internal" href="import_export_servers.html">Import/Export Servers</a></li>
|
| 139 |
+
</ul>
|
| 140 |
+
</li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 142 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 143 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 144 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 149 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 150 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 151 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 152 |
+
</ul>
|
| 153 |
+
|
| 154 |
+
<search id="searchbox" style="display: none" role="search">
|
| 155 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 156 |
+
<div class="searchformwrapper">
|
| 157 |
+
<form class="search" action="search.html" method="get">
|
| 158 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 159 |
+
<input type="submit" value="Go" />
|
| 160 |
+
</form>
|
| 161 |
+
</div>
|
| 162 |
+
</search>
|
| 163 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 164 |
+
</div>
|
| 165 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 166 |
+
<span>«</span>
|
| 167 |
+
</div>
|
| 168 |
+
|
| 169 |
+
</div>
|
| 170 |
+
<div class="clearer"></div>
|
| 171 |
+
</div>
|
| 172 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 173 |
+
<h3>Navigation</h3>
|
| 174 |
+
<ul>
|
| 175 |
+
<li class="right" style="margin-right: 10px">
|
| 176 |
+
<a href="genindex.html" title="General Index"
|
| 177 |
+
>index</a></li>
|
| 178 |
+
<li class="right" >
|
| 179 |
+
<a href="server_group_dialog.html" title="Server Group Dialog"
|
| 180 |
+
>next</a> |</li>
|
| 181 |
+
<li class="right" >
|
| 182 |
+
<a href="external_database.html" title="External database for pgAdmin user settings"
|
| 183 |
+
>previous</a> |</li>
|
| 184 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 185 |
+
<li class="nav-item nav-item-this"><a href="">Connecting To A Server</a></li>
|
| 186 |
+
</ul>
|
| 187 |
+
</div>
|
| 188 |
+
<div class="footer" role="contentinfo">
|
| 189 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 190 |
+
<ul>
|
| 191 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 192 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 193 |
+
<li class="right" ><a href="server_group_dialog.html" title="Server Group Dialog" accesskey="N">next</a> |</li>
|
| 194 |
+
<li class="right" ><a href="external_database.html" title="External database for pgAdmin user settings" accesskey="P">previous</a> |</li>
|
| 195 |
+
</ul>
|
| 196 |
+
</div>
|
| 197 |
+
</div>
|
| 198 |
+
</body>
|
| 199 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/container_deployment.html
ADDED
|
@@ -0,0 +1,582 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Container Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Login Page" href="login.html" />
|
| 23 |
+
<link rel="prev" title="Server Deployment" href="server_deployment.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="login.html" title="Login Page"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="server_deployment.html" title="Server Deployment"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="deployment.html" accesskey="U">Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">Container Deployment</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="container-deployment">
|
| 50 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Container Deployment<a class="headerlink" href="#container-deployment" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>pgAdmin can be deployed in a container using the image at:</p>
|
| 52 |
+
<blockquote>
|
| 53 |
+
<div><p><a class="reference external" href="https://hub.docker.com/r/dpage/pgadmin4/">https://hub.docker.com/r/dpage/pgadmin4/</a></p>
|
| 54 |
+
</div></blockquote>
|
| 55 |
+
<p>There are various tags that you can select from to get the version of pgAdmin
|
| 56 |
+
that you want, using a command such as this if you’re using Docker:</p>
|
| 57 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4:<tag<span class="w"> </span>name>
|
| 58 |
+
</pre></div>
|
| 59 |
+
</div>
|
| 60 |
+
<p>where <em><tag name></em> is one of the following:</p>
|
| 61 |
+
<table class="longtable docutils align-default">
|
| 62 |
+
<colgroup>
|
| 63 |
+
<col style="width: 20.0%" />
|
| 64 |
+
<col style="width: 80.0%" />
|
| 65 |
+
</colgroup>
|
| 66 |
+
<thead>
|
| 67 |
+
<tr class="row-odd"><th class="head"><p>Tag name</p></th>
|
| 68 |
+
<th class="head"><p>Description</p></th>
|
| 69 |
+
</tr>
|
| 70 |
+
</thead>
|
| 71 |
+
<tbody>
|
| 72 |
+
<tr class="row-even"><td><p>latest</p></td>
|
| 73 |
+
<td><p>The most recent release.</p></td>
|
| 74 |
+
</tr>
|
| 75 |
+
<tr class="row-odd"><td><p>8.4</p></td>
|
| 76 |
+
<td><p>A specific version (8.4 in this case).</p></td>
|
| 77 |
+
</tr>
|
| 78 |
+
<tr class="row-even"><td><p>8</p></td>
|
| 79 |
+
<td><p>the latest release of a specific major version (major version 8 in this case).</p></td>
|
| 80 |
+
</tr>
|
| 81 |
+
<tr class="row-odd"><td><p>snapshot</p></td>
|
| 82 |
+
<td><p>The latest nightly test build.</p></td>
|
| 83 |
+
</tr>
|
| 84 |
+
</tbody>
|
| 85 |
+
</table>
|
| 86 |
+
<section id="postgresql-utilities">
|
| 87 |
+
<h2>PostgreSQL Utilities<a class="headerlink" href="#postgresql-utilities" title="Link to this heading">¶</a></h2>
|
| 88 |
+
<p>The PostgreSQL utilities <em>pg_dump</em>, <em>pg_dumpall</em>, <em>pg_restore</em> and <em>psql</em> are
|
| 89 |
+
included in the container to allow backups to be created and restored and other
|
| 90 |
+
maintenance functions to be executed. Multiple versions are included in the
|
| 91 |
+
following directories to allow use with different versions of the database
|
| 92 |
+
server:</p>
|
| 93 |
+
<ul class="simple">
|
| 94 |
+
<li><p>PostgreSQL 12: <em>/usr/local/pgsql-12</em></p></li>
|
| 95 |
+
<li><p>PostgreSQL 13: <em>/usr/local/pgsql-13</em></p></li>
|
| 96 |
+
<li><p>PostgreSQL 14: <em>/usr/local/pgsql-14</em></p></li>
|
| 97 |
+
<li><p>PostgreSQL 15: <em>/usr/local/pgsql-15</em></p></li>
|
| 98 |
+
<li><p>PostgreSQL 16: <em>/usr/local/pgsql-16</em></p></li>
|
| 99 |
+
</ul>
|
| 100 |
+
<p>The default binary paths set in the container are as follows:</p>
|
| 101 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">DEFAULT_BINARY_PATHS</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">{</span>
|
| 102 |
+
<span class="w"> </span><span class="s1">'pg-16'</span>:<span class="w"> </span><span class="s1">'/usr/local/pgsql-16'</span>,
|
| 103 |
+
<span class="w"> </span><span class="s1">'pg-15'</span>:<span class="w"> </span><span class="s1">'/usr/local/pgsql-15'</span>,
|
| 104 |
+
<span class="w"> </span><span class="s1">'pg-14'</span>:<span class="w"> </span><span class="s1">'/usr/local/pgsql-14'</span>,
|
| 105 |
+
<span class="w"> </span><span class="s1">'pg-13'</span>:<span class="w"> </span><span class="s1">'/usr/local/pgsql-13'</span>,
|
| 106 |
+
<span class="w"> </span><span class="s1">'pg-12'</span>:<span class="w"> </span><span class="s1">'/usr/local/pgsql-12'</span>
|
| 107 |
+
<span class="o">}</span>
|
| 108 |
+
</pre></div>
|
| 109 |
+
</div>
|
| 110 |
+
<p>this may be changed in the <a class="reference internal" href="preferences.html#preferences"><span class="std std-ref">Preferences Dialog</span></a>.</p>
|
| 111 |
+
</section>
|
| 112 |
+
<section id="environment-variables">
|
| 113 |
+
<h2>Environment Variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h2>
|
| 114 |
+
<p>The container will accept the following variables at startup:</p>
|
| 115 |
+
<p><strong>PGADMIN_DEFAULT_EMAIL</strong></p>
|
| 116 |
+
<p>This is the email address used when setting up the initial administrator account
|
| 117 |
+
to login to pgAdmin. This variable is required and must be set at launch time.</p>
|
| 118 |
+
<p><strong>PGADMIN_DEFAULT_PASSWORD</strong></p>
|
| 119 |
+
<p>This is the password used when setting up the initial administrator account to
|
| 120 |
+
login to pgAdmin. This variable is required and must be set at launch time.</p>
|
| 121 |
+
<p><strong>PGADMIN_DEFAULT_PASSWORD_FILE</strong></p>
|
| 122 |
+
<p>This is the password used when setting up the initial administrator account to
|
| 123 |
+
login to pgAdmin. This value should be set to <em>docker secret</em> in order to set
|
| 124 |
+
the password. This variable is supported in docker swarm environment or while creating
|
| 125 |
+
container with docker compose. PGADMIN_DEFAULT_PASSWORD or PGADMIN_DEFAULT_PASSWORD_FILE
|
| 126 |
+
variable is required and must be set at launch time.</p>
|
| 127 |
+
<p><strong>PGADMIN_DISABLE_POSTFIX</strong></p>
|
| 128 |
+
<p><em>Default: <null></em></p>
|
| 129 |
+
<p>If left unset, a Postfix server will be started to deliver password reset
|
| 130 |
+
emails.</p>
|
| 131 |
+
<p>If set to any value, the Postfix server will not be started, and pgAdmin will
|
| 132 |
+
need to be configured to use an external mail server using the <em>PGADMIN_CONFIG_</em>
|
| 133 |
+
options below.</p>
|
| 134 |
+
<p>This option is useful if you’re running in an environment that prevents the use
|
| 135 |
+
of sudo to start Postfix, or if you wish to use an external mail server.</p>
|
| 136 |
+
<p><strong>PGADMIN_ENABLE_TLS</strong></p>
|
| 137 |
+
<p><em>Default: <null></em></p>
|
| 138 |
+
<p>If left un-set, the container will listen on port 80 for connections in plain
|
| 139 |
+
text. If set to any value, the container will listen on port 443 for TLS
|
| 140 |
+
connections.</p>
|
| 141 |
+
<p>When TLS is enabled, a certificate and key must be provided. Typically these
|
| 142 |
+
should be stored on the host file system and mounted from the container. The
|
| 143 |
+
expected paths are /certs/server.cert and /certs/server.key</p>
|
| 144 |
+
<p><strong>PGADMIN_LISTEN_ADDRESS</strong></p>
|
| 145 |
+
<p><em>Default: [::]</em></p>
|
| 146 |
+
<p>Specify the local address that the servers listens on. The default should work
|
| 147 |
+
for most users - in IPv4-only environments, this may need to be set to
|
| 148 |
+
0.0.0.0.</p>
|
| 149 |
+
<p><strong>PGADMIN_LISTEN_PORT</strong></p>
|
| 150 |
+
<p><em>Default: 80 or 443 (if TLS is enabled)</em></p>
|
| 151 |
+
<p>Allows the port that the server listens on to be set to a specific value rather
|
| 152 |
+
than using the default.</p>
|
| 153 |
+
<p><strong>PGADMIN_SERVER_JSON_FILE</strong></p>
|
| 154 |
+
<p><em>Default: /pgadmin4/servers.json</em></p>
|
| 155 |
+
<p>Override the default file path for the server definition list. See the
|
| 156 |
+
/pgadmin4/servers.json mapped file below for more information. See the format
|
| 157 |
+
of the <a class="reference external" href="https://www.pgadmin.org/docs/pgadmin4/latest/import_export_servers.html#json-format">Servers JSON file</a>.</p>
|
| 158 |
+
<p><strong>PGADMIN_PREFERENCES_JSON_FILE</strong></p>
|
| 159 |
+
<p><em>Default: /pgadmin4/preferences.json</em></p>
|
| 160 |
+
<p>Override the default file path for the preferences customization at the container creation. See the
|
| 161 |
+
/pgadmin4/preferences.json mapped file below for more information. See the format
|
| 162 |
+
of the <a class="reference external" href="https://www.pgadmin.org/docs/pgadmin4/latest/preferences.html#json-format">Preferences JSON file</a>.</p>
|
| 163 |
+
<p><strong>GUNICORN_ACCESS_LOGFILE</strong></p>
|
| 164 |
+
<p><em>Default: -</em> (stdout)</p>
|
| 165 |
+
<p>Specify an output file in which to store the Gunicorn access logs, instead of
|
| 166 |
+
sending them to stdout.</p>
|
| 167 |
+
<p><strong>GUNICORN_LIMIT_REQUEST_LINE</strong></p>
|
| 168 |
+
<p><em>Default: 8190</em></p>
|
| 169 |
+
<p>Set the maximum size of HTTP request line in bytes. By default the pgAdmin
|
| 170 |
+
container uses the maximum limited size offered by Gunicorn as some requests
|
| 171 |
+
can be quite large. In exceptional cases this value can be set to 0 (zero) to
|
| 172 |
+
specify “unlimited”, however this poses a potential denial of service hazard.</p>
|
| 173 |
+
<p><strong>GUNICORN_THREADS</strong></p>
|
| 174 |
+
<p><em>Default: 25</em></p>
|
| 175 |
+
<p>Adjust the number of threads the Gunicorn server uses to handle incoming
|
| 176 |
+
requests. This should typically be left as-is, except in highly loaded systems
|
| 177 |
+
where it may be increased.</p>
|
| 178 |
+
<p><strong>PGADMIN_CONFIG_*</strong></p>
|
| 179 |
+
<p>This is a variable prefix that can be used to override any of the configuration
|
| 180 |
+
options in pgAdmin’s <em>config.py</em> file. Add the <em>PGADMIN_CONFIG_</em> prefix to any
|
| 181 |
+
variable name from <em>config.py</em> and give the value in the format ‘string value’
|
| 182 |
+
for strings, True/False for booleans or 123 for numbers. See below for an
|
| 183 |
+
example.</p>
|
| 184 |
+
<p>Settings are written to <em>/pgadmin4/config_distro.py</em> within the container, which
|
| 185 |
+
is read after <em>/pgadmin4/config.py</em> and before <em>/pgadmin4/config_local.py</em>.
|
| 186 |
+
Any settings given will therefore override anything in config.py, but can be
|
| 187 |
+
overridden by settings in config_local.py.</p>
|
| 188 |
+
<p>Settings are only written to <em>/pgadmin4/config_distro.py</em> once, typically on
|
| 189 |
+
first launch of the container. If <em>/pgadmin4/config_distro.py</em> contains one or
|
| 190 |
+
more lines, then no changes are made; for example, if the container instance is
|
| 191 |
+
restarted, or <em>/pgadmin4/config_distro.py</em> is mapped to a file on persistent
|
| 192 |
+
storage (not recommended - use <em>/pgadmin4/config_local.py</em> instead)!</p>
|
| 193 |
+
<p>See <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">The config.py File</span></a> for more information on the available configuration settings.</p>
|
| 194 |
+
</section>
|
| 195 |
+
<section id="mapped-files-and-directories">
|
| 196 |
+
<h2>Mapped Files and Directories<a class="headerlink" href="#mapped-files-and-directories" title="Link to this heading">¶</a></h2>
|
| 197 |
+
<p>The following files or directories can be mapped from the container onto the
|
| 198 |
+
host machine to allow configuration to be customised and shared between
|
| 199 |
+
instances.</p>
|
| 200 |
+
<div class="admonition warning">
|
| 201 |
+
<p class="admonition-title">Warning</p>
|
| 202 |
+
<p>Warning: pgAdmin runs as the <em>pgadmin</em> user (UID: 5050) in the
|
| 203 |
+
<em>pgadmin</em> group (GID: 5050) in the container. You must ensure that all files
|
| 204 |
+
are readable, and where necessary (e.g. the working/session directory)
|
| 205 |
+
writeable for this user on the host machine. For example:</p>
|
| 206 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>chown<span class="w"> </span>-R<span class="w"> </span><span class="m">5050</span>:5050<span class="w"> </span><host_directory>
|
| 207 |
+
</pre></div>
|
| 208 |
+
</div>
|
| 209 |
+
<p>On some filesystems that do not support extended attributes, it may not be
|
| 210 |
+
possible to run pgAdmin without specifying a value for <em>PGADMIN_LISTEN_PORT</em>
|
| 211 |
+
that is greater than 1024. In such cases, specify an alternate port when
|
| 212 |
+
launching the container by adding the environment variable, for example:</p>
|
| 213 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>-e<span class="w"> </span><span class="s1">'PGADMIN_LISTEN_PORT=5050'</span>
|
| 214 |
+
</pre></div>
|
| 215 |
+
</div>
|
| 216 |
+
<p>Don’t forget to adjust any host-container port mapping accordingly.</p>
|
| 217 |
+
</div>
|
| 218 |
+
<p><strong>/var/lib/pgadmin</strong></p>
|
| 219 |
+
<p>This is the working directory in which pgAdmin stores session data, user files,
|
| 220 |
+
configuration files, and it’s configuration database. Mapping this directory
|
| 221 |
+
onto the host machine gives you an easy way to maintain configuration between
|
| 222 |
+
invocations of the container.</p>
|
| 223 |
+
<p><strong>/pgadmin4/config_local.py</strong></p>
|
| 224 |
+
<p>This file can be used to override configuration settings in pgAdmin. Settings
|
| 225 |
+
found in config.py can be overridden with deployment specific values if
|
| 226 |
+
required. Settings in config_local.py will also override anything specified in
|
| 227 |
+
the container environment through <em>PGADMIN_CONFIG_</em> prefixed variables.</p>
|
| 228 |
+
<p><strong>/pgadmin4/servers.json</strong></p>
|
| 229 |
+
<p>If this file is mapped, server definitions found in it will be loaded at launch
|
| 230 |
+
time. This allows connection information to be pre-loaded into the instance of
|
| 231 |
+
pgAdmin in the container. Note that server definitions are only loaded on first
|
| 232 |
+
launch, i.e. when the configuration database is created, and not on subsequent
|
| 233 |
+
launches using the same configuration database.</p>
|
| 234 |
+
<p><strong>/pgadmin4/preferences.json</strong></p>
|
| 235 |
+
<p>If this file is mapped, preferences defined in it will be updated at launch
|
| 236 |
+
time. This allows customization of preferences settings into the instance of
|
| 237 |
+
pgAdmin in the container. Note that preferences are only set on first
|
| 238 |
+
launch, i.e. when the configuration database is created, and not on subsequent
|
| 239 |
+
launches using the same configuration database.</p>
|
| 240 |
+
<p><strong>/certs/server.cert</strong></p>
|
| 241 |
+
<p>If TLS is enabled, this file will be used as the servers TLS certificate.</p>
|
| 242 |
+
<p><strong>/certs/server.key</strong></p>
|
| 243 |
+
<p>If TLS is enabled, this file will be used as the key file for the servers TLS
|
| 244 |
+
certificate.</p>
|
| 245 |
+
</section>
|
| 246 |
+
<section id="examples">
|
| 247 |
+
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
|
| 248 |
+
<p>Run a simple container over port 80:</p>
|
| 249 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 250 |
+
docker<span class="w"> </span>run<span class="w"> </span>-p<span class="w"> </span><span class="m">80</span>:80<span class="w"> </span><span class="se">\</span>
|
| 251 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_DEFAULT_EMAIL=user@domain.com'</span><span class="w"> </span><span class="se">\</span>
|
| 252 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_DEFAULT_PASSWORD=SuperSecret'</span><span class="w"> </span><span class="se">\</span>
|
| 253 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 254 |
+
</pre></div>
|
| 255 |
+
</div>
|
| 256 |
+
<p>Run a simple container over port 80, setting some configuration options:</p>
|
| 257 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 258 |
+
docker<span class="w"> </span>run<span class="w"> </span>-p<span class="w"> </span><span class="m">80</span>:80<span class="w"> </span><span class="se">\</span>
|
| 259 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_DEFAULT_EMAIL=user@domain.com'</span><span class="w"> </span><span class="se">\</span>
|
| 260 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_DEFAULT_PASSWORD=SuperSecret'</span><span class="w"> </span><span class="se">\</span>
|
| 261 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_CONFIG_ENHANCED_COOKIE_PROTECTION=True'</span><span class="w"> </span><span class="se">\</span>
|
| 262 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_CONFIG_LOGIN_BANNER="Authorised users only!"'</span><span class="w"> </span><span class="se">\</span>
|
| 263 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_CONFIG_CONSOLE_LOG_LEVEL=10'</span><span class="w"> </span><span class="se">\</span>
|
| 264 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 265 |
+
</pre></div>
|
| 266 |
+
</div>
|
| 267 |
+
<p>Run a TLS secured container using a shared config/storage directory in
|
| 268 |
+
/private/var/lib/pgadmin on the host, and servers pre-loaded from
|
| 269 |
+
/tmp/servers.json on the host:</p>
|
| 270 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 271 |
+
docker<span class="w"> </span>run<span class="w"> </span>-p<span class="w"> </span><span class="m">443</span>:443<span class="w"> </span><span class="se">\</span>
|
| 272 |
+
<span class="w"> </span>-v<span class="w"> </span>/private/var/lib/pgadmin:/var/lib/pgadmin<span class="w"> </span><span class="se">\</span>
|
| 273 |
+
<span class="w"> </span>-v<span class="w"> </span>/path/to/certificate.cert:/certs/server.cert<span class="w"> </span><span class="se">\</span>
|
| 274 |
+
<span class="w"> </span>-v<span class="w"> </span>/path/to/certificate.key:/certs/server.key<span class="w"> </span><span class="se">\</span>
|
| 275 |
+
<span class="w"> </span>-v<span class="w"> </span>/tmp/servers.json:/pgadmin4/servers.json<span class="w"> </span><span class="se">\</span>
|
| 276 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_DEFAULT_EMAIL=user@domain.com'</span><span class="w"> </span><span class="se">\</span>
|
| 277 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_DEFAULT_PASSWORD=SuperSecret'</span><span class="w"> </span><span class="se">\</span>
|
| 278 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s1">'PGADMIN_ENABLE_TLS=True'</span><span class="w"> </span><span class="se">\</span>
|
| 279 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 280 |
+
</pre></div>
|
| 281 |
+
</div>
|
| 282 |
+
</section>
|
| 283 |
+
<section id="reverse-proxying">
|
| 284 |
+
<h2>Reverse Proxying<a class="headerlink" href="#reverse-proxying" title="Link to this heading">¶</a></h2>
|
| 285 |
+
<p>Sometimes it’s desirable to have users connect to pgAdmin through a reverse
|
| 286 |
+
proxy rather than directly to the container it’s running in. The following
|
| 287 |
+
examples show how this can be achieved. With traditional reverse proxy servers
|
| 288 |
+
such as <a class="reference external" href="https://www.nginx.com/">Nginx</a>, pgAdmin is running in a container on
|
| 289 |
+
the same host, with port 5050 on the host mapped to port 80 on the container,
|
| 290 |
+
for example:</p>
|
| 291 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 292 |
+
docker<span class="w"> </span>run<span class="w"> </span>-p<span class="w"> </span><span class="m">5050</span>:80<span class="w"> </span><span class="se">\</span>
|
| 293 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_EMAIL=user@domain.com"</span><span class="w"> </span><span class="se">\</span>
|
| 294 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_PASSWORD=SuperSecret"</span><span class="w"> </span><span class="se">\</span>
|
| 295 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 296 |
+
</pre></div>
|
| 297 |
+
</div>
|
| 298 |
+
<section id="pgadmin-x-forwarded-configuration">
|
| 299 |
+
<h3>pgAdmin X-Forwarded-* Configuration<a class="headerlink" href="#pgadmin-x-forwarded-configuration" title="Link to this heading">¶</a></h3>
|
| 300 |
+
<p>pgAdmin needs to understand how many proxies set each header so it knows what
|
| 301 |
+
values to trust. The configuration parameters for the X-Forwarded-* options
|
| 302 |
+
which are used for this purpose are shown below, along with their default
|
| 303 |
+
values.</p>
|
| 304 |
+
<p>pgAdmin is configured by default to be able to run behind a reverse proxy even
|
| 305 |
+
on a non-standard port and these config options don’t normally need to be
|
| 306 |
+
changed. If you’re running an unusual configuration (such as multiple reverse
|
| 307 |
+
proxies) you can adjust the configuration to suit.</p>
|
| 308 |
+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Number of values to trust for X-Forwarded-For</span>
|
| 309 |
+
<span class="n">PROXY_X_FOR_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
| 310 |
+
|
| 311 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Proto.</span>
|
| 312 |
+
<span class="n">PROXY_X_PROTO_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
| 313 |
+
|
| 314 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Host.</span>
|
| 315 |
+
<span class="n">PROXY_X_HOST_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
| 316 |
+
|
| 317 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Port.</span>
|
| 318 |
+
<span class="n">PROXY_X_PORT_COUNT</span> <span class="o">=</span> <span class="mi">1</span>
|
| 319 |
+
|
| 320 |
+
<span class="c1"># Number of values to trust for X-Forwarded-Prefix.</span>
|
| 321 |
+
<span class="n">PROXY_X_PREFIX_COUNT</span> <span class="o">=</span> <span class="mi">0</span>
|
| 322 |
+
</pre></div>
|
| 323 |
+
</div>
|
| 324 |
+
</section>
|
| 325 |
+
<section id="http-via-nginx">
|
| 326 |
+
<h3>HTTP via Nginx<a class="headerlink" href="#http-via-nginx" title="Link to this heading">¶</a></h3>
|
| 327 |
+
<p>A configuration similar to the following can be used to create a simple HTTP
|
| 328 |
+
reverse proxy listening for all hostnames with <a class="reference external" href="https://www.nginx.com/">Nginx</a>:</p>
|
| 329 |
+
<div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span>
|
| 330 |
+
<span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">80</span><span class="p">;</span>
|
| 331 |
+
<span class="w"> </span><span class="kn">server_name</span><span class="w"> </span><span class="s">_</span><span class="p">;</span>
|
| 332 |
+
|
| 333 |
+
<span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/</span><span class="w"> </span><span class="p">{</span>
|
| 334 |
+
<span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">Host</span><span class="w"> </span><span class="nv">$host</span><span class="p">;</span>
|
| 335 |
+
<span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://localhost:5050/</span><span class="p">;</span>
|
| 336 |
+
<span class="w"> </span><span class="kn">proxy_redirect</span><span class="w"> </span><span class="no">off</span><span class="p">;</span>
|
| 337 |
+
<span class="w"> </span><span class="p">}</span>
|
| 338 |
+
<span class="p">}</span>
|
| 339 |
+
</pre></div>
|
| 340 |
+
</div>
|
| 341 |
+
<p>If you wish to host pgAdmin under a subdirectory rather than on the root of the
|
| 342 |
+
server, you must specify the location and set the <em>X-Script-Name</em> header which
|
| 343 |
+
tells the pgAdmin container how to rewrite paths:</p>
|
| 344 |
+
<div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span>
|
| 345 |
+
<span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">80</span><span class="p">;</span>
|
| 346 |
+
<span class="w"> </span><span class="kn">server_name</span><span class="w"> </span><span class="s">_</span><span class="p">;</span>
|
| 347 |
+
|
| 348 |
+
<span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/pgadmin4/</span><span class="w"> </span><span class="p">{</span>
|
| 349 |
+
<span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">X-Script-Name</span><span class="w"> </span><span class="s">/pgadmin4</span><span class="p">;</span>
|
| 350 |
+
<span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">Host</span><span class="w"> </span><span class="nv">$host</span><span class="p">;</span>
|
| 351 |
+
<span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://localhost:5050/</span><span class="p">;</span>
|
| 352 |
+
<span class="w"> </span><span class="kn">proxy_redirect</span><span class="w"> </span><span class="no">off</span><span class="p">;</span>
|
| 353 |
+
<span class="w"> </span><span class="p">}</span>
|
| 354 |
+
<span class="p">}</span>
|
| 355 |
+
</pre></div>
|
| 356 |
+
</div>
|
| 357 |
+
<p>If Nginx is also running in a container, there is no need to map the pgAdmin
|
| 358 |
+
port to the host, provided the two containers are running in the same Docker
|
| 359 |
+
network. In such a configuration, the <em>proxy_pass</em> option would be changed to
|
| 360 |
+
point to the pgAdmin container within the Docker network.</p>
|
| 361 |
+
</section>
|
| 362 |
+
<section id="https-via-nginx">
|
| 363 |
+
<h3>HTTPS via Nginx<a class="headerlink" href="#https-via-nginx" title="Link to this heading">¶</a></h3>
|
| 364 |
+
<p>The following configuration can be used to serve pgAdmin over HTTPS to the user
|
| 365 |
+
whilst the backend container is serving plain HTTP to the proxy server. In this
|
| 366 |
+
configuration we not only set <em>X-Script-Name</em>, but also <em>X-Scheme</em> to tell the
|
| 367 |
+
pgAdmin server to generate any URLs using the correct scheme. A redirect from
|
| 368 |
+
HTTP to HTTPS is also included. The certificate and key paths may need to be
|
| 369 |
+
adjusted as appropriate to the specific deployment:</p>
|
| 370 |
+
<div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span>
|
| 371 |
+
<span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">80</span><span class="p">;</span>
|
| 372 |
+
<span class="w"> </span><span class="kn">return</span><span class="w"> </span><span class="mi">301</span><span class="w"> </span><span class="s">https://</span><span class="nv">$host$request_uri</span><span class="p">;</span>
|
| 373 |
+
<span class="p">}</span>
|
| 374 |
+
|
| 375 |
+
<span class="k">server</span><span class="w"> </span><span class="p">{</span>
|
| 376 |
+
<span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">443</span><span class="p">;</span>
|
| 377 |
+
<span class="w"> </span><span class="kn">server_name</span><span class="w"> </span><span class="s">_</span><span class="p">;</span>
|
| 378 |
+
|
| 379 |
+
<span class="w"> </span><span class="kn">ssl_certificate</span><span class="w"> </span><span class="s">/etc/nginx/server.cert</span><span class="p">;</span>
|
| 380 |
+
<span class="w"> </span><span class="kn">ssl_certificate_key</span><span class="w"> </span><span class="s">/etc/nginx/server.key</span><span class="p">;</span>
|
| 381 |
+
|
| 382 |
+
<span class="w"> </span><span class="kn">ssl</span><span class="w"> </span><span class="no">on</span><span class="p">;</span>
|
| 383 |
+
<span class="w"> </span><span class="kn">ssl_session_cache</span><span class="w"> </span><span class="n">builtin</span><span class="p">:</span><span class="mi">1000</span><span class="w"> </span><span class="s">shared:SSL:10m</span><span class="p">;</span>
|
| 384 |
+
<span class="w"> </span><span class="kn">ssl_protocols</span><span class="w"> </span><span class="s">TLSv1</span><span class="w"> </span><span class="s">TLSv1.1</span><span class="w"> </span><span class="s">TLSv1.2</span><span class="p">;</span>
|
| 385 |
+
<span class="w"> </span><span class="kn">ssl_ciphers</span><span class="w"> </span><span class="s">HIGH:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4</span><span class="p">;</span>
|
| 386 |
+
<span class="w"> </span><span class="kn">ssl_prefer_server_ciphers</span><span class="w"> </span><span class="no">on</span><span class="p">;</span>
|
| 387 |
+
|
| 388 |
+
<span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/pgadmin4/</span><span class="w"> </span><span class="p">{</span>
|
| 389 |
+
<span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">X-Script-Name</span><span class="w"> </span><span class="s">/pgadmin4</span><span class="p">;</span>
|
| 390 |
+
<span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">X-Scheme</span><span class="w"> </span><span class="nv">$scheme</span><span class="p">;</span>
|
| 391 |
+
<span class="w"> </span><span class="kn">proxy_set_header</span><span class="w"> </span><span class="s">Host</span><span class="w"> </span><span class="nv">$host</span><span class="p">;</span>
|
| 392 |
+
<span class="w"> </span><span class="kn">proxy_pass</span><span class="w"> </span><span class="s">http://localhost:5050/</span><span class="p">;</span>
|
| 393 |
+
<span class="w"> </span><span class="kn">proxy_redirect</span><span class="w"> </span><span class="no">off</span><span class="p">;</span>
|
| 394 |
+
<span class="w"> </span><span class="p">}</span>
|
| 395 |
+
<span class="p">}</span>
|
| 396 |
+
</pre></div>
|
| 397 |
+
</div>
|
| 398 |
+
</section>
|
| 399 |
+
<section id="traefik">
|
| 400 |
+
<h3>Traefik<a class="headerlink" href="#traefik" title="Link to this heading">¶</a></h3>
|
| 401 |
+
<p>Configuring <a class="reference external" href="https://traefik.io/">Traefik</a> is straightforward for either HTTP
|
| 402 |
+
or HTTPS when running pgAdmin in a container as it will automatically configure
|
| 403 |
+
itself to serve content from containers that are running on the local machine,
|
| 404 |
+
virtual hosting them at <em><container_name>.<domain_name></em>, where the domain
|
| 405 |
+
name is that specified in the Traefik configuration. The container is typically
|
| 406 |
+
launched per the example below:</p>
|
| 407 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 408 |
+
docker<span class="w"> </span>run<span class="w"> </span>--name<span class="w"> </span><span class="s2">"pgadmin4"</span><span class="w"> </span><span class="se">\</span>
|
| 409 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_EMAIL=user@domain.com"</span><span class="w"> </span><span class="se">\</span>
|
| 410 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_PASSWORD=SuperSecret"</span><span class="w"> </span><span class="se">\</span>
|
| 411 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 412 |
+
</pre></div>
|
| 413 |
+
</div>
|
| 414 |
+
<p>Note that the TCP/IP port has not been mapped to the host as it was in the
|
| 415 |
+
Nginx example, and the container name has been set to a known value as it will
|
| 416 |
+
be used as the hostname and may need to be added to the DNS zone file.</p>
|
| 417 |
+
<p>The following configuration will listen on ports 80 and 443, redirecting 80 to
|
| 418 |
+
443, using the default certificate shipped with Traefik. See the Traefik
|
| 419 |
+
documentation for options to use certificates from LetsEncrypt or other issuers.</p>
|
| 420 |
+
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="na">defaultEntryPoints</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["http", "https"]</span>
|
| 421 |
+
|
| 422 |
+
<span class="k">[entryPoints]</span>
|
| 423 |
+
<span class="w"> </span><span class="k">[entryPoints.http]</span>
|
| 424 |
+
<span class="w"> </span><span class="na">address</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">":80"</span>
|
| 425 |
+
<span class="w"> </span><span class="k">[entryPoints.http.redirect]</span>
|
| 426 |
+
<span class="w"> </span><span class="na">entryPoint</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"https"</span>
|
| 427 |
+
<span class="w"> </span><span class="k">[entryPoints.https]</span>
|
| 428 |
+
<span class="w"> </span><span class="na">address</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">":443"</span>
|
| 429 |
+
<span class="w"> </span><span class="k">[entryPoints.https.tls]</span>
|
| 430 |
+
|
| 431 |
+
<span class="k">[docker]</span>
|
| 432 |
+
<span class="na">domain</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"domain_name"</span>
|
| 433 |
+
<span class="na">watch</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span>
|
| 434 |
+
</pre></div>
|
| 435 |
+
</div>
|
| 436 |
+
<p>If you wish to host pgAdmin under a subdirectory using Traefik, the
|
| 437 |
+
configuration changes are typically made to the way the container is launched
|
| 438 |
+
and not to Traefik itself. For example, to host pgAdmin under <em>/pgadmin4/</em>
|
| 439 |
+
instead of at the root directory, the Traefik configuration above may be used if
|
| 440 |
+
the container is launched like this while using the version v1 of Traefik:</p>
|
| 441 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 442 |
+
docker<span class="w"> </span>run<span class="w"> </span>--name<span class="w"> </span><span class="s2">"pgadmin4"</span><span class="w"> </span><span class="se">\</span>
|
| 443 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_EMAIL=user@domain.com"</span><span class="w"> </span><span class="se">\</span>
|
| 444 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_PASSWORD=SuperSecret"</span><span class="w"> </span><span class="se">\</span>
|
| 445 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"SCRIPT_NAME=/pgadmin4"</span><span class="w"> </span><span class="se">\</span>
|
| 446 |
+
<span class="w"> </span>-l<span class="w"> </span><span class="s2">"traefik.frontend.rule=PathPrefix:/pgadmin4"</span><span class="w"> </span><span class="se">\</span>
|
| 447 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 448 |
+
</pre></div>
|
| 449 |
+
</div>
|
| 450 |
+
<p>The <em>SCRIPT_NAME</em> environment variable has been set to tell the container it is
|
| 451 |
+
being hosted under a subdirectory (in the same way as the <em>X-Script-Name</em> header
|
| 452 |
+
is used with Nginx), and a label has been added to tell Traefik to route
|
| 453 |
+
requests under the subdirectory to this container.</p>
|
| 454 |
+
<p>While using the Traefik configuration for version v2 for hosting pgAdmin under subdirectory
|
| 455 |
+
the container is typically launched per the example below:</p>
|
| 456 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>pull<span class="w"> </span>dpage/pgadmin4
|
| 457 |
+
docker<span class="w"> </span>run<span class="w"> </span>--name<span class="w"> </span><span class="s2">"pgadmin4"</span><span class="w"> </span><span class="se">\</span>
|
| 458 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_EMAIL=user@domain.com"</span><span class="w"> </span><span class="se">\</span>
|
| 459 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"PGADMIN_DEFAULT_PASSWORD=SuperSecret"</span><span class="w"> </span><span class="se">\</span>
|
| 460 |
+
<span class="w"> </span>-e<span class="w"> </span><span class="s2">"SCRIPT_NAME=/pgadmin4"</span><span class="w"> </span><span class="se">\</span>
|
| 461 |
+
<span class="w"> </span>-l<span class="w"> </span><span class="s2">"traefik.frontend.pgadmin4.rule=Host(`host.example.com`) && PathPrefix(`/pgadmin4`)"</span><span class="w"> </span><span class="se">\</span>
|
| 462 |
+
<span class="w"> </span>-d<span class="w"> </span>dpage/pgadmin4
|
| 463 |
+
</pre></div>
|
| 464 |
+
</div>
|
| 465 |
+
</section>
|
| 466 |
+
</section>
|
| 467 |
+
</section>
|
| 468 |
+
|
| 469 |
+
|
| 470 |
+
<div class="clearer"></div>
|
| 471 |
+
</div>
|
| 472 |
+
</div>
|
| 473 |
+
</div>
|
| 474 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 475 |
+
<div class="sphinxsidebarwrapper">
|
| 476 |
+
<div>
|
| 477 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 478 |
+
<ul>
|
| 479 |
+
<li><a class="reference internal" href="#">Container Deployment</a><ul>
|
| 480 |
+
<li><a class="reference internal" href="#postgresql-utilities">PostgreSQL Utilities</a></li>
|
| 481 |
+
<li><a class="reference internal" href="#environment-variables">Environment Variables</a></li>
|
| 482 |
+
<li><a class="reference internal" href="#mapped-files-and-directories">Mapped Files and Directories</a></li>
|
| 483 |
+
<li><a class="reference internal" href="#examples">Examples</a></li>
|
| 484 |
+
<li><a class="reference internal" href="#reverse-proxying">Reverse Proxying</a><ul>
|
| 485 |
+
<li><a class="reference internal" href="#pgadmin-x-forwarded-configuration">pgAdmin X-Forwarded-* Configuration</a></li>
|
| 486 |
+
<li><a class="reference internal" href="#http-via-nginx">HTTP via Nginx</a></li>
|
| 487 |
+
<li><a class="reference internal" href="#https-via-nginx">HTTPS via Nginx</a></li>
|
| 488 |
+
<li><a class="reference internal" href="#traefik">Traefik</a></li>
|
| 489 |
+
</ul>
|
| 490 |
+
</li>
|
| 491 |
+
</ul>
|
| 492 |
+
</li>
|
| 493 |
+
</ul>
|
| 494 |
+
|
| 495 |
+
</div>
|
| 496 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 497 |
+
<ul class="current">
|
| 498 |
+
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| 499 |
+
<li class="toctree-l2 current"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
| 500 |
+
<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| 501 |
+
<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| 502 |
+
<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| 503 |
+
<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
|
| 504 |
+
<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
|
| 505 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| 506 |
+
<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| 507 |
+
<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| 508 |
+
<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| 509 |
+
<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| 510 |
+
<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| 511 |
+
<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| 512 |
+
<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| 513 |
+
<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| 514 |
+
<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| 515 |
+
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| 516 |
+
<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| 517 |
+
<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| 518 |
+
</ul>
|
| 519 |
+
</li>
|
| 520 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 521 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 522 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 523 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 524 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 525 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 526 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 527 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 528 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 529 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 530 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 531 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 532 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 533 |
+
</ul>
|
| 534 |
+
|
| 535 |
+
<search id="searchbox" style="display: none" role="search">
|
| 536 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 537 |
+
<div class="searchformwrapper">
|
| 538 |
+
<form class="search" action="search.html" method="get">
|
| 539 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 540 |
+
<input type="submit" value="Go" />
|
| 541 |
+
</form>
|
| 542 |
+
</div>
|
| 543 |
+
</search>
|
| 544 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 545 |
+
</div>
|
| 546 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 547 |
+
<span>«</span>
|
| 548 |
+
</div>
|
| 549 |
+
|
| 550 |
+
</div>
|
| 551 |
+
<div class="clearer"></div>
|
| 552 |
+
</div>
|
| 553 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 554 |
+
<h3>Navigation</h3>
|
| 555 |
+
<ul>
|
| 556 |
+
<li class="right" style="margin-right: 10px">
|
| 557 |
+
<a href="genindex.html" title="General Index"
|
| 558 |
+
>index</a></li>
|
| 559 |
+
<li class="right" >
|
| 560 |
+
<a href="login.html" title="Login Page"
|
| 561 |
+
>next</a> |</li>
|
| 562 |
+
<li class="right" >
|
| 563 |
+
<a href="server_deployment.html" title="Server Deployment"
|
| 564 |
+
>previous</a> |</li>
|
| 565 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 566 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 567 |
+
<li class="nav-item nav-item-2"><a href="deployment.html" >Deployment</a> »</li>
|
| 568 |
+
<li class="nav-item nav-item-this"><a href="">Container Deployment</a></li>
|
| 569 |
+
</ul>
|
| 570 |
+
</div>
|
| 571 |
+
<div class="footer" role="contentinfo">
|
| 572 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 573 |
+
<ul>
|
| 574 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 575 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 576 |
+
<li class="right" ><a href="login.html" title="Login Page" accesskey="N">next</a> |</li>
|
| 577 |
+
<li class="right" ><a href="server_deployment.html" title="Server Deployment" accesskey="P">previous</a> |</li>
|
| 578 |
+
</ul>
|
| 579 |
+
</div>
|
| 580 |
+
</div>
|
| 581 |
+
</body>
|
| 582 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/contributions.html
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>pgAdmin Project Contributions — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Submitting Pull Requests" href="submitting_pull_requests.html" />
|
| 23 |
+
<link rel="prev" title="Creating a pgAgent Job" href="pgagent_jobs.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="submitting_pull_requests.html" title="Submitting Pull Requests"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="pgagent_jobs.html" title="Creating a pgAgent Job"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-this"><a href="">pgAdmin Project Contributions</a></li>
|
| 39 |
+
</ul>
|
| 40 |
+
</div>
|
| 41 |
+
|
| 42 |
+
<div class="document">
|
| 43 |
+
<div class="documentwrapper">
|
| 44 |
+
<div class="bodywrapper">
|
| 45 |
+
<div class="body" role="main">
|
| 46 |
+
|
| 47 |
+
<section id="pgadmin-project-contributions">
|
| 48 |
+
<span id="contributions"></span><h1><span class="target" id="index-0"></span>pgAdmin Project Contributions<a class="headerlink" href="#pgadmin-project-contributions" title="Link to this heading">¶</a></h1>
|
| 49 |
+
<p>pgAdmin is an open-source project that invites you to get involved in the
|
| 50 |
+
development process. For more information about contributing to the pgAdmin
|
| 51 |
+
project, contact the developers on the pgAdmin mailing list
|
| 52 |
+
<a class="reference external" href="mailto:pgadmin-hackers%40postgresql.org">pgadmin-hackers<span>@</span>postgresql<span>.</span>org</a> to discuss any ideas you might have for
|
| 53 |
+
enhancements or bug fixes.</p>
|
| 54 |
+
<p>In the following sections, you’ll find detailed information about the
|
| 55 |
+
development process used to develop, improve, and maintain the pgAdmin client.</p>
|
| 56 |
+
<div class="toctree-wrapper compound">
|
| 57 |
+
<ul>
|
| 58 |
+
<li class="toctree-l1"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
|
| 59 |
+
<li class="toctree-l1"><a class="reference internal" href="code_overview.html">Code Overview</a><ul>
|
| 60 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html#runtime">Runtime</a></li>
|
| 61 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html#web-application">Web Application</a><ul>
|
| 62 |
+
<li class="toctree-l3"><a class="reference internal" href="code_overview.html#configuration">Configuration</a></li>
|
| 63 |
+
<li class="toctree-l3"><a class="reference internal" href="code_overview.html#user-settings">User Settings</a></li>
|
| 64 |
+
</ul>
|
| 65 |
+
</li>
|
| 66 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html#pgadmin-core">pgAdmin Core</a></li>
|
| 67 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html#modules">Modules</a></li>
|
| 68 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html#nodes">Nodes</a></li>
|
| 69 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html#front-end">Front End</a></li>
|
| 70 |
+
</ul>
|
| 71 |
+
</li>
|
| 72 |
+
<li class="toctree-l1"><a class="reference internal" href="coding_standards.html">Coding Standards</a><ul>
|
| 73 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html#general">General</a></li>
|
| 74 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html#css-3">CSS 3</a></li>
|
| 75 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html#html-5">HTML 5</a></li>
|
| 76 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html#javascript">Javascript</a></li>
|
| 77 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html#python">Python</a></li>
|
| 78 |
+
</ul>
|
| 79 |
+
</li>
|
| 80 |
+
<li class="toctree-l1"><a class="reference internal" href="code_snippets.html">Code Snippets</a><ul>
|
| 81 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html#pgadminmodule">PgAdminModule</a></li>
|
| 82 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html#nodeview">NodeView</a></li>
|
| 83 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html#basedriver">BaseDriver</a></li>
|
| 84 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html#baseconnection">BaseConnection</a></li>
|
| 85 |
+
</ul>
|
| 86 |
+
</li>
|
| 87 |
+
<li class="toctree-l1"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
|
| 88 |
+
<li class="toctree-l1"><a class="reference internal" href="translations.html">Translations</a><ul>
|
| 89 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html#translation-marking">Translation Marking</a></li>
|
| 90 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html#updating-and-merging">Updating and Merging</a></li>
|
| 91 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html#adding-a-new-language">Adding a New Language</a></li>
|
| 92 |
+
</ul>
|
| 93 |
+
</li>
|
| 94 |
+
</ul>
|
| 95 |
+
</div>
|
| 96 |
+
</section>
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
<div class="clearer"></div>
|
| 100 |
+
</div>
|
| 101 |
+
</div>
|
| 102 |
+
</div>
|
| 103 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 104 |
+
<div class="sphinxsidebarwrapper">
|
| 105 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 106 |
+
<ul class="current">
|
| 107 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 108 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 109 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 110 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 111 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 113 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 114 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 115 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 116 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 118 |
+
<li class="toctree-l1 current"><a class="current reference internal" href="#">pgAdmin Project Contributions</a><ul>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="submitting_pull_requests.html">Submitting Pull Requests</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="code_overview.html">Code Overview</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="coding_standards.html">Coding Standards</a></li>
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="code_snippets.html">Code Snippets</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="code_review.html">Code Review Notes</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="translations.html">Translations</a></li>
|
| 125 |
+
</ul>
|
| 126 |
+
</li>
|
| 127 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 128 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 129 |
+
</ul>
|
| 130 |
+
|
| 131 |
+
<search id="searchbox" style="display: none" role="search">
|
| 132 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 133 |
+
<div class="searchformwrapper">
|
| 134 |
+
<form class="search" action="search.html" method="get">
|
| 135 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 136 |
+
<input type="submit" value="Go" />
|
| 137 |
+
</form>
|
| 138 |
+
</div>
|
| 139 |
+
</search>
|
| 140 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 141 |
+
</div>
|
| 142 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 143 |
+
<span>«</span>
|
| 144 |
+
</div>
|
| 145 |
+
|
| 146 |
+
</div>
|
| 147 |
+
<div class="clearer"></div>
|
| 148 |
+
</div>
|
| 149 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 150 |
+
<h3>Navigation</h3>
|
| 151 |
+
<ul>
|
| 152 |
+
<li class="right" style="margin-right: 10px">
|
| 153 |
+
<a href="genindex.html" title="General Index"
|
| 154 |
+
>index</a></li>
|
| 155 |
+
<li class="right" >
|
| 156 |
+
<a href="submitting_pull_requests.html" title="Submitting Pull Requests"
|
| 157 |
+
>next</a> |</li>
|
| 158 |
+
<li class="right" >
|
| 159 |
+
<a href="pgagent_jobs.html" title="Creating a pgAgent Job"
|
| 160 |
+
>previous</a> |</li>
|
| 161 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 162 |
+
<li class="nav-item nav-item-this"><a href="">pgAdmin Project Contributions</a></li>
|
| 163 |
+
</ul>
|
| 164 |
+
</div>
|
| 165 |
+
<div class="footer" role="contentinfo">
|
| 166 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 167 |
+
<ul>
|
| 168 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 169 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 170 |
+
<li class="right" ><a href="submitting_pull_requests.html" title="Submitting Pull Requests" accesskey="N">next</a> |</li>
|
| 171 |
+
<li class="right" ><a href="pgagent_jobs.html" title="Creating a pgAgent Job" accesskey="P">previous</a> |</li>
|
| 172 |
+
</ul>
|
| 173 |
+
</div>
|
| 174 |
+
</div>
|
| 175 |
+
</body>
|
| 176 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/database_dialog.html
ADDED
|
@@ -0,0 +1,255 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Database Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Resource Group Dialog" href="resource_group_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Managing Cluster Objects" href="managing_cluster_objects.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="resource_group_dialog.html" title="Resource Group Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="managing_cluster_objects.html" title="Managing Cluster Objects"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_cluster_objects.html" accesskey="U">Managing Cluster Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Database Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="database-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Database Dialog<a class="headerlink" href="#database-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Database</em> dialog to define or modify a database. To create a database,
|
| 51 |
+
you must be a database superuser or have the CREATE privilege.</p>
|
| 52 |
+
<p>The <em>Database</em> dialog organizes the development of a database through the
|
| 53 |
+
following dialog tabs: <em>General</em>, <em>Definition</em>, <em>Security</em>, and <em>Parameters</em>.
|
| 54 |
+
The <em>SQL</em> tab displays the SQL code generated by dialog selections.</p>
|
| 55 |
+
<img alt="Database dialog general tab" class="align-center" src="_images/database_general.png" />
|
| 56 |
+
<p>Use the fields in the <em>General</em> tab to identify the database:</p>
|
| 57 |
+
<ul class="simple">
|
| 58 |
+
<li><p>Use the <em>Database</em> field to add a descriptive name for the database. The name
|
| 59 |
+
will be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 60 |
+
<li><p>Use the <em>OID</em> field to specify the object identifier to be used for the new
|
| 61 |
+
database. Users can specify the value greater than 16383. This option is available
|
| 62 |
+
from v15 and above.</p></li>
|
| 63 |
+
<li><p>Select the owner of the database from the drop-down listbox in the <em>Owner</em>
|
| 64 |
+
field.</p></li>
|
| 65 |
+
<li><p>Store notes about the database in the <em>Comment</em> field.</p></li>
|
| 66 |
+
</ul>
|
| 67 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 68 |
+
<img alt="Database dialog definition tab" class="align-center" src="_images/database_definition.png" />
|
| 69 |
+
<p>Use the <em>Definition</em> tab to set properties for the database:</p>
|
| 70 |
+
<ul class="simple">
|
| 71 |
+
<li><p>Select a character set from the drop-down listbox in the <em>Encoding</em> field.
|
| 72 |
+
The default is <em>UTF8</em>.</p></li>
|
| 73 |
+
<li><p>Select a template from the drop-down listbox in the <em>Template</em> field. If you
|
| 74 |
+
do not specify a template, the database will use template1.</p></li>
|
| 75 |
+
<li><p>Select a tablespace from the drop-down listbox in the <em>Tablespace</em> field. The
|
| 76 |
+
selected tablespace will be the default tablespace used to contain database
|
| 77 |
+
objects.</p></li>
|
| 78 |
+
<li><p>Select the strategy from the drop-down listbox in the <em>Strategy</em> field while
|
| 79 |
+
creating a new database. This option is available from v15 and above.</p></li>
|
| 80 |
+
<li><p>Select the locale provider from the drop-down listbox in the <em>Locale Provider</em>
|
| 81 |
+
field to set the default collation for this database. Possible values are: icu, libc.
|
| 82 |
+
This option is available from v15 and above.</p></li>
|
| 83 |
+
<li><p>Select the collation order from the drop-down listbox in the <em>Collation</em> field.</p></li>
|
| 84 |
+
<li><p>Select the character classification from the drop-down listbox in the
|
| 85 |
+
<em>Character Type</em> field. This affects the categorization of characters, e.g.
|
| 86 |
+
lower, upper and digit. The default, or a blank field, uses the character
|
| 87 |
+
classification of the template database.</p></li>
|
| 88 |
+
<li><p>Select the icu locale from the drop-down listbox in the <em>ICU Locale</em> to
|
| 89 |
+
specifies the ICU locale ID if the ICU locale provider is used.
|
| 90 |
+
This option is available from v15 and above.</p></li>
|
| 91 |
+
<li><p>Specify the icu rules in the <em>ICU Rules</em> field as additional collation
|
| 92 |
+
rules to customize the behavior of the default collation of this database.
|
| 93 |
+
This option is available from v16 and above.</p></li>
|
| 94 |
+
<li><p>Specify a connection limit in the <em>Connection Limit</em> field to configure the
|
| 95 |
+
maximum number of connection requests. The default value (<em>-1</em>) allows
|
| 96 |
+
unlimited connections to the database.</p></li>
|
| 97 |
+
<li><p>If the <em>templates?</em> is set to true, then database will be a template database.</p></li>
|
| 98 |
+
</ul>
|
| 99 |
+
<p>Click the <em>Security</em> tab to continue.</p>
|
| 100 |
+
<img alt="Database dialog security tab" class="align-center" src="_images/database_security.png" />
|
| 101 |
+
<p>Use the <em>Security</em> tab to assign privileges and define security labels.</p>
|
| 102 |
+
<p>Use the <em>Privileges</em> panel to assign privileges to a role. Click the <em>Add</em> icon
|
| 103 |
+
(+) to set privileges for database objects:</p>
|
| 104 |
+
<ul class="simple">
|
| 105 |
+
<li><p>Select the name of the role from the drop-down listbox in the <em>Grantee</em> field.</p></li>
|
| 106 |
+
<li><p>Click inside the <em>Privileges</em> field. Check the boxes to the left of one or
|
| 107 |
+
more privileges to grant the selected privilege to the specified user.</p></li>
|
| 108 |
+
<li><p>The current user, who is the default grantor for granting the privilege, is displayed in the <em>Grantor</em> field.</p></li>
|
| 109 |
+
</ul>
|
| 110 |
+
<p>Click add to set additional privileges; to discard a privilege, click the trash
|
| 111 |
+
icon to the left of the row and confirm deletion in the <em>Delete Row</em> popup.</p>
|
| 112 |
+
<p>Use the <em>Security Labels</em> panel to define security labels applied to the
|
| 113 |
+
database. Click the <em>Add</em> icon (+) to add each security label selection:</p>
|
| 114 |
+
<ul class="simple">
|
| 115 |
+
<li><p>Specify a security label provider in the <em>Provider</em> field. The named provider
|
| 116 |
+
must be loaded and must consent to the proposed labeling operation.</p></li>
|
| 117 |
+
<li><p>Specify a a security label in the <em>Security Label</em> field. The meaning of a
|
| 118 |
+
given label is at the discretion of the label provider. PostgreSQL places no
|
| 119 |
+
restrictions on whether or how a label provider must interpret security
|
| 120 |
+
labels; it merely provides a mechanism for storing them.</p></li>
|
| 121 |
+
</ul>
|
| 122 |
+
<p>To discard a security label, click the trash icon to the left of the row and
|
| 123 |
+
confirm deletion in the <em>Delete Row</em> popup.</p>
|
| 124 |
+
<p>Click the <em>Parameters</em> tab to continue.</p>
|
| 125 |
+
<img alt="Database dialog parameters tab" class="align-center" src="_images/database_parameters.png" />
|
| 126 |
+
<p>Use the <em>Parameters</em> tab to set parameters for the database. Click the <em>Add</em>
|
| 127 |
+
icon (+) to add each parameter:</p>
|
| 128 |
+
<ul class="simple">
|
| 129 |
+
<li><p>Use the drop-down listbox in the <em>Name</em> field to select a parameter.</p></li>
|
| 130 |
+
<li><p>Use the <em>Value</em> field to set a value for the parameter.</p></li>
|
| 131 |
+
<li><p>Use the drop-down listbox next to <em>Role</em> to select a role to which the
|
| 132 |
+
parameter setting specified will apply.</p></li>
|
| 133 |
+
</ul>
|
| 134 |
+
<p>Follow these steps to add additional parameter value definitions; to discard a
|
| 135 |
+
parameter, click the trash icon to the left of the row and confirm deletion in
|
| 136 |
+
the <em>Delete Row</em> popup.</p>
|
| 137 |
+
<p>Click the <em>Advanced</em> tab to continue.</p>
|
| 138 |
+
<img alt="Database dialog advanced tab" class="align-center" src="_images/database_advanced.png" />
|
| 139 |
+
<p>Use the <em>Advanced</em> tab to set advanced parameters for the database.</p>
|
| 140 |
+
<ul class="simple">
|
| 141 |
+
<li><p>Use <em>Schema restriction</em> field to provide a SQL restriction that will be used
|
| 142 |
+
against the pg_namespace table to limit the schemas that you see.
|
| 143 |
+
For example, you might enter: <em>public</em> so that only <em>public</em> are shown in
|
| 144 |
+
the pgAdmin browser.Separate entries with a comma or tab as you type.</p></li>
|
| 145 |
+
</ul>
|
| 146 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 147 |
+
<p>Your entries in the <em>Database</em> dialog generate a SQL command (see an example
|
| 148 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 149 |
+
to the SQL command.</p>
|
| 150 |
+
<section id="example">
|
| 151 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 152 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 153 |
+
the <em>Database</em> dialog:</p>
|
| 154 |
+
<img alt="Database dialog sql tab" class="align-center" src="_images/database_sql.png" />
|
| 155 |
+
<p>The example creates a database named <em>hr</em> that is owned by <em>postgres</em>. It
|
| 156 |
+
allows unlimited connections, and is available to all authenticated users.</p>
|
| 157 |
+
<ul class="simple">
|
| 158 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 159 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 160 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 161 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 162 |
+
</ul>
|
| 163 |
+
</section>
|
| 164 |
+
</section>
|
| 165 |
+
|
| 166 |
+
|
| 167 |
+
<div class="clearer"></div>
|
| 168 |
+
</div>
|
| 169 |
+
</div>
|
| 170 |
+
</div>
|
| 171 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 172 |
+
<div class="sphinxsidebarwrapper">
|
| 173 |
+
<div>
|
| 174 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 175 |
+
<ul>
|
| 176 |
+
<li><a class="reference internal" href="#">Database Dialog</a><ul>
|
| 177 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 178 |
+
</ul>
|
| 179 |
+
</li>
|
| 180 |
+
</ul>
|
| 181 |
+
|
| 182 |
+
</div>
|
| 183 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 184 |
+
<ul class="current">
|
| 185 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 186 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 187 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 188 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a><ul class="current">
|
| 189 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Database Dialog</a></li>
|
| 190 |
+
<li class="toctree-l2"><a class="reference internal" href="resource_group_dialog.html">Resource Group Dialog</a></li>
|
| 191 |
+
<li class="toctree-l2"><a class="reference internal" href="role_dialog.html">Login/Group Role Dialog</a></li>
|
| 192 |
+
<li class="toctree-l2"><a class="reference internal" href="tablespace_dialog.html">Tablespace Dialog</a></li>
|
| 193 |
+
<li class="toctree-l2"><a class="reference internal" href="replica_nodes_dialog.html">Replica Node Dialog</a></li>
|
| 194 |
+
<li class="toctree-l2"><a class="reference internal" href="role_reassign_dialog.html">Role Reassign/Drop Own Dialog</a></li>
|
| 195 |
+
</ul>
|
| 196 |
+
</li>
|
| 197 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 198 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 199 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 200 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 201 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 202 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 203 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 204 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 205 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 206 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 207 |
+
</ul>
|
| 208 |
+
|
| 209 |
+
<search id="searchbox" style="display: none" role="search">
|
| 210 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 211 |
+
<div class="searchformwrapper">
|
| 212 |
+
<form class="search" action="search.html" method="get">
|
| 213 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 214 |
+
<input type="submit" value="Go" />
|
| 215 |
+
</form>
|
| 216 |
+
</div>
|
| 217 |
+
</search>
|
| 218 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 219 |
+
</div>
|
| 220 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 221 |
+
<span>«</span>
|
| 222 |
+
</div>
|
| 223 |
+
|
| 224 |
+
</div>
|
| 225 |
+
<div class="clearer"></div>
|
| 226 |
+
</div>
|
| 227 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 228 |
+
<h3>Navigation</h3>
|
| 229 |
+
<ul>
|
| 230 |
+
<li class="right" style="margin-right: 10px">
|
| 231 |
+
<a href="genindex.html" title="General Index"
|
| 232 |
+
>index</a></li>
|
| 233 |
+
<li class="right" >
|
| 234 |
+
<a href="resource_group_dialog.html" title="Resource Group Dialog"
|
| 235 |
+
>next</a> |</li>
|
| 236 |
+
<li class="right" >
|
| 237 |
+
<a href="managing_cluster_objects.html" title="Managing Cluster Objects"
|
| 238 |
+
>previous</a> |</li>
|
| 239 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 240 |
+
<li class="nav-item nav-item-1"><a href="managing_cluster_objects.html" >Managing Cluster Objects</a> »</li>
|
| 241 |
+
<li class="nav-item nav-item-this"><a href="">Database Dialog</a></li>
|
| 242 |
+
</ul>
|
| 243 |
+
</div>
|
| 244 |
+
<div class="footer" role="contentinfo">
|
| 245 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 246 |
+
<ul>
|
| 247 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 248 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 249 |
+
<li class="right" ><a href="resource_group_dialog.html" title="Resource Group Dialog" accesskey="N">next</a> |</li>
|
| 250 |
+
<li class="right" ><a href="managing_cluster_objects.html" title="Managing Cluster Objects" accesskey="P">previous</a> |</li>
|
| 251 |
+
</ul>
|
| 252 |
+
</div>
|
| 253 |
+
</div>
|
| 254 |
+
</body>
|
| 255 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/dbms_job.html
ADDED
|
@@ -0,0 +1,227 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>DBMS Job — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="DBMS Program" href="dbms_program.html" />
|
| 23 |
+
<link rel="prev" title="Using EDB Job Scheduler" href="dbms_job_scheduler.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="dbms_program.html" title="DBMS Program"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="dbms_job_scheduler.html" title="Using EDB Job Scheduler"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="dbms_job_scheduler.html" accesskey="U">Using EDB Job Scheduler</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">DBMS Job</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="dbms-job">
|
| 50 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>DBMS Job<a class="headerlink" href="#dbms-job" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>Use the <em>DBMS Job</em> dialog to create a DBMS Job.</p>
|
| 52 |
+
<img alt="DBMS Job dialog general tab" class="align-center" src="_images/dbms_job_general.png" />
|
| 53 |
+
<p>Use the fields in the <em>General</em> tab to create job:</p>
|
| 54 |
+
<ul class="simple">
|
| 55 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the job. The name will
|
| 56 |
+
be displayed in the <em>pgAdmin</em> object explorer.</p></li>
|
| 57 |
+
<li><p>Use the <em>Enabled?</em> switch to indicate that job should be enabled or disabled.</p></li>
|
| 58 |
+
<li><p>Use the <em>Job Type</em> field to select the type of the job. Type could be SELF-CONTAINED or PRE-DEFINED.
|
| 59 |
+
If the Job Type is Self-Contained you need to specify the action and repeat interval in the Action and Repeat tabs respectively.
|
| 60 |
+
If the Job Type is Pre-Defined you need to specify the existing Program and Schedule names in the Pre-Defined tab.</p></li>
|
| 61 |
+
<li><p>Store notes about the job in the <em>Comment</em> field.</p></li>
|
| 62 |
+
</ul>
|
| 63 |
+
<p>Click the <em>Action</em> tab to continue.</p>
|
| 64 |
+
<img alt="DBMS Job dialog action tab" class="align-center" src="_images/dbms_job_action.png" />
|
| 65 |
+
<p>Use the <em>Action</em> tab to select the action for the job. This tab is only enabled when the job type is ‘SELF-CONTAINED’.</p>
|
| 66 |
+
<ul class="simple">
|
| 67 |
+
<li><p>Use the <em>Type</em> field to select the type of the job. Type could be PLSQL BLOCK or STORED PROCEDURE.</p></li>
|
| 68 |
+
<li><p>Use the <em>Procedure</em> field to select an existing procedure that executes when the job is invoked.</p></li>
|
| 69 |
+
<li><p><em>Number of Arguments</em> field is read-only and indicates the quantity of arguments necessary for the chosen procedure.</p></li>
|
| 70 |
+
</ul>
|
| 71 |
+
<p>Click the <em>Code</em> tab to continue.</p>
|
| 72 |
+
<img alt="DBMS Job dialog code tab" class="align-center" src="_images/dbms_job_code.png" />
|
| 73 |
+
<ul class="simple">
|
| 74 |
+
<li><p>Use the <em>Code</em> field to write the code that executes when the job is invoked.
|
| 75 |
+
This tab is only enabled when the job type is ‘SELF-CONTAINED’ and type of the action is set to ‘PLSQL BLOCK’.</p></li>
|
| 76 |
+
</ul>
|
| 77 |
+
<p>Click the <em>Arguments</em> tab to continue.</p>
|
| 78 |
+
<img alt="DBMS Job dialog arguments tab" class="align-center" src="_images/dbms_job_arguments.png" />
|
| 79 |
+
<ul class="simple">
|
| 80 |
+
<li><p><em>Arguments</em> tab outlines the arguments required by the selected procedure in the ‘Action’ tab. This tab is only enabled when the job type is ‘SELF-CONTAINED’.</p></li>
|
| 81 |
+
</ul>
|
| 82 |
+
<p>Click the <em>Repeat</em> tab to continue.</p>
|
| 83 |
+
<img alt="DBMS Job dialog repeat tab" class="align-center" src="_images/dbms_job_repeat.png" />
|
| 84 |
+
<p>Use the <em>Repeat</em> tab to select the repeat interval for the job. This tab is only enabled when the job type is ‘SELF-CONTAINED’.</p>
|
| 85 |
+
<ul class="simple">
|
| 86 |
+
<li><p>Use the calendar selector in the <em>Start</em> field to specify the starting date
|
| 87 |
+
and time for the job.</p></li>
|
| 88 |
+
<li><p>Use the calendar selector in the <em>End</em> field to specify the ending date and
|
| 89 |
+
time for the job.</p></li>
|
| 90 |
+
<li><p>Use the <em>Frequency</em> field to select the frequency. Frequency is one of the following:
|
| 91 |
+
YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY.</p></li>
|
| 92 |
+
<li><p>Use the <em>Date</em> field to select the date on which job will execute.Date is YYYYMMDD.</p></li>
|
| 93 |
+
<li><p>Use the <em>Months</em> field to select the months in which the job will execute.</p></li>
|
| 94 |
+
<li><p>Use the <em>Week Days</em> field to select the days on which the job will execute.</p></li>
|
| 95 |
+
<li><p>Use the <em>Month Days</em> field to select the numeric days on which the job will
|
| 96 |
+
execute.</p></li>
|
| 97 |
+
<li><p>Use the <em>Hours</em> field to select the hour at which the job will execute.</p></li>
|
| 98 |
+
<li><p>Use the <em>Minutes</em> field to select the minute at which the job will execute.</p></li>
|
| 99 |
+
</ul>
|
| 100 |
+
<p>Click the <em>Pre-Defined</em> tab to continue.</p>
|
| 101 |
+
<img alt="DBMS Job dialog predefined tab" class="align-center" src="_images/dbms_job_predefined.png" />
|
| 102 |
+
<p>Use the <em>Pre-Defined</em> tab to select the existing program and schedule to create the job.
|
| 103 |
+
This tab is only enabled when the job type is ‘PRE-DEFINED’.</p>
|
| 104 |
+
<ul class="simple">
|
| 105 |
+
<li><p>Use the <em>Program Name</em> field to select the existing program.</p></li>
|
| 106 |
+
<li><p>Use the <em>Schedule Name</em> field to select an existing schedule.</p></li>
|
| 107 |
+
</ul>
|
| 108 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 109 |
+
<p>Your entries in the <em>DBMS Job</em> dialog generate a SQL command (see an example below).
|
| 110 |
+
Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes to the
|
| 111 |
+
SQL command.</p>
|
| 112 |
+
<p><strong>Example</strong></p>
|
| 113 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 114 |
+
the <em>DBMS Job</em> dialog:</p>
|
| 115 |
+
<img alt="DBMS Job dialog sql tab" class="align-center" src="_images/dbms_job_sql.png" />
|
| 116 |
+
<ul class="simple">
|
| 117 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 118 |
+
<li><p>Click the <em>Help</em> button (?) to access dialog help.</p></li>
|
| 119 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 120 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 121 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 122 |
+
</ul>
|
| 123 |
+
</section>
|
| 124 |
+
|
| 125 |
+
|
| 126 |
+
<div class="clearer"></div>
|
| 127 |
+
</div>
|
| 128 |
+
</div>
|
| 129 |
+
</div>
|
| 130 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 131 |
+
<div class="sphinxsidebarwrapper">
|
| 132 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 133 |
+
<ul class="current">
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 135 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 136 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 137 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 138 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 139 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 140 |
+
<li class="toctree-l2 current"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 142 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 143 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 144 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 145 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 146 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 147 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 148 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 149 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 150 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 151 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 152 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 153 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 154 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 155 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 156 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 157 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 158 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 159 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 160 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 161 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 162 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 163 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 164 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 165 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 166 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 167 |
+
</ul>
|
| 168 |
+
</li>
|
| 169 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 170 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 171 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 172 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 173 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 174 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 175 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 176 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 177 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 178 |
+
</ul>
|
| 179 |
+
|
| 180 |
+
<search id="searchbox" style="display: none" role="search">
|
| 181 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 182 |
+
<div class="searchformwrapper">
|
| 183 |
+
<form class="search" action="search.html" method="get">
|
| 184 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 185 |
+
<input type="submit" value="Go" />
|
| 186 |
+
</form>
|
| 187 |
+
</div>
|
| 188 |
+
</search>
|
| 189 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 190 |
+
</div>
|
| 191 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 192 |
+
<span>«</span>
|
| 193 |
+
</div>
|
| 194 |
+
|
| 195 |
+
</div>
|
| 196 |
+
<div class="clearer"></div>
|
| 197 |
+
</div>
|
| 198 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 199 |
+
<h3>Navigation</h3>
|
| 200 |
+
<ul>
|
| 201 |
+
<li class="right" style="margin-right: 10px">
|
| 202 |
+
<a href="genindex.html" title="General Index"
|
| 203 |
+
>index</a></li>
|
| 204 |
+
<li class="right" >
|
| 205 |
+
<a href="dbms_program.html" title="DBMS Program"
|
| 206 |
+
>next</a> |</li>
|
| 207 |
+
<li class="right" >
|
| 208 |
+
<a href="dbms_job_scheduler.html" title="Using EDB Job Scheduler"
|
| 209 |
+
>previous</a> |</li>
|
| 210 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 211 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 212 |
+
<li class="nav-item nav-item-2"><a href="dbms_job_scheduler.html" >Using EDB Job Scheduler</a> »</li>
|
| 213 |
+
<li class="nav-item nav-item-this"><a href="">DBMS Job</a></li>
|
| 214 |
+
</ul>
|
| 215 |
+
</div>
|
| 216 |
+
<div class="footer" role="contentinfo">
|
| 217 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 218 |
+
<ul>
|
| 219 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 220 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 221 |
+
<li class="right" ><a href="dbms_program.html" title="DBMS Program" accesskey="N">next</a> |</li>
|
| 222 |
+
<li class="right" ><a href="dbms_job_scheduler.html" title="Using EDB Job Scheduler" accesskey="P">previous</a> |</li>
|
| 223 |
+
</ul>
|
| 224 |
+
</div>
|
| 225 |
+
</div>
|
| 226 |
+
</body>
|
| 227 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/dbms_job_scheduler.html
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Using EDB Job Scheduler — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="DBMS Job" href="dbms_job.html" />
|
| 23 |
+
<link rel="prev" title="Cast Dialog" href="cast_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="dbms_job.html" title="DBMS Job"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="cast_dialog.html" title="Cast Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Using EDB Job Scheduler</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="using-edb-job-scheduler">
|
| 49 |
+
<span id="dbms-job-scheduler"></span><h1><span class="target" id="index-0"></span>Using EDB Job Scheduler<a class="headerlink" href="#using-edb-job-scheduler" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>In the past versions of EPAS, DBMS_SCHEDULER or DBMS_JOBS required the configuration
|
| 51 |
+
of pgAgent, an essential service for their functionality. Maintaining pgAgent in a
|
| 52 |
+
production environment is cumbersome. The need for correct configuration, regular updates,
|
| 53 |
+
and ensuring the service’s health added complexity.</p>
|
| 54 |
+
<p>EPAS 16 revolutionizes job scheduling by eliminating the need for the pgAgent component.
|
| 55 |
+
The new version introduces EDB Job Scheduler which is an extension that runs the job scheduler
|
| 56 |
+
as a background process for the DBMS_SCHEDULER and DBMS_JOB packages.</p>
|
| 57 |
+
<p>The EDB Job Scheduler has a scheduler process that starts when the database cluster starts.
|
| 58 |
+
To start the scheduler process, load the EDB Job Scheduler extension using the <strong>shared_preload_libraries</strong>
|
| 59 |
+
parameter. After you load the extension, create the extension <strong>‘edb_job_scheduler’</strong> and <strong>‘dbms_scheduler’</strong> using
|
| 60 |
+
the CREATE EXTENSION command. The database in which you’re creating the extension must be listed in the
|
| 61 |
+
<strong>edb_job_scheduler.database_list</strong> parameter.</p>
|
| 62 |
+
<p>Instructions for configuring the EDB Job Scheduler can be found in the
|
| 63 |
+
<a class="reference external" href="https://www.enterprisedb.com/docs/pg_extensions/edb_job_scheduler/configuring/">Configuring EDB Job Scheduler</a>.</p>
|
| 64 |
+
<img alt="DBMS Job Scheduler Object Browser" class="align-center" src="_images/dbms_job_scheduler.png" />
|
| 65 |
+
<section id="check-the-status-of-all-the-jobs">
|
| 66 |
+
<h2>Check the status of all the jobs<a class="headerlink" href="#check-the-status-of-all-the-jobs" title="Link to this heading">¶</a></h2>
|
| 67 |
+
<p>To check the running status of all the jobs select the ‘DBMS Job Scheduler’ collection node from the object
|
| 68 |
+
explorer and select the Properties tab.</p>
|
| 69 |
+
<img alt="DBMS Job Details" class="align-center" src="_images/dbms_job_details.png" />
|
| 70 |
+
<div class="toctree-wrapper compound">
|
| 71 |
+
<ul>
|
| 72 |
+
<li class="toctree-l1"><a class="reference internal" href="dbms_job.html">DBMS Job</a></li>
|
| 73 |
+
<li class="toctree-l1"><a class="reference internal" href="dbms_program.html">DBMS Program</a></li>
|
| 74 |
+
<li class="toctree-l1"><a class="reference internal" href="dbms_schedule.html">DBMS Schedule</a></li>
|
| 75 |
+
</ul>
|
| 76 |
+
</div>
|
| 77 |
+
</section>
|
| 78 |
+
</section>
|
| 79 |
+
|
| 80 |
+
|
| 81 |
+
<div class="clearer"></div>
|
| 82 |
+
</div>
|
| 83 |
+
</div>
|
| 84 |
+
</div>
|
| 85 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 86 |
+
<div class="sphinxsidebarwrapper">
|
| 87 |
+
<div>
|
| 88 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 89 |
+
<ul>
|
| 90 |
+
<li><a class="reference internal" href="#">Using EDB Job Scheduler</a><ul>
|
| 91 |
+
<li><a class="reference internal" href="#check-the-status-of-all-the-jobs">Check the status of all the jobs</a></li>
|
| 92 |
+
</ul>
|
| 93 |
+
</li>
|
| 94 |
+
</ul>
|
| 95 |
+
|
| 96 |
+
</div>
|
| 97 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 98 |
+
<ul class="current">
|
| 99 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 100 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 101 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 102 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 103 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 104 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 105 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Using EDB Job Scheduler</a></li>
|
| 106 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 107 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 108 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 109 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 110 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 111 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 112 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 113 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 114 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 115 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 116 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 117 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 118 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 132 |
+
</ul>
|
| 133 |
+
</li>
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 135 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 136 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 137 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 139 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 140 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 142 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 143 |
+
</ul>
|
| 144 |
+
|
| 145 |
+
<search id="searchbox" style="display: none" role="search">
|
| 146 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 147 |
+
<div class="searchformwrapper">
|
| 148 |
+
<form class="search" action="search.html" method="get">
|
| 149 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 150 |
+
<input type="submit" value="Go" />
|
| 151 |
+
</form>
|
| 152 |
+
</div>
|
| 153 |
+
</search>
|
| 154 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 155 |
+
</div>
|
| 156 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 157 |
+
<span>«</span>
|
| 158 |
+
</div>
|
| 159 |
+
|
| 160 |
+
</div>
|
| 161 |
+
<div class="clearer"></div>
|
| 162 |
+
</div>
|
| 163 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 164 |
+
<h3>Navigation</h3>
|
| 165 |
+
<ul>
|
| 166 |
+
<li class="right" style="margin-right: 10px">
|
| 167 |
+
<a href="genindex.html" title="General Index"
|
| 168 |
+
>index</a></li>
|
| 169 |
+
<li class="right" >
|
| 170 |
+
<a href="dbms_job.html" title="DBMS Job"
|
| 171 |
+
>next</a> |</li>
|
| 172 |
+
<li class="right" >
|
| 173 |
+
<a href="cast_dialog.html" title="Cast Dialog"
|
| 174 |
+
>previous</a> |</li>
|
| 175 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 176 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 177 |
+
<li class="nav-item nav-item-this"><a href="">Using EDB Job Scheduler</a></li>
|
| 178 |
+
</ul>
|
| 179 |
+
</div>
|
| 180 |
+
<div class="footer" role="contentinfo">
|
| 181 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 182 |
+
<ul>
|
| 183 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 184 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 185 |
+
<li class="right" ><a href="dbms_job.html" title="DBMS Job" accesskey="N">next</a> |</li>
|
| 186 |
+
<li class="right" ><a href="cast_dialog.html" title="Cast Dialog" accesskey="P">previous</a> |</li>
|
| 187 |
+
</ul>
|
| 188 |
+
</div>
|
| 189 |
+
</div>
|
| 190 |
+
</body>
|
| 191 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/dbms_program.html
ADDED
|
@@ -0,0 +1,198 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>DBMS Program — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="DBMS Schedule" href="dbms_schedule.html" />
|
| 23 |
+
<link rel="prev" title="DBMS Job" href="dbms_job.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="dbms_schedule.html" title="DBMS Schedule"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="dbms_job.html" title="DBMS Job"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="dbms_job_scheduler.html" accesskey="U">Using EDB Job Scheduler</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">DBMS Program</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="dbms-program">
|
| 50 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>DBMS Program<a class="headerlink" href="#dbms-program" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>Use the <em>DBMS Program</em> dialog to create a DBMS Program.</p>
|
| 52 |
+
<img alt="DBMS Program dialog general tab" class="align-center" src="_images/dbms_program_general.png" />
|
| 53 |
+
<p>Use the fields in the <em>General</em> tab to create program:</p>
|
| 54 |
+
<ul class="simple">
|
| 55 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the program. The name will
|
| 56 |
+
be displayed in the <em>pgAdmin</em> object explorer.</p></li>
|
| 57 |
+
<li><p>Use the <em>Enabled?</em> switch to indicate that program should be enabled or disabled.</p></li>
|
| 58 |
+
<li><p>Store notes about the program in the <em>Comment</em> field.</p></li>
|
| 59 |
+
</ul>
|
| 60 |
+
<p>Click the <em>Action</em> tab to continue.</p>
|
| 61 |
+
<img alt="DBMS Program dialog action tab" class="align-center" src="_images/dbms_program_action.png" />
|
| 62 |
+
<p>Use the <em>Action</em> tab to select the action for the program:</p>
|
| 63 |
+
<ul class="simple">
|
| 64 |
+
<li><p>Use the <em>Type</em> field to select the type of the program. Type could be PLSQL BLOCK or STORED PROCEDURE.</p></li>
|
| 65 |
+
<li><p>Use the <em>Procedure</em> field to select an existing procedure that executes when the program is invoked.</p></li>
|
| 66 |
+
<li><p><em>Number of Arguments</em> field is read-only and indicates the quantity of arguments necessary for the chosen procedure.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
<p>Click the <em>Code</em> tab to continue.</p>
|
| 69 |
+
<img alt="DBMS Program dialog code tab" class="align-center" src="_images/dbms_program_code.png" />
|
| 70 |
+
<ul class="simple">
|
| 71 |
+
<li><p>Use the <em>Code</em> field to write the code that executes when the program is invoked.
|
| 72 |
+
This tab is only enabled when the type of the program is set to ‘PLSQL BLOCK’.</p></li>
|
| 73 |
+
</ul>
|
| 74 |
+
<p>Click the <em>Arguments</em> tab to continue.</p>
|
| 75 |
+
<img alt="DBMS Program dialog arguments tab" class="align-center" src="_images/dbms_program_arguments.png" />
|
| 76 |
+
<ul class="simple">
|
| 77 |
+
<li><p><em>Arguments</em> tab is a read-only section that outlines the arguments required by the selected procedure in the ‘Action’ tab.</p></li>
|
| 78 |
+
</ul>
|
| 79 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 80 |
+
<p>Your entries in the <em>DBMS Program</em> dialog generate a SQL command (see an example below).
|
| 81 |
+
Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes to the
|
| 82 |
+
SQL command.</p>
|
| 83 |
+
<p><strong>Example</strong></p>
|
| 84 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 85 |
+
the <em>DBMS Program</em> dialog:</p>
|
| 86 |
+
<img alt="DBMS Program dialog sql tab" class="align-center" src="_images/dbms_program_sql.png" />
|
| 87 |
+
<ul class="simple">
|
| 88 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 89 |
+
<li><p>Click the <em>Help</em> button (?) to access dialog help.</p></li>
|
| 90 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 91 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 92 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 93 |
+
</ul>
|
| 94 |
+
</section>
|
| 95 |
+
|
| 96 |
+
|
| 97 |
+
<div class="clearer"></div>
|
| 98 |
+
</div>
|
| 99 |
+
</div>
|
| 100 |
+
</div>
|
| 101 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 102 |
+
<div class="sphinxsidebarwrapper">
|
| 103 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 104 |
+
<ul class="current">
|
| 105 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 107 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 108 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 109 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 110 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 111 |
+
<li class="toctree-l2 current"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 112 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 113 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 114 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 115 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 116 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 117 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 118 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 132 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 138 |
+
</ul>
|
| 139 |
+
</li>
|
| 140 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 142 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 143 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 144 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 147 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 149 |
+
</ul>
|
| 150 |
+
|
| 151 |
+
<search id="searchbox" style="display: none" role="search">
|
| 152 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 153 |
+
<div class="searchformwrapper">
|
| 154 |
+
<form class="search" action="search.html" method="get">
|
| 155 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 156 |
+
<input type="submit" value="Go" />
|
| 157 |
+
</form>
|
| 158 |
+
</div>
|
| 159 |
+
</search>
|
| 160 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 161 |
+
</div>
|
| 162 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 163 |
+
<span>«</span>
|
| 164 |
+
</div>
|
| 165 |
+
|
| 166 |
+
</div>
|
| 167 |
+
<div class="clearer"></div>
|
| 168 |
+
</div>
|
| 169 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 170 |
+
<h3>Navigation</h3>
|
| 171 |
+
<ul>
|
| 172 |
+
<li class="right" style="margin-right: 10px">
|
| 173 |
+
<a href="genindex.html" title="General Index"
|
| 174 |
+
>index</a></li>
|
| 175 |
+
<li class="right" >
|
| 176 |
+
<a href="dbms_schedule.html" title="DBMS Schedule"
|
| 177 |
+
>next</a> |</li>
|
| 178 |
+
<li class="right" >
|
| 179 |
+
<a href="dbms_job.html" title="DBMS Job"
|
| 180 |
+
>previous</a> |</li>
|
| 181 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 182 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 183 |
+
<li class="nav-item nav-item-2"><a href="dbms_job_scheduler.html" >Using EDB Job Scheduler</a> »</li>
|
| 184 |
+
<li class="nav-item nav-item-this"><a href="">DBMS Program</a></li>
|
| 185 |
+
</ul>
|
| 186 |
+
</div>
|
| 187 |
+
<div class="footer" role="contentinfo">
|
| 188 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 189 |
+
<ul>
|
| 190 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 191 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 192 |
+
<li class="right" ><a href="dbms_schedule.html" title="DBMS Schedule" accesskey="N">next</a> |</li>
|
| 193 |
+
<li class="right" ><a href="dbms_job.html" title="DBMS Job" accesskey="P">previous</a> |</li>
|
| 194 |
+
</ul>
|
| 195 |
+
</div>
|
| 196 |
+
</div>
|
| 197 |
+
</body>
|
| 198 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/dbms_schedule.html
ADDED
|
@@ -0,0 +1,196 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>DBMS Schedule — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Collation Dialog" href="collation_dialog.html" />
|
| 23 |
+
<link rel="prev" title="DBMS Program" href="dbms_program.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="collation_dialog.html" title="Collation Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="dbms_program.html" title="DBMS Program"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="dbms_job_scheduler.html" accesskey="U">Using EDB Job Scheduler</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">DBMS Schedule</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="dbms-schedule">
|
| 50 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>DBMS Schedule<a class="headerlink" href="#dbms-schedule" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>Use the <em>DBMS Schedule</em> dialog to create a DBMS Schedule.</p>
|
| 52 |
+
<img alt="DBMS Schedule dialog general tab" class="align-center" src="_images/dbms_schedule_general.png" />
|
| 53 |
+
<p>Use the fields in the <em>General</em> tab to create schedule:</p>
|
| 54 |
+
<ul class="simple">
|
| 55 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the schedule. The name will
|
| 56 |
+
be displayed in the <em>pgAdmin</em> object explorer.</p></li>
|
| 57 |
+
<li><p>Store notes about the schedule in the <em>Comment</em> field.</p></li>
|
| 58 |
+
</ul>
|
| 59 |
+
<p>Click the <em>Repeat</em> tab to continue.</p>
|
| 60 |
+
<img alt="DBMS Schedule dialog repeat tab" class="align-center" src="_images/dbms_schedule_repeat.png" />
|
| 61 |
+
<p>Use the <em>Repeat</em> tab to select the repeat interval for the schedule:</p>
|
| 62 |
+
<ul class="simple">
|
| 63 |
+
<li><p>Use the calendar selector in the <em>Start</em> field to specify the starting date
|
| 64 |
+
and time for the schedule.</p></li>
|
| 65 |
+
<li><p>Use the calendar selector in the <em>End</em> field to specify the ending date and
|
| 66 |
+
time for the schedule.</p></li>
|
| 67 |
+
<li><p>Use the <em>Frequency</em> field to select the frequency. Frequency is one of the following:
|
| 68 |
+
YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY.</p></li>
|
| 69 |
+
<li><p>Use the <em>Date</em> field to select the date on which schedule will execute.Date is YYYYMMDD.</p></li>
|
| 70 |
+
<li><p>Use the <em>Months</em> field to select the months in which the schedule will execute.</p></li>
|
| 71 |
+
<li><p>Use the <em>Week Days</em> field to select the days on which the schedule will execute.</p></li>
|
| 72 |
+
<li><p>Use the <em>Month Days</em> field to select the numeric days on which the schedule will
|
| 73 |
+
execute.</p></li>
|
| 74 |
+
<li><p>Use the <em>Hours</em> field to select the hour at which the schedule will execute.</p></li>
|
| 75 |
+
<li><p>Use the <em>Minutes</em> field to select the minute at which the schedule will execute.</p></li>
|
| 76 |
+
</ul>
|
| 77 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 78 |
+
<p>Your entries in the <em>DBMS Schedule</em> dialog generate a SQL command (see an example below).
|
| 79 |
+
Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes to the
|
| 80 |
+
SQL command.</p>
|
| 81 |
+
<p><strong>Example</strong></p>
|
| 82 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 83 |
+
the <em>DBMS Schedule</em> dialog:</p>
|
| 84 |
+
<img alt="DBMS Schedule dialog sql tab" class="align-center" src="_images/dbms_schedule_sql.png" />
|
| 85 |
+
<ul class="simple">
|
| 86 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 87 |
+
<li><p>Click the <em>Help</em> button (?) to access dialog help.</p></li>
|
| 88 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 89 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 90 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 91 |
+
</ul>
|
| 92 |
+
</section>
|
| 93 |
+
|
| 94 |
+
|
| 95 |
+
<div class="clearer"></div>
|
| 96 |
+
</div>
|
| 97 |
+
</div>
|
| 98 |
+
</div>
|
| 99 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 100 |
+
<div class="sphinxsidebarwrapper">
|
| 101 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 102 |
+
<ul class="current">
|
| 103 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 104 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 105 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 106 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 107 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 108 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 109 |
+
<li class="toctree-l2 current"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 110 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 111 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 112 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 113 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 114 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 115 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 116 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 117 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 118 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 132 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 136 |
+
</ul>
|
| 137 |
+
</li>
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 139 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 140 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 142 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 143 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 144 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 145 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 146 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 147 |
+
</ul>
|
| 148 |
+
|
| 149 |
+
<search id="searchbox" style="display: none" role="search">
|
| 150 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 151 |
+
<div class="searchformwrapper">
|
| 152 |
+
<form class="search" action="search.html" method="get">
|
| 153 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 154 |
+
<input type="submit" value="Go" />
|
| 155 |
+
</form>
|
| 156 |
+
</div>
|
| 157 |
+
</search>
|
| 158 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 159 |
+
</div>
|
| 160 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 161 |
+
<span>«</span>
|
| 162 |
+
</div>
|
| 163 |
+
|
| 164 |
+
</div>
|
| 165 |
+
<div class="clearer"></div>
|
| 166 |
+
</div>
|
| 167 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 168 |
+
<h3>Navigation</h3>
|
| 169 |
+
<ul>
|
| 170 |
+
<li class="right" style="margin-right: 10px">
|
| 171 |
+
<a href="genindex.html" title="General Index"
|
| 172 |
+
>index</a></li>
|
| 173 |
+
<li class="right" >
|
| 174 |
+
<a href="collation_dialog.html" title="Collation Dialog"
|
| 175 |
+
>next</a> |</li>
|
| 176 |
+
<li class="right" >
|
| 177 |
+
<a href="dbms_program.html" title="DBMS Program"
|
| 178 |
+
>previous</a> |</li>
|
| 179 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 180 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 181 |
+
<li class="nav-item nav-item-2"><a href="dbms_job_scheduler.html" >Using EDB Job Scheduler</a> »</li>
|
| 182 |
+
<li class="nav-item nav-item-this"><a href="">DBMS Schedule</a></li>
|
| 183 |
+
</ul>
|
| 184 |
+
</div>
|
| 185 |
+
<div class="footer" role="contentinfo">
|
| 186 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 187 |
+
<ul>
|
| 188 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 189 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 190 |
+
<li class="right" ><a href="collation_dialog.html" title="Collation Dialog" accesskey="N">next</a> |</li>
|
| 191 |
+
<li class="right" ><a href="dbms_program.html" title="DBMS Program" accesskey="P">previous</a> |</li>
|
| 192 |
+
</ul>
|
| 193 |
+
</div>
|
| 194 |
+
</div>
|
| 195 |
+
</body>
|
| 196 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/debugger.html
ADDED
|
@@ -0,0 +1,278 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Debugger — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Query Tool" href="query_tool.html" />
|
| 23 |
+
<link rel="prev" title="Developer Tools" href="developer_tools.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="query_tool.html" title="Query Tool"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="developer_tools.html" title="Developer Tools"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="developer_tools.html" accesskey="U">Developer Tools</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Debugger</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="debugger">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Debugger<a class="headerlink" href="#debugger" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<img alt="Debugger page" class="align-center" src="_images/debug_main.png" />
|
| 51 |
+
<p>The debugger may be used to debug PL/pgSQL functions in PostgreSQL, as well as
|
| 52 |
+
EDB-SPL functions, stored procedures and packages in EDB Postgres Advanced
|
| 53 |
+
Server. The Debugger is available as an extension for your PostgreSQL
|
| 54 |
+
installation, and is distributed as part of Advanced Server. You must have
|
| 55 |
+
superuser privileges to use the debugger.</p>
|
| 56 |
+
<p>Before using the debugger, you must modify the <em>postgresql.conf</em> file, adding
|
| 57 |
+
the server-side debugger components to the value of the
|
| 58 |
+
<em>shared_preload_libraries</em> parameter, for example:</p>
|
| 59 |
+
<blockquote>
|
| 60 |
+
<div><p>shared_preload_libraries = ‘$libdir/plugin_debugger’</p>
|
| 61 |
+
</div></blockquote>
|
| 62 |
+
<p>After modifying the <em>shared_preload_libraries</em> parameter, restart the server to
|
| 63 |
+
apply the changes.</p>
|
| 64 |
+
<p>The debugger may be used for either in-context debugging or direct debugging of
|
| 65 |
+
a target function or procedure. When you use the debugger for in-context
|
| 66 |
+
debugging, you set a breakpoint at the first line of a program; when a session
|
| 67 |
+
invokes the target, control is transferred to the debugger. When using direct
|
| 68 |
+
debugging, the debugger prompts you for any parameters required by the target,
|
| 69 |
+
and then allows you to step through the code.</p>
|
| 70 |
+
<section id="in-context-debugging">
|
| 71 |
+
<h2>In-context Debugging<a class="headerlink" href="#in-context-debugging" title="Link to this heading">¶</a></h2>
|
| 72 |
+
<p>To set a breakpoint at the first line of a program, right-click the name of the
|
| 73 |
+
object you would like to debug, and select <em>Set breakpoint</em> from the <em>Debugging</em>
|
| 74 |
+
sub-menu. The debugger window will open, waiting for another session to invoke
|
| 75 |
+
the program.</p>
|
| 76 |
+
<img alt="Debugger set a breakpoint demo" class="align-center" src="_images/debug_set_breakpoint.png" />
|
| 77 |
+
<p>When another session invokes the target, the debugger will display the code,
|
| 78 |
+
allowing you to add break points, or step through line-by-line. The other
|
| 79 |
+
session is suspended until the debugging completes; then control is returned
|
| 80 |
+
to the session.</p>
|
| 81 |
+
<img alt="Debugger step-in demo" class="align-center" src="_images/debug_ic_step_in.png" />
|
| 82 |
+
</section>
|
| 83 |
+
<section id="direct-debugging">
|
| 84 |
+
<h2>Direct Debugging<a class="headerlink" href="#direct-debugging" title="Link to this heading">¶</a></h2>
|
| 85 |
+
<p>To use the debugger for direct debugging, right click on the name of the object
|
| 86 |
+
that you wish to debug in the pgAdmin tree control and select <em>Debug</em> from the
|
| 87 |
+
<em>Debugging</em> sub-menu. The debugger window will open, prompting you for any
|
| 88 |
+
values required by the program:</p>
|
| 89 |
+
<img alt="Debugger parameter dialog" src="_images/debug_params.png" />
|
| 90 |
+
<p>Use the fields on the <em>Debugger</em> dialog to provide a value for each parameter:</p>
|
| 91 |
+
<blockquote>
|
| 92 |
+
<div><ul class="simple">
|
| 93 |
+
<li><p>The <em>Name</em> field contains the formal parameter name.</p></li>
|
| 94 |
+
<li><p>The <em>Type</em> field contains the parameter data type.</p></li>
|
| 95 |
+
<li><p>Check the <em>Null?</em> checkbox to indicate that the parameter is a NULL value.</p></li>
|
| 96 |
+
<li><p>Check the <em>Expression?</em> checkbox if the Value field contains an expression.</p></li>
|
| 97 |
+
<li><p>Use the <em>Value</em> field to provide the parameter value that will be passed to
|
| 98 |
+
the program. When entering parameter values, type the value into the
|
| 99 |
+
appropriate cell on the grid, or, leave the cell empty to represent NULL,
|
| 100 |
+
enter ‘’ (two single quotes) to represent an empty string, or to enter a
|
| 101 |
+
literal string consisting of just two single quotes, enter ''. PostgreSQL
|
| 102 |
+
8.4 and above supports variadic function parameters. These may be entered as
|
| 103 |
+
a comma-delimited list of values, quoted and/or cast as required.</p></li>
|
| 104 |
+
<li><p>Check the <em>Use default?</em> checkbox to indicate that the program should use
|
| 105 |
+
the value in the Default Value field.</p></li>
|
| 106 |
+
<li><p>The <em>Default Value</em> field contains the default value of the parameter.</p></li>
|
| 107 |
+
</ul>
|
| 108 |
+
</div></blockquote>
|
| 109 |
+
<p>Provide values required by the program, and click the <em>Debug</em> button to start
|
| 110 |
+
stepping through the program.
|
| 111 |
+
The values of the arguments provided here are saved. The values will be pre-filled
|
| 112 |
+
next time the dialog opens. To clear the values, use the <em>Clear All</em> button.</p>
|
| 113 |
+
<img alt="Debugger step-in demo" class="align-center" src="_images/debug_step_in.png" />
|
| 114 |
+
</section>
|
| 115 |
+
<section id="using-the-debugger">
|
| 116 |
+
<h2>Using the Debugger<a class="headerlink" href="#using-the-debugger" title="Link to this heading">¶</a></h2>
|
| 117 |
+
<p>The main debugger window consists of two panels and a context-sensitive toolbar.
|
| 118 |
+
Use toolbar icons to manage breakpoints and step into or through code; hover
|
| 119 |
+
over an icon for a tooltip that identifies the option associated with the icon.
|
| 120 |
+
The toolbar options are:</p>
|
| 121 |
+
<img alt="Debugger navigation toolbar" class="align-center" src="_images/debug_toolbar.png" />
|
| 122 |
+
<table class="docutils align-default">
|
| 123 |
+
<thead>
|
| 124 |
+
<tr class="row-odd"><th class="head"><p>Option</p></th>
|
| 125 |
+
<th class="head"><p>Action</p></th>
|
| 126 |
+
</tr>
|
| 127 |
+
</thead>
|
| 128 |
+
<tbody>
|
| 129 |
+
<tr class="row-even"><td><p><em>Step into</em></p></td>
|
| 130 |
+
<td><p>Click the <em>Step into</em> icon to execute the currently highlighted line of code.</p></td>
|
| 131 |
+
</tr>
|
| 132 |
+
<tr class="row-odd"><td><p><em>Step over</em></p></td>
|
| 133 |
+
<td><p>Click the <em>Step over</em> icon to execute a line of code, stepping over any sub-functions invoked by the code.
|
| 134 |
+
The sub-function executes, but is not debugged unless it contains a breakpoint.</p></td>
|
| 135 |
+
</tr>
|
| 136 |
+
<tr class="row-even"><td><p><em>Continue/Start</em></p></td>
|
| 137 |
+
<td><p>Click the <em>Continue/Start</em> icon to execute the highlighted code, and continue until the program
|
| 138 |
+
encounters a breakpoint or completes.</p></td>
|
| 139 |
+
</tr>
|
| 140 |
+
<tr class="row-odd"><td><p><em>Toggle breakpoint</em></p></td>
|
| 141 |
+
<td><p>Use the <em>Toggle breakpoint</em> icon to enable or disable a breakpoint (without removing the breakpoint).</p></td>
|
| 142 |
+
</tr>
|
| 143 |
+
<tr class="row-even"><td><p><em>Clear all breakpoints</em></p></td>
|
| 144 |
+
<td><p>Click the <em>Clear all breakpoints</em> icon to remove all breakpoints from the program.</p></td>
|
| 145 |
+
</tr>
|
| 146 |
+
<tr class="row-odd"><td><p><em>Stop</em></p></td>
|
| 147 |
+
<td><p>Click the <em>Stop</em> icon to halt the execution of a program.</p></td>
|
| 148 |
+
</tr>
|
| 149 |
+
<tr class="row-even"><td><p><em>Help</em></p></td>
|
| 150 |
+
<td><p>Click the <em>Help</em> icon to open debugger documentation.</p></td>
|
| 151 |
+
</tr>
|
| 152 |
+
</tbody>
|
| 153 |
+
</table>
|
| 154 |
+
<p>The top panel of the debugger window displays the program body; click in the
|
| 155 |
+
grey margin next to a line number to add a breakpoint. The highlighted line in
|
| 156 |
+
the top panel is the line that is about to execute.</p>
|
| 157 |
+
<img alt="Debugger main window" class="align-center" src="_images/debug_main.png" />
|
| 158 |
+
<p>The lower panel of the debugger window provides a set of tabs that allow you to
|
| 159 |
+
review information about the program:</p>
|
| 160 |
+
<blockquote>
|
| 161 |
+
<div><ul class="simple">
|
| 162 |
+
<li><p>The <em>Parameters</em> tab displays the value of each parameter.</p></li>
|
| 163 |
+
<li><p>The <em>Local</em> variables tab displays the current value of the program variables.</p></li>
|
| 164 |
+
<li><p>The <em>Messages</em> tab displays any messages returned by the server (errors,
|
| 165 |
+
warnings and informational messages).</p></li>
|
| 166 |
+
<li><p>The <em>Results</em> tab displays the server message when the program completes.</p></li>
|
| 167 |
+
<li><p>The <em>Stack</em> tab displays the list of functions that have been invoked, but
|
| 168 |
+
which have not yet completed.</p></li>
|
| 169 |
+
</ul>
|
| 170 |
+
</div></blockquote>
|
| 171 |
+
<p>As you step through a program, the <em>Local variables</em> tab displays the current
|
| 172 |
+
value of each variable:</p>
|
| 173 |
+
<img alt="Debugger local variables tab" class="align-center" src="_images/debug_variables.png" />
|
| 174 |
+
<p>When you step into a subroutine, the <em>Stack</em> tab displays the call stack,
|
| 175 |
+
including the name of each caller, the parameter values for each caller (if
|
| 176 |
+
any), and the line number within each caller:</p>
|
| 177 |
+
<img alt="Debugger local stack tab" class="align-center" src="_images/debug_stack.png" />
|
| 178 |
+
<p>Select a caller to change focus to that stack frame and display the state of
|
| 179 |
+
the caller in the upper panel.</p>
|
| 180 |
+
<p>When the program completes, the <em>Results</em> tab displays the message returned by
|
| 181 |
+
the server. If the program encounters an error, the <em>Messages</em> tab displays
|
| 182 |
+
details:</p>
|
| 183 |
+
<img alt="Debugger error message" class="align-center" src="_images/debug_error_message.png" />
|
| 184 |
+
</section>
|
| 185 |
+
</section>
|
| 186 |
+
|
| 187 |
+
|
| 188 |
+
<div class="clearer"></div>
|
| 189 |
+
</div>
|
| 190 |
+
</div>
|
| 191 |
+
</div>
|
| 192 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 193 |
+
<div class="sphinxsidebarwrapper">
|
| 194 |
+
<div>
|
| 195 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 196 |
+
<ul>
|
| 197 |
+
<li><a class="reference internal" href="#">Debugger</a><ul>
|
| 198 |
+
<li><a class="reference internal" href="#in-context-debugging">In-context Debugging</a></li>
|
| 199 |
+
<li><a class="reference internal" href="#direct-debugging">Direct Debugging</a></li>
|
| 200 |
+
<li><a class="reference internal" href="#using-the-debugger">Using the Debugger</a></li>
|
| 201 |
+
</ul>
|
| 202 |
+
</li>
|
| 203 |
+
</ul>
|
| 204 |
+
|
| 205 |
+
</div>
|
| 206 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 207 |
+
<ul class="current">
|
| 208 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 209 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 210 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 211 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 212 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 213 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 214 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 215 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 216 |
+
<li class="toctree-l1 current"><a class="reference internal" href="developer_tools.html">Developer Tools</a><ul class="current">
|
| 217 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Debugger</a></li>
|
| 218 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html">Query Tool</a></li>
|
| 219 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html">View/Edit Data</a></li>
|
| 220 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_diff.html">Schema Diff</a></li>
|
| 221 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html">ERD Tool</a></li>
|
| 222 |
+
<li class="toctree-l2"><a class="reference internal" href="psql_tool.html">PSQL Tool</a></li>
|
| 223 |
+
</ul>
|
| 224 |
+
</li>
|
| 225 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 226 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 227 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 228 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 229 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 230 |
+
</ul>
|
| 231 |
+
|
| 232 |
+
<search id="searchbox" style="display: none" role="search">
|
| 233 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 234 |
+
<div class="searchformwrapper">
|
| 235 |
+
<form class="search" action="search.html" method="get">
|
| 236 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 237 |
+
<input type="submit" value="Go" />
|
| 238 |
+
</form>
|
| 239 |
+
</div>
|
| 240 |
+
</search>
|
| 241 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 242 |
+
</div>
|
| 243 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 244 |
+
<span>«</span>
|
| 245 |
+
</div>
|
| 246 |
+
|
| 247 |
+
</div>
|
| 248 |
+
<div class="clearer"></div>
|
| 249 |
+
</div>
|
| 250 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 251 |
+
<h3>Navigation</h3>
|
| 252 |
+
<ul>
|
| 253 |
+
<li class="right" style="margin-right: 10px">
|
| 254 |
+
<a href="genindex.html" title="General Index"
|
| 255 |
+
>index</a></li>
|
| 256 |
+
<li class="right" >
|
| 257 |
+
<a href="query_tool.html" title="Query Tool"
|
| 258 |
+
>next</a> |</li>
|
| 259 |
+
<li class="right" >
|
| 260 |
+
<a href="developer_tools.html" title="Developer Tools"
|
| 261 |
+
>previous</a> |</li>
|
| 262 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 263 |
+
<li class="nav-item nav-item-1"><a href="developer_tools.html" >Developer Tools</a> »</li>
|
| 264 |
+
<li class="nav-item nav-item-this"><a href="">Debugger</a></li>
|
| 265 |
+
</ul>
|
| 266 |
+
</div>
|
| 267 |
+
<div class="footer" role="contentinfo">
|
| 268 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 269 |
+
<ul>
|
| 270 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 271 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 272 |
+
<li class="right" ><a href="query_tool.html" title="Query Tool" accesskey="N">next</a> |</li>
|
| 273 |
+
<li class="right" ><a href="developer_tools.html" title="Developer Tools" accesskey="P">previous</a> |</li>
|
| 274 |
+
</ul>
|
| 275 |
+
</div>
|
| 276 |
+
</div>
|
| 277 |
+
</body>
|
| 278 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/deployment.html
ADDED
|
@@ -0,0 +1,172 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="The config.py File" href="config_py.html" />
|
| 23 |
+
<link rel="prev" title="Getting Started" href="getting_started.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="config_py.html" title="The config.py File"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="getting_started.html" title="Getting Started"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" accesskey="U">Getting Started</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Deployment</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="deployment">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Deployment<a class="headerlink" href="#deployment" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Pre-compiled and configured installation packages for pgAdmin 4 are available
|
| 51 |
+
for a number of desktop environments; we recommend using an installer whenever
|
| 52 |
+
possible. If you are interested in learning more about the project, or if a
|
| 53 |
+
pgAdmin installer is not available for your environment, the pages listed below
|
| 54 |
+
will provide detailed information about creating a custom deployment.</p>
|
| 55 |
+
<div class="toctree-wrapper compound">
|
| 56 |
+
<ul>
|
| 57 |
+
<li class="toctree-l1"><a class="reference internal" href="config_py.html">The config.py File</a></li>
|
| 58 |
+
<li class="toctree-l1"><a class="reference internal" href="desktop_deployment.html">Desktop Deployment</a><ul>
|
| 59 |
+
<li class="toctree-l2"><a class="reference internal" href="desktop_deployment.html#configuration">Configuration</a></li>
|
| 60 |
+
</ul>
|
| 61 |
+
</li>
|
| 62 |
+
<li class="toctree-l1"><a class="reference internal" href="server_deployment.html">Server Deployment</a><ul>
|
| 63 |
+
<li class="toctree-l2"><a class="reference internal" href="server_deployment.html#requirements">Requirements</a></li>
|
| 64 |
+
<li class="toctree-l2"><a class="reference internal" href="server_deployment.html#configuration">Configuration</a></li>
|
| 65 |
+
<li class="toctree-l2"><a class="reference internal" href="server_deployment.html#hosting">Hosting</a></li>
|
| 66 |
+
</ul>
|
| 67 |
+
</li>
|
| 68 |
+
<li class="toctree-l1"><a class="reference internal" href="container_deployment.html">Container Deployment</a><ul>
|
| 69 |
+
<li class="toctree-l2"><a class="reference internal" href="container_deployment.html#postgresql-utilities">PostgreSQL Utilities</a></li>
|
| 70 |
+
<li class="toctree-l2"><a class="reference internal" href="container_deployment.html#environment-variables">Environment Variables</a></li>
|
| 71 |
+
<li class="toctree-l2"><a class="reference internal" href="container_deployment.html#mapped-files-and-directories">Mapped Files and Directories</a></li>
|
| 72 |
+
<li class="toctree-l2"><a class="reference internal" href="container_deployment.html#examples">Examples</a></li>
|
| 73 |
+
<li class="toctree-l2"><a class="reference internal" href="container_deployment.html#reverse-proxying">Reverse Proxying</a></li>
|
| 74 |
+
</ul>
|
| 75 |
+
</li>
|
| 76 |
+
</ul>
|
| 77 |
+
</div>
|
| 78 |
+
</section>
|
| 79 |
+
|
| 80 |
+
|
| 81 |
+
<div class="clearer"></div>
|
| 82 |
+
</div>
|
| 83 |
+
</div>
|
| 84 |
+
</div>
|
| 85 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 86 |
+
<div class="sphinxsidebarwrapper">
|
| 87 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 88 |
+
<ul class="current">
|
| 89 |
+
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| 90 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Deployment</a></li>
|
| 91 |
+
<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| 92 |
+
<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| 93 |
+
<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| 94 |
+
<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
|
| 95 |
+
<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
|
| 96 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| 97 |
+
<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| 98 |
+
<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| 99 |
+
<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| 100 |
+
<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| 101 |
+
<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| 102 |
+
<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| 103 |
+
<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| 104 |
+
<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| 105 |
+
<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| 106 |
+
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| 107 |
+
<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| 108 |
+
<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| 109 |
+
</ul>
|
| 110 |
+
</li>
|
| 111 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 112 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 113 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 114 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 115 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 116 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 119 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 120 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 121 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 122 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 123 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 124 |
+
</ul>
|
| 125 |
+
|
| 126 |
+
<search id="searchbox" style="display: none" role="search">
|
| 127 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 128 |
+
<div class="searchformwrapper">
|
| 129 |
+
<form class="search" action="search.html" method="get">
|
| 130 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 131 |
+
<input type="submit" value="Go" />
|
| 132 |
+
</form>
|
| 133 |
+
</div>
|
| 134 |
+
</search>
|
| 135 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 136 |
+
</div>
|
| 137 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 138 |
+
<span>«</span>
|
| 139 |
+
</div>
|
| 140 |
+
|
| 141 |
+
</div>
|
| 142 |
+
<div class="clearer"></div>
|
| 143 |
+
</div>
|
| 144 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 145 |
+
<h3>Navigation</h3>
|
| 146 |
+
<ul>
|
| 147 |
+
<li class="right" style="margin-right: 10px">
|
| 148 |
+
<a href="genindex.html" title="General Index"
|
| 149 |
+
>index</a></li>
|
| 150 |
+
<li class="right" >
|
| 151 |
+
<a href="config_py.html" title="The config.py File"
|
| 152 |
+
>next</a> |</li>
|
| 153 |
+
<li class="right" >
|
| 154 |
+
<a href="getting_started.html" title="Getting Started"
|
| 155 |
+
>previous</a> |</li>
|
| 156 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 157 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 158 |
+
<li class="nav-item nav-item-this"><a href="">Deployment</a></li>
|
| 159 |
+
</ul>
|
| 160 |
+
</div>
|
| 161 |
+
<div class="footer" role="contentinfo">
|
| 162 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 163 |
+
<ul>
|
| 164 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 165 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 166 |
+
<li class="right" ><a href="config_py.html" title="The config.py File" accesskey="N">next</a> |</li>
|
| 167 |
+
<li class="right" ><a href="getting_started.html" title="Getting Started" accesskey="P">previous</a> |</li>
|
| 168 |
+
</ul>
|
| 169 |
+
</div>
|
| 170 |
+
</div>
|
| 171 |
+
</body>
|
| 172 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/desktop_deployment.html
ADDED
|
@@ -0,0 +1,298 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Desktop Deployment — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Server Deployment" href="server_deployment.html" />
|
| 23 |
+
<link rel="prev" title="The config.py File" href="config_py.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="server_deployment.html" title="Server Deployment"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="config_py.html" title="The config.py File"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-2"><a href="deployment.html" accesskey="U">Deployment</a> »</li>
|
| 40 |
+
<li class="nav-item nav-item-this"><a href="">Desktop Deployment</a></li>
|
| 41 |
+
</ul>
|
| 42 |
+
</div>
|
| 43 |
+
|
| 44 |
+
<div class="document">
|
| 45 |
+
<div class="documentwrapper">
|
| 46 |
+
<div class="bodywrapper">
|
| 47 |
+
<div class="body" role="main">
|
| 48 |
+
|
| 49 |
+
<section id="desktop-deployment">
|
| 50 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Desktop Deployment<a class="headerlink" href="#desktop-deployment" title="Link to this heading">¶</a></h1>
|
| 51 |
+
<p>pgAdmin may be deployed as a desktop application by configuring the application
|
| 52 |
+
to run in desktop mode and then utilising the desktop runtime to host the
|
| 53 |
+
program on a supported Windows, Mac OS X or Linux installation.</p>
|
| 54 |
+
<p>The desktop runtime is a standalone application that when launched, runs the
|
| 55 |
+
pgAdmin server and opens a window to render the user interface.</p>
|
| 56 |
+
<div class="admonition note">
|
| 57 |
+
<p class="admonition-title">Note</p>
|
| 58 |
+
<p>Pre-compiled and configured installation packages are available for
|
| 59 |
+
a number of platforms. These packages should be used by end-users whereever
|
| 60 |
+
possible - the following information is useful for the maintainers of those
|
| 61 |
+
packages and users interested in understanding how pgAdmin works.</p>
|
| 62 |
+
</div>
|
| 63 |
+
<div class="admonition seealso">
|
| 64 |
+
<p class="admonition-title">See also</p>
|
| 65 |
+
<p>For detailed instructions on building and configuring pgAdmin from
|
| 66 |
+
scratch, please see the README file in the top level directory of the source code.
|
| 67 |
+
For convenience, you can find the latest version of the file
|
| 68 |
+
<a class="reference external" href="https://github.com/pgadmin-org/pgadmin4/blob/master/README.md">here</a>,
|
| 69 |
+
but be aware that this may differ from the version included with the source code
|
| 70 |
+
for a specific version of pgAdmin.</p>
|
| 71 |
+
</div>
|
| 72 |
+
<section id="configuration">
|
| 73 |
+
<h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h2>
|
| 74 |
+
<p>From pgAdmin 4 v2 onwards, the default configuration mode is server, however,
|
| 75 |
+
this is overridden by the desktop runtime at startup. In most environments, no
|
| 76 |
+
Python configuration is required unless you wish to override other default
|
| 77 |
+
settings.</p>
|
| 78 |
+
<p>See <a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">The config.py File</span></a> for more information on configuration settings.</p>
|
| 79 |
+
<section id="desktop-runtime-standalone-application">
|
| 80 |
+
<h3>Desktop Runtime Standalone Application<a class="headerlink" href="#desktop-runtime-standalone-application" title="Link to this heading">¶</a></h3>
|
| 81 |
+
<p>The Desktop Runtime is based on <a class="reference external" href="https://nwjs.io/">NWjs</a> which integrates a
|
| 82 |
+
browser and the Python server creating a standalone application.</p>
|
| 83 |
+
<img alt="Runtime Standalone" class="align-center" src="_images/runtime_standalone.png" />
|
| 84 |
+
<section id="runtime-menu">
|
| 85 |
+
<h4>Runtime Menu<a class="headerlink" href="#runtime-menu" title="Link to this heading">¶</a></h4>
|
| 86 |
+
<img alt="Runtime Menu" class="align-center" src="_images/runtime_menu.png" />
|
| 87 |
+
<p>Use the <em>File Menu</em> to access the <em>Runtime Menu</em>:</p>
|
| 88 |
+
<table class="docutils align-default">
|
| 89 |
+
<thead>
|
| 90 |
+
<tr class="row-odd"><th class="head"><p>Option</p></th>
|
| 91 |
+
<th class="head"><p>Action</p></th>
|
| 92 |
+
</tr>
|
| 93 |
+
</thead>
|
| 94 |
+
<tbody>
|
| 95 |
+
<tr class="row-even"><td><p><em>Configure…</em></p></td>
|
| 96 |
+
<td><p>Click to open configuration dialog to configure fixed port, port number and connection timeout.</p></td>
|
| 97 |
+
</tr>
|
| 98 |
+
<tr class="row-odd"><td><p><em>View log…</em></p></td>
|
| 99 |
+
<td><p>Click to open the view log dialog to view the pgAdmin 4 logs.</p></td>
|
| 100 |
+
</tr>
|
| 101 |
+
<tr class="row-even"><td><p><em>Enter Full Screen</em></p></td>
|
| 102 |
+
<td><p>Click to enter/exit the full screen mode. Keyboard Shortcuts: OSX (Cmd + Ctrl + F), Other OS (F10).</p></td>
|
| 103 |
+
</tr>
|
| 104 |
+
<tr class="row-odd"><td><p><em>Actual Size</em></p></td>
|
| 105 |
+
<td><p>Click to change the window size to it original size. Keyboard Shortcuts: OSX (Cmd + 0),
|
| 106 |
+
Other OS (Ctrl + 0).</p></td>
|
| 107 |
+
</tr>
|
| 108 |
+
<tr class="row-even"><td><p><em>Zoom In</em></p></td>
|
| 109 |
+
<td><p>Click to increase the zoom level. Keyboard Shortcuts: OSX (Cmd + +), Other OS (Ctrl + +).</p></td>
|
| 110 |
+
</tr>
|
| 111 |
+
<tr class="row-odd"><td><p><em>Zoom Out</em></p></td>
|
| 112 |
+
<td><p>Click to decrease the zoom level. Keyboard Shortcuts: OSX (Cmd + -), Other OS (Ctrl + -).</p></td>
|
| 113 |
+
</tr>
|
| 114 |
+
</tbody>
|
| 115 |
+
</table>
|
| 116 |
+
</section>
|
| 117 |
+
<section id="configuration-dialog">
|
| 118 |
+
<h4>Configuration Dialog<a class="headerlink" href="#configuration-dialog" title="Link to this heading">¶</a></h4>
|
| 119 |
+
<p>Use the <em>Runtime Menu</em> to access the <em>Configuration</em> dialog:</p>
|
| 120 |
+
<img alt="Runtime Configuration" class="align-center" src="_images/runtime_configuration.png" />
|
| 121 |
+
<p>Following are the details of the <em>Fixed port number?</em>, <em>Port Number</em>, <em>Connection
|
| 122 |
+
Timeout</em>, and ‘Open Documentation in Default Browser?’ configuration parameters:</p>
|
| 123 |
+
<table class="longtable docutils align-default">
|
| 124 |
+
<colgroup>
|
| 125 |
+
<col style="width: 28.6%" />
|
| 126 |
+
<col style="width: 14.3%" />
|
| 127 |
+
<col style="width: 57.1%" />
|
| 128 |
+
</colgroup>
|
| 129 |
+
<thead>
|
| 130 |
+
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
| 131 |
+
<th class="head"><p>Type</p></th>
|
| 132 |
+
<th class="head"><p>Purpose</p></th>
|
| 133 |
+
</tr>
|
| 134 |
+
</thead>
|
| 135 |
+
<tbody>
|
| 136 |
+
<tr class="row-even"><td><p>FixedPort</p></td>
|
| 137 |
+
<td><p>Boolean</p></td>
|
| 138 |
+
<td><p>Use a fixed network port number rather than a random one.</p></td>
|
| 139 |
+
</tr>
|
| 140 |
+
<tr class="row-odd"><td><p>PortNumber</p></td>
|
| 141 |
+
<td><p>Integer</p></td>
|
| 142 |
+
<td><p>The port number to use, if using a fixed port.</p></td>
|
| 143 |
+
</tr>
|
| 144 |
+
<tr class="row-even"><td><p>ConnectionTimeout</p></td>
|
| 145 |
+
<td><p>Integer</p></td>
|
| 146 |
+
<td><p>The number of seconds to wait for application server startup.</p></td>
|
| 147 |
+
</tr>
|
| 148 |
+
<tr class="row-odd"><td><p>Open Documentation in Default Browser</p></td>
|
| 149 |
+
<td><p>Boolean</p></td>
|
| 150 |
+
<td><p>By checking this option, all documentation links will open in
|
| 151 |
+
the default browser instead of in a new window.</p></td>
|
| 152 |
+
</tr>
|
| 153 |
+
</tbody>
|
| 154 |
+
</table>
|
| 155 |
+
</section>
|
| 156 |
+
<section id="log-dialog">
|
| 157 |
+
<h4>Log dialog<a class="headerlink" href="#log-dialog" title="Link to this heading">¶</a></h4>
|
| 158 |
+
<p>Use the <em>Runtime Menu</em> to access the <em>Log</em> dialog:</p>
|
| 159 |
+
<img alt="Runtime View Log" class="align-center" src="_images/runtime_view_log.png" />
|
| 160 |
+
<p>Click on the <em>Reload</em> button at the bottom to view the latest logs of pgAdmin 4
|
| 161 |
+
Server.</p>
|
| 162 |
+
<p>When executed, the runtime will automatically try to execute the pgAdmin Python
|
| 163 |
+
application. If execution fails, it will prompt you with error message
|
| 164 |
+
displaying a <em>Configure</em> button at the bottom. You can configure a fixed port
|
| 165 |
+
number to avoid clashes of the default random port number with other
|
| 166 |
+
applications and a connection timeout if desired.</p>
|
| 167 |
+
<img alt="Runtime Error" class="align-center" src="_images/runtime_error.png" />
|
| 168 |
+
<p>If the error is related to Python Path or pgAdmin Python file then you need to
|
| 169 |
+
create a file named ‘dev_config.json’ and specify the following entries:</p>
|
| 170 |
+
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
| 171 |
+
<span class="w"> </span><span class="nt">"pythonPath"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/path/to/python.exe"</span><span class="p">,</span>
|
| 172 |
+
<span class="w"> </span><span class="nt">"pgadminFile"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/path/to/pgAdmin4.py"</span>
|
| 173 |
+
<span class="p">}</span>
|
| 174 |
+
</pre></div>
|
| 175 |
+
</div>
|
| 176 |
+
<p>Note that the <em>dev_config.py</em> file should only be required by developers who are
|
| 177 |
+
working outside of a standard installation.</p>
|
| 178 |
+
<p>The configuration settings are stored in <em>runtime_config.json</em> file, which
|
| 179 |
+
will be available on Unix systems (~/.local/share/pgadmin/),
|
| 180 |
+
on Mac OS X (~/Library/Preferences/pgadmin),
|
| 181 |
+
and on Windows (%APPDATA%/pgadmin).</p>
|
| 182 |
+
</section>
|
| 183 |
+
</section>
|
| 184 |
+
</section>
|
| 185 |
+
</section>
|
| 186 |
+
|
| 187 |
+
|
| 188 |
+
<div class="clearer"></div>
|
| 189 |
+
</div>
|
| 190 |
+
</div>
|
| 191 |
+
</div>
|
| 192 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 193 |
+
<div class="sphinxsidebarwrapper">
|
| 194 |
+
<div>
|
| 195 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 196 |
+
<ul>
|
| 197 |
+
<li><a class="reference internal" href="#">Desktop Deployment</a><ul>
|
| 198 |
+
<li><a class="reference internal" href="#configuration">Configuration</a><ul>
|
| 199 |
+
<li><a class="reference internal" href="#desktop-runtime-standalone-application">Desktop Runtime Standalone Application</a><ul>
|
| 200 |
+
<li><a class="reference internal" href="#runtime-menu">Runtime Menu</a></li>
|
| 201 |
+
<li><a class="reference internal" href="#configuration-dialog">Configuration Dialog</a></li>
|
| 202 |
+
<li><a class="reference internal" href="#log-dialog">Log dialog</a></li>
|
| 203 |
+
</ul>
|
| 204 |
+
</li>
|
| 205 |
+
</ul>
|
| 206 |
+
</li>
|
| 207 |
+
</ul>
|
| 208 |
+
</li>
|
| 209 |
+
</ul>
|
| 210 |
+
|
| 211 |
+
</div>
|
| 212 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 213 |
+
<ul class="current">
|
| 214 |
+
<li class="toctree-l1 current"><a class="reference internal" href="getting_started.html">Getting Started</a><ul class="current">
|
| 215 |
+
<li class="toctree-l2 current"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
| 216 |
+
<li class="toctree-l2"><a class="reference internal" href="login.html">Login Page</a></li>
|
| 217 |
+
<li class="toctree-l2"><a class="reference internal" href="mfa.html">Enabling two-factor authentication (2FA)</a></li>
|
| 218 |
+
<li class="toctree-l2"><a class="reference internal" href="user_management.html">User Management Dialog</a></li>
|
| 219 |
+
<li class="toctree-l2"><a class="reference internal" href="change_ownership.html">Change Ownership Dialog</a></li>
|
| 220 |
+
<li class="toctree-l2"><a class="reference internal" href="change_user_password.html">Change User Password Dialog</a></li>
|
| 221 |
+
<li class="toctree-l2"><a class="reference internal" href="restore_locked_user.html">Lock/Restore Account</a></li>
|
| 222 |
+
<li class="toctree-l2"><a class="reference internal" href="ldap.html">Enabling LDAP Authentication</a></li>
|
| 223 |
+
<li class="toctree-l2"><a class="reference internal" href="kerberos.html">Enabling Kerberos Authentication</a></li>
|
| 224 |
+
<li class="toctree-l2"><a class="reference internal" href="oauth2.html">Enabling OAUTH2 Authentication</a></li>
|
| 225 |
+
<li class="toctree-l2"><a class="reference internal" href="webserver.html">Enabling Webserver Authentication</a></li>
|
| 226 |
+
<li class="toctree-l2"><a class="reference internal" href="user_interface.html">User Interface</a></li>
|
| 227 |
+
<li class="toctree-l2"><a class="reference internal" href="menu_bar.html">Menu Bar</a></li>
|
| 228 |
+
<li class="toctree-l2"><a class="reference internal" href="toolbar.html">Toolbar</a></li>
|
| 229 |
+
<li class="toctree-l2"><a class="reference internal" href="tabbed_browser.html">Tabbed Browser</a></li>
|
| 230 |
+
<li class="toctree-l2"><a class="reference internal" href="tree_control.html">Tree Control</a></li>
|
| 231 |
+
<li class="toctree-l2"><a class="reference internal" href="preferences.html">Preferences Dialog</a></li>
|
| 232 |
+
<li class="toctree-l2"><a class="reference internal" href="keyboard_shortcuts.html">Keyboard Shortcuts:</a></li>
|
| 233 |
+
<li class="toctree-l2"><a class="reference internal" href="search_objects.html">Search objects</a></li>
|
| 234 |
+
</ul>
|
| 235 |
+
</li>
|
| 236 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 237 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 238 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 239 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 240 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 241 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 242 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 243 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 244 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 245 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 246 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 247 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 248 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 249 |
+
</ul>
|
| 250 |
+
|
| 251 |
+
<search id="searchbox" style="display: none" role="search">
|
| 252 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 253 |
+
<div class="searchformwrapper">
|
| 254 |
+
<form class="search" action="search.html" method="get">
|
| 255 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 256 |
+
<input type="submit" value="Go" />
|
| 257 |
+
</form>
|
| 258 |
+
</div>
|
| 259 |
+
</search>
|
| 260 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 261 |
+
</div>
|
| 262 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 263 |
+
<span>«</span>
|
| 264 |
+
</div>
|
| 265 |
+
|
| 266 |
+
</div>
|
| 267 |
+
<div class="clearer"></div>
|
| 268 |
+
</div>
|
| 269 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 270 |
+
<h3>Navigation</h3>
|
| 271 |
+
<ul>
|
| 272 |
+
<li class="right" style="margin-right: 10px">
|
| 273 |
+
<a href="genindex.html" title="General Index"
|
| 274 |
+
>index</a></li>
|
| 275 |
+
<li class="right" >
|
| 276 |
+
<a href="server_deployment.html" title="Server Deployment"
|
| 277 |
+
>next</a> |</li>
|
| 278 |
+
<li class="right" >
|
| 279 |
+
<a href="config_py.html" title="The config.py File"
|
| 280 |
+
>previous</a> |</li>
|
| 281 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 282 |
+
<li class="nav-item nav-item-1"><a href="getting_started.html" >Getting Started</a> »</li>
|
| 283 |
+
<li class="nav-item nav-item-2"><a href="deployment.html" >Deployment</a> »</li>
|
| 284 |
+
<li class="nav-item nav-item-this"><a href="">Desktop Deployment</a></li>
|
| 285 |
+
</ul>
|
| 286 |
+
</div>
|
| 287 |
+
<div class="footer" role="contentinfo">
|
| 288 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 289 |
+
<ul>
|
| 290 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 291 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 292 |
+
<li class="right" ><a href="server_deployment.html" title="Server Deployment" accesskey="N">next</a> |</li>
|
| 293 |
+
<li class="right" ><a href="config_py.html" title="The config.py File" accesskey="P">previous</a> |</li>
|
| 294 |
+
</ul>
|
| 295 |
+
</div>
|
| 296 |
+
</div>
|
| 297 |
+
</body>
|
| 298 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/developer_tools.html
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Developer Tools — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Debugger" href="debugger.html" />
|
| 23 |
+
<link rel="prev" title="Restore Dialog" href="restore_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="debugger.html" title="Debugger"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="restore_dialog.html" title="Restore Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-this"><a href="">Developer Tools</a></li>
|
| 39 |
+
</ul>
|
| 40 |
+
</div>
|
| 41 |
+
|
| 42 |
+
<div class="document">
|
| 43 |
+
<div class="documentwrapper">
|
| 44 |
+
<div class="bodywrapper">
|
| 45 |
+
<div class="body" role="main">
|
| 46 |
+
|
| 47 |
+
<section id="developer-tools">
|
| 48 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Developer Tools<a class="headerlink" href="#developer-tools" title="Link to this heading">¶</a></h1>
|
| 49 |
+
<p>The pgAdmin <em>Tools</em> menu displays a list of powerful developer tools that you
|
| 50 |
+
can use to execute and analyze complex SQL commands, manage data, and debug
|
| 51 |
+
PL/SQL code.</p>
|
| 52 |
+
<div class="toctree-wrapper compound">
|
| 53 |
+
<ul>
|
| 54 |
+
<li class="toctree-l1"><a class="reference internal" href="debugger.html">Debugger</a><ul>
|
| 55 |
+
<li class="toctree-l2"><a class="reference internal" href="debugger.html#in-context-debugging">In-context Debugging</a></li>
|
| 56 |
+
<li class="toctree-l2"><a class="reference internal" href="debugger.html#direct-debugging">Direct Debugging</a></li>
|
| 57 |
+
<li class="toctree-l2"><a class="reference internal" href="debugger.html#using-the-debugger">Using the Debugger</a></li>
|
| 58 |
+
</ul>
|
| 59 |
+
</li>
|
| 60 |
+
<li class="toctree-l1"><a class="reference internal" href="query_tool.html">Query Tool</a><ul>
|
| 61 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#toolbar">Toolbar</a></li>
|
| 62 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#the-sql-editor-panel">The SQL Editor Panel</a></li>
|
| 63 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#query-history-panel">Query History Panel</a></li>
|
| 64 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#the-data-output-panel">The Data Output Panel</a></li>
|
| 65 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#explain-panel">Explain Panel</a></li>
|
| 66 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#messages-panel">Messages Panel</a></li>
|
| 67 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#notifications-panel">Notifications Panel</a></li>
|
| 68 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#graph-visualiser-panel">Graph Visualiser Panel</a></li>
|
| 69 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#connection-status">Connection Status</a></li>
|
| 70 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#change-connection">Change connection</a></li>
|
| 71 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html#macros">Macros</a></li>
|
| 72 |
+
</ul>
|
| 73 |
+
</li>
|
| 74 |
+
<li class="toctree-l1"><a class="reference internal" href="editgrid.html">View/Edit Data</a><ul>
|
| 75 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html#the-view-edit-data-toolbar">The View/Edit Data Toolbar</a></li>
|
| 76 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html#the-data-grid">The Data Grid</a></li>
|
| 77 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html#sort-filter-options-dialog">Sort/Filter options dialog</a></li>
|
| 78 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html#promote-view-edit-data-to-query-tool">Promote View/Edit Data to Query Tool</a></li>
|
| 79 |
+
</ul>
|
| 80 |
+
</li>
|
| 81 |
+
<li class="toctree-l1"><a class="reference internal" href="schema_diff.html">Schema Diff</a><ul>
|
| 82 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_diff.html#the-schema-diff-object-comparison-panel">The Schema Diff Object Comparison Panel</a></li>
|
| 83 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_diff.html#schema-diff-ddl-comparison-panel">Schema Diff DDL Comparison Panel</a></li>
|
| 84 |
+
</ul>
|
| 85 |
+
</li>
|
| 86 |
+
<li class="toctree-l1"><a class="reference internal" href="erd_tool.html">ERD Tool</a><ul>
|
| 87 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#toolbar">Toolbar</a></li>
|
| 88 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#file-options">File Options</a></li>
|
| 89 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#export-options">Export Options</a></li>
|
| 90 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#editing-options">Editing Options</a></li>
|
| 91 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#table-relationship-options">Table Relationship Options</a></li>
|
| 92 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#node-color-options">Node Color Options</a></li>
|
| 93 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#utility-options">Utility Options</a></li>
|
| 94 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#zoom-options">Zoom Options</a></li>
|
| 95 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#table-dialog">Table Dialog</a></li>
|
| 96 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#table-node">Table Node</a></li>
|
| 97 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#the-one-to-many-link-dialog">The One to Many Link Dialog</a></li>
|
| 98 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#the-many-to-many-link-dialog">The Many to Many Link Dialog</a></li>
|
| 99 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#the-table-link">The Table Link</a></li>
|
| 100 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html#the-table-notes">The Table Notes</a></li>
|
| 101 |
+
</ul>
|
| 102 |
+
</li>
|
| 103 |
+
<li class="toctree-l1"><a class="reference internal" href="psql_tool.html">PSQL Tool</a></li>
|
| 104 |
+
</ul>
|
| 105 |
+
</div>
|
| 106 |
+
</section>
|
| 107 |
+
|
| 108 |
+
|
| 109 |
+
<div class="clearer"></div>
|
| 110 |
+
</div>
|
| 111 |
+
</div>
|
| 112 |
+
</div>
|
| 113 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 114 |
+
<div class="sphinxsidebarwrapper">
|
| 115 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 116 |
+
<ul class="current">
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 119 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 120 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 121 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 122 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 123 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 124 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 125 |
+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer Tools</a><ul>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="debugger.html">Debugger</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html">Query Tool</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html">View/Edit Data</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_diff.html">Schema Diff</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html">ERD Tool</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="psql_tool.html">PSQL Tool</a></li>
|
| 132 |
+
</ul>
|
| 133 |
+
</li>
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 135 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 136 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 137 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 139 |
+
</ul>
|
| 140 |
+
|
| 141 |
+
<search id="searchbox" style="display: none" role="search">
|
| 142 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 143 |
+
<div class="searchformwrapper">
|
| 144 |
+
<form class="search" action="search.html" method="get">
|
| 145 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 146 |
+
<input type="submit" value="Go" />
|
| 147 |
+
</form>
|
| 148 |
+
</div>
|
| 149 |
+
</search>
|
| 150 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 151 |
+
</div>
|
| 152 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 153 |
+
<span>«</span>
|
| 154 |
+
</div>
|
| 155 |
+
|
| 156 |
+
</div>
|
| 157 |
+
<div class="clearer"></div>
|
| 158 |
+
</div>
|
| 159 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 160 |
+
<h3>Navigation</h3>
|
| 161 |
+
<ul>
|
| 162 |
+
<li class="right" style="margin-right: 10px">
|
| 163 |
+
<a href="genindex.html" title="General Index"
|
| 164 |
+
>index</a></li>
|
| 165 |
+
<li class="right" >
|
| 166 |
+
<a href="debugger.html" title="Debugger"
|
| 167 |
+
>next</a> |</li>
|
| 168 |
+
<li class="right" >
|
| 169 |
+
<a href="restore_dialog.html" title="Restore Dialog"
|
| 170 |
+
>previous</a> |</li>
|
| 171 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 172 |
+
<li class="nav-item nav-item-this"><a href="">Developer Tools</a></li>
|
| 173 |
+
</ul>
|
| 174 |
+
</div>
|
| 175 |
+
<div class="footer" role="contentinfo">
|
| 176 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 177 |
+
<ul>
|
| 178 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 179 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 180 |
+
<li class="right" ><a href="debugger.html" title="Debugger" accesskey="N">next</a> |</li>
|
| 181 |
+
<li class="right" ><a href="restore_dialog.html" title="Restore Dialog" accesskey="P">previous</a> |</li>
|
| 182 |
+
</ul>
|
| 183 |
+
</div>
|
| 184 |
+
</div>
|
| 185 |
+
</body>
|
| 186 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/domain_constraint_dialog.html
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Domain Constraints Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Event Trigger Dialog" href="event_trigger_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Domain Dialog" href="domain_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="event_trigger_dialog.html" title="Event Trigger Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="domain_dialog.html" title="Domain Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Domain Constraints Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="domain-constraints-dialog">
|
| 49 |
+
<span id="domain-constraint-dialog"></span><h1><span class="target" id="index-0"></span>Domain Constraints Dialog<a class="headerlink" href="#domain-constraints-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Domain Constraints</em> dialog to create or modify a domain constraint. A
|
| 51 |
+
domain constraint confirms that the values provided for a domain meet a defined
|
| 52 |
+
criteria. The <em>Domain Constraints</em> dialog implements options of the ALTER DOMAIN
|
| 53 |
+
command.</p>
|
| 54 |
+
<p>The <em>Domain Constraints</em> dialog organizes the development of a domain constraint
|
| 55 |
+
through the following dialog tabs: <em>General</em> and <em>Definition</em>. The <em>SQL</em> tab
|
| 56 |
+
displays the SQL code generated by dialog selections.</p>
|
| 57 |
+
<img alt="Domain constraint dialog general tab" class="align-center" src="_images/domain_constraint_general.png" />
|
| 58 |
+
<p>Use the fields in the <em>General</em> tab to identify the domain constraint:</p>
|
| 59 |
+
<ul class="simple">
|
| 60 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the constraint. The name
|
| 61 |
+
will be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 62 |
+
<li><p>Store notes about the constraint in the <em>Comment</em> field.</p></li>
|
| 63 |
+
</ul>
|
| 64 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 65 |
+
<img alt="Domain constraint dialog general tab" class="align-center" src="_images/domain_constraint_definition.png" />
|
| 66 |
+
<p>Use the fields in the <em>Definition</em> tab to define the domain constraint:</p>
|
| 67 |
+
<ul class="simple">
|
| 68 |
+
<li><p>Use the <em>Check</em> field to provide a CHECK expression. A CHECK expression
|
| 69 |
+
specifies a constraint that the domain must satisfy. A constraint must produce
|
| 70 |
+
a Boolean result; include the key word VALUE to refer to the value being
|
| 71 |
+
tested. Only those expressions that evaluate to TRUE or UNKNOWN will succeed.
|
| 72 |
+
A CHECK expression cannot contain subqueries or refer to variables other than
|
| 73 |
+
VALUE. If a domain has multiple CHECK constraints, they will be tested in
|
| 74 |
+
alphabetical order.</p></li>
|
| 75 |
+
<li><p>Move the <em>Validate?</em> switch to the <em>No</em> position to mark the constraint NOT
|
| 76 |
+
VALID. If the constraint is marked NOT VALID, the constraint will not be
|
| 77 |
+
applied to existing column data. The default value is <em>Yes</em>.</p></li>
|
| 78 |
+
</ul>
|
| 79 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 80 |
+
<p>Your entries in the <em>Domain Constraints</em> dialog generate a SQL command (see an
|
| 81 |
+
example below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any
|
| 82 |
+
changes to the SQL command.</p>
|
| 83 |
+
<section id="example">
|
| 84 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 85 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 86 |
+
the <em>Domain Constraints</em> dialog:</p>
|
| 87 |
+
<img alt="Domain constraint dialog general tab" class="align-center" src="_images/domain_constraint_sql.png" />
|
| 88 |
+
<p>The example shown demonstrates creating a domain constraint on the domain
|
| 89 |
+
<em>timesheets</em> named <em>weekday</em>. It constrains a value equal to <em>Friday</em>.</p>
|
| 90 |
+
<ul class="simple">
|
| 91 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 92 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 93 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 94 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 95 |
+
</ul>
|
| 96 |
+
</section>
|
| 97 |
+
</section>
|
| 98 |
+
|
| 99 |
+
|
| 100 |
+
<div class="clearer"></div>
|
| 101 |
+
</div>
|
| 102 |
+
</div>
|
| 103 |
+
</div>
|
| 104 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 105 |
+
<div class="sphinxsidebarwrapper">
|
| 106 |
+
<div>
|
| 107 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 108 |
+
<ul>
|
| 109 |
+
<li><a class="reference internal" href="#">Domain Constraints Dialog</a><ul>
|
| 110 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 111 |
+
</ul>
|
| 112 |
+
</li>
|
| 113 |
+
</ul>
|
| 114 |
+
|
| 115 |
+
</div>
|
| 116 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 117 |
+
<ul class="current">
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 119 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 120 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 121 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 122 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 127 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Domain Constraints Dialog</a></li>
|
| 128 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 132 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 138 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 139 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 140 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 142 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 143 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 144 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 145 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 146 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 147 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 148 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 149 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 150 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 151 |
+
</ul>
|
| 152 |
+
</li>
|
| 153 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 154 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 155 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 156 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 157 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 158 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 159 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 160 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 161 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 162 |
+
</ul>
|
| 163 |
+
|
| 164 |
+
<search id="searchbox" style="display: none" role="search">
|
| 165 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 166 |
+
<div class="searchformwrapper">
|
| 167 |
+
<form class="search" action="search.html" method="get">
|
| 168 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 169 |
+
<input type="submit" value="Go" />
|
| 170 |
+
</form>
|
| 171 |
+
</div>
|
| 172 |
+
</search>
|
| 173 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 174 |
+
</div>
|
| 175 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 176 |
+
<span>«</span>
|
| 177 |
+
</div>
|
| 178 |
+
|
| 179 |
+
</div>
|
| 180 |
+
<div class="clearer"></div>
|
| 181 |
+
</div>
|
| 182 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 183 |
+
<h3>Navigation</h3>
|
| 184 |
+
<ul>
|
| 185 |
+
<li class="right" style="margin-right: 10px">
|
| 186 |
+
<a href="genindex.html" title="General Index"
|
| 187 |
+
>index</a></li>
|
| 188 |
+
<li class="right" >
|
| 189 |
+
<a href="event_trigger_dialog.html" title="Event Trigger Dialog"
|
| 190 |
+
>next</a> |</li>
|
| 191 |
+
<li class="right" >
|
| 192 |
+
<a href="domain_dialog.html" title="Domain Dialog"
|
| 193 |
+
>previous</a> |</li>
|
| 194 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 195 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 196 |
+
<li class="nav-item nav-item-this"><a href="">Domain Constraints Dialog</a></li>
|
| 197 |
+
</ul>
|
| 198 |
+
</div>
|
| 199 |
+
<div class="footer" role="contentinfo">
|
| 200 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 201 |
+
<ul>
|
| 202 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 203 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 204 |
+
<li class="right" ><a href="event_trigger_dialog.html" title="Event Trigger Dialog" accesskey="N">next</a> |</li>
|
| 205 |
+
<li class="right" ><a href="domain_dialog.html" title="Domain Dialog" accesskey="P">previous</a> |</li>
|
| 206 |
+
</ul>
|
| 207 |
+
</div>
|
| 208 |
+
</div>
|
| 209 |
+
</body>
|
| 210 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/domain_dialog.html
ADDED
|
@@ -0,0 +1,255 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Domain Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Domain Constraints Dialog" href="domain_constraint_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Collation Dialog" href="collation_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="domain_constraint_dialog.html" title="Domain Constraints Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="collation_dialog.html" title="Collation Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Domain Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="domain-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Domain Dialog<a class="headerlink" href="#domain-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Domain</em> dialog to define a domain. A domain is a data type definition
|
| 51 |
+
that may constrain permissible values. Domains are useful when you are creating
|
| 52 |
+
multiple tables that contain comparable columns; you can create a domain that
|
| 53 |
+
defines constraints that are common to the columns and re-use the domain
|
| 54 |
+
definition when creating the columns, rather than individually defining each
|
| 55 |
+
set of constraints.</p>
|
| 56 |
+
<p>The <em>Domain</em> dialog organizes the development of a domain through the following
|
| 57 |
+
tabs: <em>General</em>, <em>Definition</em>, <em>Constraints</em>, and <em>Security</em>. The <em>SQL</em> tab
|
| 58 |
+
displays the SQL code generated by dialog selections.</p>
|
| 59 |
+
<img alt="Domain dialog general tab" class="align-center" src="_images/domain_general.png" />
|
| 60 |
+
<p>Use the fields on the <em>General</em> tab to identify a domain:</p>
|
| 61 |
+
<ul class="simple">
|
| 62 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the domain. The name will
|
| 63 |
+
be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 64 |
+
<li><p>Use the drop-down listbox next to <em>Owner</em> to select a role that will own the
|
| 65 |
+
domain.</p></li>
|
| 66 |
+
<li><p>Select the name of the schema in which the domain will reside from the
|
| 67 |
+
drop-down listbox in the <em>Schema</em> field.</p></li>
|
| 68 |
+
<li><p>Store notes about the domain in the <em>Comment</em> field.</p></li>
|
| 69 |
+
</ul>
|
| 70 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 71 |
+
<img alt="Domain dialog definition tab" class="align-center" src="_images/domain_definition.png" />
|
| 72 |
+
<p>Use the fields in the <em>Definition</em> tab to describe the domain:</p>
|
| 73 |
+
<ul class="simple">
|
| 74 |
+
<li><p>Use the drop-down listbox next to <em>Base type</em> to specify a data type.</p></li>
|
| 75 |
+
<li><p>Use the context-sensitive <em>Length</em> field to specify a numeric length for a
|
| 76 |
+
numeric type.</p></li>
|
| 77 |
+
<li><p>Use the context-sensitive <em>Precision</em> field to specify the total count of
|
| 78 |
+
significant digits for a numeric type.</p></li>
|
| 79 |
+
<li><p>Specify a default value for the domain data type in the <em>Default</em> field. The
|
| 80 |
+
data type of the default expression must match the data type of the domain. If
|
| 81 |
+
no default value is specified, then the default value is the null value.</p></li>
|
| 82 |
+
<li><p>Move the <em>Not Null</em> switch to specify the values of this domain are prevented
|
| 83 |
+
from being null.</p></li>
|
| 84 |
+
<li><p>Use the drop-down listbox next to <em>Collation</em> to apply a collation cast. If
|
| 85 |
+
no collation is specified, the underlying data type’s default collation is
|
| 86 |
+
used. The underlying type must be collatable if COLLATE is specified.</p></li>
|
| 87 |
+
</ul>
|
| 88 |
+
<p>Click the <em>Constraints</em> tab to continue.</p>
|
| 89 |
+
<img alt="Domain dialog constraints tab" class="align-center" src="_images/domain_constraints.png" />
|
| 90 |
+
<p>Use the fields in the <em>Constraints</em> tab to specify rules for the domain. Click
|
| 91 |
+
the <em>Add</em> icon (+) to set constraints:</p>
|
| 92 |
+
<ul class="simple">
|
| 93 |
+
<li><p>Use the <em>Name</em> field to specify a name for the constraint.</p></li>
|
| 94 |
+
<li><p>Use the <em>Check</em> field to provide an expression for the constraint.</p></li>
|
| 95 |
+
<li><p>Use the <em>Validate</em> checkbox to determine whether the constraint will be
|
| 96 |
+
validated. The default checkbox is checked and sets a validation requirement.</p></li>
|
| 97 |
+
</ul>
|
| 98 |
+
<p>A CHECK clause specifies an integrity test which values of the domain must
|
| 99 |
+
satisfy. Each constraint must be an expression that produces a Boolean result.
|
| 100 |
+
Use the key word VALUE to refer to the value being tested. Expressions
|
| 101 |
+
evaluating to TRUE or UNKNOWN succeed. If the expression produces a FALSE
|
| 102 |
+
result, an error is reported and the value is not allowed to be converted to
|
| 103 |
+
the domain type. A CHECK expression cannot contain subqueries nor refer to
|
| 104 |
+
variables other than VALUE. If a domain has multiple CHECK constraints, they
|
| 105 |
+
will be tested in alphabetical order by name.</p>
|
| 106 |
+
<p>Click the <em>Add</em> icon (+) to set additional constraints; to discard a constraint,
|
| 107 |
+
click the trash icon to the left of the row and confirm deletion in the <em>Delete
|
| 108 |
+
Row</em> popup.</p>
|
| 109 |
+
<p>Click the <em>Security</em> tab to continue.</p>
|
| 110 |
+
<img alt="Domain dialog security tab" class="align-center" src="_images/domain_security.png" />
|
| 111 |
+
<p>Use the <em>Security Labels</em> panel to assign security labels. Click the <em>Add</em> icon
|
| 112 |
+
(+) to add a label:</p>
|
| 113 |
+
<ul class="simple">
|
| 114 |
+
<li><p>Specify a security label provider in the <em>Provider</em> field. The named provider
|
| 115 |
+
must be loaded and must consent to the proposed labeling operation.</p></li>
|
| 116 |
+
<li><p>Specify a a security label in the <em>Security Label</em> field. The meaning of a
|
| 117 |
+
given label is at the discretion of the label provider. PostgreSQL places no
|
| 118 |
+
restrictions on whether or how a label provider must interpret security
|
| 119 |
+
labels; it merely provides a mechanism for storing them.</p></li>
|
| 120 |
+
</ul>
|
| 121 |
+
<p>Click the <em>Add</em> icon (+) to specify each additional label; to discard a label,
|
| 122 |
+
click the trash icon to the left of the row and confirm deletion in the <em>Delete
|
| 123 |
+
Row</em> popup.</p>
|
| 124 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 125 |
+
<p>Your entries in the <em>Domain</em> dialog generate a SQL command (see an example
|
| 126 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 127 |
+
to the SQL command.</p>
|
| 128 |
+
<section id="example">
|
| 129 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 130 |
+
<p>The following is an example of the sql command generated by selections made in
|
| 131 |
+
the <em>Domain</em> dialog:</p>
|
| 132 |
+
<img alt="Domain dialog sql tab" class="align-center" src="_images/domain_sql.png" />
|
| 133 |
+
<p>The example shown demonstrates creating a domain named <em>postal_code</em> that
|
| 134 |
+
confirms that the value entered is in proper format.</p>
|
| 135 |
+
<ul class="simple">
|
| 136 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 137 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 138 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 139 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 140 |
+
</ul>
|
| 141 |
+
</section>
|
| 142 |
+
</section>
|
| 143 |
+
|
| 144 |
+
|
| 145 |
+
<div class="clearer"></div>
|
| 146 |
+
</div>
|
| 147 |
+
</div>
|
| 148 |
+
</div>
|
| 149 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 150 |
+
<div class="sphinxsidebarwrapper">
|
| 151 |
+
<div>
|
| 152 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 153 |
+
<ul>
|
| 154 |
+
<li><a class="reference internal" href="#">Domain Dialog</a><ul>
|
| 155 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 156 |
+
</ul>
|
| 157 |
+
</li>
|
| 158 |
+
</ul>
|
| 159 |
+
|
| 160 |
+
</div>
|
| 161 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 162 |
+
<ul class="current">
|
| 163 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 164 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 165 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 166 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 167 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 168 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 169 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 170 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 171 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Domain Dialog</a></li>
|
| 172 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 173 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 174 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 175 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 176 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 177 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 178 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 179 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 180 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 181 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 182 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 183 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 184 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 185 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 186 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 187 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 188 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 189 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 190 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 191 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 192 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 193 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 194 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 195 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 196 |
+
</ul>
|
| 197 |
+
</li>
|
| 198 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 199 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 200 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 201 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 202 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 203 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 204 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 205 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 206 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 207 |
+
</ul>
|
| 208 |
+
|
| 209 |
+
<search id="searchbox" style="display: none" role="search">
|
| 210 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 211 |
+
<div class="searchformwrapper">
|
| 212 |
+
<form class="search" action="search.html" method="get">
|
| 213 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 214 |
+
<input type="submit" value="Go" />
|
| 215 |
+
</form>
|
| 216 |
+
</div>
|
| 217 |
+
</search>
|
| 218 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 219 |
+
</div>
|
| 220 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 221 |
+
<span>«</span>
|
| 222 |
+
</div>
|
| 223 |
+
|
| 224 |
+
</div>
|
| 225 |
+
<div class="clearer"></div>
|
| 226 |
+
</div>
|
| 227 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 228 |
+
<h3>Navigation</h3>
|
| 229 |
+
<ul>
|
| 230 |
+
<li class="right" style="margin-right: 10px">
|
| 231 |
+
<a href="genindex.html" title="General Index"
|
| 232 |
+
>index</a></li>
|
| 233 |
+
<li class="right" >
|
| 234 |
+
<a href="domain_constraint_dialog.html" title="Domain Constraints Dialog"
|
| 235 |
+
>next</a> |</li>
|
| 236 |
+
<li class="right" >
|
| 237 |
+
<a href="collation_dialog.html" title="Collation Dialog"
|
| 238 |
+
>previous</a> |</li>
|
| 239 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 240 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 241 |
+
<li class="nav-item nav-item-this"><a href="">Domain Dialog</a></li>
|
| 242 |
+
</ul>
|
| 243 |
+
</div>
|
| 244 |
+
<div class="footer" role="contentinfo">
|
| 245 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 246 |
+
<ul>
|
| 247 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 248 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 249 |
+
<li class="right" ><a href="domain_constraint_dialog.html" title="Domain Constraints Dialog" accesskey="N">next</a> |</li>
|
| 250 |
+
<li class="right" ><a href="collation_dialog.html" title="Collation Dialog" accesskey="P">previous</a> |</li>
|
| 251 |
+
</ul>
|
| 252 |
+
</div>
|
| 253 |
+
</div>
|
| 254 |
+
</body>
|
| 255 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/editgrid.html
ADDED
|
@@ -0,0 +1,341 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>View/Edit Data — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="View/Edit Data Filter" href="viewdata_filter.html" />
|
| 23 |
+
<link rel="prev" title="Query Tool Toolbar" href="query_tool_toolbar.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="viewdata_filter.html" title="View/Edit Data Filter"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="query_tool_toolbar.html" title="Query Tool Toolbar"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="developer_tools.html" accesskey="U">Developer Tools</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">View/Edit Data</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="view-edit-data">
|
| 49 |
+
<span id="editgrid"></span><h1><span class="target" id="index-0"></span>View/Edit Data<a class="headerlink" href="#view-edit-data" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>To view or modify data, right click on a table or view name in the
|
| 51 |
+
<em>Object Explorer</em>. When the context menu opens, use the <em>View/Edit Data</em> menu
|
| 52 |
+
to specify the number of rows you would like to display in the editor panel.</p>
|
| 53 |
+
<img alt="Edit grid window" class="align-center" src="_images/editgrid.png" />
|
| 54 |
+
<p>To modify the content of a table, each row in the table must be uniquely
|
| 55 |
+
identifiable. If the table definition does not include an OID or a primary key,
|
| 56 |
+
the displayed data is read only. Note that views cannot be edited; updatable
|
| 57 |
+
views (using rules) are not supported.</p>
|
| 58 |
+
<p>The editor features a toolbar that allows quick access to frequently used
|
| 59 |
+
options, and a work environment divided into two panels:</p>
|
| 60 |
+
<ul class="simple">
|
| 61 |
+
<li><p>The upper panel displays the SQL command that was used to select the content
|
| 62 |
+
displayed in the lower panel.</p></li>
|
| 63 |
+
<li><p>The lower panel (the Data Grid) displays the data selected from the table or
|
| 64 |
+
view.</p></li>
|
| 65 |
+
</ul>
|
| 66 |
+
<section id="the-view-edit-data-toolbar">
|
| 67 |
+
<h2>The View/Edit Data Toolbar<a class="headerlink" href="#the-view-edit-data-toolbar" title="Link to this heading">¶</a></h2>
|
| 68 |
+
<p>The <a class="reference internal" href="query_tool.html#query-tool"><span class="std std-ref">Query Tool</span></a> and <a class="reference internal" href="#editgrid"><span class="std std-ref">View/Edit Data</span></a> tools
|
| 69 |
+
are actually different operating modes of the same tool. Some controls will be
|
| 70 |
+
disabled in either mode. Please see
|
| 71 |
+
<a class="reference internal" href="query_tool_toolbar.html#query-tool-toolbar"><span class="std std-ref">The Query Tool Toolbar</span></a> for a description of the
|
| 72 |
+
available controls.</p>
|
| 73 |
+
</section>
|
| 74 |
+
<section id="the-data-grid">
|
| 75 |
+
<span id="data-grid"></span><h2>The Data Grid<a class="headerlink" href="#the-data-grid" title="Link to this heading">¶</a></h2>
|
| 76 |
+
<p>The top row of the data grid displays the name of each column, the data type,
|
| 77 |
+
and if applicable, the number of characters allowed. A column that is part of
|
| 78 |
+
the primary key will additionally be marked with [PK].</p>
|
| 79 |
+
<p>To modify the displayed data:</p>
|
| 80 |
+
<ul class="simple">
|
| 81 |
+
<li><p>To change a numeric value within the grid, double-click the value to select
|
| 82 |
+
the field. Modify the content in the square in which it is displayed.</p></li>
|
| 83 |
+
<li><p>To change a non-numeric value within the grid, double-click the content to
|
| 84 |
+
access the edit bubble. After modifying the contentof the edit bubble, click
|
| 85 |
+
the <em>Ok</em> button to display your changes in the data grid, or <em>Cancel</em> to
|
| 86 |
+
exit the edit bubble without saving.</p></li>
|
| 87 |
+
</ul>
|
| 88 |
+
<p>To enter a newline character, click Ctrl-Enter or Shift-Enter. Newline
|
| 89 |
+
formatting is only displayed when the field content is accessed via an edit
|
| 90 |
+
bubble.</p>
|
| 91 |
+
<p>To add a new row to the table, enter data into the last (unnumbered) row of the
|
| 92 |
+
table. As soon as you store the data, the row is assigned a row number, and a
|
| 93 |
+
fresh empty line is added to the data grid.</p>
|
| 94 |
+
<p>To write a SQL NULL to the table, simply leave the field empty. When you store
|
| 95 |
+
the new row, the will server fill in the default value for that column. If you
|
| 96 |
+
store a change to an existing row, the value NULL will explicitly be written.</p>
|
| 97 |
+
<p>To write an empty string to the table, enter the special string ‘’ (two single
|
| 98 |
+
quotes) in the field. If you want to write a string containing solely two single
|
| 99 |
+
quotes to the table, you need to escape these quotes, by typing ''</p>
|
| 100 |
+
<p>To delete a row, press the <em>Delete</em> toolbar button. A popup will open, asking
|
| 101 |
+
you to confirm the deletion.</p>
|
| 102 |
+
<p>To commit the changes to the server, select the <em>Save Data</em> toolbar button.</p>
|
| 103 |
+
<p><strong>Geometry Data Viewer</strong></p>
|
| 104 |
+
<p>If PostGIS is installed, you can view GIS objects in a map by selecting row(s)
|
| 105 |
+
and clicking the ‘View Geometry’ button in the column. If no rows are selected,
|
| 106 |
+
the entire data set will be rendered:</p>
|
| 107 |
+
<img alt="Geometry Viewer Button" class="align-center" src="_images/geometry_viewer.png" />
|
| 108 |
+
<p>You can adjust the layout by dragging the title of the panel. To view the
|
| 109 |
+
properties of the geometries directly in map, just click the specific geometry:</p>
|
| 110 |
+
<img alt="Geometry Viewer Property Table" class="align-center" src="_images/geometry_viewer_property_table.png" />
|
| 111 |
+
<div class="admonition note">
|
| 112 |
+
<p class="admonition-title">Note</p>
|
| 113 |
+
<ul class="simple">
|
| 114 |
+
<li><p><em>Supported data types:</em> The Geometry Viewer supports 2D and 3DM geometries in
|
| 115 |
+
EWKB format including <cite>Point, LineString, Polygon MultiPoint, MultiLineString,
|
| 116 |
+
MultiPolygon and GeometryCollection</cite>.</p></li>
|
| 117 |
+
<li><p><em>SRIDs:</em> If there are geometries with different SRIDs in the same column, the
|
| 118 |
+
viewer will render geometries with the same SRID in the map. If SRID=4326 the
|
| 119 |
+
OSM tile layer will be added into the map.</p></li>
|
| 120 |
+
<li><p><em>Data size:</em> For performance reasons, the viewer will render no more than
|
| 121 |
+
100000 geometries, totaling up to 20MB.</p></li>
|
| 122 |
+
<li><p><em>Internet access:</em> An internet connection is required for the Geometry Viewer
|
| 123 |
+
to function correctly.</p></li>
|
| 124 |
+
</ul>
|
| 125 |
+
</div>
|
| 126 |
+
<p><strong>JSON Data Editor</strong></p>
|
| 127 |
+
<p>A built in json editor is provided for <em>JSON/JSONB Data</em>.Double clicking on json/jsonb
|
| 128 |
+
data type cell in data grid will open JSON Editor.Editor provides different mode to
|
| 129 |
+
view and edit json data.</p>
|
| 130 |
+
<img alt="Json Editor" class="align-center" src="_images/json_editor_modes.png" />
|
| 131 |
+
<p><em>Code Mode</em>:
|
| 132 |
+
Provides way to format & compact json data.Also provides ability to repair json data
|
| 133 |
+
by fixing quotes and escape characters, removing comments and JSONP notation and
|
| 134 |
+
turn JavaScript objects into JSON.</p>
|
| 135 |
+
<p><em>Tree Mode</em>:
|
| 136 |
+
Enabled to change, add, move, remove, and duplicate fields and values.Provides ability
|
| 137 |
+
to searh & hilight data.</p>
|
| 138 |
+
<p><em>Form Mode</em>:
|
| 139 |
+
Allows only to edit values in json data there by providing ability to keep data structure
|
| 140 |
+
unchanged while editing.</p>
|
| 141 |
+
<p><em>Preview Mode</em>:
|
| 142 |
+
Provides ability to check data before saving and also shows size of current json data.
|
| 143 |
+
Format and compact json data as well.</p>
|
| 144 |
+
<p><em>Editor Toolbar</em></p>
|
| 145 |
+
<p>Different options are provided to manipulate json data.</p>
|
| 146 |
+
<p>Code/Preview mode:</p>
|
| 147 |
+
<img alt="Json Editor Code/Preview mode Tool Bar" class="align-center" src="_images/json_editor_code_preview_tool_bar.png" />
|
| 148 |
+
<p>Tree/Form mode:</p>
|
| 149 |
+
<img alt="Json Editor Tree/Form mode Tool Bar" class="align-center" src="_images/json_editor_tree_form_mode_tool_bar.png" />
|
| 150 |
+
<table class="longtable docutils align-default">
|
| 151 |
+
<colgroup>
|
| 152 |
+
<col style="width: 16.7%" />
|
| 153 |
+
<col style="width: 50.0%" />
|
| 154 |
+
<col style="width: 33.3%" />
|
| 155 |
+
</colgroup>
|
| 156 |
+
<thead>
|
| 157 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 158 |
+
<th class="head"><p>Behavior</p></th>
|
| 159 |
+
<th class="head"><p>Available in mode</p></th>
|
| 160 |
+
</tr>
|
| 161 |
+
</thead>
|
| 162 |
+
<tbody>
|
| 163 |
+
<tr class="row-even"><td><p><em>Format Json</em></p></td>
|
| 164 |
+
<td><p>Click to <em>Format Json</em> format json data with proper indentation.</p></td>
|
| 165 |
+
<td><p>Code, Preview</p></td>
|
| 166 |
+
</tr>
|
| 167 |
+
<tr class="row-odd"><td><p><em>Compact Json</em></p></td>
|
| 168 |
+
<td><p>Click to <em>Compact Json</em> get compacted json data.</p></td>
|
| 169 |
+
<td><p>Code, Preview</p></td>
|
| 170 |
+
</tr>
|
| 171 |
+
<tr class="row-even"><td><p><em>Sort</em></p></td>
|
| 172 |
+
<td><p>Click to <em>Sort</em> icon to set sorting criteria for the data using file values.</p></td>
|
| 173 |
+
<td><p>Code, Preview, Tree</p></td>
|
| 174 |
+
</tr>
|
| 175 |
+
<tr class="row-odd"><td><p><em>Transform</em></p></td>
|
| 176 |
+
<td><p>Click to <em>Transform</em> to filter data using JSME query language.</p></td>
|
| 177 |
+
<td><p>Code, Preview, Tree</p></td>
|
| 178 |
+
</tr>
|
| 179 |
+
<tr class="row-even"><td><p><em>Undo</em></p></td>
|
| 180 |
+
<td><p>Click to <em>Undo</em> to undo last action performed on data .</p></td>
|
| 181 |
+
<td><p>Code, Preview, Tree, From</p></td>
|
| 182 |
+
</tr>
|
| 183 |
+
<tr class="row-odd"><td><p><em>Redo</em></p></td>
|
| 184 |
+
<td><p>Click to <em>Redo</em> to repat last action performed on data .</p></td>
|
| 185 |
+
<td><p>Code, Preview, Tree, From</p></td>
|
| 186 |
+
</tr>
|
| 187 |
+
<tr class="row-even"><td><p><em>Mode</em></p></td>
|
| 188 |
+
<td><p>Click to <em>Mode</em> dropdown to change dipaly mode of editor.Different modes avaialble
|
| 189 |
+
are Code, Preview, Tree, From.</p></td>
|
| 190 |
+
<td><p>Code, Tree, From, Preview</p></td>
|
| 191 |
+
</tr>
|
| 192 |
+
<tr class="row-odd"><td><p><em>Expand All</em></p></td>
|
| 193 |
+
<td><p>Click to <em>Expand All</em> to expand json data.</p></td>
|
| 194 |
+
<td><p>Tree, From</p></td>
|
| 195 |
+
</tr>
|
| 196 |
+
<tr class="row-even"><td><p><em>Collapse All</em></p></td>
|
| 197 |
+
<td><p>Click to <em>Redo</em> to collapse json data.</p></td>
|
| 198 |
+
<td><p>Tree, From</p></td>
|
| 199 |
+
</tr>
|
| 200 |
+
<tr class="row-odd"><td><p><em>Search Box</em></p></td>
|
| 201 |
+
<td><p>Enter partial/complete string to search in data.</p></td>
|
| 202 |
+
<td><p>Tree, From</p></td>
|
| 203 |
+
</tr>
|
| 204 |
+
</tbody>
|
| 205 |
+
</table>
|
| 206 |
+
</section>
|
| 207 |
+
<section id="sort-filter-options-dialog">
|
| 208 |
+
<h2>Sort/Filter options dialog<a class="headerlink" href="#sort-filter-options-dialog" title="Link to this heading">¶</a></h2>
|
| 209 |
+
<p>You can access <em>Sort/Filter options dialog</em> by clicking on Sort/Filter button.
|
| 210 |
+
This allows you to specify an SQL Filter to limit the data displayed and data
|
| 211 |
+
sorting options in the edit grid window:</p>
|
| 212 |
+
<img alt="Edit grid filter dialog window" class="align-center" src="_images/editgrid_filter_dialog.png" />
|
| 213 |
+
<ul class="simple">
|
| 214 |
+
<li><p>Use <em>SQL Filter</em> to provide SQL filtering criteria. These will be added to
|
| 215 |
+
the “WHERE” clause of the query used to retrieve the data. For example,
|
| 216 |
+
you might enter:</p></li>
|
| 217 |
+
</ul>
|
| 218 |
+
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="n">id</span><span class="w"> </span><span class="o">></span><span class="w"> </span><span class="mi">25</span><span class="w"> </span><span class="k">AND</span><span class="w"> </span><span class="n">created</span><span class="w"> </span><span class="o">></span><span class="w"> </span><span class="s1">'2018-01-01'</span>
|
| 219 |
+
</pre></div>
|
| 220 |
+
</div>
|
| 221 |
+
<ul class="simple">
|
| 222 |
+
<li><p>Use <em>Data Sorting</em> to sort the data in the output grid</p></li>
|
| 223 |
+
</ul>
|
| 224 |
+
<p>To add new column(s) in data sorting grid, click on the [+] icon.</p>
|
| 225 |
+
<ul class="simple">
|
| 226 |
+
<li><p>Use the drop-down <em>Column</em> to select the column you want to sort.</p></li>
|
| 227 |
+
<li><p>Use the drop-down <em>Order</em> to select the sort order for the column.</p></li>
|
| 228 |
+
</ul>
|
| 229 |
+
<p>To delete a row from the grid, click the trash icon.</p>
|
| 230 |
+
<ul class="simple">
|
| 231 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 232 |
+
<li><p>Click the <em>Close</em> button to discard current changes and close the dialog.</p></li>
|
| 233 |
+
</ul>
|
| 234 |
+
<div class="toctree-wrapper compound">
|
| 235 |
+
<ul>
|
| 236 |
+
<li class="toctree-l1"><a class="reference internal" href="viewdata_filter.html">View/Edit Data Filter</a></li>
|
| 237 |
+
</ul>
|
| 238 |
+
</div>
|
| 239 |
+
</section>
|
| 240 |
+
<section id="promote-view-edit-data-to-query-tool">
|
| 241 |
+
<h2>Promote View/Edit Data to Query Tool<a class="headerlink" href="#promote-view-edit-data-to-query-tool" title="Link to this heading">¶</a></h2>
|
| 242 |
+
<p>A View/Edit Data tab can be converted to a Query Tool Tab just by editing the query. Once you start editing, it will ask if you really want to move away from View/Edit.</p>
|
| 243 |
+
<img alt="Promote View/Edit Data tab to Query Tool tab warning" class="align-center" src="_images/promote_view_edit_data_warning.png" />
|
| 244 |
+
<p>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?”</p>
|
| 245 |
+
<p>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.</p>
|
| 246 |
+
</section>
|
| 247 |
+
</section>
|
| 248 |
+
|
| 249 |
+
|
| 250 |
+
<div class="clearer"></div>
|
| 251 |
+
</div>
|
| 252 |
+
</div>
|
| 253 |
+
</div>
|
| 254 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 255 |
+
<div class="sphinxsidebarwrapper">
|
| 256 |
+
<div>
|
| 257 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 258 |
+
<ul>
|
| 259 |
+
<li><a class="reference internal" href="#">View/Edit Data</a><ul>
|
| 260 |
+
<li><a class="reference internal" href="#the-view-edit-data-toolbar">The View/Edit Data Toolbar</a></li>
|
| 261 |
+
<li><a class="reference internal" href="#the-data-grid">The Data Grid</a></li>
|
| 262 |
+
<li><a class="reference internal" href="#sort-filter-options-dialog">Sort/Filter options dialog</a></li>
|
| 263 |
+
<li><a class="reference internal" href="#promote-view-edit-data-to-query-tool">Promote View/Edit Data to Query Tool</a></li>
|
| 264 |
+
</ul>
|
| 265 |
+
</li>
|
| 266 |
+
</ul>
|
| 267 |
+
|
| 268 |
+
</div>
|
| 269 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 270 |
+
<ul class="current">
|
| 271 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 272 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 273 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 274 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 275 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 276 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 277 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 278 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 279 |
+
<li class="toctree-l1 current"><a class="reference internal" href="developer_tools.html">Developer Tools</a><ul class="current">
|
| 280 |
+
<li class="toctree-l2"><a class="reference internal" href="debugger.html">Debugger</a></li>
|
| 281 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html">Query Tool</a></li>
|
| 282 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">View/Edit Data</a></li>
|
| 283 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_diff.html">Schema Diff</a></li>
|
| 284 |
+
<li class="toctree-l2"><a class="reference internal" href="erd_tool.html">ERD Tool</a></li>
|
| 285 |
+
<li class="toctree-l2"><a class="reference internal" href="psql_tool.html">PSQL Tool</a></li>
|
| 286 |
+
</ul>
|
| 287 |
+
</li>
|
| 288 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 289 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 290 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 291 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 292 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 293 |
+
</ul>
|
| 294 |
+
|
| 295 |
+
<search id="searchbox" style="display: none" role="search">
|
| 296 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 297 |
+
<div class="searchformwrapper">
|
| 298 |
+
<form class="search" action="search.html" method="get">
|
| 299 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 300 |
+
<input type="submit" value="Go" />
|
| 301 |
+
</form>
|
| 302 |
+
</div>
|
| 303 |
+
</search>
|
| 304 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 305 |
+
</div>
|
| 306 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 307 |
+
<span>«</span>
|
| 308 |
+
</div>
|
| 309 |
+
|
| 310 |
+
</div>
|
| 311 |
+
<div class="clearer"></div>
|
| 312 |
+
</div>
|
| 313 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 314 |
+
<h3>Navigation</h3>
|
| 315 |
+
<ul>
|
| 316 |
+
<li class="right" style="margin-right: 10px">
|
| 317 |
+
<a href="genindex.html" title="General Index"
|
| 318 |
+
>index</a></li>
|
| 319 |
+
<li class="right" >
|
| 320 |
+
<a href="viewdata_filter.html" title="View/Edit Data Filter"
|
| 321 |
+
>next</a> |</li>
|
| 322 |
+
<li class="right" >
|
| 323 |
+
<a href="query_tool_toolbar.html" title="Query Tool Toolbar"
|
| 324 |
+
>previous</a> |</li>
|
| 325 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 326 |
+
<li class="nav-item nav-item-1"><a href="developer_tools.html" >Developer Tools</a> »</li>
|
| 327 |
+
<li class="nav-item nav-item-this"><a href="">View/Edit Data</a></li>
|
| 328 |
+
</ul>
|
| 329 |
+
</div>
|
| 330 |
+
<div class="footer" role="contentinfo">
|
| 331 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 332 |
+
<ul>
|
| 333 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 334 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 335 |
+
<li class="right" ><a href="viewdata_filter.html" title="View/Edit Data Filter" accesskey="N">next</a> |</li>
|
| 336 |
+
<li class="right" ><a href="query_tool_toolbar.html" title="Query Tool Toolbar" accesskey="P">previous</a> |</li>
|
| 337 |
+
</ul>
|
| 338 |
+
</div>
|
| 339 |
+
</div>
|
| 340 |
+
</body>
|
| 341 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/erd_tool.html
ADDED
|
@@ -0,0 +1,481 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>ERD Tool — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="PSQL Tool" href="psql_tool.html" />
|
| 23 |
+
<link rel="prev" title="Schema Diff" href="schema_diff.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="psql_tool.html" title="PSQL Tool"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="schema_diff.html" title="Schema Diff"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="developer_tools.html" accesskey="U">Developer Tools</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">ERD Tool</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="erd-tool">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>ERD Tool<a class="headerlink" href="#erd-tool" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>The Entity-Relationship Diagram (ERD) tool is a database design tool that provides a graphical representation of database tables, columns, and inter-relationships. ERD can give sufficient information for the database administrator to follow when developing and maintaining the database. The ERD Tool allows you to:</p>
|
| 51 |
+
<ul class="simple">
|
| 52 |
+
<li><p>Design and visualize the database tables and their relationships.</p></li>
|
| 53 |
+
<li><p>Add notes to the diagram.</p></li>
|
| 54 |
+
<li><p>Auto-align the tables and links for cleaner visualization.</p></li>
|
| 55 |
+
<li><p>Save the diagram and open it later to continue working on it.</p></li>
|
| 56 |
+
<li><p>Generate ready to run SQL from the database design.</p></li>
|
| 57 |
+
<li><p>Generate the database diagram for an existing database.</p></li>
|
| 58 |
+
<li><p>Drag and drop tables from object explorer to the diagram.</p></li>
|
| 59 |
+
</ul>
|
| 60 |
+
<img alt="ERD tool window" class="align-center" src="_images/erd_tool.png" />
|
| 61 |
+
<p>You can open multiple copies of the ERD tool in individual tabs simultaneously.
|
| 62 |
+
You can also generate an ERD from a database, schema or a table.</p>
|
| 63 |
+
<ul class="simple">
|
| 64 |
+
<li><p>The ERD for database will fetch all the tables from all the schemas of the database and plot them with foreign key links.</p></li>
|
| 65 |
+
<li><p>The ERD for schema will fetch all the tables from a schema and plot them with foreign key links. If any table refers to a table in another
|
| 66 |
+
schema, then that link/foreign key will be removed.</p></li>
|
| 67 |
+
<li><p>The ERD for table will fetch all the tables linked directly or indirectly to mentioned table. You can change the depth of traversal from <a class="reference internal" href="preferences.html#preferences"><span class="std std-ref">Preferences</span></a>.</p></li>
|
| 68 |
+
</ul>
|
| 69 |
+
<section id="toolbar">
|
| 70 |
+
<h2>Toolbar<a class="headerlink" href="#toolbar" title="Link to this heading">¶</a></h2>
|
| 71 |
+
<p>The <em>ERD Tool</em> toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. The option is enabled for the highlighted icon and is disabled for the grayed-out icon.</p>
|
| 72 |
+
<img alt="ERD tool toolbar" class="align-center" src="_images/erd_tool_toolbar.png" />
|
| 73 |
+
<p>Hover over an icon on Toolbar to display a tooltip that describes the icon’s functionality.</p>
|
| 74 |
+
</section>
|
| 75 |
+
<section id="file-options">
|
| 76 |
+
<h2>File Options<a class="headerlink" href="#file-options" title="Link to this heading">¶</a></h2>
|
| 77 |
+
<table class="longtable docutils align-default">
|
| 78 |
+
<colgroup>
|
| 79 |
+
<col style="width: 16.7%" />
|
| 80 |
+
<col style="width: 66.7%" />
|
| 81 |
+
<col style="width: 16.7%" />
|
| 82 |
+
</colgroup>
|
| 83 |
+
<thead>
|
| 84 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 85 |
+
<th class="head"><p>Behavior</p></th>
|
| 86 |
+
<th class="head"><p>Shortcut</p></th>
|
| 87 |
+
</tr>
|
| 88 |
+
</thead>
|
| 89 |
+
<tbody>
|
| 90 |
+
<tr class="row-even"><td><p><em>Open File</em></p></td>
|
| 91 |
+
<td><p>Click the <em>Open File</em> icon to load a previously saved diagram.</p></td>
|
| 92 |
+
<td><p>Ctrl + O</p></td>
|
| 93 |
+
</tr>
|
| 94 |
+
<tr class="row-odd"><td><p><em>Save</em></p></td>
|
| 95 |
+
<td><p>Click the <em>Save</em> icon to perform a quick-save of a previously saved diagram, or to save the
|
| 96 |
+
diagram to a file.</p></td>
|
| 97 |
+
<td><p>Ctrl + S</p></td>
|
| 98 |
+
</tr>
|
| 99 |
+
<tr class="row-even"><td><p><em>Save as</em></p></td>
|
| 100 |
+
<td><p>Click the <em>Save As</em> to open a new browser dialog and specify a new location to save the diagram.
|
| 101 |
+
You need to click the down arrow beside the save button to see <em>Save As</em>.</p></td>
|
| 102 |
+
<td><p>Ctrl + Shift +
|
| 103 |
+
S</p></td>
|
| 104 |
+
</tr>
|
| 105 |
+
</tbody>
|
| 106 |
+
</table>
|
| 107 |
+
</section>
|
| 108 |
+
<section id="export-options">
|
| 109 |
+
<h2>Export Options<a class="headerlink" href="#export-options" title="Link to this heading">¶</a></h2>
|
| 110 |
+
<table class="longtable docutils align-default">
|
| 111 |
+
<colgroup>
|
| 112 |
+
<col style="width: 16.7%" />
|
| 113 |
+
<col style="width: 66.7%" />
|
| 114 |
+
<col style="width: 16.7%" />
|
| 115 |
+
</colgroup>
|
| 116 |
+
<thead>
|
| 117 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 118 |
+
<th class="head"><p>Behavior</p></th>
|
| 119 |
+
<th class="head"><p>Shortcut</p></th>
|
| 120 |
+
</tr>
|
| 121 |
+
</thead>
|
| 122 |
+
<tbody>
|
| 123 |
+
<tr class="row-even"><td><p><em>Generate SQL</em></p></td>
|
| 124 |
+
<td><p>Click the <em>Generate SQL</em> icon to generate the DDL SQL for the diagram and open a query tool
|
| 125 |
+
with the generated SQL ready for execution.
|
| 126 |
+
You can select the option <em>With DROP Table</em> if you wish to have DROP Table DDL statements before
|
| 127 |
+
each CREATE Table DDL. You can see the option by clicking the down arrow beside the SQL button.</p></td>
|
| 128 |
+
<td><p>Option + Ctrl +
|
| 129 |
+
S</p></td>
|
| 130 |
+
</tr>
|
| 131 |
+
<tr class="row-odd"><td><p><em>Download image</em></p></td>
|
| 132 |
+
<td><p>Click the <em>Download image</em> icon to save the ERD diagram in a image formate</p></td>
|
| 133 |
+
<td><p>Option + Ctrl +
|
| 134 |
+
I</p></td>
|
| 135 |
+
</tr>
|
| 136 |
+
</tbody>
|
| 137 |
+
</table>
|
| 138 |
+
</section>
|
| 139 |
+
<section id="editing-options">
|
| 140 |
+
<h2>Editing Options<a class="headerlink" href="#editing-options" title="Link to this heading">¶</a></h2>
|
| 141 |
+
<table class="longtable docutils align-default">
|
| 142 |
+
<colgroup>
|
| 143 |
+
<col style="width: 16.7%" />
|
| 144 |
+
<col style="width: 66.7%" />
|
| 145 |
+
<col style="width: 16.7%" />
|
| 146 |
+
</colgroup>
|
| 147 |
+
<thead>
|
| 148 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 149 |
+
<th class="head"><p>Behavior</p></th>
|
| 150 |
+
<th class="head"><p>Shortcut</p></th>
|
| 151 |
+
</tr>
|
| 152 |
+
</thead>
|
| 153 |
+
<tbody>
|
| 154 |
+
<tr class="row-even"><td><p><em>Add table</em></p></td>
|
| 155 |
+
<td><p>Click this button to add a new table to the diagram. On clicking, this will open a table dialog
|
| 156 |
+
where you can put the table details.</p></td>
|
| 157 |
+
<td><p>Option/Alt +
|
| 158 |
+
Ctrl + A</p></td>
|
| 159 |
+
</tr>
|
| 160 |
+
<tr class="row-odd"><td><p><em>Edit table</em></p></td>
|
| 161 |
+
<td><p>Click this button to edit a table on the diagram. On clicking, this will open a table dialog
|
| 162 |
+
where you can change table details. This will enable when a table is selected.</p></td>
|
| 163 |
+
<td><p>Option/Alt +
|
| 164 |
+
Ctrl + E</p></td>
|
| 165 |
+
</tr>
|
| 166 |
+
<tr class="row-even"><td><p><em>Clone table</em></p></td>
|
| 167 |
+
<td><p>Click this button to clone the complete table structure, name it with a auto generated name and
|
| 168 |
+
put it in the diagram.</p></td>
|
| 169 |
+
<td><p>Option/Alt +
|
| 170 |
+
Ctrl + C</p></td>
|
| 171 |
+
</tr>
|
| 172 |
+
<tr class="row-odd"><td><p><em>Drop table/link</em></p></td>
|
| 173 |
+
<td><p>You can drop a table or link using this button. You need to select a table or link and click on
|
| 174 |
+
this button to drop it.</p></td>
|
| 175 |
+
<td><p>Option/Alt +
|
| 176 |
+
Ctrl + D</p></td>
|
| 177 |
+
</tr>
|
| 178 |
+
</tbody>
|
| 179 |
+
</table>
|
| 180 |
+
</section>
|
| 181 |
+
<section id="table-relationship-options">
|
| 182 |
+
<h2>Table Relationship Options<a class="headerlink" href="#table-relationship-options" title="Link to this heading">¶</a></h2>
|
| 183 |
+
<table class="longtable docutils align-default">
|
| 184 |
+
<colgroup>
|
| 185 |
+
<col style="width: 16.7%" />
|
| 186 |
+
<col style="width: 66.7%" />
|
| 187 |
+
<col style="width: 16.7%" />
|
| 188 |
+
</colgroup>
|
| 189 |
+
<thead>
|
| 190 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 191 |
+
<th class="head"><p>Behavior</p></th>
|
| 192 |
+
<th class="head"><p>Shortcut</p></th>
|
| 193 |
+
</tr>
|
| 194 |
+
</thead>
|
| 195 |
+
<tbody>
|
| 196 |
+
<tr class="row-even"><td><p><em>1M</em></p></td>
|
| 197 |
+
<td><p>Click this button to open a one-to-many relationship dialog to add a relationship between the
|
| 198 |
+
two tables. The selected table becomes the referencing table and will have the <em>many</em> endpoint of
|
| 199 |
+
the link.</p></td>
|
| 200 |
+
<td><p>Option/Alt +
|
| 201 |
+
Ctrl + O</p></td>
|
| 202 |
+
</tr>
|
| 203 |
+
<tr class="row-odd"><td><p><em>MM</em></p></td>
|
| 204 |
+
<td><p>Click this button to open a many-to-many relationship dialog to add a relationship between the
|
| 205 |
+
two tables. This option will create a new table based on the selected columns for the two relating
|
| 206 |
+
tables and link them.</p></td>
|
| 207 |
+
<td><p>Option/Alt +
|
| 208 |
+
Ctrl + M</p></td>
|
| 209 |
+
</tr>
|
| 210 |
+
</tbody>
|
| 211 |
+
</table>
|
| 212 |
+
</section>
|
| 213 |
+
<section id="node-color-options">
|
| 214 |
+
<h2>Node Color Options<a class="headerlink" href="#node-color-options" title="Link to this heading">¶</a></h2>
|
| 215 |
+
<table class="longtable docutils align-default">
|
| 216 |
+
<colgroup>
|
| 217 |
+
<col style="width: 16.7%" />
|
| 218 |
+
<col style="width: 83.3%" />
|
| 219 |
+
</colgroup>
|
| 220 |
+
<thead>
|
| 221 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 222 |
+
<th class="head"><p>Behavior</p></th>
|
| 223 |
+
</tr>
|
| 224 |
+
</thead>
|
| 225 |
+
<tbody>
|
| 226 |
+
<tr class="row-even"><td><p><em>Fill Color</em></p></td>
|
| 227 |
+
<td><p>Use Fill Color to change the background color of a table node. This is helpful if you want to
|
| 228 |
+
identify a of group tables. Once set, all the newly added tables will take the same color.</p></td>
|
| 229 |
+
</tr>
|
| 230 |
+
<tr class="row-odd"><td><p><em>Text Color</em></p></td>
|
| 231 |
+
<td><p>Use Text Color to change the text color of a table node based on the fill color to make text
|
| 232 |
+
easily readable.</p></td>
|
| 233 |
+
</tr>
|
| 234 |
+
</tbody>
|
| 235 |
+
</table>
|
| 236 |
+
</section>
|
| 237 |
+
<section id="utility-options">
|
| 238 |
+
<h2>Utility Options<a class="headerlink" href="#utility-options" title="Link to this heading">¶</a></h2>
|
| 239 |
+
<table class="longtable docutils align-default">
|
| 240 |
+
<colgroup>
|
| 241 |
+
<col style="width: 16.7%" />
|
| 242 |
+
<col style="width: 66.7%" />
|
| 243 |
+
<col style="width: 16.7%" />
|
| 244 |
+
</colgroup>
|
| 245 |
+
<thead>
|
| 246 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 247 |
+
<th class="head"><p>Behavior</p></th>
|
| 248 |
+
<th class="head"><p>Shortcut</p></th>
|
| 249 |
+
</tr>
|
| 250 |
+
</thead>
|
| 251 |
+
<tbody>
|
| 252 |
+
<tr class="row-even"><td><p><em>Add/Edit note</em></p></td>
|
| 253 |
+
<td><p>Click this button to make notes on tables nodes while designing the database.</p></td>
|
| 254 |
+
<td><p>Option/Alt +
|
| 255 |
+
Ctrl + N</p></td>
|
| 256 |
+
</tr>
|
| 257 |
+
<tr class="row-odd"><td><p><em>Auto align</em></p></td>
|
| 258 |
+
<td><p>Click this button to auto align all tables and links to make it look more cleaner.</p></td>
|
| 259 |
+
<td><p>Option/Alt +
|
| 260 |
+
Ctrl + L</p></td>
|
| 261 |
+
</tr>
|
| 262 |
+
<tr class="row-even"><td><p><em>Show details</em></p></td>
|
| 263 |
+
<td><p>Click this button to toggle the column details visibility. It allows you to show few or more
|
| 264 |
+
column details.</p></td>
|
| 265 |
+
<td><p>Option/Alt +
|
| 266 |
+
Shift + D</p></td>
|
| 267 |
+
</tr>
|
| 268 |
+
<tr class="row-odd"><td><p><em>Cardinality Notation</em></p></td>
|
| 269 |
+
<td><p>Change the cardinality notation format used to present relationship links. Options available
|
| 270 |
+
are - Crow’s Foot Notation and Chen Notation.</p></td>
|
| 271 |
+
<td></td>
|
| 272 |
+
</tr>
|
| 273 |
+
</tbody>
|
| 274 |
+
</table>
|
| 275 |
+
</section>
|
| 276 |
+
<section id="zoom-options">
|
| 277 |
+
<h2>Zoom Options<a class="headerlink" href="#zoom-options" title="Link to this heading">¶</a></h2>
|
| 278 |
+
<table class="longtable docutils align-default">
|
| 279 |
+
<colgroup>
|
| 280 |
+
<col style="width: 16.7%" />
|
| 281 |
+
<col style="width: 66.7%" />
|
| 282 |
+
<col style="width: 16.7%" />
|
| 283 |
+
</colgroup>
|
| 284 |
+
<thead>
|
| 285 |
+
<tr class="row-odd"><th class="head"><p>Icon</p></th>
|
| 286 |
+
<th class="head"><p>Behavior</p></th>
|
| 287 |
+
<th class="head"><p>Shortcut</p></th>
|
| 288 |
+
</tr>
|
| 289 |
+
</thead>
|
| 290 |
+
<tbody>
|
| 291 |
+
<tr class="row-even"><td><p><em>Zoom to fit</em></p></td>
|
| 292 |
+
<td><p>Click this button to zoom in/out automatically and fit all the tables to the view.</p></td>
|
| 293 |
+
<td><p>Option/Alt +
|
| 294 |
+
Shift + F</p></td>
|
| 295 |
+
</tr>
|
| 296 |
+
<tr class="row-odd"><td><p><em>Zoom in</em></p></td>
|
| 297 |
+
<td><p>Click this button to zoom in the diagram.</p></td>
|
| 298 |
+
<td><p>Option/Alt +
|
| 299 |
+
Shift + “+”</p></td>
|
| 300 |
+
</tr>
|
| 301 |
+
<tr class="row-even"><td><p><em>Zoom out</em></p></td>
|
| 302 |
+
<td><p>Click this button to zoom out the diagram.</p></td>
|
| 303 |
+
<td><p>Option/Alt +
|
| 304 |
+
Shift + “-”</p></td>
|
| 305 |
+
</tr>
|
| 306 |
+
</tbody>
|
| 307 |
+
</table>
|
| 308 |
+
</section>
|
| 309 |
+
<section id="table-dialog">
|
| 310 |
+
<h2>Table Dialog<a class="headerlink" href="#table-dialog" title="Link to this heading">¶</a></h2>
|
| 311 |
+
<img alt="ERD tool table dialog" class="align-center" src="_images/erd_table_dialog.png" />
|
| 312 |
+
<p>The table dialog allows you to:</p>
|
| 313 |
+
<ul class="simple">
|
| 314 |
+
<li><p>Change the table structure details.</p></li>
|
| 315 |
+
<li><p>It can be used edit an existing table or add a new one.</p></li>
|
| 316 |
+
<li><p>Refer <a class="reference internal" href="table_dialog.html#table-dialog"><span class="std std-ref">table dialog</span></a> for information on different fields.</p></li>
|
| 317 |
+
</ul>
|
| 318 |
+
</section>
|
| 319 |
+
<section id="table-node">
|
| 320 |
+
<h2>Table Node<a class="headerlink" href="#table-node" title="Link to this heading">¶</a></h2>
|
| 321 |
+
<img alt="ERD tool table node" class="align-center" src="_images/erd_table_node.png" />
|
| 322 |
+
<p>The table node shows table details in a graphical representation:</p>
|
| 323 |
+
<ul class="simple">
|
| 324 |
+
<li><p>The top bar has a <em>details toggle button</em> that is used to toggle column details visibility. There is also a <em>note button</em> that is visible only if there is some note added. you can click on this button to quickly change the note.</p></li>
|
| 325 |
+
<li><p>The first row shows the schema name of the table. Eg. <em>public</em> in above image.</p></li>
|
| 326 |
+
<li><p>The second row shows the table name. Eg. <em>users</em> in above image.</p></li>
|
| 327 |
+
<li><p>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.</p></li>
|
| 328 |
+
<li><p>you can click on the node and drag to move on the canvas.</p></li>
|
| 329 |
+
<li><p>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 <a class="reference internal" href="table_dialog.html#table-dialog"><span class="std std-ref">table dialog</span></a> for information on different fields.</p></li>
|
| 330 |
+
</ul>
|
| 331 |
+
</section>
|
| 332 |
+
<section id="the-one-to-many-link-dialog">
|
| 333 |
+
<h2>The One to Many Link Dialog<a class="headerlink" href="#the-one-to-many-link-dialog" title="Link to this heading">¶</a></h2>
|
| 334 |
+
<img alt="ERD tool 1M dialog" class="align-center" src="_images/erd_1m_dialog.png" />
|
| 335 |
+
<p>The one to many link dialog allows you to:</p>
|
| 336 |
+
<ul class="simple">
|
| 337 |
+
<li><p>Add a foreign key relationship between two tables.</p></li>
|
| 338 |
+
<li><p><em>Local Table</em> is the table that references a table and has the <em>many</em> end point.</p></li>
|
| 339 |
+
<li><p><em>Local Column</em> the column that references.</p></li>
|
| 340 |
+
<li><p><em>Referenced Table</em> is the table that is being referred and has the <em>one</em> end point.</p></li>
|
| 341 |
+
<li><p><em>Referenced Column</em> the column that is being referred.</p></li>
|
| 342 |
+
</ul>
|
| 343 |
+
</section>
|
| 344 |
+
<section id="the-many-to-many-link-dialog">
|
| 345 |
+
<h2>The Many to Many Link Dialog<a class="headerlink" href="#the-many-to-many-link-dialog" title="Link to this heading">¶</a></h2>
|
| 346 |
+
<img alt="ERD tool MM dialog" class="align-center" src="_images/erd_mm_dialog.png" />
|
| 347 |
+
<p>The many to many link dialog allows you to:</p>
|
| 348 |
+
<ul class="simple">
|
| 349 |
+
<li><p>Add a many to many relationship between two tables.</p></li>
|
| 350 |
+
<li><p>It creates a relationship tables having columns derived from the two tables and link them to the tables.</p></li>
|
| 351 |
+
<li><p><em>Left Table</em> is the first table that is to be linked. It will receive the <em>one</em> endpoint of the link with the new relation table.</p></li>
|
| 352 |
+
<li><p><em>Left Column</em> the column of the first table, that will always be a primary key.</p></li>
|
| 353 |
+
<li><p><em>Right Table</em> is the second table that is to be linked. It will receive the <em>one</em> endpoint of the link with the new relation table.</p></li>
|
| 354 |
+
<li><p><em>Right Column</em> the column of the second table, that will always be a primary key.</p></li>
|
| 355 |
+
</ul>
|
| 356 |
+
</section>
|
| 357 |
+
<section id="the-table-link">
|
| 358 |
+
<h2>The Table Link<a class="headerlink" href="#the-table-link" title="Link to this heading">¶</a></h2>
|
| 359 |
+
<img alt="ERD tool table link" class="align-center" src="_images/erd_table_link.png" />
|
| 360 |
+
<p>The table link shows relationship between tables:</p>
|
| 361 |
+
<ul class="simple">
|
| 362 |
+
<li><p>The single line endpoint of the link shows the column that is being referred.</p></li>
|
| 363 |
+
<li><p>The three line endpoint of the link shows the column that refers.</p></li>
|
| 364 |
+
<li><p>If one of the columns that is being referred or that refers is removed from the table then the link will get dropped.</p></li>
|
| 365 |
+
<li><p>you can click on the link and drag to move on the canvas.</p></li>
|
| 366 |
+
</ul>
|
| 367 |
+
</section>
|
| 368 |
+
<section id="the-table-notes">
|
| 369 |
+
<h2>The Table Notes<a class="headerlink" href="#the-table-notes" title="Link to this heading">¶</a></h2>
|
| 370 |
+
<img alt="ERD tool table note" class="align-center" src="_images/erd_table_note.png" />
|
| 371 |
+
<ul class="simple">
|
| 372 |
+
<li><p>You can use the notes popup to mark some notes while designing the database.</p></li>
|
| 373 |
+
<li><p>You open the pop-up using the toolbar note button.</p></li>
|
| 374 |
+
<li><p>If some note is added to a table then it will have notes button on the table node. You can click on the button to check/update notes.</p></li>
|
| 375 |
+
</ul>
|
| 376 |
+
</section>
|
| 377 |
+
</section>
|
| 378 |
+
|
| 379 |
+
|
| 380 |
+
<div class="clearer"></div>
|
| 381 |
+
</div>
|
| 382 |
+
</div>
|
| 383 |
+
</div>
|
| 384 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 385 |
+
<div class="sphinxsidebarwrapper">
|
| 386 |
+
<div>
|
| 387 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 388 |
+
<ul>
|
| 389 |
+
<li><a class="reference internal" href="#">ERD Tool</a><ul>
|
| 390 |
+
<li><a class="reference internal" href="#toolbar">Toolbar</a></li>
|
| 391 |
+
<li><a class="reference internal" href="#file-options">File Options</a></li>
|
| 392 |
+
<li><a class="reference internal" href="#export-options">Export Options</a></li>
|
| 393 |
+
<li><a class="reference internal" href="#editing-options">Editing Options</a></li>
|
| 394 |
+
<li><a class="reference internal" href="#table-relationship-options">Table Relationship Options</a></li>
|
| 395 |
+
<li><a class="reference internal" href="#node-color-options">Node Color Options</a></li>
|
| 396 |
+
<li><a class="reference internal" href="#utility-options">Utility Options</a></li>
|
| 397 |
+
<li><a class="reference internal" href="#zoom-options">Zoom Options</a></li>
|
| 398 |
+
<li><a class="reference internal" href="#table-dialog">Table Dialog</a></li>
|
| 399 |
+
<li><a class="reference internal" href="#table-node">Table Node</a></li>
|
| 400 |
+
<li><a class="reference internal" href="#the-one-to-many-link-dialog">The One to Many Link Dialog</a></li>
|
| 401 |
+
<li><a class="reference internal" href="#the-many-to-many-link-dialog">The Many to Many Link Dialog</a></li>
|
| 402 |
+
<li><a class="reference internal" href="#the-table-link">The Table Link</a></li>
|
| 403 |
+
<li><a class="reference internal" href="#the-table-notes">The Table Notes</a></li>
|
| 404 |
+
</ul>
|
| 405 |
+
</li>
|
| 406 |
+
</ul>
|
| 407 |
+
|
| 408 |
+
</div>
|
| 409 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 410 |
+
<ul class="current">
|
| 411 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 412 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 413 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 414 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 415 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 416 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 417 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 418 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 419 |
+
<li class="toctree-l1 current"><a class="reference internal" href="developer_tools.html">Developer Tools</a><ul class="current">
|
| 420 |
+
<li class="toctree-l2"><a class="reference internal" href="debugger.html">Debugger</a></li>
|
| 421 |
+
<li class="toctree-l2"><a class="reference internal" href="query_tool.html">Query Tool</a></li>
|
| 422 |
+
<li class="toctree-l2"><a class="reference internal" href="editgrid.html">View/Edit Data</a></li>
|
| 423 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_diff.html">Schema Diff</a></li>
|
| 424 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">ERD Tool</a></li>
|
| 425 |
+
<li class="toctree-l2"><a class="reference internal" href="psql_tool.html">PSQL Tool</a></li>
|
| 426 |
+
</ul>
|
| 427 |
+
</li>
|
| 428 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 429 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 430 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 431 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 432 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 433 |
+
</ul>
|
| 434 |
+
|
| 435 |
+
<search id="searchbox" style="display: none" role="search">
|
| 436 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 437 |
+
<div class="searchformwrapper">
|
| 438 |
+
<form class="search" action="search.html" method="get">
|
| 439 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 440 |
+
<input type="submit" value="Go" />
|
| 441 |
+
</form>
|
| 442 |
+
</div>
|
| 443 |
+
</search>
|
| 444 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 445 |
+
</div>
|
| 446 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 447 |
+
<span>«</span>
|
| 448 |
+
</div>
|
| 449 |
+
|
| 450 |
+
</div>
|
| 451 |
+
<div class="clearer"></div>
|
| 452 |
+
</div>
|
| 453 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 454 |
+
<h3>Navigation</h3>
|
| 455 |
+
<ul>
|
| 456 |
+
<li class="right" style="margin-right: 10px">
|
| 457 |
+
<a href="genindex.html" title="General Index"
|
| 458 |
+
>index</a></li>
|
| 459 |
+
<li class="right" >
|
| 460 |
+
<a href="psql_tool.html" title="PSQL Tool"
|
| 461 |
+
>next</a> |</li>
|
| 462 |
+
<li class="right" >
|
| 463 |
+
<a href="schema_diff.html" title="Schema Diff"
|
| 464 |
+
>previous</a> |</li>
|
| 465 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 466 |
+
<li class="nav-item nav-item-1"><a href="developer_tools.html" >Developer Tools</a> »</li>
|
| 467 |
+
<li class="nav-item nav-item-this"><a href="">ERD Tool</a></li>
|
| 468 |
+
</ul>
|
| 469 |
+
</div>
|
| 470 |
+
<div class="footer" role="contentinfo">
|
| 471 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 472 |
+
<ul>
|
| 473 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 474 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 475 |
+
<li class="right" ><a href="psql_tool.html" title="PSQL Tool" accesskey="N">next</a> |</li>
|
| 476 |
+
<li class="right" ><a href="schema_diff.html" title="Schema Diff" accesskey="P">previous</a> |</li>
|
| 477 |
+
</ul>
|
| 478 |
+
</div>
|
| 479 |
+
</div>
|
| 480 |
+
</body>
|
| 481 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/event_trigger_dialog.html
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Event Trigger Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Extension Dialog" href="extension_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Domain Constraints Dialog" href="domain_constraint_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="extension_dialog.html" title="Extension Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="domain_constraint_dialog.html" title="Domain Constraints Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Event Trigger Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="event-trigger-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Event Trigger Dialog<a class="headerlink" href="#event-trigger-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Event Trigger</em> dialog to define an event trigger. Unlike regular
|
| 51 |
+
triggers, which are attached to a single table and capture only DML events,
|
| 52 |
+
event triggers are global to a particular database and are capable of capturing
|
| 53 |
+
DDL events. Like regular triggers, event triggers can be written in any
|
| 54 |
+
procedural language that includes event trigger support, or in C, but not in
|
| 55 |
+
SQL.</p>
|
| 56 |
+
<p>The <em>Event Trigger</em> dialog organizes the development of a event trigger through
|
| 57 |
+
the following dialog tabs: <em>General</em>, <em>Definition</em>, and <em>Security Labels</em>. The
|
| 58 |
+
<em>SQL</em> tab displays the SQL code generated by dialog selections.</p>
|
| 59 |
+
<img alt="Event trigger dialog general tab" class="align-center" src="_images/event_trigger_general.png" />
|
| 60 |
+
<p>Use the fields in the <em>General</em> tab to identify the event trigger:</p>
|
| 61 |
+
<ul class="simple">
|
| 62 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the event trigger. The name
|
| 63 |
+
will be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 64 |
+
<li><p>Use the drop-down listbox next to <em>Owner</em> to specify the owner of the event
|
| 65 |
+
trigger.</p></li>
|
| 66 |
+
<li><p>Store notes about the event trigger in the <em>Comment</em> field.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 69 |
+
<img alt="Event trigger dialog definition tab" class="align-center" src="_images/event_trigger_definition.png" />
|
| 70 |
+
<p>Use the fields in the <em>Definition</em> tab to define the event trigger:</p>
|
| 71 |
+
<ul class="simple">
|
| 72 |
+
<li><p>Select a value from the drop down of <em>Trigger Enabled</em> field to specify a status
|
| 73 |
+
for the trigger: <em>Enable</em> <em>Disable</em>, <em>Replica</em> <em>Always</em>.</p></li>
|
| 74 |
+
<li><p>Use the drop-down listbox next to <em>Trigger function</em> to specify an existing
|
| 75 |
+
function. A trigger function takes an empty argument list, and returns a
|
| 76 |
+
value of type event_trigger.</p></li>
|
| 77 |
+
<li><p>Select a value from the drop down of <em>Events</em> field to specify when the event
|
| 78 |
+
trigger will fire: <em>DDL COMMAND START</em>, <em>DDL COMMAND END</em>, or <em>SQL DROP</em>.</p></li>
|
| 79 |
+
<li><p>Use the <em>When TAG in</em> field to enter filter values for TAG for which the trigger
|
| 80 |
+
will be executed. The values must be in single quotes separated by comma.</p></li>
|
| 81 |
+
</ul>
|
| 82 |
+
<p>Click the <em>Security Labels</em> tab to continue.</p>
|
| 83 |
+
<img alt="Event trigger dialog security tab" class="align-center" src="_images/event_trigger_security.png" />
|
| 84 |
+
<p>Use the <em>Security</em> tab to define security labels applied to the trigger. Click
|
| 85 |
+
the <em>Add</em> icon (+) to add each security label.</p>
|
| 86 |
+
<ul class="simple">
|
| 87 |
+
<li><p>Specify a security label provider in the <em>Provider</em> field. The named provider
|
| 88 |
+
must be loaded and must consent to the proposed labeling operation.</p></li>
|
| 89 |
+
<li><p>Specify a security label in the <em>Security Label</em> field. The meaning of a given
|
| 90 |
+
label is at the discretion of the label provider. PostgreSQL places no
|
| 91 |
+
restrictions on whether or how a label provider must interpret security
|
| 92 |
+
labels; it merely provides a mechanism for storing them.</p></li>
|
| 93 |
+
</ul>
|
| 94 |
+
<p>Click the <em>Add</em> icon (+) to assign additional security labels; to discard a
|
| 95 |
+
security label, click the trash icon to the left of the row and confirm deletion
|
| 96 |
+
in the <em>Delete Row</em> popup.</p>
|
| 97 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 98 |
+
<p>Your entries in the <em>Event Trigger</em> dialog generate a generate a SQL command.
|
| 99 |
+
Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes to the
|
| 100 |
+
SQL command.</p>
|
| 101 |
+
<section id="example">
|
| 102 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 103 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 104 |
+
the <em>Event Trigger</em> dialog:</p>
|
| 105 |
+
<img alt="Event trigger dialog sql tab" class="align-center" src="_images/event_trigger_sql.png" />
|
| 106 |
+
<p>The command creates an event trigger named <em>accounts</em> that invokes the procedure
|
| 107 |
+
named <em>evt_tri_fun</em>.</p>
|
| 108 |
+
<ul class="simple">
|
| 109 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 110 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 111 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 112 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 113 |
+
</ul>
|
| 114 |
+
</section>
|
| 115 |
+
</section>
|
| 116 |
+
|
| 117 |
+
|
| 118 |
+
<div class="clearer"></div>
|
| 119 |
+
</div>
|
| 120 |
+
</div>
|
| 121 |
+
</div>
|
| 122 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 123 |
+
<div class="sphinxsidebarwrapper">
|
| 124 |
+
<div>
|
| 125 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 126 |
+
<ul>
|
| 127 |
+
<li><a class="reference internal" href="#">Event Trigger Dialog</a><ul>
|
| 128 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 129 |
+
</ul>
|
| 130 |
+
</li>
|
| 131 |
+
</ul>
|
| 132 |
+
|
| 133 |
+
</div>
|
| 134 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 135 |
+
<ul class="current">
|
| 136 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 137 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 139 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 140 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 142 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 143 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 144 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 145 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 146 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Event Trigger Dialog</a></li>
|
| 147 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 148 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 149 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 150 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 151 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 152 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 153 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 154 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 155 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 156 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 157 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 158 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 159 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 160 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 161 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 162 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 163 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 164 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 165 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 166 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 167 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 168 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 169 |
+
</ul>
|
| 170 |
+
</li>
|
| 171 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 172 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 173 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 174 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 175 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 176 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 177 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 178 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 179 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 180 |
+
</ul>
|
| 181 |
+
|
| 182 |
+
<search id="searchbox" style="display: none" role="search">
|
| 183 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 184 |
+
<div class="searchformwrapper">
|
| 185 |
+
<form class="search" action="search.html" method="get">
|
| 186 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 187 |
+
<input type="submit" value="Go" />
|
| 188 |
+
</form>
|
| 189 |
+
</div>
|
| 190 |
+
</search>
|
| 191 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 192 |
+
</div>
|
| 193 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 194 |
+
<span>«</span>
|
| 195 |
+
</div>
|
| 196 |
+
|
| 197 |
+
</div>
|
| 198 |
+
<div class="clearer"></div>
|
| 199 |
+
</div>
|
| 200 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 201 |
+
<h3>Navigation</h3>
|
| 202 |
+
<ul>
|
| 203 |
+
<li class="right" style="margin-right: 10px">
|
| 204 |
+
<a href="genindex.html" title="General Index"
|
| 205 |
+
>index</a></li>
|
| 206 |
+
<li class="right" >
|
| 207 |
+
<a href="extension_dialog.html" title="Extension Dialog"
|
| 208 |
+
>next</a> |</li>
|
| 209 |
+
<li class="right" >
|
| 210 |
+
<a href="domain_constraint_dialog.html" title="Domain Constraints Dialog"
|
| 211 |
+
>previous</a> |</li>
|
| 212 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 213 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 214 |
+
<li class="nav-item nav-item-this"><a href="">Event Trigger Dialog</a></li>
|
| 215 |
+
</ul>
|
| 216 |
+
</div>
|
| 217 |
+
<div class="footer" role="contentinfo">
|
| 218 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 219 |
+
<ul>
|
| 220 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 221 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 222 |
+
<li class="right" ><a href="extension_dialog.html" title="Extension Dialog" accesskey="N">next</a> |</li>
|
| 223 |
+
<li class="right" ><a href="domain_constraint_dialog.html" title="Domain Constraints Dialog" accesskey="P">previous</a> |</li>
|
| 224 |
+
</ul>
|
| 225 |
+
</div>
|
| 226 |
+
</div>
|
| 227 |
+
</body>
|
| 228 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/exclusion_constraint_dialog.html
ADDED
|
@@ -0,0 +1,229 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Exclusion Constraint Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Foreign key Dialog" href="foreign_key_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Compound Trigger Dialog" href="compound_trigger_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="foreign_key_dialog.html" title="Foreign key Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="compound_trigger_dialog.html" title="Compound Trigger Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" accesskey="U">Creating or Modifying a Table</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Exclusion Constraint Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="exclusion-constraint-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Exclusion Constraint Dialog<a class="headerlink" href="#exclusion-constraint-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Exclusion constraint</em> dialog to define or modify the behavior of an
|
| 51 |
+
exclusion constraint. An exclusion constraint guarantees that if any two rows
|
| 52 |
+
are compared on the specified column or expression (using the specified
|
| 53 |
+
operator), at least one of the operator comparisons will return false or null.</p>
|
| 54 |
+
<p>The <em>Exclusion constraint</em> dialog organizes the development of an exclusion
|
| 55 |
+
constraint through the following dialog tabs: <em>General</em>, <em>Definition</em>, and
|
| 56 |
+
<em>Columns</em>. The <em>SQL</em> tab displays the SQL code generated by dialog selections.</p>
|
| 57 |
+
<img alt="Exclusion constraint dialog general tab" class="align-center" src="_images/exclusion_constraint_general.png" />
|
| 58 |
+
<p>Use the fields in the <em>General</em> tab to identify the exclusion constraint:</p>
|
| 59 |
+
<ul class="simple">
|
| 60 |
+
<li><p>Use the <em>Name</em> field to provide a descriptive name for the exclusion
|
| 61 |
+
constraint. The name will be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 62 |
+
</ul>
|
| 63 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 64 |
+
<img alt="Exclusion constraint dialog definition tab" class="align-center" src="_images/exclusion_constraint_definition.png" />
|
| 65 |
+
<p>Use the fields in the <em>Definition</em> tab to define the exclusion constraint:</p>
|
| 66 |
+
<ul>
|
| 67 |
+
<li><p>Use the drop-down listbox next to <em>Tablespace</em> to select the tablespace in
|
| 68 |
+
which the index associated with the exclude constraint will reside.</p></li>
|
| 69 |
+
<li><p>Use the drop-down listbox next to <em>Access method</em> to specify the type of
|
| 70 |
+
index that will be used when implementing the exclusion constraint:</p>
|
| 71 |
+
<blockquote>
|
| 72 |
+
<div><ul class="simple">
|
| 73 |
+
<li><p>Select <em>gist</em> to specify a GiST index.</p></li>
|
| 74 |
+
<li><p>Select <em>spgist</em> to specify a space-partitioned GiST index.</p></li>
|
| 75 |
+
<li><p>Select <em>btree</em> to specify a B-tree index.</p></li>
|
| 76 |
+
<li><p>Select <em>hash</em> to specify a hash index.</p></li>
|
| 77 |
+
</ul>
|
| 78 |
+
</div></blockquote>
|
| 79 |
+
</li>
|
| 80 |
+
<li><p>Use the <em>Fill Factor</em> field to specify a fill factor for the table and
|
| 81 |
+
associated index. The fill factor is a percentage between 10 and 100. 100
|
| 82 |
+
(complete packing) is the default.</p></li>
|
| 83 |
+
<li><p>Move the <em>Deferrable?</em> switch to the <em>Yes</em> position to specify that the
|
| 84 |
+
timing of the constraint is deferrable, and can be postponed until the end of
|
| 85 |
+
the statement. The default is <em>No</em>.</p></li>
|
| 86 |
+
<li><p>If enabled, move the <em>Deferred?</em> switch to the <em>Yes</em> position to specify the
|
| 87 |
+
timing of the constraint is deferred to the end of the statement. The default
|
| 88 |
+
is <em>No</em>.</p></li>
|
| 89 |
+
<li><p>Use the <em>Constraint</em> field to provide a condition that a row must satisfy to
|
| 90 |
+
be included in the table.</p></li>
|
| 91 |
+
</ul>
|
| 92 |
+
<p>Click the <em>Columns</em> tab to continue.</p>
|
| 93 |
+
<img alt="Exclusion constraint dialog columns tab" class="align-center" src="_images/exclusion_constraint_columns.png" />
|
| 94 |
+
<p>Use the fields in the <em>Columns</em> tab to specify the column(s) or expression(s)
|
| 95 |
+
to which the constraint applies. Use the <em>Is expression ?</em> switch to enable
|
| 96 |
+
expression text input. Use the drop-down listbox next to <em>Column</em>
|
| 97 |
+
to select a column. Once the <em>Column</em> is selected or the <em>Expression</em> is
|
| 98 |
+
entered then click the <em>Add</em> icon (+) to provide details of the action on the
|
| 99 |
+
column/expression:</p>
|
| 100 |
+
<ul class="simple">
|
| 101 |
+
<li><p>The <em>Col/Exp</em> field is populated with the selection made in the <em>Column</em>
|
| 102 |
+
drop-down listbox or the <em>Expression</em> entered.</p></li>
|
| 103 |
+
<li><p>If applicable, use the drop-down listbox in the <em>Operator class</em> to specify
|
| 104 |
+
the operator class that will be used by the index for the column.</p></li>
|
| 105 |
+
<li><p>Move the <em>DESC</em> switch to <em>DESC</em> to specify a descending sort order. The
|
| 106 |
+
default is <em>ASC</em> which specifies an ascending sort order.</p></li>
|
| 107 |
+
<li><p>Use the <em>NULLs order</em> column to specify the placement of NULL values (when
|
| 108 |
+
sorted). Specify <em>FIRST</em> or <em>LAST</em>.</p></li>
|
| 109 |
+
<li><p>Use the drop-down list next to <em>Operator</em> to specify a comparison or
|
| 110 |
+
conditional operator.</p></li>
|
| 111 |
+
</ul>
|
| 112 |
+
<p>Use <em>Include columns</em> field to specify columns for <em>INCLUDE</em> clause of the
|
| 113 |
+
constraint. This option is available in Postgres 11 and later.</p>
|
| 114 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 115 |
+
<p>Your entries in the <em>Exclusion Constraint</em> dialog generate a SQL command (see
|
| 116 |
+
an example below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make
|
| 117 |
+
any changes to the SQL command.</p>
|
| 118 |
+
<section id="example">
|
| 119 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 120 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 121 |
+
the <em>Exclusion Constraint</em> dialog:</p>
|
| 122 |
+
<img alt="Exclusion constraint dialog sql tab" class="align-center" src="_images/exclusion_constraint_sql.png" />
|
| 123 |
+
<p>The example shown demonstrates creating an exclusion constraint named
|
| 124 |
+
<em>ex_dept_no</em>. The constraint uses a btree index.</p>
|
| 125 |
+
<ul class="simple">
|
| 126 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 127 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 128 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 129 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 130 |
+
</ul>
|
| 131 |
+
</section>
|
| 132 |
+
</section>
|
| 133 |
+
|
| 134 |
+
|
| 135 |
+
<div class="clearer"></div>
|
| 136 |
+
</div>
|
| 137 |
+
</div>
|
| 138 |
+
</div>
|
| 139 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 140 |
+
<div class="sphinxsidebarwrapper">
|
| 141 |
+
<div>
|
| 142 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 143 |
+
<ul>
|
| 144 |
+
<li><a class="reference internal" href="#">Exclusion Constraint Dialog</a><ul>
|
| 145 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 146 |
+
</ul>
|
| 147 |
+
</li>
|
| 148 |
+
</ul>
|
| 149 |
+
|
| 150 |
+
</div>
|
| 151 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 152 |
+
<ul class="current">
|
| 153 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 154 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 155 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 156 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 157 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 158 |
+
<li class="toctree-l1 current"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a><ul class="current">
|
| 159 |
+
<li class="toctree-l2"><a class="reference internal" href="check_dialog.html">Check Dialog</a></li>
|
| 160 |
+
<li class="toctree-l2"><a class="reference internal" href="column_dialog.html">Column Dialog</a></li>
|
| 161 |
+
<li class="toctree-l2"><a class="reference internal" href="compound_trigger_dialog.html">Compound Trigger Dialog</a></li>
|
| 162 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Exclusion Constraint Dialog</a></li>
|
| 163 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_key_dialog.html">Foreign key Dialog</a></li>
|
| 164 |
+
<li class="toctree-l2"><a class="reference internal" href="index_dialog.html">Index Dialog</a></li>
|
| 165 |
+
<li class="toctree-l2"><a class="reference internal" href="primary_key_dialog.html">Primary key Dialog</a></li>
|
| 166 |
+
<li class="toctree-l2"><a class="reference internal" href="rls_policy_dialog.html">RLS Policy Dialog</a></li>
|
| 167 |
+
<li class="toctree-l2"><a class="reference internal" href="rule_dialog.html">Rule Dialog</a></li>
|
| 168 |
+
<li class="toctree-l2"><a class="reference internal" href="table_dialog.html">Table Dialog</a></li>
|
| 169 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_dialog.html">Trigger Dialog</a></li>
|
| 170 |
+
<li class="toctree-l2"><a class="reference internal" href="unique_constraint_dialog.html">Unique Constraint Dialog</a></li>
|
| 171 |
+
</ul>
|
| 172 |
+
</li>
|
| 173 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 174 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 175 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 176 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 177 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 178 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 179 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 180 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 181 |
+
</ul>
|
| 182 |
+
|
| 183 |
+
<search id="searchbox" style="display: none" role="search">
|
| 184 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 185 |
+
<div class="searchformwrapper">
|
| 186 |
+
<form class="search" action="search.html" method="get">
|
| 187 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 188 |
+
<input type="submit" value="Go" />
|
| 189 |
+
</form>
|
| 190 |
+
</div>
|
| 191 |
+
</search>
|
| 192 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 193 |
+
</div>
|
| 194 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 195 |
+
<span>«</span>
|
| 196 |
+
</div>
|
| 197 |
+
|
| 198 |
+
</div>
|
| 199 |
+
<div class="clearer"></div>
|
| 200 |
+
</div>
|
| 201 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 202 |
+
<h3>Navigation</h3>
|
| 203 |
+
<ul>
|
| 204 |
+
<li class="right" style="margin-right: 10px">
|
| 205 |
+
<a href="genindex.html" title="General Index"
|
| 206 |
+
>index</a></li>
|
| 207 |
+
<li class="right" >
|
| 208 |
+
<a href="foreign_key_dialog.html" title="Foreign key Dialog"
|
| 209 |
+
>next</a> |</li>
|
| 210 |
+
<li class="right" >
|
| 211 |
+
<a href="compound_trigger_dialog.html" title="Compound Trigger Dialog"
|
| 212 |
+
>previous</a> |</li>
|
| 213 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 214 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" >Creating or Modifying a Table</a> »</li>
|
| 215 |
+
<li class="nav-item nav-item-this"><a href="">Exclusion Constraint Dialog</a></li>
|
| 216 |
+
</ul>
|
| 217 |
+
</div>
|
| 218 |
+
<div class="footer" role="contentinfo">
|
| 219 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 220 |
+
<ul>
|
| 221 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 222 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 223 |
+
<li class="right" ><a href="foreign_key_dialog.html" title="Foreign key Dialog" accesskey="N">next</a> |</li>
|
| 224 |
+
<li class="right" ><a href="compound_trigger_dialog.html" title="Compound Trigger Dialog" accesskey="P">previous</a> |</li>
|
| 225 |
+
</ul>
|
| 226 |
+
</div>
|
| 227 |
+
</div>
|
| 228 |
+
</body>
|
| 229 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/extension_dialog.html
ADDED
|
@@ -0,0 +1,209 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Extension Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Foreign Data Wrapper Dialog" href="foreign_data_wrapper_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Event Trigger Dialog" href="event_trigger_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="foreign_data_wrapper_dialog.html" title="Foreign Data Wrapper Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="event_trigger_dialog.html" title="Event Trigger Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Extension Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="extension-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Extension Dialog<a class="headerlink" href="#extension-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Extension</em> dialog to install a new extension into the current database.
|
| 51 |
+
An extension is a collection of SQL objects that add targeted functionality to
|
| 52 |
+
your Postgres installation. The <em>Extension</em> dialog adds the functionality of
|
| 53 |
+
an extension to the current database only; you must register the extension in
|
| 54 |
+
each database that use the extension. Before you load an extension into a
|
| 55 |
+
database, you should confirm that any pre-requisite files are installed.</p>
|
| 56 |
+
<p>The <em>Extension</em> dialog allows you to implement options of the CREATE EXTENSION
|
| 57 |
+
command through the following dialog tabs: <em>General</em> and <em>Definition</em>. The <em>SQL</em>
|
| 58 |
+
tab displays the SQL code generated by dialog selections.</p>
|
| 59 |
+
<img alt="Extension dialog general tab" class="align-center" src="_images/extension_general.png" />
|
| 60 |
+
<p>Use the fields in the <em>General</em> tab to identify an extension:</p>
|
| 61 |
+
<ul class="simple">
|
| 62 |
+
<li><p>Use the drop-down listbox in the <em>Name</em> field to select the extension. Each
|
| 63 |
+
extension must have a unique name.</p></li>
|
| 64 |
+
<li><p>Move the switch next to <em>Cascade?</em> towards right position to automatically
|
| 65 |
+
install any extensions that this extension depends on that are not already
|
| 66 |
+
installed.</p></li>
|
| 67 |
+
<li><p>Store notes about the extension in the <em>Comment</em> field.</p></li>
|
| 68 |
+
</ul>
|
| 69 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 70 |
+
<img alt="Extension dialog definition tab" class="align-center" src="_images/extension_definition.png" />
|
| 71 |
+
<p>Use the <em>Definition</em> tab to select the <em>Schema</em> and <em>Version</em>:</p>
|
| 72 |
+
<ul class="simple">
|
| 73 |
+
<li><p>Use the drop-down listbox next to <em>Schema</em> to select the name of the schema
|
| 74 |
+
in which to install the extension’s objects.</p></li>
|
| 75 |
+
<li><p>Use the drop-down listbox next to <em>Version</em> to select the version of the
|
| 76 |
+
extension to install.</p></li>
|
| 77 |
+
</ul>
|
| 78 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 79 |
+
<p>Your entries in the <em>Extension</em> dialog generate a SQL command (see an example
|
| 80 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 81 |
+
to the SQL command.</p>
|
| 82 |
+
<section id="example">
|
| 83 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 84 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 85 |
+
the <em>Extension</em> dialog:</p>
|
| 86 |
+
<img alt="Extension dialog sql tab" class="align-center" src="_images/extension_sql.png" />
|
| 87 |
+
<p>The command creates the <em>adminpack</em> extension in the <em>public</em> schema. It is
|
| 88 |
+
version <em>2.0</em> of <em>adminpack</em>.</p>
|
| 89 |
+
<ul class="simple">
|
| 90 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 91 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 92 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 93 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 94 |
+
</ul>
|
| 95 |
+
</section>
|
| 96 |
+
</section>
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
<div class="clearer"></div>
|
| 100 |
+
</div>
|
| 101 |
+
</div>
|
| 102 |
+
</div>
|
| 103 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 104 |
+
<div class="sphinxsidebarwrapper">
|
| 105 |
+
<div>
|
| 106 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 107 |
+
<ul>
|
| 108 |
+
<li><a class="reference internal" href="#">Extension Dialog</a><ul>
|
| 109 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 110 |
+
</ul>
|
| 111 |
+
</li>
|
| 112 |
+
</ul>
|
| 113 |
+
|
| 114 |
+
</div>
|
| 115 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 116 |
+
<ul class="current">
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 118 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 119 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 120 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 121 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 122 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 123 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 124 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 125 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 126 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 127 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 128 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Extension Dialog</a></li>
|
| 129 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 130 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 131 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 132 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 133 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 134 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 135 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 136 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 137 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 138 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 139 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 140 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 141 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 142 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 143 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 144 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 145 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 146 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 147 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 148 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 149 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 150 |
+
</ul>
|
| 151 |
+
</li>
|
| 152 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 153 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 154 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 155 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 156 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 157 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 158 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 159 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 160 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 161 |
+
</ul>
|
| 162 |
+
|
| 163 |
+
<search id="searchbox" style="display: none" role="search">
|
| 164 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 165 |
+
<div class="searchformwrapper">
|
| 166 |
+
<form class="search" action="search.html" method="get">
|
| 167 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 168 |
+
<input type="submit" value="Go" />
|
| 169 |
+
</form>
|
| 170 |
+
</div>
|
| 171 |
+
</search>
|
| 172 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 173 |
+
</div>
|
| 174 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 175 |
+
<span>«</span>
|
| 176 |
+
</div>
|
| 177 |
+
|
| 178 |
+
</div>
|
| 179 |
+
<div class="clearer"></div>
|
| 180 |
+
</div>
|
| 181 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 182 |
+
<h3>Navigation</h3>
|
| 183 |
+
<ul>
|
| 184 |
+
<li class="right" style="margin-right: 10px">
|
| 185 |
+
<a href="genindex.html" title="General Index"
|
| 186 |
+
>index</a></li>
|
| 187 |
+
<li class="right" >
|
| 188 |
+
<a href="foreign_data_wrapper_dialog.html" title="Foreign Data Wrapper Dialog"
|
| 189 |
+
>next</a> |</li>
|
| 190 |
+
<li class="right" >
|
| 191 |
+
<a href="event_trigger_dialog.html" title="Event Trigger Dialog"
|
| 192 |
+
>previous</a> |</li>
|
| 193 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 194 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 195 |
+
<li class="nav-item nav-item-this"><a href="">Extension Dialog</a></li>
|
| 196 |
+
</ul>
|
| 197 |
+
</div>
|
| 198 |
+
<div class="footer" role="contentinfo">
|
| 199 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 200 |
+
<ul>
|
| 201 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 202 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 203 |
+
<li class="right" ><a href="foreign_data_wrapper_dialog.html" title="Foreign Data Wrapper Dialog" accesskey="N">next</a> |</li>
|
| 204 |
+
<li class="right" ><a href="event_trigger_dialog.html" title="Event Trigger Dialog" accesskey="P">previous</a> |</li>
|
| 205 |
+
</ul>
|
| 206 |
+
</div>
|
| 207 |
+
</div>
|
| 208 |
+
</body>
|
| 209 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/external_database.html
ADDED
|
@@ -0,0 +1,183 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>External database for pgAdmin user settings — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Connecting To A Server" href="connecting.html" />
|
| 23 |
+
<link rel="prev" title="Search objects" href="search_objects.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="connecting.html" title="Connecting To A Server"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="search_objects.html" title="Search objects"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-this"><a href="">External database for pgAdmin user settings</a></li>
|
| 39 |
+
</ul>
|
| 40 |
+
</div>
|
| 41 |
+
|
| 42 |
+
<div class="document">
|
| 43 |
+
<div class="documentwrapper">
|
| 44 |
+
<div class="bodywrapper">
|
| 45 |
+
<div class="body" role="main">
|
| 46 |
+
|
| 47 |
+
<section id="external-database-for-pgadmin-user-settings">
|
| 48 |
+
<span id="external-database"></span><h1><span class="target" id="index-0"></span>External database for pgAdmin user settings<a class="headerlink" href="#external-database-for-pgadmin-user-settings" title="Link to this heading">¶</a></h1>
|
| 49 |
+
<p>The user settings used by pgAdmin are stored in a SQLite database. In this
|
| 50 |
+
database, many settings are stored, such as preferences, user accounts,
|
| 51 |
+
auto-discovered servers, and many more.</p>
|
| 52 |
+
<p>As SQLite is a file-based database and it can be anywhere in the file system,
|
| 53 |
+
so it is not designed to take care of failures (no HA support). Furthermore,
|
| 54 |
+
it isn’t designed to handle multiple connections concurrently reading/writing
|
| 55 |
+
data to it. Example: In environments such as Kubernetes it may be useful to
|
| 56 |
+
use an alternate backend to avoid using SQLite on non-ephemeral storage and to
|
| 57 |
+
allow HA of the settings database.</p>
|
| 58 |
+
<p>In order to prevent this, pgAdmin now supports storing user settings in an
|
| 59 |
+
external database using the new ‘CONFIG_DATABASE_URI’ parameter in the
|
| 60 |
+
<a class="reference internal" href="config_py.html#config-py"><span class="std std-ref">config.py</span></a> file.</p>
|
| 61 |
+
<section id="use-sqlite-database">
|
| 62 |
+
<h2>Use SQLite Database<a class="headerlink" href="#use-sqlite-database" title="Link to this heading">¶</a></h2>
|
| 63 |
+
<p>In order to use SQLite Database, make sure CONFIG_DATABASE_URI parameter is
|
| 64 |
+
set to an empty string like ‘’. By default it is set to an empty string in the
|
| 65 |
+
config.py so if you would like to use SQLite database then no need to change
|
| 66 |
+
anything.</p>
|
| 67 |
+
</section>
|
| 68 |
+
<section id="use-external-database">
|
| 69 |
+
<h2>Use External Database<a class="headerlink" href="#use-external-database" title="Link to this heading">¶</a></h2>
|
| 70 |
+
<p>In order to use an external database, make sure CONFIG_DATABASE_URI parameter
|
| 71 |
+
is set like “dialect+driver://username:password@host:port/database”.</p>
|
| 72 |
+
<p><strong>Note</strong> It is recommended to create the database in advance.</p>
|
| 73 |
+
</section>
|
| 74 |
+
<section id="use-postgresql-database">
|
| 75 |
+
<h2>Use PostgreSQL Database<a class="headerlink" href="#use-postgresql-database" title="Link to this heading">¶</a></h2>
|
| 76 |
+
<p>Following are the formats to use PostgreSQL as an external database.</p>
|
| 77 |
+
<p>Basic syntax:</p>
|
| 78 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>postgresql://username:password@host:port/database
|
| 79 |
+
</pre></div>
|
| 80 |
+
</div>
|
| 81 |
+
<p>Using specific schema (It is recommended to create the schema in advance):</p>
|
| 82 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>postgresql://username:password@host:port/database?options<span class="o">=</span>-csearch_path<span class="o">=</span><schema<span class="w"> </span>name>
|
| 83 |
+
</pre></div>
|
| 84 |
+
</div>
|
| 85 |
+
<p>Using default pgpass path for the service account:</p>
|
| 86 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>postgresql://username@host:port?options<span class="o">=</span>-csearch_path<span class="o">=</span><schema<span class="w"> </span>name>
|
| 87 |
+
</pre></div>
|
| 88 |
+
</div>
|
| 89 |
+
<p>Specifying pgpass file path:</p>
|
| 90 |
+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>postgresql://username@host:port?passfile<span class="o">=</span><path<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>pgpass<span class="w"> </span>file><span class="p">&</span><span class="nv">options</span><span class="o">=</span>-csearch_path<span class="o">=</span><schema<span class="w"> </span>name>
|
| 91 |
+
</pre></div>
|
| 92 |
+
</div>
|
| 93 |
+
</section>
|
| 94 |
+
</section>
|
| 95 |
+
|
| 96 |
+
|
| 97 |
+
<div class="clearer"></div>
|
| 98 |
+
</div>
|
| 99 |
+
</div>
|
| 100 |
+
</div>
|
| 101 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 102 |
+
<div class="sphinxsidebarwrapper">
|
| 103 |
+
<div>
|
| 104 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 105 |
+
<ul>
|
| 106 |
+
<li><a class="reference internal" href="#">External database for pgAdmin user settings</a><ul>
|
| 107 |
+
<li><a class="reference internal" href="#use-sqlite-database">Use SQLite Database</a></li>
|
| 108 |
+
<li><a class="reference internal" href="#use-external-database">Use External Database</a></li>
|
| 109 |
+
<li><a class="reference internal" href="#use-postgresql-database">Use PostgreSQL Database</a></li>
|
| 110 |
+
</ul>
|
| 111 |
+
</li>
|
| 112 |
+
</ul>
|
| 113 |
+
|
| 114 |
+
</div>
|
| 115 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 116 |
+
<ul class="current">
|
| 117 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 118 |
+
<li class="toctree-l1 current"><a class="current reference internal" href="#">External database for pgAdmin user settings</a><ul>
|
| 119 |
+
<li class="toctree-l2"><a class="reference internal" href="#use-sqlite-database">Use SQLite Database</a></li>
|
| 120 |
+
<li class="toctree-l2"><a class="reference internal" href="#use-external-database">Use External Database</a></li>
|
| 121 |
+
<li class="toctree-l2"><a class="reference internal" href="#use-postgresql-database">Use PostgreSQL Database</a></li>
|
| 122 |
+
</ul>
|
| 123 |
+
</li>
|
| 124 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 125 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 126 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 127 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 128 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 129 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 130 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 131 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 132 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 133 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 134 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 135 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 136 |
+
</ul>
|
| 137 |
+
|
| 138 |
+
<search id="searchbox" style="display: none" role="search">
|
| 139 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 140 |
+
<div class="searchformwrapper">
|
| 141 |
+
<form class="search" action="search.html" method="get">
|
| 142 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 143 |
+
<input type="submit" value="Go" />
|
| 144 |
+
</form>
|
| 145 |
+
</div>
|
| 146 |
+
</search>
|
| 147 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 148 |
+
</div>
|
| 149 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 150 |
+
<span>«</span>
|
| 151 |
+
</div>
|
| 152 |
+
|
| 153 |
+
</div>
|
| 154 |
+
<div class="clearer"></div>
|
| 155 |
+
</div>
|
| 156 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 157 |
+
<h3>Navigation</h3>
|
| 158 |
+
<ul>
|
| 159 |
+
<li class="right" style="margin-right: 10px">
|
| 160 |
+
<a href="genindex.html" title="General Index"
|
| 161 |
+
>index</a></li>
|
| 162 |
+
<li class="right" >
|
| 163 |
+
<a href="connecting.html" title="Connecting To A Server"
|
| 164 |
+
>next</a> |</li>
|
| 165 |
+
<li class="right" >
|
| 166 |
+
<a href="search_objects.html" title="Search objects"
|
| 167 |
+
>previous</a> |</li>
|
| 168 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 169 |
+
<li class="nav-item nav-item-this"><a href="">External database for pgAdmin user settings</a></li>
|
| 170 |
+
</ul>
|
| 171 |
+
</div>
|
| 172 |
+
<div class="footer" role="contentinfo">
|
| 173 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 174 |
+
<ul>
|
| 175 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 176 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 177 |
+
<li class="right" ><a href="connecting.html" title="Connecting To A Server" accesskey="N">next</a> |</li>
|
| 178 |
+
<li class="right" ><a href="search_objects.html" title="Search objects" accesskey="P">previous</a> |</li>
|
| 179 |
+
</ul>
|
| 180 |
+
</div>
|
| 181 |
+
</div>
|
| 182 |
+
</body>
|
| 183 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/foreign_data_wrapper_dialog.html
ADDED
|
@@ -0,0 +1,240 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Foreign Data Wrapper Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Foreign Server Dialog" href="foreign_server_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Extension Dialog" href="extension_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="foreign_server_dialog.html" title="Foreign Server Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="extension_dialog.html" title="Extension Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Foreign Data Wrapper Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="foreign-data-wrapper-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Foreign Data Wrapper Dialog<a class="headerlink" href="#foreign-data-wrapper-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Foreign Data Wrapper</em> dialog to create or modify a foreign data
|
| 51 |
+
wrapper. A foreign data wrapper is an adapter between a Postgres database and
|
| 52 |
+
data stored on another data source.</p>
|
| 53 |
+
<p>You must be a superuser to create a foreign data wrapper.</p>
|
| 54 |
+
<p>The <em>Foreign Data Wrapper</em> dialog organizes the development of a foreign data
|
| 55 |
+
wrapper through the following dialog tabs: <em>General</em>, <em>Definition</em>, <em>Options</em>,
|
| 56 |
+
and <em>Security</em>. The <em>SQL</em> tab displays the SQL code generated by dialog
|
| 57 |
+
selections.</p>
|
| 58 |
+
<img alt="Foreign data wrapper dialog general tab" class="align-center" src="_images/foreign_data_wrapper_general.png" />
|
| 59 |
+
<p>Use the fields in the <em>General</em> tab to identify the foreign data wrapper:</p>
|
| 60 |
+
<ul class="simple">
|
| 61 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the foreign data wrapper.
|
| 62 |
+
A foreign data wrapper name must be unique within the database. The name will
|
| 63 |
+
be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 64 |
+
<li><p>Use the drop-down listbox next to <em>Owner</em> to select the name of the role that
|
| 65 |
+
will own the foreign data wrapper.</p></li>
|
| 66 |
+
<li><p>Store notes about the foreign data wrapper in the <em>Comment</em> field.</p></li>
|
| 67 |
+
</ul>
|
| 68 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 69 |
+
<img alt="Foreign data wrapper dialog definition tab" class="align-center" src="_images/foreign_data_wrapper_definition.png" />
|
| 70 |
+
<p>Use the fields in the <em>Definition</em> tab to set parameters:</p>
|
| 71 |
+
<ul class="simple">
|
| 72 |
+
<li><p>Select the name of the handler function from the drop-down listbox in the
|
| 73 |
+
<em>Handler</em> field. This is the name of an existing function that will be called
|
| 74 |
+
to retrieve the execution functions for foreign tables.</p></li>
|
| 75 |
+
<li><p>Select the name of the validator function from the drop-down listbox in the
|
| 76 |
+
<em>Validator</em> field. This is the name of an existing function that will be
|
| 77 |
+
called to check the generic options given to the foreign data wrapper, as
|
| 78 |
+
well as options for foreign servers, user mappings and foreign tables using
|
| 79 |
+
the foreign data wrapper.</p></li>
|
| 80 |
+
</ul>
|
| 81 |
+
<p>Click the <em>Options</em> tab to continue.</p>
|
| 82 |
+
<img alt="Foreign data wrapper dialog options tab" class="align-center" src="_images/foreign_data_wrapper_options.png" />
|
| 83 |
+
<p>Use the fields in the <em>Options</em> tab to specify options:</p>
|
| 84 |
+
<ul class="simple">
|
| 85 |
+
<li><p>Click the <em>Add</em> icon (+) button to add an option/value pair for the
|
| 86 |
+
foreign data wrapper. Supported option/value pairs will be specific to the
|
| 87 |
+
selected foreign data wrapper.</p></li>
|
| 88 |
+
<li><p>Specify the option name in the <em>Option</em> field and provide a corresponding
|
| 89 |
+
value in the <em>Value</em> field.</p></li>
|
| 90 |
+
</ul>
|
| 91 |
+
<p>Click the <em>Add</em> icon (+) to specify each additional pair; to discard an option,
|
| 92 |
+
click the trash icon to the left of the row and confirm deletion in the <em>Delete
|
| 93 |
+
Row</em> popup.</p>
|
| 94 |
+
<p>Click the <em>Security</em> tab to continue.</p>
|
| 95 |
+
<img alt="Foreign data wrapper dialog security tab" class="align-center" src="_images/foreign_data_wrapper_security.png" />
|
| 96 |
+
<p>Use the <em>Security</em> tab to assign security privileges. Click the <em>Add</em> icon (+)
|
| 97 |
+
to assign a set of privileges.</p>
|
| 98 |
+
<ul class="simple">
|
| 99 |
+
<li><p>Select the name of the role from the drop-down listbox in the <em>Grantee</em> field.</p></li>
|
| 100 |
+
<li><p>Click inside the <em>Privileges</em> field. Check the boxes to the left of one or
|
| 101 |
+
more privileges to grant the selected privileges to the specified user.</p></li>
|
| 102 |
+
<li><p>The current user, who is the default grantor for granting the privilege, is displayed in the <em>Grantor</em> field.</p></li>
|
| 103 |
+
</ul>
|
| 104 |
+
<p>Click add to assign additional privileges; to discard a privilege, click the
|
| 105 |
+
trash icon to the left of the row and confirm deletion in the <em>Delete Row</em>
|
| 106 |
+
popup.</p>
|
| 107 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 108 |
+
<p>Your entries in the <em>Foreign Data Wrapper</em> dialog generate a SQL command (see an
|
| 109 |
+
example below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any
|
| 110 |
+
changes to the SQL command.</p>
|
| 111 |
+
<section id="example">
|
| 112 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 113 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 114 |
+
the <em>Foreign Data Wrapper</em> dialog:</p>
|
| 115 |
+
<img alt="Foreign data wrapper dialog sql tab" class="align-center" src="_images/foreign_data_wrapper_sql.png" />
|
| 116 |
+
<p>The example creates a foreign data wrapper named <em>lib_qp_debug</em> that uses
|
| 117 |
+
pre-existing validator and handler functions, <em>dblink_fdw_validator</em> and
|
| 118 |
+
<em>libpg_fdw_handler</em>. Selections on the <em>Options</em> tab set <em>debug</em> equal to
|
| 119 |
+
<em>true</em>. The foreign data wrapper is owned by <em>postgres</em>.</p>
|
| 120 |
+
<ul class="simple">
|
| 121 |
+
<li><p>Click the <em>Help</em> button (?) to access online help.</p></li>
|
| 122 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 123 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 124 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 125 |
+
</ul>
|
| 126 |
+
</section>
|
| 127 |
+
</section>
|
| 128 |
+
|
| 129 |
+
|
| 130 |
+
<div class="clearer"></div>
|
| 131 |
+
</div>
|
| 132 |
+
</div>
|
| 133 |
+
</div>
|
| 134 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 135 |
+
<div class="sphinxsidebarwrapper">
|
| 136 |
+
<div>
|
| 137 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 138 |
+
<ul>
|
| 139 |
+
<li><a class="reference internal" href="#">Foreign Data Wrapper Dialog</a><ul>
|
| 140 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 141 |
+
</ul>
|
| 142 |
+
</li>
|
| 143 |
+
</ul>
|
| 144 |
+
|
| 145 |
+
</div>
|
| 146 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 147 |
+
<ul class="current">
|
| 148 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 149 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 150 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 151 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 152 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 153 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 154 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 155 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 156 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 157 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 158 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 159 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 160 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Foreign Data Wrapper Dialog</a></li>
|
| 161 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_server_dialog.html">Foreign Server Dialog</a></li>
|
| 162 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 163 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 164 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 165 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 166 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 167 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 168 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 169 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 170 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 171 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 172 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 173 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 174 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 175 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 176 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 177 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 178 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 179 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 180 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 181 |
+
</ul>
|
| 182 |
+
</li>
|
| 183 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 184 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 185 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 186 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 187 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 188 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 189 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 190 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 191 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 192 |
+
</ul>
|
| 193 |
+
|
| 194 |
+
<search id="searchbox" style="display: none" role="search">
|
| 195 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 196 |
+
<div class="searchformwrapper">
|
| 197 |
+
<form class="search" action="search.html" method="get">
|
| 198 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 199 |
+
<input type="submit" value="Go" />
|
| 200 |
+
</form>
|
| 201 |
+
</div>
|
| 202 |
+
</search>
|
| 203 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 204 |
+
</div>
|
| 205 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 206 |
+
<span>«</span>
|
| 207 |
+
</div>
|
| 208 |
+
|
| 209 |
+
</div>
|
| 210 |
+
<div class="clearer"></div>
|
| 211 |
+
</div>
|
| 212 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 213 |
+
<h3>Navigation</h3>
|
| 214 |
+
<ul>
|
| 215 |
+
<li class="right" style="margin-right: 10px">
|
| 216 |
+
<a href="genindex.html" title="General Index"
|
| 217 |
+
>index</a></li>
|
| 218 |
+
<li class="right" >
|
| 219 |
+
<a href="foreign_server_dialog.html" title="Foreign Server Dialog"
|
| 220 |
+
>next</a> |</li>
|
| 221 |
+
<li class="right" >
|
| 222 |
+
<a href="extension_dialog.html" title="Extension Dialog"
|
| 223 |
+
>previous</a> |</li>
|
| 224 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 225 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 226 |
+
<li class="nav-item nav-item-this"><a href="">Foreign Data Wrapper Dialog</a></li>
|
| 227 |
+
</ul>
|
| 228 |
+
</div>
|
| 229 |
+
<div class="footer" role="contentinfo">
|
| 230 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 231 |
+
<ul>
|
| 232 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 233 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 234 |
+
<li class="right" ><a href="foreign_server_dialog.html" title="Foreign Server Dialog" accesskey="N">next</a> |</li>
|
| 235 |
+
<li class="right" ><a href="extension_dialog.html" title="Extension Dialog" accesskey="P">previous</a> |</li>
|
| 236 |
+
</ul>
|
| 237 |
+
</div>
|
| 238 |
+
</div>
|
| 239 |
+
</body>
|
| 240 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/foreign_key_dialog.html
ADDED
|
@@ -0,0 +1,265 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Foreign key Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Index Dialog" href="index_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Exclusion Constraint Dialog" href="exclusion_constraint_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="index_dialog.html" title="Index Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="exclusion_constraint_dialog.html" title="Exclusion Constraint Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" accesskey="U">Creating or Modifying a Table</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Foreign key Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="foreign-key-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Foreign key Dialog<a class="headerlink" href="#foreign-key-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Foreign key</em> dialog to specify the behavior of a foreign key
|
| 51 |
+
constraint. A foreign key constraint maintains referential integrity between
|
| 52 |
+
two tables. A foreign key constraint cannot be defined between a temporary
|
| 53 |
+
table and a permanent table.</p>
|
| 54 |
+
<p>The <em>Foreign key</em> dialog organizes the development of a foreign key constraint
|
| 55 |
+
through the following dialog tabs: <em>General</em>, <em>Definition</em>, <em>Columns</em>, and
|
| 56 |
+
<em>Action</em>. The <em>SQL</em> tab displays the SQL code generated by dialog selections.</p>
|
| 57 |
+
<img alt="Foreign key dialog general tab" class="align-center" src="_images/foreign_key_general.png" />
|
| 58 |
+
<p>Use the fields in the <em>General</em> tab to identify the foreign key constraint:</p>
|
| 59 |
+
<ul class="simple">
|
| 60 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the foreign key. The name
|
| 61 |
+
will be displayed in the <em>pgAdmin</em> tree control.</p></li>
|
| 62 |
+
<li><p>Store notes about the foreign key constraint in the <em>Comment</em> field.</p></li>
|
| 63 |
+
</ul>
|
| 64 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 65 |
+
<img alt="Foreign key dialog definition tab" class="align-center" src="_images/foreign_key_definition.png" />
|
| 66 |
+
<p>Use the fields in the <em>Definition</em> tab to define the foreign key constraint:</p>
|
| 67 |
+
<ul>
|
| 68 |
+
<li><p>Move the <em>Deferrable?</em> switch to the <em>Yes</em> position to specify the timing of
|
| 69 |
+
the constraint is deferrable and can be postponed until the end of the
|
| 70 |
+
statement. The default is <em>No</em>.</p></li>
|
| 71 |
+
<li><p>If enabled, move the <em>Deferred?</em> switch to the <em>Yes</em> position to specify the
|
| 72 |
+
timing of the constraint is deferred to the end of the statement. The default
|
| 73 |
+
is <em>No</em>.</p></li>
|
| 74 |
+
<li><p>Move the <em>Match type</em> switch specify the type of matching that is enforced by
|
| 75 |
+
the constraint:</p>
|
| 76 |
+
<blockquote>
|
| 77 |
+
<div><ul class="simple">
|
| 78 |
+
<li><p>Select <em>Full</em> to indicate that all columns of a multicolumn foreign key
|
| 79 |
+
must be null if any column is null; if all columns are null, the row is
|
| 80 |
+
not required to have a match in the referenced table.</p></li>
|
| 81 |
+
<li><p>Select <em>Simple</em> to specify that a single foreign key column may be null;
|
| 82 |
+
if any column is null, the row is not required to have a match in the
|
| 83 |
+
referenced table.</p></li>
|
| 84 |
+
</ul>
|
| 85 |
+
</div></blockquote>
|
| 86 |
+
</li>
|
| 87 |
+
<li><p>Move the <em>Validated</em> switch to the <em>Yes</em> position to instruct the server to
|
| 88 |
+
validate the existing table content (against a foreign key or check
|
| 89 |
+
constraint) when you save modifications to this dialog.</p></li>
|
| 90 |
+
<li><p>Move the <em>Auto FK Index</em> switch to the <em>No</em> position to disable the automatic
|
| 91 |
+
index feature.</p></li>
|
| 92 |
+
<li><p>The field next to <em>Covering Index</em> generates the name of an index if the <em>Auto
|
| 93 |
+
FK Index</em> switch is in the <em>Yes</em> position; or, this field is disabled.</p></li>
|
| 94 |
+
</ul>
|
| 95 |
+
<p>Click the <em>Columns</em> tab to continue.</p>
|
| 96 |
+
<img alt="Foreign key dialog columns tab" class="align-center" src="_images/foreign_key_columns.png" />
|
| 97 |
+
<p>Use the fields in the <em>Columns</em> tab to specify one or more reference column(s).
|
| 98 |
+
A Foreign Key constraint requires that one or more columns of a table must only
|
| 99 |
+
contain values that match values in the referenced column(s) of a row of a
|
| 100 |
+
referenced table:</p>
|
| 101 |
+
<ul class="simple">
|
| 102 |
+
<li><p>Use the drop-down listbox next to <em>Local column</em> to specify the column in the
|
| 103 |
+
current table that will be compared to the foreign table.</p></li>
|
| 104 |
+
<li><p>Use the drop-down listbox next to <em>References</em> to specify the name of the
|
| 105 |
+
table in which the comparison column(s) resides.</p></li>
|
| 106 |
+
<li><p>Use the drop-down listbox next to <em>Referencing</em> to specify a column in the
|
| 107 |
+
foreign table.</p></li>
|
| 108 |
+
</ul>
|
| 109 |
+
<p>Click the <em>Add</em> icon (+) to add a column to the list; repeat the steps above and
|
| 110 |
+
click the <em>Add</em> icon (+) to add additional columns. To discard an entry, click
|
| 111 |
+
the trash icon to the left of the entry and confirm deletion in the <em>Delete Row</em>
|
| 112 |
+
popup.</p>
|
| 113 |
+
<p>Click the <em>Action</em> tab to continue.</p>
|
| 114 |
+
<img alt="Foreign key dialog action tab" class="align-center" src="_images/foreign_key_action.png" />
|
| 115 |
+
<p>Use the drop-down listboxes on the <em>Action</em> tab to specify behavior related to
|
| 116 |
+
the foreign key constraint that will be performed when data within the table is
|
| 117 |
+
updated or deleted:</p>
|
| 118 |
+
<ul class="simple">
|
| 119 |
+
<li><p>Use the drop-down listbox next to <em>On update</em> to select an action that will be
|
| 120 |
+
performed when data in the table is updated.</p></li>
|
| 121 |
+
<li><p>Use the drop-down listbox next to <em>On delete</em> to select an action that will be
|
| 122 |
+
performed when data in the table is deleted.</p></li>
|
| 123 |
+
</ul>
|
| 124 |
+
<p>The supported actions are:</p>
|
| 125 |
+
<table class="docutils align-default">
|
| 126 |
+
<tbody>
|
| 127 |
+
<tr class="row-odd"><td><p>NO ACTION</p></td>
|
| 128 |
+
<td><p>Produce an error indicating that the deletion or update will create a foreign key constraint violation.
|
| 129 |
+
If the constraint is deferred, this error will be produced at constraint check time if any referencing
|
| 130 |
+
rows still exist. This is the default.</p></td>
|
| 131 |
+
</tr>
|
| 132 |
+
<tr class="row-even"><td><p>RESTRICT</p></td>
|
| 133 |
+
<td><p>Throw an error indicating that the deletion or update would create a foreign key constraint violation.
|
| 134 |
+
This is the same as NO ACTION except that the check is not deferrable.</p></td>
|
| 135 |
+
</tr>
|
| 136 |
+
<tr class="row-odd"><td><p>CASCADE</p></td>
|
| 137 |
+
<td><p>Delete any rows referencing the deleted row, or update the values of the referencing column(s) to the new
|
| 138 |
+
values of the referenced columns, respectively.</p></td>
|
| 139 |
+
</tr>
|
| 140 |
+
<tr class="row-even"><td><p>SET NULL</p></td>
|
| 141 |
+
<td><p>Set the referencing column(s) to null.</p></td>
|
| 142 |
+
</tr>
|
| 143 |
+
<tr class="row-odd"><td><p>SET DEFAULT</p></td>
|
| 144 |
+
<td><p>Set the referencing column(s) to their default values. There must be a row in the referenced table
|
| 145 |
+
that matches the default values (if they are not null), or the operation will fail.</p></td>
|
| 146 |
+
</tr>
|
| 147 |
+
</tbody>
|
| 148 |
+
</table>
|
| 149 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 150 |
+
<p>Your entries in the <em>Foreign key</em> dialog generate a SQL command (see an example
|
| 151 |
+
below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any changes
|
| 152 |
+
to the SQL command.</p>
|
| 153 |
+
<section id="example">
|
| 154 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 155 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 156 |
+
the <em>Foreign key</em> dialog:</p>
|
| 157 |
+
<img alt="Foreign key dialog sql tab" class="align-center" src="_images/foreign_key_sql.png" />
|
| 158 |
+
<p>The example shown demonstrates creating a foreign key constraint named
|
| 159 |
+
<em>jobhist_ref_dept_fk</em> that matches values in the <em>jobhist</em> table <em>dept_no</em>
|
| 160 |
+
column with those of the <em>dept</em> table <em>deptno</em> column.</p>
|
| 161 |
+
<ul class="simple">
|
| 162 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 163 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 164 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 165 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 166 |
+
</ul>
|
| 167 |
+
</section>
|
| 168 |
+
</section>
|
| 169 |
+
|
| 170 |
+
|
| 171 |
+
<div class="clearer"></div>
|
| 172 |
+
</div>
|
| 173 |
+
</div>
|
| 174 |
+
</div>
|
| 175 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 176 |
+
<div class="sphinxsidebarwrapper">
|
| 177 |
+
<div>
|
| 178 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 179 |
+
<ul>
|
| 180 |
+
<li><a class="reference internal" href="#">Foreign key Dialog</a><ul>
|
| 181 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 182 |
+
</ul>
|
| 183 |
+
</li>
|
| 184 |
+
</ul>
|
| 185 |
+
|
| 186 |
+
</div>
|
| 187 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 188 |
+
<ul class="current">
|
| 189 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 190 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 191 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 192 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 193 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a></li>
|
| 194 |
+
<li class="toctree-l1 current"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a><ul class="current">
|
| 195 |
+
<li class="toctree-l2"><a class="reference internal" href="check_dialog.html">Check Dialog</a></li>
|
| 196 |
+
<li class="toctree-l2"><a class="reference internal" href="column_dialog.html">Column Dialog</a></li>
|
| 197 |
+
<li class="toctree-l2"><a class="reference internal" href="compound_trigger_dialog.html">Compound Trigger Dialog</a></li>
|
| 198 |
+
<li class="toctree-l2"><a class="reference internal" href="exclusion_constraint_dialog.html">Exclusion Constraint Dialog</a></li>
|
| 199 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Foreign key Dialog</a></li>
|
| 200 |
+
<li class="toctree-l2"><a class="reference internal" href="index_dialog.html">Index Dialog</a></li>
|
| 201 |
+
<li class="toctree-l2"><a class="reference internal" href="primary_key_dialog.html">Primary key Dialog</a></li>
|
| 202 |
+
<li class="toctree-l2"><a class="reference internal" href="rls_policy_dialog.html">RLS Policy Dialog</a></li>
|
| 203 |
+
<li class="toctree-l2"><a class="reference internal" href="rule_dialog.html">Rule Dialog</a></li>
|
| 204 |
+
<li class="toctree-l2"><a class="reference internal" href="table_dialog.html">Table Dialog</a></li>
|
| 205 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_dialog.html">Trigger Dialog</a></li>
|
| 206 |
+
<li class="toctree-l2"><a class="reference internal" href="unique_constraint_dialog.html">Unique Constraint Dialog</a></li>
|
| 207 |
+
</ul>
|
| 208 |
+
</li>
|
| 209 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 210 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 211 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 212 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 213 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 214 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 215 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 216 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 217 |
+
</ul>
|
| 218 |
+
|
| 219 |
+
<search id="searchbox" style="display: none" role="search">
|
| 220 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 221 |
+
<div class="searchformwrapper">
|
| 222 |
+
<form class="search" action="search.html" method="get">
|
| 223 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 224 |
+
<input type="submit" value="Go" />
|
| 225 |
+
</form>
|
| 226 |
+
</div>
|
| 227 |
+
</search>
|
| 228 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 229 |
+
</div>
|
| 230 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 231 |
+
<span>«</span>
|
| 232 |
+
</div>
|
| 233 |
+
|
| 234 |
+
</div>
|
| 235 |
+
<div class="clearer"></div>
|
| 236 |
+
</div>
|
| 237 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 238 |
+
<h3>Navigation</h3>
|
| 239 |
+
<ul>
|
| 240 |
+
<li class="right" style="margin-right: 10px">
|
| 241 |
+
<a href="genindex.html" title="General Index"
|
| 242 |
+
>index</a></li>
|
| 243 |
+
<li class="right" >
|
| 244 |
+
<a href="index_dialog.html" title="Index Dialog"
|
| 245 |
+
>next</a> |</li>
|
| 246 |
+
<li class="right" >
|
| 247 |
+
<a href="exclusion_constraint_dialog.html" title="Exclusion Constraint Dialog"
|
| 248 |
+
>previous</a> |</li>
|
| 249 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 250 |
+
<li class="nav-item nav-item-1"><a href="modifying_tables.html" >Creating or Modifying a Table</a> »</li>
|
| 251 |
+
<li class="nav-item nav-item-this"><a href="">Foreign key Dialog</a></li>
|
| 252 |
+
</ul>
|
| 253 |
+
</div>
|
| 254 |
+
<div class="footer" role="contentinfo">
|
| 255 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 256 |
+
<ul>
|
| 257 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 258 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 259 |
+
<li class="right" ><a href="index_dialog.html" title="Index Dialog" accesskey="N">next</a> |</li>
|
| 260 |
+
<li class="right" ><a href="exclusion_constraint_dialog.html" title="Exclusion Constraint Dialog" accesskey="P">previous</a> |</li>
|
| 261 |
+
</ul>
|
| 262 |
+
</div>
|
| 263 |
+
</div>
|
| 264 |
+
</body>
|
| 265 |
+
</html>
|
pgsql/pgAdmin 4/docs/en_US/html/foreign_server_dialog.html
ADDED
|
@@ -0,0 +1,230 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
|
| 2 |
+
|
| 3 |
+
<!DOCTYPE html>
|
| 4 |
+
|
| 5 |
+
<html lang="en" data-content_root="./">
|
| 6 |
+
<head>
|
| 7 |
+
<meta charset="utf-8" />
|
| 8 |
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
| 9 |
+
|
| 10 |
+
<title>Foreign Server Dialog — pgAdmin 4 8.6 documentation</title>
|
| 11 |
+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
|
| 12 |
+
<link rel="stylesheet" type="text/css" href="_static/style.css?v=d36593c3" />
|
| 13 |
+
|
| 14 |
+
<script src="_static/documentation_options.js?v=d4c83366"></script>
|
| 15 |
+
<script src="_static/doctools.js?v=9a2dae69"></script>
|
| 16 |
+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
| 17 |
+
|
| 18 |
+
<script src="_static/sidebar.js"></script>
|
| 19 |
+
|
| 20 |
+
<link rel="index" title="Index" href="genindex.html" />
|
| 21 |
+
<link rel="search" title="Search" href="search.html" />
|
| 22 |
+
<link rel="next" title="Foreign Table Dialog" href="foreign_table_dialog.html" />
|
| 23 |
+
<link rel="prev" title="Foreign Data Wrapper Dialog" href="foreign_data_wrapper_dialog.html" />
|
| 24 |
+
</head><body>
|
| 25 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 26 |
+
<h3>Navigation</h3>
|
| 27 |
+
<ul>
|
| 28 |
+
<li class="right" style="margin-right: 10px">
|
| 29 |
+
<a href="genindex.html" title="General Index"
|
| 30 |
+
accesskey="I">index</a></li>
|
| 31 |
+
<li class="right" >
|
| 32 |
+
<a href="foreign_table_dialog.html" title="Foreign Table Dialog"
|
| 33 |
+
accesskey="N">next</a> |</li>
|
| 34 |
+
<li class="right" >
|
| 35 |
+
<a href="foreign_data_wrapper_dialog.html" title="Foreign Data Wrapper Dialog"
|
| 36 |
+
accesskey="P">previous</a> |</li>
|
| 37 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 38 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> »</li>
|
| 39 |
+
<li class="nav-item nav-item-this"><a href="">Foreign Server Dialog</a></li>
|
| 40 |
+
</ul>
|
| 41 |
+
</div>
|
| 42 |
+
|
| 43 |
+
<div class="document">
|
| 44 |
+
<div class="documentwrapper">
|
| 45 |
+
<div class="bodywrapper">
|
| 46 |
+
<div class="body" role="main">
|
| 47 |
+
|
| 48 |
+
<section id="foreign-server-dialog">
|
| 49 |
+
<span id="id1"></span><h1><span class="target" id="index-0"></span>Foreign Server Dialog<a class="headerlink" href="#foreign-server-dialog" title="Link to this heading">¶</a></h1>
|
| 50 |
+
<p>Use the <em>Foreign Server</em> dialog to create a foreign server. A foreign server
|
| 51 |
+
typically encapsulates connection information that a foreign-data wrapper uses
|
| 52 |
+
to access an external data resource. Each foreign data wrapper may connect to a
|
| 53 |
+
different foreign server; in the <em>pgAdmin</em> tree control, expand the node of the
|
| 54 |
+
applicable foreign data wrapper to launch the <em>Foreign Server</em> dialog.</p>
|
| 55 |
+
<p>The <em>Foreign Server</em> dialog organizes the development of a foreign server
|
| 56 |
+
through the following dialog tabs: <em>General</em>, <em>Definition</em>, <em>Options</em>, and
|
| 57 |
+
<em>Security</em>. The <em>SQL</em> tab displays the SQL code generated by dialog selections.</p>
|
| 58 |
+
<img alt="Foreign server dialog general tab" class="align-center" src="_images/foreign_server_general.png" />
|
| 59 |
+
<p>Use the fields in the <em>General</em> tab to identify the foreign server:</p>
|
| 60 |
+
<ul class="simple">
|
| 61 |
+
<li><p>Use the <em>Name</em> field to add a descriptive name for the foreign server. The
|
| 62 |
+
name will be displayed in the <em>pgAdmin</em> tree control. It must be unique within
|
| 63 |
+
the database.</p></li>
|
| 64 |
+
<li><p>Use the drop-down listbox next to <em>Owner</em> to select a role.</p></li>
|
| 65 |
+
<li><p>Store notes about the foreign server in the <em>Comment</em> field.</p></li>
|
| 66 |
+
</ul>
|
| 67 |
+
<p>Click the <em>Definition</em> tab to continue.</p>
|
| 68 |
+
<img alt="Foreign server dialog definition tab" class="align-center" src="_images/foreign_server_definition.png" />
|
| 69 |
+
<p>Use the fields in the <em>Definition</em> tab to set parameters:</p>
|
| 70 |
+
<ul class="simple">
|
| 71 |
+
<li><p>Use the <em>Type</em> field to specify a server type.</p></li>
|
| 72 |
+
<li><p>Use the <em>Version</em> field to specify a server version.</p></li>
|
| 73 |
+
</ul>
|
| 74 |
+
<p>Click the <em>Options</em> tab to continue.</p>
|
| 75 |
+
<img alt="Foreign server dialog options tab" class="align-center" src="_images/foreign_server_options.png" />
|
| 76 |
+
<p>Use the fields in the <em>Options</em> tab to specify options. Click the <em>Add</em> button
|
| 77 |
+
to create an option clause for the foreign server.</p>
|
| 78 |
+
<ul class="simple">
|
| 79 |
+
<li><p>Specify the option name in the <em>Option</em> field.</p></li>
|
| 80 |
+
<li><p>Provide a corresponding value in the <em>Value</em> field.</p></li>
|
| 81 |
+
</ul>
|
| 82 |
+
<p>Click <em>Add</em> to create each additional clause; to discard an option, click the
|
| 83 |
+
trash icon to the left of the row and confirm deletion in the <em>Delete Row</em>
|
| 84 |
+
popup.</p>
|
| 85 |
+
<p>Click the <em>Security</em> tab to continue.</p>
|
| 86 |
+
<img alt="Foreign server dialog security tab" class="align-center" src="_images/foreign_server_security.png" />
|
| 87 |
+
<p>Use the <em>Security</em> tab to assign security privileges to the foreign server.
|
| 88 |
+
Click <em>Add</em> before you assign a set of privileges.</p>
|
| 89 |
+
<ul class="simple">
|
| 90 |
+
<li><p>Select the name of the role from the drop-down listbox in the <em>Grantee</em> field.</p></li>
|
| 91 |
+
<li><p>Click inside the <em>Privileges</em> field. Check the boxes to the left of one or
|
| 92 |
+
more privileges to grant the selected privileges to the specified user.</p></li>
|
| 93 |
+
<li><p>The current user, who is the default grantor for granting the privilege, is displayed in the <em>Grantor</em> field.</p></li>
|
| 94 |
+
</ul>
|
| 95 |
+
<p>Click <em>Add</em> to assign a new set of privileges; to discard a privilege, click the
|
| 96 |
+
trash icon to the left of the row and confirm deletion in the <em>Delete Row</em>
|
| 97 |
+
dialog.</p>
|
| 98 |
+
<p>Click the <em>SQL</em> tab to continue.</p>
|
| 99 |
+
<p>Your entries in the <em>Foreign Server</em> dialog generate a SQL command (see an
|
| 100 |
+
example below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make
|
| 101 |
+
any changes to the SQL command.</p>
|
| 102 |
+
<section id="example">
|
| 103 |
+
<h2>Example<a class="headerlink" href="#example" title="Link to this heading">¶</a></h2>
|
| 104 |
+
<p>The following is an example of the sql command generated by user selections in
|
| 105 |
+
the <em>Foreign Server</em> dialog:</p>
|
| 106 |
+
<img alt="Foreign server dialog sql tab" class="align-center" src="_images/foreign_server_sql.png" />
|
| 107 |
+
<p>The example shown demonstrates creating a foreign server for the foreign data
|
| 108 |
+
wrapper <em>hdfs_fdw</em>. It has the name <em>hdfs_server</em>; its type is <em>hiveserver2</em>.
|
| 109 |
+
Options for the foreign server include a host and a port.</p>
|
| 110 |
+
<ul class="simple">
|
| 111 |
+
<li><p>Click the <em>Info</em> button (i) to access online help.</p></li>
|
| 112 |
+
<li><p>Click the <em>Save</em> button to save work.</p></li>
|
| 113 |
+
<li><p>Click the <em>Close</em> button to exit without saving work.</p></li>
|
| 114 |
+
<li><p>Click the <em>Reset</em> button to restore configuration parameters.</p></li>
|
| 115 |
+
</ul>
|
| 116 |
+
</section>
|
| 117 |
+
</section>
|
| 118 |
+
|
| 119 |
+
|
| 120 |
+
<div class="clearer"></div>
|
| 121 |
+
</div>
|
| 122 |
+
</div>
|
| 123 |
+
</div>
|
| 124 |
+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
| 125 |
+
<div class="sphinxsidebarwrapper">
|
| 126 |
+
<div>
|
| 127 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 128 |
+
<ul>
|
| 129 |
+
<li><a class="reference internal" href="#">Foreign Server Dialog</a><ul>
|
| 130 |
+
<li><a class="reference internal" href="#example">Example</a></li>
|
| 131 |
+
</ul>
|
| 132 |
+
</li>
|
| 133 |
+
</ul>
|
| 134 |
+
|
| 135 |
+
</div>
|
| 136 |
+
<h3><a href="index.html">Table of Contents</a></h3>
|
| 137 |
+
<ul class="current">
|
| 138 |
+
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
|
| 139 |
+
<li class="toctree-l1"><a class="reference internal" href="external_database.html">External database for pgAdmin user settings</a></li>
|
| 140 |
+
<li class="toctree-l1"><a class="reference internal" href="connecting.html">Connecting To A Server</a></li>
|
| 141 |
+
<li class="toctree-l1"><a class="reference internal" href="managing_cluster_objects.html">Managing Cluster Objects</a></li>
|
| 142 |
+
<li class="toctree-l1 current"><a class="reference internal" href="managing_database_objects.html">Managing Database Objects</a><ul class="current">
|
| 143 |
+
<li class="toctree-l2"><a class="reference internal" href="cast_dialog.html">Cast Dialog</a></li>
|
| 144 |
+
<li class="toctree-l2"><a class="reference internal" href="dbms_job_scheduler.html">Using EDB Job Scheduler</a></li>
|
| 145 |
+
<li class="toctree-l2"><a class="reference internal" href="collation_dialog.html">Collation Dialog</a></li>
|
| 146 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_dialog.html">Domain Dialog</a></li>
|
| 147 |
+
<li class="toctree-l2"><a class="reference internal" href="domain_constraint_dialog.html">Domain Constraints Dialog</a></li>
|
| 148 |
+
<li class="toctree-l2"><a class="reference internal" href="event_trigger_dialog.html">Event Trigger Dialog</a></li>
|
| 149 |
+
<li class="toctree-l2"><a class="reference internal" href="extension_dialog.html">Extension Dialog</a></li>
|
| 150 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_data_wrapper_dialog.html">Foreign Data Wrapper Dialog</a></li>
|
| 151 |
+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Foreign Server Dialog</a></li>
|
| 152 |
+
<li class="toctree-l2"><a class="reference internal" href="foreign_table_dialog.html">Foreign Table Dialog</a></li>
|
| 153 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_configuration_dialog.html">FTS Configuration Dialog</a></li>
|
| 154 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_dictionary_dialog.html">FTS Dictionary Dialog</a></li>
|
| 155 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_parser_dialog.html">FTS Parser Dialog</a></li>
|
| 156 |
+
<li class="toctree-l2"><a class="reference internal" href="fts_template_dialog.html">FTS Template Dialog</a></li>
|
| 157 |
+
<li class="toctree-l2"><a class="reference internal" href="function_dialog.html">Function Dialog</a></li>
|
| 158 |
+
<li class="toctree-l2"><a class="reference internal" href="language_dialog.html">Language Dialog</a></li>
|
| 159 |
+
<li class="toctree-l2"><a class="reference internal" href="materialized_view_dialog.html">Materialized View Dialog</a></li>
|
| 160 |
+
<li class="toctree-l2"><a class="reference internal" href="package_dialog.html">Package Dialog</a></li>
|
| 161 |
+
<li class="toctree-l2"><a class="reference internal" href="procedure_dialog.html">Procedure Dialog</a></li>
|
| 162 |
+
<li class="toctree-l2"><a class="reference internal" href="publication_dialog.html">Publication Dialog</a></li>
|
| 163 |
+
<li class="toctree-l2"><a class="reference internal" href="schema_dialog.html">Schema Dialog</a></li>
|
| 164 |
+
<li class="toctree-l2"><a class="reference internal" href="sequence_dialog.html">Sequence Dialog</a></li>
|
| 165 |
+
<li class="toctree-l2"><a class="reference internal" href="subscription_dialog.html">Subscription Dialog</a></li>
|
| 166 |
+
<li class="toctree-l2"><a class="reference internal" href="synonym_dialog.html">Synonym Dialog</a></li>
|
| 167 |
+
<li class="toctree-l2"><a class="reference internal" href="trigger_function_dialog.html">Trigger Function Dialog</a></li>
|
| 168 |
+
<li class="toctree-l2"><a class="reference internal" href="type_dialog.html">Type Dialog</a></li>
|
| 169 |
+
<li class="toctree-l2"><a class="reference internal" href="user_mapping_dialog.html">User Mapping Dialog</a></li>
|
| 170 |
+
<li class="toctree-l2"><a class="reference internal" href="view_dialog.html">View Dialog</a></li>
|
| 171 |
+
</ul>
|
| 172 |
+
</li>
|
| 173 |
+
<li class="toctree-l1"><a class="reference internal" href="modifying_tables.html">Creating or Modifying a Table</a></li>
|
| 174 |
+
<li class="toctree-l1"><a class="reference internal" href="management_basics.html">Management Basics</a></li>
|
| 175 |
+
<li class="toctree-l1"><a class="reference internal" href="backup_and_restore.html">Backup and Restore</a></li>
|
| 176 |
+
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
| 177 |
+
<li class="toctree-l1"><a class="reference internal" href="processes.html">Processes</a></li>
|
| 178 |
+
<li class="toctree-l1"><a class="reference internal" href="pgagent.html">pgAgent</a></li>
|
| 179 |
+
<li class="toctree-l1"><a class="reference internal" href="contributions.html">pgAdmin Project Contributions</a></li>
|
| 180 |
+
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
|
| 181 |
+
<li class="toctree-l1"><a class="reference internal" href="licence.html">Licence</a></li>
|
| 182 |
+
</ul>
|
| 183 |
+
|
| 184 |
+
<search id="searchbox" style="display: none" role="search">
|
| 185 |
+
<h3 id="searchlabel">Quick search</h3>
|
| 186 |
+
<div class="searchformwrapper">
|
| 187 |
+
<form class="search" action="search.html" method="get">
|
| 188 |
+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
| 189 |
+
<input type="submit" value="Go" />
|
| 190 |
+
</form>
|
| 191 |
+
</div>
|
| 192 |
+
</search>
|
| 193 |
+
<script>document.getElementById('searchbox').style.display = "block"</script>
|
| 194 |
+
</div>
|
| 195 |
+
<div id="sidebarbutton" title="Collapse sidebar">
|
| 196 |
+
<span>«</span>
|
| 197 |
+
</div>
|
| 198 |
+
|
| 199 |
+
</div>
|
| 200 |
+
<div class="clearer"></div>
|
| 201 |
+
</div>
|
| 202 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 203 |
+
<h3>Navigation</h3>
|
| 204 |
+
<ul>
|
| 205 |
+
<li class="right" style="margin-right: 10px">
|
| 206 |
+
<a href="genindex.html" title="General Index"
|
| 207 |
+
>index</a></li>
|
| 208 |
+
<li class="right" >
|
| 209 |
+
<a href="foreign_table_dialog.html" title="Foreign Table Dialog"
|
| 210 |
+
>next</a> |</li>
|
| 211 |
+
<li class="right" >
|
| 212 |
+
<a href="foreign_data_wrapper_dialog.html" title="Foreign Data Wrapper Dialog"
|
| 213 |
+
>previous</a> |</li>
|
| 214 |
+
<li class="nav-item nav-item-0"><a href="index.html">pgAdmin 4 8.6 documentation</a> »</li>
|
| 215 |
+
<li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> »</li>
|
| 216 |
+
<li class="nav-item nav-item-this"><a href="">Foreign Server Dialog</a></li>
|
| 217 |
+
</ul>
|
| 218 |
+
</div>
|
| 219 |
+
<div class="footer" role="contentinfo">
|
| 220 |
+
<div class="related" role="navigation" aria-label="related navigation">
|
| 221 |
+
<ul>
|
| 222 |
+
<li class="left" style="margin-left: 10px">© Copyright (C) 2013 - 2024, The pgAdmin Development Team.</li>
|
| 223 |
+
<li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
|
| 224 |
+
<li class="right" ><a href="foreign_table_dialog.html" title="Foreign Table Dialog" accesskey="N">next</a> |</li>
|
| 225 |
+
<li class="right" ><a href="foreign_data_wrapper_dialog.html" title="Foreign Data Wrapper Dialog" accesskey="P">previous</a> |</li>
|
| 226 |
+
</ul>
|
| 227 |
+
</div>
|
| 228 |
+
</div>
|
| 229 |
+
</body>
|
| 230 |
+
</html>
|