sqlalchemy查看已经创建的索引

以下是使用 sqlalchemy 查看一个模型所建索引的步骤：

解决思路：

1. 导入所需的模块，包括 sqlalchemy 及其相关组件。
2. 定义一个模型类，该类继承自 sqlalchemy 的 Base 类。
3. 创建一个 MetaData 对象，它可以用来存储表的元数据信息。
4. 使用 MetaData 对象的 create_all 方法将模型映射到数据库，从而在数据库中创建表。
5. 利用 MetaData 对象的 tables 属性获取表的元数据信息，进而查看该表的索引信息。

from sqlalchemy import create_engine, Column, Integer, String, Index
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

# 创建一个数据库引擎
engine = create_engine('sqlite:///example.db')
# 创建一个基类
Base = declarative_base()

# 定义一个模型类
class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    age = Column(Integer)
    # 定义一个索引
    Index('idx_name', 'name')


# 创建表
Base.metadata.create_all(engine)

# 获取表的元数据信息
metadata = Base.metadata
table = metadata.tables.get('users')

# 查看索引
if table:
    indexes = table.indexes
    for index in indexes:
        print(f"Index Name: {index.name}, Columns: {index.columns.keys()}")

代码解释：

• from sqlalchemy import create_engine, Column, Integer, String, Index：从 sqlalchemy 中导入所需的模块，包括创建引擎的 create_engine、定义列的 Column、数据类型 Integer 和 String 以及创建索引的 Index。
• from sqlalchemy.ext.declarative import declarative_base：导入 declarative_base，用于创建 Base 类，后续的模型类会继承这个基类。
• from sqlalchemy.orm import sessionmaker：导入 sessionmaker 用于创建会话，这里未使用但通常会在其他操作中用到。
• engine = create_engine('sqlite:///example.db')：创建一个连接到 sqlite 数据库的引擎，数据库文件名为 example.db。
• Base = declarative_base()：创建 Base 类，作为模型类的基类。
• class User(Base)：定义 User 模型类，继承自 Base，并使用 __tablename__ 定义表名。
• id = Column(Integer, primary_key=True)：定义一个名为 id 的列，其数据类型为 Integer，并作为主键。
• name = Column(String)：定义一个名为 name 的列，数据类型为 String。
• age = Column(Integer)：定义一个名为 age 的列，数据类型为 Integer。
• Index('idx_name', 'name')：为 name 列创建一个名为 idx_name 的索引。
• Base.metadata.create_all(engine)：根据定义的模型类创建表。
• metadata = Base.metadata：获取 Base 的元数据。
• table = metadata.tables.get('users')：从元数据中获取名为 users 的表。
• if table:：检查是否存在该表。
• indexes = table.indexes：获取表的索引列表。
• for index in indexes:：遍历索引列表。
• print(f"Index Name: {index.name}, Columns: {index.columns.keys()}")：打印出索引的名称和其包含的列的键。

如果你已经有一个存在的数据库和表，并且想要查看其索引，可以直接使用以下方式，假设你已经有了 engine 和 metadata 对象：

metadata.reflect(bind=engine)
table = metadata.tables.get('users')
if table:
    indexes = table.indexes
    for index in indexes:
        print(f"Index Name: {index.name}, Columns: {index.columns.keys()}")

代码解释：

• metadata.reflect(bind=engine)：使用 reflect 方法将数据库中的表信息反射到 metadata 中，以便获取现有表的元数据信息。
• 后续步骤与上述相同，获取表的 indexes 并打印。

另外，如果你使用的是 flask_sqlalchemy，你可以通过以下方式查看：

from flask_sqlalchemy import SQLAlchemy
from flask import Flask

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db'
db = SQLAlchemy(app)


class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String)
    age = db.Column(db.Integer)
    db.Index('idx_name', 'name')


with app.app_context():
    db.create_all()
    indexes = db.metadata.tables['users'].indexes
    for index in indexes:
        print(f"Index Name: {index.name}, Columns: {index.columns.keys()}")

代码解释：

• from flask_sqlalchemy import SQLAlchemy 和 from flask import Flask：导入 flask_sqlalchemy 模块和 Flask 应用。
• app = Flask(__name__)：创建一个 Flask 应用实例。
• app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db'：配置数据库连接。
• db = SQLAlchemy(app)：创建 SQLAlchemy 实例。
• class User(db.Model)：定义模型类，使用 db.Model 作为基类。
• db.Index('idx_name', 'name')：创建索引。
• with app.app_context():：在应用上下文中操作，确保操作的环境正确。
• db.create_all()：创建表。
• indexes = db.metadata.tables['users'].indexes：获取 users 表的索引列表。
• for index in indexes:：遍历索引列表。
• print(f"Index Name: {index.name}, Columns: {index.columns.keys()}")：打印索引信息。