Enums

Dimension types for dsgrid

class dsgrid.dimension.base_models.DimensionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Dimension types

static get_dimension_types_allowed_as_columns() → set[DimensionType]

Return the dimension types that may exist in the data table as columns.

static get_allowed_dimension_column_names() → set[str]

Return the dimension types that may exist in the data table as columns.

Dimensions related to time

class dsgrid.dimension.time.TimeDimensionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Defines the supported time formats in the load data.

class dsgrid.dimension.time.RepresentativePeriodFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Defines the supported formats for representative period data.

class dsgrid.dimension.time.LeapDayAdjustmentType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Leap day adjustment enum types

class dsgrid.dimension.time.TimeIntervalType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Time interval enum types

class dsgrid.dimension.time.MeasurementType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Time value measurement enum types

class dsgrid.dimension.time.TimeZone(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Time zone enum types - tz: zoneinfo.available_timezones() - tz_name: spark uses Java timezones: https://jenkov.com/tutorials/java-date-time/java-util-timezone.html

get_standard_time()

get equivalent standard time

get_prevailing_time()

get equivalent prevailing time

Common definitions for registry components

class dsgrid.registry.common.DatasetRegistryStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Statuses for a dataset within a project

class dsgrid.registry.common.ProjectRegistryStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Statuses for a project within the DSGRID registry

class dsgrid.config.dataset_config.InputDatasetType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

class dsgrid.config.dataset_config.DataSchemaType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Data schema types.

class dsgrid.config.dataset_config.DataClassificationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Data risk classification type.

See https://uit.stanford.edu/guide/riskclassifications for more information.

class dsgrid.config.dataset_config.DatasetQualifierType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

class dsgrid.config.dataset_config.GrowthRateType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Dimension Mapping Type

class dsgrid.config.dimension_mapping_base.DimensionMappingType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Defines the operation dsgrid will apply to the data during a mapping.