官方文档:https://docs.sqlalchemy.org/en/14/tutorial/metadata.html
SQLAlchemy 核心 和 ORM 的核心元素是 SQL 表达式语句,它允许流畅的、可组合的 SQL 结构化查询。这些查询的基础是:把数据库概念表示为 Python 对象,如表和列。这些对象被统称为数据库元数据。
当我们使用一个关系型数据库时,我们创建和查询的基本结构被称为”表“(Table)。在 SQLAlchemy 中,"表 "由一个类似于 Table 的 Python 对象表示。
我们先来创建一个 MetaData
对象:
from sqlalchemy import MetaData
metadata_obj = MetaData()
声明式定义数据表
创建好了 MetaData
对象,我们就可以声明一些 Table
对象。本教程将从经典的 user
表和 address
表开始。
from sqlalchemy import create_engine, MetaData
from sqlalchemy import Table, Column, Integer, String, ForeignKey
engine = create_engine('sqlite:///memory.db', echo=True, future=True)
metadata_obj = MetaData()
user_table = Table(
"user_account",
metadata_obj,
Column('id', Integer, primary_key=True),
Column('name', String(30)),
Column('fullname', String)
)
metadata_obj.create_all(engine)
我们可以观察到,上面的表结构看起来很像 SQL 的 CREATE TABLE
语句;从表名开始,然后列出每一列,并定义每一列的名称和数据类型。
Table
- 代表一个数据库表,并将自己分配给一个 MetaData
集合。
Column
- 代表数据库表中的一个列,并将自己分配给一个 Table
对象。
就父表而言,Column
对象的集合通过 Table.c
的关联数组进行访问:
>>> user_table.c.name
>>> user_table.c.keys()
MetaData.create_all()
方法帮助我们创建好数据库并执行相应的 SQL 语句。以上面例子来说,我们会在终端看到这样的 SQL 语句输出。
CREATE TABLE user_account (
id INTEGER NOT NULL,
name VARCHAR(30),
fullname VARCHAR,
PRIMARY KEY (id)
)
外键 - ForeignKey
关于外键的概念,学习过关系型数据库的人都应该理解,本例中 address_table
表通过 user_account.id
跟 user_account
表关联起来。
from sqlalchemy import create_engine, MetaData
from sqlalchemy import Table, Column, Integer, String, ForeignKey
engine = create_engine('sqlite:///memory.db', echo=True, future=True)
metadata_obj = MetaData()
user_table = Table(
"user_account",
metadata_obj,
Column('id', Integer, primary_key=True),
Column('name', String(30)),
Column('fullname', String)
)
address_table = Table(
"address",
metadata_obj,
Column('id', Integer, primary_key=True),
Column('user_id', ForeignKey('user_account.id'), nullable=False),
Column('email_address', String, nullable=False)
)
metadata_obj.create_all(engine)
用 ORM 定义元数据
当使用 ORM 时,我们需要创建一个注册表对象(registry)。
from sqlalchemy.orm import registry
mapper_registry = registry()
这个注册表对象是会自动包含一个 MetaData
对象在内的。
>>> mapper_registry.metadata
MetaData()
现在我们不直接用声明来定义数据库,而是通过定义 Python 类来把数据表对象映射到数据表结构。数据表对象需要先继承一个声明性基类的公共基类(Base)。
我们使用 registry.generate_base()
方法从注册表中获得一个声明性基类(Base)。
Base = mapper_registry.generate_base()
另一种创建 Base
类的方法是使用 declarative_base()
函数。
from sqlalchemy.orm import declarative_base
Base = declarative_base()
接下来我们把上一节的例子用 ORM 的方法实现一次。
from sqlalchemy import create_engine, MetaData
from sqlalchemy import Table, Column, Integer, String, ForeignKey
from sqlalchemy.orm import declarative_base, relationship
engine = create_engine('sqlite:///memory.db', echo=True, future=True)
Base = declarative_base()
class User(Base):
__tablename__ = 'user_account'
id = Column(Integer, primary_key=True)
name = Column(String(30))
fullname = Column(String)
addresses = relationship("Address", back_populates="user")
def __repr__(self):
return f"User(id={self.id!r}, name={self.name!r}, fullname={self.fullname!r})"
class Address(Base):
__tablename__ = 'address'
id = Column(Integer, primary_key=True)
email_address = Column(String, nullable=False)
user_id = Column(Integer, ForeignKey('user_account.id'))
user = relationship("User", back_populates="addresses")
def __repr__(self):
return f"Address(id={self.id!r}, email_address={self.email_address!r})"
Base.metadata.create_all(engine)
执行上面代码会在根目录创建 memory.db
数据库文件,并创建 user_account
和 address
两张数据表。
我们使用 Base.metadata.create_all(engine)
来执行创建的命令,如果我们用 mapper_registry
来创建 Base
类,也可以这样写:
mapper_registry.metadata.create_all(engine)