如何通过SQLAlchemy在数据库初始化时自动部署存储过程？

问题根源 #

SQLAlchemy的connection.execute()默认会对传入的SQL做语法解析，而存储过程的.sql文件通常包含DELIMITER切换、多行语句块这类MariaDB客户端专属语法，这些内容无法被SQLAlchemy的语句解析器识别，因此抛出"Not an executable object"错误。

具体解决步骤 #

1. 预处理SQL文件内容 #

首先需要移除SQL文件中的DELIMITER命令（SQLAlchemy不支持这个客户端指令），并将存储过程定义的结束符从自定义的//（或其他符号）改回标准的;。

2. 使用驱动原生执行方法（SQLAlchemy 2.0+推荐） #

SQLAlchemy 2.0+提供了exec_driver_sql()方法，可以直接将原始SQL传递给MariaDB驱动执行，绕过SQLAlchemy自身的语句解析，完美支持多语句和存储过程定义。

示例代码：

from sqlalchemy import create_engine
import os

# 初始化数据库连接
engine = create_engine("mariadb+mariadbconnector://<用户名>:<密码>@<数据库地址>/<库名>")

def run_sql_script(file_path):
    # 读取SQL文件内容
    with open(file_path, 'r', encoding='utf-8') as f:
        sql_content = f.read()
    
    # 预处理：移除DELIMITER指令，替换存储过程结束符
    sql_content = sql_content.replace('DELIMITER //', '') \
                             .replace('//', ';') \
                             .strip()
    
    # 执行脚本
    with engine.connect() as conn:
        conn.exec_driver_sql(sql_content)
        conn.commit()  # 提交事务

# 遍历指定目录下的所有.sql文件
script_dir = "/path/to/your/sql/scripts"
for file_name in os.listdir(script_dir):
    if file_name.endswith('.sql'):
        run_sql_script(os.path.join(script_dir, file_name))

3. SQLAlchemy 1.x兼容方案 #

如果你还在使用SQLAlchemy 1.x版本，需要在创建引擎时开启多语句支持，并用text()包裹SQL内容：

from sqlalchemy import create_engine, text
import os

engine = create_engine(
    "mariadb+mariadbconnector://<用户名>:<密码>@<数据库地址>/<库名>",
    connect_args={"allow_multi_statements": True}  # 开启多语句支持
)

def run_sql_script(file_path):
    with open(file_path, 'r', encoding='utf-8') as f:
        sql_content = f.read()
    
    sql_content = sql_content.replace('DELIMITER //', '') \
                             .replace('//', ';') \
                             .strip()
    
    with engine.connect() as conn:
        conn.execute(text(sql_content))
        conn.commit()

# 遍历执行脚本
script_dir = "/path/to/your/sql/scripts"
for file_name in os.listdir(script_dir):
    if file_name.endswith('.sql'):
        run_sql_script(os.path.join(script_dir, file_name))

注意事项 #

• 确保所有.sql文件中的存储过程语法正确（你已经验证过手动执行可行，预处理后不会有问题）。
• 执行脚本时必须提交事务，否则存储过程不会被持久化到数据库。
• 如果你使用的是其他MariaDB驱动（比如pymysql），allow_multi_statements参数同样适用，但需要确认驱动版本支持该参数。

内容的提问来源于stack exchange，提问作者Zachary Wadie