Атрибут comment класса Table
Атрибут comment класса Table хранит
текстовый комментарий к таблице базы данных.
Комментарий задается при создании таблицы
параметром comment и попадает в DDL
при генерации схемы. Значением по умолчанию
выступает None, если комментарий
не был указан.
Синтаксис
table.comment
Пример
Давайте создадим таблицу articles
с комментарием и выведем значение атрибута
comment:
from sqlalchemy import Table, Column, Integer, String, MetaData
metadata = MetaData()
articles = Table(
'articles',
metadata,
Column('id', Integer, primary_key=True),
Column('title', String),
comment='Таблица статей'
)
print(articles.comment)
Результат выполнения кода:
"Таблица статей"
Пример
Давайте создадим таблицу без комментария
и убедимся, что атрибут равен None:
from sqlalchemy import Table, Column, Integer, String, MetaData
metadata = MetaData()
articles = Table(
'articles',
metadata,
Column('id', Integer, primary_key=True),
Column('title', String)
)
print(articles.comment)
Результат выполнения кода:
None
Пример
Давайте посмотрим, как комментарий попадает в DDL при создании таблицы:
from sqlalchemy import Table, Column, Integer, String, MetaData
from sqlalchemy.schema import CreateTable
from sqlalchemy.dialects import sqlite
metadata = MetaData()
articles = Table(
'articles',
metadata,
Column('id', Integer, primary_key=True),
Column('title', String),
comment='Таблица статей'
)
print(CreateTable(articles).compile(dialect=sqlite.dialect()))
Итоговый SQL запрос:
CREATE TABLE articles (
id INTEGER NOT NULL,
title VARCHAR,
PRIMARY KEY (id)
)
