Ctrl+K

hipscat.catalog.association_catalog.association_catalog_info

hipscat.catalog.association_catalog.association_catalog_info#

Module Contents#

Classes#

AssociationCatalogInfo

Catalog Info for a HiPSCat Association Catalog
class AssociationCatalogInfo[source]#

Bases: hipscat.catalog.dataset.base_catalog_info.BaseCatalogInfo

Catalog Info for a HiPSCat Association Catalog

primary_catalog: str | None[source]#

Catalog name for the primary (left) side of association

primary_column: str | None[source]#

Column name in the primary (left) side of join

primary_column_association: str | None[source]#

Column name in the association table that matches the primary (left) side of join

join_catalog: str | None[source]#

Catalog name for the joining (right) side of association

join_column: str | None[source]#

Column name in the joining (right) side of join

join_column_association: str | None[source]#

Column name in the association table that matches the joining (right) side of join

contains_leaf_files: bool = False[source]#

Whether or not the association catalog contains leaf parquet files

required_fields[source]#
DEFAULT_TYPE[source]#
REQUIRED_TYPE[source]#
Contents