hipscat.catalog.index.index_catalog_info

Contents

`hipscat.catalog.index.index_catalog_info`#

Catalog Info for a HiPSCat Index table

Module Contents#

Classes#

IndexCatalogInfo

Catalog Info for a HiPSCat Index table

class IndexCatalogInfo[source]#

Bases: hipscat.catalog.dataset.base_catalog_info.BaseCatalogInfo

Catalog Info for a HiPSCat Index table

primary_catalog: str[source]#: Reference to object or source catalog

indexing_column: str[source]#: Column that we provide an index over

extra_columns: List[str][source]#: Any additional payload columns included in index

required_fields[source]#

DEFAULT_TYPE[source]#

REQUIRED_TYPE[source]#