MCPcopy
hub / github.com/sqlalchemy/sqlalchemy / get_multi_columns

Method get_multi_columns

lib/sqlalchemy/engine/reflection.py:887–944  ·  view source on GitHub ↗

r"""Return information about columns in all objects in the given schema. The objects can be filtered by passing the names to use to ``filter_names``. For each table the value is a list of :class:`.ReflectedColumn`. :param schema: string schema name; if omit

(
        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

885 col_def["type"] = coltype()
886
887 def get_multi_columns(
888 self,
889 schema: Optional[str] = None,
890 filter_names: Optional[Sequence[str]] = None,
891 kind: ObjectKind = ObjectKind.TABLE,
892 scope: ObjectScope = ObjectScope.DEFAULT,
893 **kw: Any,
894 ) -> Dict[TableKey, List[ReflectedColumn]]:
895 r"""Return information about columns in all objects in the given
896 schema.
897
898 The objects can be filtered by passing the names to use to
899 ``filter_names``.
900
901 For each table the value is a list of :class:`.ReflectedColumn`.
902
903 :param schema: string schema name; if omitted, uses the default schema
904 of the database connection. For special quoting,
905 use :class:`.quoted_name`.
906
907 :param filter_names: optionally return information only for the
908 objects listed here.
909
910 :param kind: a :class:`.ObjectKind` that specifies the type of objects
911 to reflect. Defaults to ``ObjectKind.TABLE``.
912
913 :param scope: a :class:`.ObjectScope` that specifies if columns of
914 default, temporary or any tables should be reflected.
915 Defaults to ``ObjectScope.DEFAULT``.
916
917 :param \**kw: Additional keyword argument to pass to the dialect
918 specific implementation. See the documentation of the dialect
919 in use for more information.
920
921 :return: a dictionary where the keys are two-tuple schema,table-name
922 and the values are list of dictionaries, each representing the
923 definition of a database column.
924 The schema is ``None`` if no schema is provided.
925
926 .. versionadded:: 2.0
927
928 .. seealso:: :meth:`Inspector.get_columns`
929 """
930
931 with self._operation_context() as conn:
932 table_col_defs = dict(
933 self.dialect.get_multi_columns(
934 conn,
935 schema=schema,
936 filter_names=filter_names,
937 kind=kind,
938 scope=scope,
939 info_cache=self.info_cache,
940 **kw,
941 )
942 )
943 self._instantiate_types(table_col_defs.values())
944 return table_col_defs

Callers

nothing calls this directly

Calls 3

_operation_contextMethod · 0.95
_instantiate_typesMethod · 0.95
valuesMethod · 0.45

Tested by

no test coverage detected