
本文详细介绍了如何使用fastapi框架结合sqlalchemy orm来查询oracle数据库中已存在的表。核心内容包括配置oracle数据库连接、sqlalchemy模型定义与现有表的映射策略(包括`base.metadata.create_all()`的`checkfirst`默认行为和显式反射机制),以及如何构建fastapi接口提供数据查询服务。文章提供了示例代码和实践建议,帮助开发者高效地实现数据库交互。
在使用FastAPI与SQLAlchemy连接Oracle数据库之前,需要确保Python环境中安装了必要的库,并配置好Oracle Instant Client。
1.1. 依赖库安装
首先,安装fastapi、uvicorn(ASGI服务器)、sqlalchemy和cx_Oracle。
pip install fastapi uvicorn sqlalchemy cx_Oracle
1.2. Oracle Instant Client配置
cx_Oracle库需要Oracle Instant Client的支持。请从Oracle官网下载对应操作系统的Instant Client,并解压。然后,在Python代码中通过cx_Oracle.init_oracle_client()指定其lib_dir路径。
import cx_Oracle # 请将此路径替换为您的Oracle Instant Client的实际lib_dir路径 # 例如:Windows系统下 r"C:\oracle\instantclient_19_12" # Linux/macOS系统下 "/opt/oracle/instantclient_19_12" cx_Oracle.init_oracle_client(lib_dir=r"E:\instantclient-basic-windows.x64-12.1.0.2.0\instantclient_12_1")
1.3. 数据库引擎与会话管理
使用SQLAlchemy的create_engine函数创建数据库连接引擎,并配置会话工厂sessionmaker。Oracle数据库的连接字符串通常格式为oracle+cx_oracle://user:password@host:port/service_name或oracle+cx_oracle://user:password@tnsname。
from sqlalchemy import create_engine from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker, Session # 替换为您的Oracle数据库连接信息 # 示例:oracle+cx_oracle://用户名:密码@主机名:端口号/服务名 my_database_connection = "oracle+cx_oracle://super:your_password@localhost:1521/db" engine = create_engine(my_database_connection) SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) Base = declarative_base()
当数据库中已存在表时,SQLAlchemy提供了多种方式来定义模型并映射到这些表。
2.1. 默认行为:Base.metadata.create_all()的checkfirst机制
许多开发者在处理现有表时,会误以为Base.metadata.create_all(bind=engine)会尝试重新创建表导致错误。然而,SQLAlchemy的MetaData.create_all()方法默认包含一个checkfirst=True的参数。这意味着在尝试创建表之前,它会检查数据库中是否已存在同名表。如果表已存在,create_all()将忽略该表,不会尝试重新创建,也不会引发错误。因此,即使您的表已经存在,使用此行代码通常也是安全的。
以下代码示例展示了这种默认行为,它定义了一个名为table1的模型,并尝试通过create_all进行映射。由于checkfirst=True是默认值,如果table1已存在,此操作将无害地通过。
from fastapi import Depends, FastAPI
from sqlalchemy import Column, Integer, String
# ... (前文的cx_Oracle初始化、engine和SessionLocal定义) ...
class table1(Base):
    __tablename__ = "table1" # 映射到数据库中名为"table1"的表
    # 定义表的列,注意主键是必须的,这里假设CN是主键或唯一标识
    # 如果没有显式主键,SQLAlchemy可能无法正确操作
    CN = Column(String(length=256), primary_key=True) # 假设CN是主键
    NAME = Column(String(length=40))
    EMAIL = Column(String(length=20))
# 即使table1已存在,此行代码在默认checkfirst=True的情况下也不会报错
# 它会检查表是否存在,如果存在则跳过创建
Base.metadata.create_all(bind=engine)
app = FastAPI()
def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()
@app.get("/table_api/")
def read_table1_data(db: Session = Depends(get_db)):
    """
    查询table1中的所有数据
    """
    cn_information = db.query(table1).all()
    return cn_information
2.2. 显式映射:使用反射机制处理现有表
虽然create_all的默认行为通常足够,但在某些情况下,您可能希望更显式地声明模型是基于数据库中现有表反射而来,而不是由ORM管理其创建。SQLAlchemy提供了反射(Reflection)机制来实现这一点。
您可以利用sqlalchemy.schema.Table和autoload_with参数来显式地从数据库反射表的结构。
from sqlalchemy import Table, MetaData
from sqlalchemy.orm import declarative_base
# ... (前文的cx_Oracle初始化、engine和SessionLocal定义) ...
Base = declarative_base()
metadata = MetaData() # 创建一个MetaData实例
# 显式反射现有表table1
# autoload_with=engine 会让SQLAlchemy连接数据库并自动加载表的列信息
class table1_reflected(Base):
    __table__ = Table("table1", metadata, autoload_with=engine)
    # 可以在这里添加额外的ORM属性或关系,但列定义会从数据库中反射
# 注意:使用反射机制时,通常不需要调用Base.metadata.create_all()
# 因为我们是基于已存在的表进行映射,而不是创建新表。
# 如果您在同一个应用中混合使用了创建和反射,请谨慎管理MetaData实例。
app = FastAPI()
def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()
@app.get("/table_api_reflected/")
def read_table1_reflected_data(db: Session = Depends(get_db)):
    """
    查询通过反射机制映射的table1数据
    """
    # 查询时使用反射后的模型类
    cn_information = db.query(table1_reflected).all()
    return cn_information在这个例子中,table1_reflected模型通过__table__ = Table("table1", metadata, autoload_with=engine)显式地从数据库中反射了table1的结构。这种方式更清晰地表明模型是基于一个已存在的数据库表。
FastAPI通过依赖注入(Depends)管理数据库会话,使得接口的编写更加简洁和模块化。
3.1. 数据库会话依赖
定义一个get_db函数作为FastAPI的依赖项,用于在每个请求中获取并管理数据库会话。
# ... (上述SQLAlchemy模型定义) ...
def get_db():
    db = SessionLocal()
    try:
        yield db # 将数据库会话传递给路由函数
    finally:
        db.close() # 请求结束后关闭会话3.2. 定义API端点
使用@app.get()装饰器定义HTTP GET请求的API端点,并通过Depends(get_db)注入数据库会话。
# ... (上述FastAPI应用实例和get_db函数) ...
@app.get("/table_api/")
def read_table_data(db: Session = Depends(get_db)):
    """
    查询table1中的所有数据并返回
    """
    # 使用SQLAlchemy会话执行查询
    cn_information = db.query(table1).all() # 使用之前定义的table1模型
    return cn_information运行FastAPI应用:
uvicorn main:app --reload
然后访问 http://127.0.0.1:8000/table_api/ 即可看到查询结果。
通过本文的指导,您应该能够熟练地使用FastAPI和SQLAlchemy来连接Oracle数据库并查询现有表。理解Base.metadata.create_all()的checkfirst默认行为,以及掌握显式反射机制,是高效处理现有数据库模式的关键。结合FastAPI的依赖注入,可以构建出结构清晰、易于维护的API服务。在实际开发中,请务必关注安全性、错误处理和性能优化等最佳实践。
以上就是使用FastAPI与SQLAlchemy查询现有Oracle数据库表的详细内容,更多请关注php中文网其它相关文章!
 
                        
                        每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
 
                Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号