Working with Attributes
Objects in PlexosDB can have attributes stored in the t_attribute_data table.
Attributes are different from properties in the following ways:
- Attribute definitions are valid for a class and are stored in
t_attribute. - Attribute values are assigned directly to individual objects in
t_attribute_data.
Listing available attributes per ClassEnum
Section titled “Listing available attributes per ClassEnum”We can use list_attributes() to see which attributes are valid for a specific
class. This returns definitions, not values assigned to a particular object.
from plexosdb import ClassEnum, PlexosDBdb = PlexosDB.from_xml("/path/to/your/model.xml")
attributes = db.list_attributes(ClassEnum.Generator)print(attributes)Adding an attribute to an existing object
Section titled “Adding an attribute to an existing object”We can use add_attribute() to assign one attribute value. The object must
already exist and the attribute name must be valid for its class.
from plexosdb import PlexosDBfrom plexosdb.enums import ClassEnum, CollectionEnum
# Initialize databasedb = PlexosDB()db.create_schema(version=10)
# Create a generator object if it doesn't existif not db.check_object_exists(ClassEnum.Generator, "Generator1"): db.add_object(ClassEnum.Generator, "Generator1")
# Add a property to the generatordb.add_attribute( ClassEnum.Generator, "Generator1", attribute_name="Latitude", attribute_value=100.0,)Extracting a single attribute from an object
Section titled “Extracting a single attribute from an object”We can use get_attribute() when we know the attribute name and need its
assigned value.
step_count = db.get_attribute( ClassEnum.Generator, object_name="Generator1", attribute_name="Latitude",)print(step_count)Extracting all assigned attributes from an object
Section titled “Extracting all assigned attributes from an object”We can use get_attributes() to retrieve all values assigned to an object.
attributes = db.get_attributes( "2020", object_class=ClassEnum.Horizon,)
for attribute in attributes: print(attribute["attribute"], attribute["value"])The result contains dictionaries with the following keys:
nameattributevaluestateWe can also filter to one attribute or a group of attributes.
step_type = db.get_attributes( "2020", object_class=ClassEnum.Horizon, attribute_names="Step Type",)
step_attributes = db.get_attributes( "2020", object_class=ClassEnum.Horizon, attribute_names=["Chrono Step Count", "Step Type"],)If the object exists but has no assigned values matching the request,
get_attributes() returns an empty list.
Checking and deleting assigned attributes
Section titled “Checking and deleting assigned attributes”We can use check_attribute_exists() to determine whether an object has an
assigned value for a particular attribute.
has_step_count = db.check_attribute_exists( "Chrono Step Count", object_name="2020", object_class=ClassEnum.Horizon,)
print(has_step_count)We can use delete_attribute() to remove an assigned value.
db.delete_attribute( "Chrono Step Count", object_name="2020", object_class=ClassEnum.Horizon,)Adding attributes in bulk
Section titled “Adding attributes in bulk”We can use add_attributes_from_records() when assigning values to many
objects. The method accepts either explicit records or a wide format.
For explicit records we can use one row per object and attribute:
db.add_attributes_from_records( [ {"name": "2020", "attribute": "Chrono Step Count", "value": 366}, {"name": "2020", "attribute": "Step Type", "value": 4}, {"name": "2021", "attribute": "Chrono Step Count", "value": 365}, ], object_class=ClassEnum.Horizon,)For wide records we can use one column per attribute:
db.add_attributes_from_records( [ { "name": "2020", "Chrono Step Count": 366, "Step Type": 4, }, { "name": "2021", "Chrono Step Count": 365, "Step Type": 4, }, ], object_class=ClassEnum.Horizon,)