Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

create_foreign_data_wrapper(7) [suse man page]

CREATE FOREIGN DATA 
WRAPPER(7) SQL Commands CREATE FOREIGN DATA WRAPPER(7) NAME
CREATE FOREIGN DATA WRAPPER - define a new foreign-data wrapper SYNOPSIS
CREATE FOREIGN DATA WRAPPER name [ VALIDATOR valfunction | NO VALIDATOR ] [ OPTIONS ( option 'value' [, ... ] ) ] DESCRIPTION
CREATE FOREIGN DATA WRAPPER creates a new foreign-data wrapper. The user who defines a foreign-data wrapper becomes its owner. The foreign-data wrapper name must be unique within the database. Only superusers can create foreign-data wrappers. PARAMETERS
name The name of the foreign-data wrapper to be created. VALIDATOR valfunction valfunction is the name of a previously registered function that will be called to check the generic options given to the foreign- data wrapper, as well as to foreign servers and user mappings using the foreign-data wrapper. If no validator function or NO VALIDA- TOR is specified, then options will not be checked at creation time. (Foreign-data wrappers will possibly ignore or reject invalid option specifications at run time, depending on the implementation.) The validator function must take two arguments: one of type text[], which will contain the array of options as stored in the system catalogs, and one of type oid, which will be the OID of the system catalog containing the options. The return type is ignored; the function should indicate invalid options using the ereport() function. OPTIONS ( option 'value' [, ... ] ) This clause specifies options for the new foreign-data wrapper. The allowed option names and values are specific to each foreign data wrapper and are validated using the foreign-data wrapper library. Option names must be unique. NOTES
At the moment, the foreign-data wrapper functionality is very rudimentary. The purpose of foreign-data wrappers, foreign servers, and user mappings is to store this information in a standard way so that it can be queried by interested applications. One such application is dblink; see in the documentation. The functionality to actually query external data through a foreign-data wrapper library does not exist yet. There is currently one foreign-data wrapper validator function provided: postgresql_fdw_validator, which accepts options corresponding to libpq connection parameters. EXAMPLES
Create a foreign-data wrapper dummy: CREATE FOREIGN DATA WRAPPER dummy; Create a foreign-data wrapper postgresql with validator function postgresql_fdw_validator: CREATE FOREIGN DATA WRAPPER postgresql VALIDATOR postgresql_fdw_validator; Create a foreign-data wrapper mywrapper with some options: CREATE FOREIGN DATA WRAPPER mywrapper OPTIONS (debug 'true'); COMPATIBILITY
CREATE FOREIGN DATA WRAPPER conforms to ISO/IEC 9075-9 (SQL/MED), with the exception that the VALIDATOR clause is an extension and the clauses LIBRARY and LANGUAGE are not yet implemented in PostgreSQL. Note, however, that the SQL/MED functionality as a whole is not yet conforming. SEE ALSO
ALTER FOREIGN DATA WRAPPER [alter_foreign_data_wrapper(7)], DROP FOREIGN DATA WRAPPER [drop_foreign_data_wrapper(7)], CREATE SERVER [cre- ate_server(7)], CREATE USER MAPPING [create_user_mapping(7)] SQL - Language Statements 2010-05-14 CREATE FOREIGN DATA WRAPPER(7)

Check Out this Related Man Page

DBLINK_CONNECT(3)					  PostgreSQL 9.2.7 Documentation					 DBLINK_CONNECT(3)

NAME
dblink_connect - opens a persistent connection to a remote database SYNOPSIS
dblink_connect(text connstr) returns text dblink_connect(text connname, text connstr) returns text DESCRIPTION
dblink_connect() establishes a connection to a remote PostgreSQL database. The server and database to be contacted are identified through a standard libpq connection string. Optionally, a name can be assigned to the connection. Multiple named connections can be open at once, but only one unnamed connection is permitted at a time. The connection will persist until closed or until the database session is ended. The connection string may also be the name of an existing foreign server. It is recommended to use the postgresql_fdw_validator when defining the corresponding foreign-data wrapper. See the example below, as well as the following: CREATE FOREIGN DATA WRAPPER (CREATE_FOREIGN_DATA_WRAPPER(7)), CREATE SERVER (CREATE_SERVER(7)), CREATE USER MAPPING (CREATE_USER_MAPPING(7)) ARGUMENTS
conname The name to use for this connection; if omitted, an unnamed connection is opened, replacing any existing unnamed connection. connstr libpq-style connection info string, for example hostaddr=127.0.0.1 port=5432 dbname=mydb user=postgres password=mypasswd. For details see PQconnectdb in Section 31.1, "Database Connection Control Functions", in the documentation. RETURN VALUE
Returns status, which is always OK (since any error causes the function to throw an error instead of returning). NOTES
Only superusers may use dblink_connect to create non-password-authenticated connections. If non-superusers need this capability, use dblink_connect_u instead. It is unwise to choose connection names that contain equal signs, as this opens a risk of confusion with connection info strings in other dblink functions. EXAMPLES
SELECT dblink_connect('dbname=postgres'); dblink_connect ---------------- OK (1 row) SELECT dblink_connect('myconn', 'dbname=postgres'); dblink_connect ---------------- OK (1 row) -- FOREIGN DATA WRAPPER functionality -- Note: local connection must require password authentication for this to work properly -- Otherwise, you will receive the following error from dblink_connect(): -- ---------------------------------------------------------------------- -- ERROR: password is required -- DETAIL: Non-superuser cannot connect if the server does not request a password. -- HINT: Target server's authentication method must be changed. CREATE USER dblink_regression_test WITH PASSWORD 'secret'; CREATE FOREIGN DATA WRAPPER postgresql VALIDATOR postgresql_fdw_validator; CREATE SERVER fdtest FOREIGN DATA WRAPPER postgresql OPTIONS (hostaddr '127.0.0.1', dbname 'contrib_regression'); CREATE USER MAPPING FOR dblink_regression_test SERVER fdtest OPTIONS (user 'dblink_regression_test', password 'secret'); GRANT USAGE ON FOREIGN SERVER fdtest TO dblink_regression_test; GRANT SELECT ON TABLE foo TO dblink_regression_test; set ORIGINAL_USER :USER c - dblink_regression_test SELECT dblink_connect('myconn', 'fdtest'); dblink_connect ---------------- OK (1 row) SELECT * FROM dblink('myconn','SELECT * FROM foo') AS t(a int, b text, c text[]); a | b | c ----+---+--------------- 0 | a | {a0,b0,c0} 1 | b | {a1,b1,c1} 2 | c | {a2,b2,c2} 3 | d | {a3,b3,c3} 4 | e | {a4,b4,c4} 5 | f | {a5,b5,c5} 6 | g | {a6,b6,c6} 7 | h | {a7,b7,c7} 8 | i | {a8,b8,c8} 9 | j | {a9,b9,c9} 10 | k | {a10,b10,c10} (11 rows) c - :ORIGINAL_USER REVOKE USAGE ON FOREIGN SERVER fdtest FROM dblink_regression_test; REVOKE SELECT ON TABLE foo FROM dblink_regression_test; DROP USER MAPPING FOR dblink_regression_test SERVER fdtest; DROP USER dblink_regression_test; DROP SERVER fdtest; DROP FOREIGN DATA WRAPPER postgresql; PostgreSQL 9.2.7 2014-02-17 DBLINK_CONNECT(3)
Man Page