ForeignKey

class pyvo.io.vosi.vodataservice.ForeignKey(config=None, pos=None, _name='foreignKey', **kwargs)[source]

Bases: Element

ForeignKey element as described in http://www.ivoa.net/xml/VODataService/v1.1

Attributes Summary

description

a free-text description of what this key points to and what the relationship means.

fkcolumns

A list of foreign key columns.

targettable

the fully-qualified name (including catalog and schema, as applicable) of the table that can be joined with the table containing this foreign key.

utype

an identifier for a concept in a data model that the association enabled by this key represents.

Methods Summary

parse(iterator, config)

For internal use.

Attributes Documentation

description

a free-text description of what this key points to and what the relationship means.

fkcolumns

A list of foreign key columns. Must contain only FKColumn objects.

a pair of column names, one from this table and one from the target table that should be used to join the tables in a query.

targettable

the fully-qualified name (including catalog and schema, as applicable) of the table that can be joined with the table containing this foreign key.

utype

an identifier for a concept in a data model that the association enabled by this key represents.

The format defined in the VOTable standard is highly recommended.

Methods Documentation

parse(iterator, config)[source]

For internal use. Parse the XML content of the children of the element. Override this method and do after-parse checks after calling super().parse, if you need to.

Parameters:
iteratorxml iterator

An iterator over XML elements as returned by get_xml_iterator.

configdict

The configuration dictionary that affects how certain elements are read.