MCPcopy Create free account
hub / github.com/sqlalchemy/sqlalchemy / get_table_comment

Method get_table_comment

lib/sqlalchemy/engine/interfaces.py:1804–1825  ·  view source on GitHub ↗

r"""Return the "comment" for the table identified by ``table_name``. Given a string ``table_name`` and an optional string ``schema``, return table comment information as a dictionary corresponding to the :class:`.ReflectedTableComment` dictionary. This is an interna

(
        self,
        connection: Connection,
        table_name: str,
        schema: Optional[str] = None,
        **kw: Any,
    )

Source from the content-addressed store, hash-verified

1802 raise NotImplementedError()
1803
1804 def get_table_comment(
1805 self,
1806 connection: Connection,
1807 table_name: str,
1808 schema: Optional[str] = None,
1809 **kw: Any,
1810 ) -> ReflectedTableComment:
1811 r"""Return the "comment" for the table identified by ``table_name``.
1812
1813 Given a string ``table_name`` and an optional string ``schema``, return
1814 table comment information as a dictionary corresponding to the
1815 :class:`.ReflectedTableComment` dictionary.
1816
1817 This is an internal dialect method. Applications should use
1818 :meth:`.Inspector.get_table_comment`.
1819
1820 :raise: ``NotImplementedError`` for dialects that don't support
1821 comments.
1822
1823 """
1824
1825 raise NotImplementedError()
1826
1827 def get_multi_table_comment(
1828 self,

Calls

no outgoing calls