Datasetpublic
codekingpro/portable-devtools

sourceHugging Faceupdated 5mo agoView on Hugging Face
1likes14kdownloads
rootpgsqlpgAdmin 4docsen_UShtmlforeign_data_wrapper_dialog.html
foreign_data_wrapper_dialog.html240 linesDownload Raw Back to html
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 &#8212; 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> &#187;</li>
38          <li class="nav-item nav-item-1"><a href="managing_database_objects.html" accesskey="U">Managing Database Objects</a> &#187;</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
51wrapper. A foreign data wrapper is an adapter between a Postgres database and
52data 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
55wrapper through the following dialog tabs: <em>General</em>, <em>Definition</em>, <em>Options</em>,
56and <em>Security</em>. The <em>SQL</em> tab displays the SQL code generated by dialog
57selections.</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.
62A foreign data wrapper name must be unique within the database. The name will
63be 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
65will 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
74to 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
77called to check the generic options given to the foreign data wrapper, as
78well as options for foreign servers, user mappings and foreign tables using
79the 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
86foreign data wrapper. Supported option/value pairs will be specific to the
87selected foreign data wrapper.</p></li>
88<li><p>Specify the option name in the <em>Option</em> field and provide a corresponding
89value 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,
92click the trash icon to the left of the row and confirm deletion in the <em>Delete
93Row</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 (+)
97to 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
101more 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
105trash icon to the left of the row and confirm deletion in the <em>Delete Row</em>
106popup.</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
109example below). Use the <em>SQL</em> tab for review; revisit or switch tabs to make any
110changes 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
114the <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
117pre-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> &#187;</li>
225          <li class="nav-item nav-item-1"><a href="managing_database_objects.html" >Managing Database Objects</a> &#187;</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">&#169; 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>