summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine/interfaces.py
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2017-03-17 14:16:27 -0400
committerGerrit Code Review <gerrit@awstats.zzzcomputing.com>2017-03-17 14:16:27 -0400
commitd96fc5d02a921820aa5973daf66445c880ca6cd4 (patch)
treea7b3a47cca6e9a5af48dda6b3d92e3ba3f0b2418 /lib/sqlalchemy/engine/interfaces.py
parent9974e9a46bdf6c570c650aa911b76c2dcfd9327b (diff)
parentfadb8d61babb76ef7bdbc98279096a8900c7328d (diff)
downloadsqlalchemy-d96fc5d02a921820aa5973daf66445c880ca6cd4.tar.gz
Merge "Implement comments for tables, columns"
Diffstat (limited to 'lib/sqlalchemy/engine/interfaces.py')
-rw-r--r--lib/sqlalchemy/engine/interfaces.py19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/sqlalchemy/engine/interfaces.py b/lib/sqlalchemy/engine/interfaces.py
index d0eff1cb1..57f8b8dda 100644
--- a/lib/sqlalchemy/engine/interfaces.py
+++ b/lib/sqlalchemy/engine/interfaces.py
@@ -422,6 +422,25 @@ class Dialect(object):
raise NotImplementedError()
+ def get_table_comment(
+ self, connection, table_name, schema=None, **kw):
+ 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 with this key:
+
+ text
+ text of the comment
+
+ Raises ``NotImplementedError`` for dialects that don't support
+ comments.
+
+ .. versionadded:: 1.2
+
+ """
+
+ raise NotImplementedError()
+
def normalize_name(self, name):
"""convert the given name to lowercase if it is detected as
case insensitive.