hats.catalog.catalog_extension#

Classes#

CatalogExtension

An extension of a HATS Catalog, holding additional columns for its rows

Module Contents#

class CatalogExtension(config_path: upath.UPath, extension_info: hats.catalog.dataset.extension_properties.ExtensionProperties, catalog: hats.catalog.catalog.Catalog | hats.catalog.catalog_collection.CatalogCollection, storage_options: dict | None = None)[source]#

An extension of a HATS Catalog, holding additional columns for its rows

Extensions are described by an <extension>.properties file, which references the primary catalog, points to the extension data, and names the columns to join them on. The extension data is a HATS catalog of its own (or a collection, when it has margins), which is valid and can be read on its own.

The reference to the extension data is resolved against the directory holding the <extension>.properties file, unless it is absolute, so the file can point to data hosted elsewhere. The file sits at the root of a collection, and names that collection as its primary, unless it gives the primary by absolute path (e.g. a remote one):

catalog_collection/
├── main_catalog/
├── extension_catalog.properties
├── collection.properties
config_path[source]#
extension_info[source]#
storage_options = None[source]#
catalog[source]#
property join_catalog_dir: upath.UPath[source]#

Path to the extension data