class documentation

class ObjectKind(Flag): (source)

View In Hierarchy

Enumerator that indicates which kind of object to return when calling the ``get_multi`` methods. This is a Flag enum, so custom combinations can be passed. For example, to reflect tables and plain views ``ObjectKind.TABLE | ObjectKind.VIEW`` may be used. .. note:: Not all dialect may support all kind of object. If a dialect does not support a particular object an empty dict is returned. In case a dialect supports an object, but the requested method is not applicable for the specified kind the default value will be returned for each reflected object. For example reflecting check constraints of view return a dict with all the views with empty lists as values.

Constant ANY Reflect all type of objects
Constant ANY_VIEW Reflect any kind of view objects
Constant MATERIALIZED_VIEW Reflect materialized view object
Constant TABLE Reflect table objects
Constant VIEW Reflect plain view objects

Reflect all type of objects

Value
(TABLE|VIEW)|MATERIALIZED_VIEW
ANY_VIEW = (source)

Reflect any kind of view objects

Value
VIEW|MATERIALIZED_VIEW
MATERIALIZED_VIEW = (source)

Reflect materialized view object

Value
auto()

Reflect table objects

Value
auto()

Reflect plain view objects

Value
auto()