PyVO
  • Index
  • Modules

Navigation

  • next »
  • « previous |
  • pyvo v1.5.dev97+gc4f67e5 »
  • Registry (pyvo.registry) »
  • search

search¶

pyvo.registry.regtap.search(*constraints: Constraint, includeaux: bool = False, maxrec: int | None = None, **kwargs)[source]¶

execute a simple query to the RegTAP registry.

The function accepts query constraints either as Constraint objects passed in as positional arguments or as their associated keywords. For what constraints are available, see ref:registry_basic_interface.

The values of keyword arguments may be tuples or lists when the associated Constraint objects take multiple arguments.

All constraints, whether passed in directly or via keywords, are evaluated as a conjunction (i.e., in an AND clause).

Parameters:
*constraintsrtcons.Constraint instances

The constraints (keywords to match, positions to cover, …) that the returned records need to satisfy.

includeauxbool

Flag for whether to include auxiliary capabilities in results. This may result in duplicate capabilities being returned, especially if the servicetype is not specified.

maxrecint

Overrides the RegTAP server’s default limit on the number of rows to return. You may need to use this if you want to retrieve more than a few thousand matches. The server may also have a hard limit that maxrec cannot override. Note that truncated search results are not reproducible.

**kwargsstrings, mostly

shorthands for constraints; see the documentation of a specific constraint for what keyword it uses and what literal it expects.

Returns:
RegistryResults

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

See also

RegistryResults

Page Contents

  • search
    • search()

Page Source   Back to Top

© Copyright 2023, the PyVO Developers.
Created using Sphinx 7.0.1.   Last built 02 Jun 2023.