Метод get_table_comment
Метод get_table_comment класса Inspector
возвращает текстовый комментарий, привязанный к таблице
базы данных. Первым параметром метод принимает имя
таблицы, вторым необязательным параметром передается
схема. Метод возвращает словарь с ключом text
или значение None, если комментарий отсутствует.
Синтаксис
inspector.get_table_comment(table_name, schema=None)
Пример
Давайте создадим таблицу с комментарием и получим его через инспектор:
<+python+>
from sqlalchemy import create_engine, MetaData, Table, Column, Integer, String
from sqlalchemy import inspect
engine = create_engine('sqlite:///:memory:')
metadata = MetaData()
articles = Table(
'articles', metadata,
Column('id', Integer, primary_key=True),
Column('title', String),
comment='Table of articles'
)
metadata.create_all(engine)
inspector = inspect(engine)
res = inspector.get_table_comment('articles')
print(res)
<-python+>
Результат выполнения кода:
<+python+>
{'text': 'Table of articles'}
<-python+>
Пример
Давайте получим комментарий у таблицы без комментария:
<+python+>
from sqlalchemy import create_engine, MetaData, Table, Column, Integer, String
from sqlalchemy import inspect
engine = create_engine('sqlite:///:memory:')
metadata = MetaData()
articles = Table(
'articles', metadata,
Column('id', Integer, primary_key=True),
Column('title', String)
)
metadata.create_all(engine)
inspector = inspect(engine)
res = inspector.get_table_comment('articles')
print(res)
<-python+>
Результат выполнения кода:
<+python+>
{'text': None}
<-python+>
Пример
Давайте выведем только текст комментария:
<+python+>
from sqlalchemy import create_engine, MetaData, Table, Column, Integer, String
from sqlalchemy import inspect
engine = create_engine('sqlite:///:memory:')
metadata = MetaData()
articles = Table(
'articles', metadata,
Column('id', Integer, primary_key=True),
Column('title', String),
comment='Table of articles'
)
metadata.create_all(engine)
inspector = inspect(engine)
res = inspector.get_table_comment('articles')
print(res['text'])
<-python+>
Результат выполнения кода:
<+python+>
"Table of articles"
<-python+>
Смотрите также
-
класс
Inspector,
который выполняет инспекцию схемы базы данных -
метод
get_table_names,
который возвращает список имен таблиц -
метод
get_columns,
который возвращает список колонок таблицы -
метод
has_table,
который проверяет существование таблицы
