Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

create_foreign_table(7) [centos man page]

CREATE FOREIGN 
TABLE(7) PostgreSQL 9.2.7 Documentation CREATE FOREIGN TABLE(7) NAME
CREATE_FOREIGN_TABLE - define a new foreign table SYNOPSIS
CREATE FOREIGN TABLE [ IF NOT EXISTS ] table_name ( [ { column_name data_type [ OPTIONS ( option 'value' [, ... ] ) ] [ NULL | NOT NULL ] } [, ... ] ] ) SERVER server_name [ OPTIONS ( option 'value' [, ... ] ) ] DESCRIPTION
CREATE FOREIGN TABLE will create a new foreign table in the current database. The table will be owned by the user issuing the command. If a schema name is given (for example, CREATE FOREIGN TABLE myschema.mytable ...) then the table is created in the specified schema. Otherwise it is created in the current schema. The name of the foreign table must be distinct from the name of any other foreign table, table, sequence, index, or view in the same schema. CREATE FOREIGN TABLE also automatically creates a data type that represents the composite type corresponding to one row of the foreign table. Therefore, foreign tables cannot have the same name as any existing data type in the same schema. To be able to create a table, you must have USAGE privilege on all column types. PARAMETERS
IF NOT EXISTS Do not throw an error if a relation with the same name already exists. A notice is issued in this case. Note that there is no guarantee that the existing relation is anything like the one that would have been created. table_name The name (optionally schema-qualified) of the table to be created. column_name The name of a column to be created in the new table. data_type The data type of the column. This can include array specifiers. For more information on the data types supported by PostgreSQL, refer to Chapter 8, Data Types, in the documentation. NOT NULL The column is not allowed to contain null values. NULL The column is allowed to contain null values. This is the default. This clause is only provided for compatibility with non-standard SQL databases. Its use is discouraged in new applications. server_name The name of an existing server for the foreign table. OPTIONS ( option 'value' [, ...] ) Options to be associated with the new foreign table or one of its columns. The allowed option names and values are specific to each foreign data wrapper and are validated using the foreign-data wrapper's validator function. Duplicate option names are not allowed (although it's OK for a table option and a column option to have the same name). EXAMPLES
Create foreign table films with film_server: CREATE FOREIGN TABLE films ( code char(5) NOT NULL, title varchar(40) NOT NULL, did integer NOT NULL, date_prod date, kind varchar(10), len interval hour to minute ) SERVER film_server; COMPATIBILITY
The CREATE FOREIGN TABLE command largely conforms to the SQL standard; however, much as with CREATE TABLE, NULL constraints and zero-column foreign tables are permitted. SEE ALSO
ALTER FOREIGN TABLE (ALTER_FOREIGN_TABLE(7)), DROP FOREIGN TABLE (DROP_FOREIGN_TABLE(7)), CREATE TABLE (CREATE_TABLE(7)), CREATE SERVER (CREATE_SERVER(7)) PostgreSQL 9.2.7 2014-02-17 CREATE FOREIGN TABLE(7)

Check Out this Related 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)
Man Page

Featured Tech Videos