Skip to main content

ACP in-app scripting API 2026 R1

DB

Last update: 16.07.2026

class compolyx.DB(*args, **kwargs)

Represents the compolyx database

Access:

>>> import compolyx
>>> db = compolyx.DB()

Attributes

Name Description
DB.active_model Active model.
DB.is_dict_item Indicates whether the object is an item in a dictionary.
DB.is_list_item Indicates whether the object is an item of a list.
DB.link_path Root path of the current node in the tree for links to this object.
DB.material_data Material database.
DB.models Models.
DB.name Name of the object.
DB.parent Parent object in the tree.
DB.root_path Root path of the current node in the tree.

Methods

Name Description
DB.clear() Clears the database.
DB.clear_generated_data([model]) Function clears the eventually stored update results and deletes the generated data such as Production and analysis plies, solid models, etc.
DB.close([model]) Closes the model.
DB.find_parent(type) Steps up the tree and returns the first parent with given type.
DB.import_model(name, path, format[, ...]) Create a model from file.
DB.open(path, *[, pre_db, unit_system_type, ...]) Open an ACPH5 file.
DB.open_h5(path[, cache_data, ...]) Load a model from an .acph5 database.
DB.refresh_acph5(path, external_sources[, ...]) Refresh an .acph5 database (Workbench application mode only).
DB.reload(model) Reloads the reference surface (mesh) of the model.
DB.run_script(path[, locals])
DB.save([path, model, cache_data]) Save active model.
DB.set_unit_system(unit_system_type) Set the unit system of all models opened in the database.
DB.visit(visitor) Walk through the tree and let the visitor perform action on every descendant node.

Connect with Ansys