Ctrl+K

hipscat.catalog.dataset.base_catalog_info

hipscat.catalog.dataset.base_catalog_info#

Module Contents#

Classes#

BaseCatalogInfo

Container class for catalog metadata
class BaseCatalogInfo[source]#

Container class for catalog metadata

catalog_name: str = ''[source]#
catalog_type: hipscat.catalog.catalog_type.CatalogType | None[source]#
total_rows: int | None[source]#
DEFAULT_TYPE[source]#

The default catalog type for this catalog info type. To be overridden by subclasses. If specified, we will use this value when no catalog_type is provided.

REQUIRED_TYPE[source]#

The required catalog type for this catalog info type. To be overridden by subclasses. If specified, the catalog MUST have this type.

required_fields = ['catalog_type'][source]#
__post_init__()[source]#
__str__()[source]#

Return str(self).

classmethod read_from_metadata_file(catalog_info_file: hipscat.io.FilePointer, storage_options: Dict[Any, Any] | None = None) → typing_extensions.Self[source]#

Read catalog info from the catalog_info.json metadata file

Parameters:

  • catalog_info_file – FilePointer pointing to the catalog_info.json file

  • storage_options – dictionary that contains abstract filesystem credentials

Returns:

A CatalogInfo object with the data from the catalog_info.json file

_check_required_fields()[source]#
Contents