postgres_fdw
 
  postgres_fdw
 
 
  The postgres_fdw> module provides the foreign-data wrapper
  postgres_fdw, which can be used to access data
  stored in external PostgreSQL servers.
 
 
  The functionality provided by this module overlaps substantially
  with the functionality of the older  module.
  But postgres_fdw> provides more transparent and
  standards-compliant syntax for accessing remote tables, and can give
  better performance in many cases.
 
 
  To prepare for remote access using postgres_fdw>:
  
   
    
     Install the  postgres_fdw> extension using .
    
   
   
    
     Create a foreign server object, using ,
     to represent each remote database you want to connect to.
     Specify connection information, except user and
     password, as options of the server object.
    
   
   
    
     Create a user mapping, using , for
     each database user you want to allow to access each foreign server.
     Specify the remote user name and password to use as
     user and password options of the
     user mapping.
    
   
   
    
     Create a foreign table, using ,
     for each remote table you want to access.  The columns of the foreign
     table must match the referenced remote table.  You can, however, use
     table and/or column names different from the remote table's, if you
     specify the correct remote names as options of the foreign table object.
    
   
  
 
 
  Now you need only SELECT> from a foreign table to access
  the data stored in its underlying remote table.  You can also modify
  the remote table using INSERT>, UPDATE>, or
  DELETE>.  (Of course, the remote user you have specified
  in your user mapping must have privileges to do these things.)
 
 
  It is generally recommended that the columns of a foreign table be declared
  with exactly the same data types, and collations if applicable, as the
  referenced columns of the remote table.  Although postgres_fdw>
  is currently rather forgiving about performing data type conversions at
  need, surprising semantic anomalies may arise when types or collations do
  not match, due to the remote server interpreting WHERE> clauses
  slightly differently from the local server.
 
 
  Note that a foreign table can be declared with fewer columns, or with a
  different column order, than its underlying remote table has.  Matching
  of columns to the remote table is by name, not position.
 
 
  FDW Options of postgres_fdw
  
   Connection Options
   
    A foreign server using the postgres_fdw> foreign data wrapper
    can have the same options that libpq> accepts in
    connection strings, as described in ,
    except that these options are not allowed:
    
     
      
       user and password (specify these
       for a user mapping, instead)
      
     
     
      
       client_encoding> (this is automatically set from the local
       server encoding)
      
     
     
      
       fallback_application_name> (always set to
       postgres_fdw>)
      
     
    
   
   
    Only superusers may connect to foreign servers without password
    authentication, so always specify the password option
    for user mappings belonging to non-superusers.
   
  
  
   Object Name Options
   
    These options can be used to control the names used in SQL statements
    sent to the remote PostgreSQL server.  These
    options are needed when a foreign table is created with names different
    from the underlying remote table's names.
   
   
    
     schema_name
     
      
       This option, which can be specified for a foreign table, gives the
       schema name to use for the foreign table on the remote server.  If this
       option is omitted, the name of the foreign table's schema is used.
      
     
    
    
     table_name
     
      
       This option, which can be specified for a foreign table, gives the
       table name to use for the foreign table on the remote server.  If this
       option is omitted, the foreign table's name is used.
      
     
    
    
     column_name
     
      
       This option, which can be specified for a column of a foreign table,
       gives the column name to use for the column on the remote server.
       If this option is omitted, the column's name is used.
      
     
    
   
  
  
   Cost Estimation Options
   
    postgres_fdw> retrieves remote data by executing queries
    against remote servers, so ideally the estimated cost of scanning a
    foreign table should be whatever it costs to be done on the remote
    server, plus some overhead for communication.  The most reliable way to
    get such an estimate is to ask the remote server and then add something
    for overhead — but for simple queries, it may not be worth the cost
    of an additional remote query to get a cost estimate.
    So postgres_fdw> provides the following options to control
    how cost estimation is done:
   
   
    
     use_remote_estimate
     
      
       This option, which can be specified for a foreign table or a foreign
       server, controls whether postgres_fdw> issues remote
       EXPLAIN commands to obtain cost estimates.
       A setting for a foreign table overrides any setting for its server,
       but only for that table.
       The default is false.
      
     
    
    
     fdw_startup_cost
     
      
       This option, which can be specified for a foreign server, is a numeric
       value that is added to the estimated startup cost of any foreign-table
       scan on that server.  This represents the additional overhead of
       establishing a connection, parsing and planning the query on the
       remote side, etc.
       The default value is 100.
      
     
    
    
     fdw_tuple_cost
     
      
       This option, which can be specified for a foreign server, is a numeric
       value that is used as extra cost per-tuple for foreign-table
       scans on that server.  This represents the additional overhead of
       data transfer between servers.  You might increase or decrease this
       number to reflect higher or lower network delay to the remote server.
       The default value is 0.01.
      
     
    
   
   
    When use_remote_estimate is true,
    postgres_fdw> obtains rowcount and cost estimates from the
    remote server and then adds fdw_startup_cost and
    fdw_tuple_cost to the cost estimates.  When
    use_remote_estimate is false,
    postgres_fdw> performs local rowcount and cost estimation
    and then adds fdw_startup_cost and
    fdw_tuple_cost to the cost estimates.  This local
    estimation is unlikely to be very accurate unless local copies of the
    remote table's statistics are available.  Running
     on the foreign table is the way to update
    the local statistics; this will perform a scan of the remote table and
    then calculate and store statistics just as though the table were local.
    Keeping local statistics can be a useful way to reduce per-query planning
    overhead for a remote table — but if the remote table is
    frequently updated, the local statistics will soon be obsolete.
   
  
 
 
  Connection Management
  
   postgres_fdw establishes a connection to a
   foreign server during the first query that uses a foreign table
   associated with the foreign server.  This connection is kept and
   re-used for subsequent queries in the same session.  However, if
   multiple user identities (user mappings) are used to access the foreign
   server, a connection is established for each user mapping.
  
 
 
  Transaction Management
  
   During a query that references any remote tables on a foreign server,
   postgres_fdw opens a transaction on the
   remote server if one is not already open corresponding to the current
   local transaction.  The remote transaction is committed or aborted when
   the local transaction commits or aborts.  Savepoints are similarly
   managed by creating corresponding remote savepoints.
  
  
   The remote transaction uses SERIALIZABLE>
   isolation level when the local transaction has SERIALIZABLE>
   isolation level; otherwise it uses REPEATABLE READ>
   isolation level.  This choice ensures that if a query performs multiple
   table scans on the remote server, it will get snapshot-consistent results
   for all the scans.  A consequence is that successive queries within a
   single transaction will see the same data from the remote server, even if
   concurrent updates are occurring on the remote server due to other
   activities.  That behavior would be expected anyway if the local
   transaction uses SERIALIZABLE> or REPEATABLE READ>
   isolation level, but it might be surprising for a READ
   COMMITTED> local transaction.  A future
   PostgreSQL release might modify these rules.
  
 
 
  Remote Query Optimization
  
   postgres_fdw> attempts to optimize remote queries to reduce
   the amount of data transferred from foreign servers.  This is done by
   sending query WHERE> clauses to the remote server for
   execution, and by not retrieving table columns that are not needed for
   the current query.  To reduce the risk of misexecution of queries,
   WHERE> clauses are not sent to the remote server unless they use
   only built-in data types, operators, and functions.  Operators and
   functions in the clauses must be IMMUTABLE> as well.
  
  
   The query that is actually sent to the remote server for execution can
   be examined using EXPLAIN VERBOSE>.
  
 
 
  Cross-Version Compatibility
  
   postgres_fdw> can be used with remote servers dating back
   to PostgreSQL> 8.3.  Read-only capability is available
   back to 8.1.  A limitation however is that postgres_fdw>
   generally assumes that immutable built-in functions and operators are
   safe to send to the remote server for execution, if they appear in a
   WHERE> clause for a foreign table.  Thus, a built-in
   function that was added since the remote server's release might be sent
   to it for execution, resulting in function does not exist> or
   a similar error.  This type of failure can be worked around by
   rewriting the query, for example by embedding the foreign table
   reference in a sub-SELECT> with OFFSET 0> as an
   optimization fence, and placing the problematic function or operator
   outside the sub-SELECT>.
  
 
 
  Author
  
   Shigeru Hanada shigeru.hanada@gmail.com