Enumerations
Public module members
Section titled “Public module members”plexosdb.enums
Section titled “plexosdb.enums”Schema
Section titled “Schema”Enum that defines the Plexos Schema.
Methods and properties
Section titled “Methods and properties”name: strTable name associated with this schema element.
Returns
strThe underlying table name parsed from the enum value.
label: str | NonePrimary label column name for the schema element, if any.
Returns
str | NoneThe label column used as a default identifier when available.
ClassEnum
Section titled “ClassEnum”Enum that defines the different Plexos classes.
Full reference: ClassEnum.
plexos_class_mapping
Section titled “plexos_class_mapping”plexos_class_mapping = {enum_member.name: enum_member.value for enum_member in ClassEnum}CollectionEnum
Section titled “CollectionEnum”Enum that defines the different Plexos colections via Collection Name.
Full reference: CollectionEnum.
PhaseEnum
Section titled “PhaseEnum”PLEXOS solve phases used in result table names.
Full reference: PhaseEnum.
PeriodEnum
Section titled “PeriodEnum”PLEXOS result periods used in result table names.
Full reference: PeriodEnum.
TableTypeEnum
Section titled “TableTypeEnum”DuckDB information_schema table types used by solution results.
Full reference: TableTypeEnum.
str2enum
Section titled “str2enum”Convert string to enum.
str2enum(string: str, schema_enum: type[Enum]=Schema) -> Schema | Noneget_default_collection
Section titled “get_default_collection”Return default collection for class.
get_default_collection(class_enum: ClassEnum) -> CollectionEnumparse_class_enum
Section titled “parse_class_enum”Parse a string or ClassEnum to a ClassEnum instance.
parse_class_enum(value: str | ClassEnum) -> ClassEnumparse_collection_enum
Section titled “parse_collection_enum”Parse a string or CollectionEnum to a CollectionEnum instance.
parse_collection_enum(value: str | CollectionEnum) -> CollectionEnum