Files
pyrseas/docs/rule.rst
T
2025-05-20 09:24:29 -04:00

36 lines
757 B
ReStructuredText

Rules
=====
.. module:: pyrseas.dbobject.rule
The :mod:`rule` module defines two classes, :class:`Rule` and
:class:`RuleDict`, derived from :class:`DbSchemaObject` and
:class:`DbObjectDict`, respectively.
Rule
----
:class:`Rule` is derived from
:class:`~pyrseas.dbobject.DbSchemaObject` and represents a `Postgres
rewrite rule
<https://www.postgresql.org/docs/current/static/rules.html>`_.
.. autoclass:: Rule
.. automethod:: Rule.identifier
.. automethod:: Rule.to_map
.. automethod:: Rule.create
Rule Dictionary
---------------
:class:`RuleDict` is derived from
:class:`~pyrseas.dbobject.DbObjectDict`. It is a dictionary that
represents the collection of rewrite rules in a database.
.. autoclass:: RuleDict
.. automethod:: RuleDict.from_map