Foreign Data Objects

module: pyrseas.dbobject.foreign

The foreign module defines nine classes related to Postgres foreign data wrappers (FDWs), namely: 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 class for dealing with the OPTIONS clauses common to the foreign data objects.

autoclass: DbObjectWithOptions
automethod: DbObjectWithOptions.to_map
automethod: DbObjectWithOptions.options_clause
automethod: DbObjectWithOptions.diff_options
automethod: DbObjectWithOptions.alter

Foreign Data Wrapper

ForeignDataWrapper is derived from DbObjectWithOptions and represents a Postgres foreign data wrapper. See also Foreign Data and Writing A Foreign Data Wrapper.

autoclass: ForeignDataWrapper
automethod: ForeignDataWrapper.to_map
automethod: ForeignDataWrapper.create

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

Foreign Server

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

autoclass: ForeignServer
automethod: ForeignServer.identifier
automethod: ForeignServer.to_map
automethod: ForeignServer.create

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

User Mapping

UserMapping is derived from DbObjectWithOptions and represents a mapping of a Postgres 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

Foreign Table

ForeignTable is derived from DbObjectWithOptions and ~pyrseas.dbobject.table.Table. It represents a Postgres foreign table.

autoclass: ForeignTable
automethod: ForeignTable.to_map
automethod: ForeignTable.create
automethod: ForeignTable.drop

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