Contents
Foreign Data Objects
The foreign module defines nine classes: DbObjectWithOptions derived from DbObject, classes ForeignDataWrapper, ForeignServer and UserMapping derived from DbObjectWithOptions, ForeignTable derived from DbObjectWithOptions and Table, classes ForeignDataWrapperDict, ForeignServerDict and UserMappingDict derived from DbObjectDict, and ForeignTableDict derived from ClassDict.
Database Object With Options
DbObjectWithOptions is derived from ~pyrseas.dbobject.DbObject. It is a helper function dealing with the OPTIONS clauses common to the foreign data objects.
Foreign Data Wrapper
ForeignDataWrapper is derived from DbObjectWithOptions and represents a PostgreSQL foreign data wrapper. For PostgreSQL versions 9.1 and later see also Foreign Data and Writing A Foreign Data Wrapper.
Foreign Data Wrapper Dictionary
ForeignDataWrapperDict is derived from ~pyrseas.dbobject.DbObjectDict. It is a dictionary that represents the collection of foreign data wrappers in a database.
Foreign Server
ForeignServer is derived from DbObjectWithOptions and represents a PostgreSQL foreign server.
Foreign Server Dictionary
ForeignServerDict is derived from ~pyrseas.dbobject.DbObjectDict. It is a Python dictionary that represents the collection of foreign servers in a database.
User Mapping
UserMapping is derived from DbObjectWithOptions and represents a PostgreSQL user mapping of a user to a foreign server.
User Mapping Dictionary
UserMappingDict is derived from ~pyrseas.dbobject.DbObjectDict. It is a dictionary that represents the collection of user mappings in a database.
Foreign Table
ForeignTable is derived from DbObjectWithOptions and ~pyrseas.dbobject.table.Table. It represents a PostgreSQL foreign table (available on PostgreSQL 9.1 or later).
Foreign Table Dictionary
ForeignTableDict is derived from ~pyrseas.dbobject.table.ClassDict. It is a dictionary that represents the collection of foreign tables in a database.