pyaccesskit.properties

pyaccesskit.properties

Access to DAO property collections (the escape hatch for properties PyAccessKit does not model).

PropertyBag

PropertyBag(session: Session, target: PropertyTarget)

The DAO Properties of a database, table, field or query.

Reading a property that does not exist raises :class:~pyaccesskit.errors.ObjectNotFoundError (a LookupError); :meth:get returns a default instead. Setting a missing property creates it — with the DAO type Access itself uses for well-known properties (Description, AppTitle, UseMDIMode...) or one inferred from the value, unless type is given::

db.properties["AppTitle"] = "Customer Manager"
db.tables["Customers"].properties.set("SubdatasheetName", "[None]")

get

get(
    name: str, default: PropertyValue = None
) -> PropertyValue

The property value, or default if it does not exist.

set

set(
    name: str,
    value: PropertyValue,
    type: PropertyType | None = None,
) -> None

Set (creating if necessary) a property; type forces the DAO type of a new property.

delete

delete(name: str) -> None

Delete a user-defined property.

to_dict

to_dict() -> dict[str, PropertyValue]

All readable properties.