Skip to content

Adding Objects to the Database

Objects in PlexosDB represent entities in your PLEXOS model like generators, regions, and nodes.

from plexosdb import PlexosDB
from plexosdb.enums import ClassEnum
# Initialize database
db = PlexosDB()
db.create_schema(version=10)
# Add a generator object
db.add_object(
ClassEnum.Generator,
name="Generator1",
description="Example generator",
category="Thermal"
)
# Add a node object
db.add_object(
ClassEnum.Node,
name="Node1"
)
# Add a region object
db.add_object(
ClassEnum.Region,
name="Region1"
)

You can organize your objects by adding them to specific categories:

# Add generator with custom category
db.add_object(
ClassEnum.Generator,
name="Wind_Farm1",
category="Renewable",
description="Offshore wind farm"
)

Before adding objects, you can check if they already exist:

if not db.check_object_exists(ClassEnum.Generator, "Generator1"):
db.add_object(ClassEnum.Generator, "Generator1")
else:
print("Generator already exists")

You can list all objects of a specific class:

# List all generators
generators = db.list_objects_by_class(ClassEnum.Generator)
print(f"Found {len(generators)} generators: {generators}")
# List all generators in a specific category
thermal_generators = db.list_objects_by_class(ClassEnum.Generator, category="Thermal")
print(f"Found {len(thermal_generators)} thermal generators")

For bulk operations, you can create multiple objects efficiently:

# Create multiple generators
for i in range(1, 101):
db.add_object(
ClassEnum.Generator,
name=f"Generator{i}",
category="Thermal" if i % 2 == 0 else "Renewable"
)