Resource Objects¶
- class app.models.AbstractResource(*, id: int | None = None, added: datetime | None = None, updated: datetime | None = None, deprecated: datetime | None = None, deprecation_reason: str | None = None, destroyed: datetime | None = None, **kwargs: Any)¶
- added = Column(None, DateTime(), table=None, nullable=False, default=CallableColumnDefault(<function datetime.utcnow>))¶
- abstract property brn: BRN¶
- classmethod csv_header() List[str] ¶
- csv_row() List[datetime | bool | int | str] ¶
- deprecate(*, reason: str) bool ¶
Marks the resource as deprecated. In the event that the resource was already deprecated, no change will be recorded and the function will return False.
- Parameters:
reason – an opaque string that records the deprecation reason
- Returns:
if the proxy was deprecated
- deprecated = Column(None, DateTime(), table=None)¶
- deprecation_reason = Column(None, String(), table=None)¶
- destroy() None ¶
Marks the resource for destruction.
- Returns:
None
- destroyed = Column(None, DateTime(), table=None)¶
- id = Column(None, Integer(), table=None, primary_key=True, nullable=False)¶
- query: t.ClassVar[Query]¶
A SQLAlchemy query for a model. Equivalent to
db.session.query(Model)
. Can be customized per-model by overridingquery_class
.Warning
The query interface is considered legacy in SQLAlchemy. Prefer using
session.execute(select())
instead.
- updated = Column(None, DateTime(), table=None, nullable=False, default=CallableColumnDefault(<function datetime.utcnow>))¶