MCPcopy Create free account
hub / github.com/zzzeek/sqlalchemy / get_multi_table_options

Method get_multi_table_options

lib/sqlalchemy/engine/reflection.py:695–750  ·  view source on GitHub ↗

r"""Return a dictionary of options specified when the tables in the given schema were created. The tables can be filtered by passing the names to use to ``filter_names``. This currently includes some options that apply to MySQL and Oracle tables. :p

(
        self,
        schema: Optional[str] = None,
        filter_names: Optional[Sequence[str]] = None,
        kind: ObjectKind = ObjectKind.TABLE,
        scope: ObjectScope = ObjectScope.DEFAULT,
        **kw: Any,
    )

Source from the content-addressed store, hash-verified

693 )
694
695 def get_multi_table_options(
696 self,
697 schema: Optional[str] = None,
698 filter_names: Optional[Sequence[str]] = None,
699 kind: ObjectKind = ObjectKind.TABLE,
700 scope: ObjectScope = ObjectScope.DEFAULT,
701 **kw: Any,
702 ) -> Dict[TableKey, Dict[str, Any]]:
703 r"""Return a dictionary of options specified when the tables in the
704 given schema were created.
705
706 The tables can be filtered by passing the names to use to
707 ``filter_names``.
708
709 This currently includes some options that apply to MySQL and Oracle
710 tables.
711
712 :param schema: string schema name; if omitted, uses the default schema
713 of the database connection. For special quoting,
714 use :class:`.quoted_name`.
715
716 :param filter_names: optionally return information only for the
717 objects listed here.
718
719 :param kind: a :class:`.ObjectKind` that specifies the type of objects
720 to reflect. Defaults to ``ObjectKind.TABLE``.
721
722 :param scope: a :class:`.ObjectScope` that specifies if options of
723 default, temporary or any tables should be reflected.
724 Defaults to ``ObjectScope.DEFAULT``.
725
726 :param \**kw: Additional keyword argument to pass to the dialect
727 specific implementation. See the documentation of the dialect
728 in use for more information.
729
730 :return: a dictionary where the keys are two-tuple schema,table-name
731 and the values are dictionaries with the table options.
732 The returned keys in each dict depend on the
733 dialect in use. Each one is prefixed with the dialect name.
734 The schema is ``None`` if no schema is provided.
735
736 .. versionadded:: 2.0
737
738 .. seealso:: :meth:`Inspector.get_table_options`
739 """
740 with self._operation_context() as conn:
741 res = self.dialect.get_multi_table_options(
742 conn,
743 schema=schema,
744 filter_names=filter_names,
745 kind=kind,
746 scope=scope,
747 info_cache=self.info_cache,
748 **kw,
749 )
750 return dict(res)
751
752 def get_view_names(

Callers

nothing calls this directly

Calls 1

_operation_contextMethod · 0.95

Tested by

no test coverage detected