VODataServiceTable

class pyvo.io.vosi.vodataservice.VODataServiceTable(config=None, pos=None, _name='table', version='1.1', **kwargs)

Bases: Element

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

Attributes Summary

columns	A list of columns in the table.
description	a free-text description of the table's contents
foreignkeys	A list of columns in the table.
name	the fully qualified name of the table.
nrows	the approximate number of rows in the table.
title	a descriptive, human-interpretable name for the table.
type	a name for the role this table plays.
utype	an identifier for a concept in a data model that the data in this table represent.
version	The version of the standard

Methods Summary

describe()
parse(iterator, config)	For internal use.

Attributes Documentation

columns

A list of columns in the table. Must contain only TableParam objects.

A description of a table column.

description

a free-text description of the table’s contents

foreignkeys

A list of columns in the table. Must contain only ForeignKey objects

a description of a foreign keys, one or more columns from the current table that can be used to join with another table.

name

the fully qualified name of the table. This name should include all catalog or schema prefixes needed to sufficiently uniquely distinguish it in a query.

In general, the format of the qualified name may depend on the context; however, when the table is intended to be queryable via ADQL, then the catalog and schema qualifiers are delimited from the table name with dots (.).

nrows

the approximate number of rows in the table.

This is None if the data provider failed to provide this information.

title

a descriptive, human-interpretable name for the table.

This is used for display purposes. There is no requirement regarding uniqueness.

type

a name for the role this table plays. Recognized values include “output”, indicating this table is output from a query; “base_table”, indicating a table whose records represent the main subjects of its schema; and “view”, indicating that the table represents a useful combination or subset of other tables. Other values are allowed.

utype

an identifier for a concept in a data model that the data in this table represent.

The format defined in the VOTable standard is highly recommended.

version

The version of the standard

Methods Documentation

describe()

parse(iterator, config)

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.