Foreign Data Objects

module: pyrseas.dbobject.foreign

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.

autoclass: DbObjectWithOptions

automethod: DbObjectWithOptions.options_clause

automethod: DbObjectWithOptions.diff_options

automethod: DbObjectWithOptions.diff_map

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.

autoclass: ForeignDataWrapper

automethod: ForeignDataWrapper.to_map

automethod: ForeignDataWrapper.create

automethod: ForeignDataWrapper.diff_map

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.

autoclass: ForeignDataWrapperDict

automethod: ForeignDataWrapperDict.from_map

automethod: ForeignDataWrapperDict.link_refs

automethod: ForeignDataWrapperDict.to_map

automethod: ForeignDataWrapperDict.diff_map

Foreign Server

ForeignServer is derived from DbObjectWithOptions and represents a PostgreSQL foreign server.

autoclass: ForeignServer

automethod: ForeignServer.identifier

automethod: ForeignServer.to_map

automethod: ForeignServer.create

automethod: ForeignServer.diff_map

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.

autoclass: ForeignServerDict

automethod: ForeignServerDict.from_map

automethod: ForeignServerDict.to_map

automethod: ForeignServerDict.link_refs

automethod: ForeignServerDict.diff_map

User Mapping

UserMapping is derived from DbObjectWithOptions and represents a PostgreSQL user mapping of a user to a foreign server.

autoclass: UserMapping

automethod: UserMapping.extern_key

automethod: UserMapping.identifier

automethod: UserMapping.create

User Mapping Dictionary

UserMappingDict is derived from ~pyrseas.dbobject.DbObjectDict. It is a dictionary that represents the collection of user mappings in a database.

autoclass: UserMappingDict

automethod: UserMappingDict.from_map

automethod: UserMappingDict.to_map

automethod: UserMappingDict.diff_map

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).

autoclass: ForeignTable

automethod: ForeignTable.to_map

automethod: ForeignTable.create

automethod: ForeignTable.drop

automethod: ForeignTable.diff_map

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.

autoclass: ForeignTableDict

automethod: ForeignTableDict.from_map

automethod: ForeignTableDict.link_refs

automethod: ForeignTableDict.diff_map