RegistryService

class pyvo.registry.vao.RegistryService(baseurl=None, resmeta=None, version='1.0')[source]

Bases: pyvo.dal.query.DALService

Deprecated since version 0.5: The RegistryService class is deprecated and may be removed in a future version.

a class for submitting searches to the VAO registry.

Deprecated since version 0.5: The RegistryService class is deprecated and may be removed in a future version.

connect to an STScI registry at the given URL Parameters ———- baseurl : str

the base URL for submitting search queries to the service. If None, it will default to the STScI public registry
resmeta
: str
an optional dictionary of properties about the service

Attributes Summary

STSCI_REGISTRY_BASEURL

Methods Summary

create_query([keywords, servicetype, ...]) create a RegistryQuery object that can be refined or saved
resolve(ivoid) Resolve the identifier against the registry, returning a resource record.
search([keywords, servicetype, waveband, ...]) execute a simple registry search of the specified

Attributes Documentation

STSCI_REGISTRY_BASEURL = 'http://vao.stsci.edu/directory/NVORegInt.asmx/'

Methods Documentation

create_query(keywords=None, servicetype=None, waveband=None, orkw=False, sqlpred=None)[source]

create a RegistryQuery object that can be refined or saved before submitting.

Parameters:

keywords : str

a string giving a single term or a python list of terms to match to registry records.

servicetype : str

the service type to restrict results to; allowed values include, ‘catalog’ (synonyms: ‘table’, ‘scs’, ‘conesearch’, ‘ConeSearch’), ‘image’ (synonyms: ‘sia’, ‘SimpleImageAccess’), ‘spectrum’ (synonyms: ‘ssa’, ‘ssap’, ‘SimpleSpectralAccess’), ‘line’ (synonyms: ‘sla’, ‘slap’, ‘SimpleLineAccess’) ‘database’ (synonyms: ‘tap’,’TableAccess’).

waveband : str

the name of a desired waveband; resources returned will be restricted to those that indicate as having data in that waveband. Allowed, case-insensitive values include ‘Radio’, ‘Millimeter’, ‘Infrared’ (synonym: ‘IR’), ‘Optical’, ‘UV’, ‘EUV’, ‘X-ray’ (synonym: ‘Xray’).

orkw : bool

If true, the keywords will be OR-ed together, and returned records will match at least one of the keywords. If false (default), the keywords qill be AND-ed, requiring the returned records to to match all of the keywords.

sqlpred : str

an SQL WHERE predicate (without the leading “WHERE”) that further contrains the search against supported keywords.

See also

RegistryQuery

resolve(ivoid)[source]

Resolve the identifier against the registry, returning a resource record.

Parameters:

ivoid : str

the IVOA Identifier of the resource

search(keywords=None, servicetype=None, waveband=None, orkw=False, sqlpred=None)[source]

execute a simple registry search of the specified keywords.

Parameters:

keywords : str or list of str

keyword terms to match to registry records. Use this parameter to find resources related to a particular topic.

servicetype : str

the service type to restrict results to. Allowed values include, ‘catalog’ (synonyms: ‘table’, ‘scs’, ‘conesearch’, ‘ConeSearch’), ‘image’ (synonyms: ‘sia’, ‘SimpleImageAccess’), ‘spectrum’ (synonyms: ‘ssa’, ‘ssap’, ‘SimpleSpectralAccess’), ‘line’ (synonyms: ‘sla’, ‘slap’, ‘SimpleLineAccess’) ‘database’ (synonyms: ‘tap’,’TableAccess’).

waveband : str

the name of a desired waveband; resources returned will be restricted to those that indicate as having data in that waveband. Allowed, case-insensitive values include ‘Radio’, ‘Millimeter’, ‘Infrared’ (synonym: ‘IR’), ‘Optical’, ‘UV’, ‘EUV’, ‘X-ray’ (synonym: ‘Xray’).

orkw : bool

If true, the keywords will be OR-ed together, and returned records will match at least one of the keywords. If false (default), the keywords qill be AND-ed, requiring the returned records to to match all of the keywords.

sqlpred : str

an SQL WHERE predicate (without the leading “WHERE”) that further contrains the search against supported keywords.

Returns:

RegistryResults

a container holding a table of matching resource (e.g. services)

See also

RegistryResults