从应用程序cod内部使用Alembic API

Question

我正在使用SQLite作为基于PySide的桌面应用程序的应用程序文件格式（请参见here了解为什么要这样做）。也就是说，当用户使用我的应用程序时，他们的数据将保存在其计算机上的单个数据库文件中。我正在使用SQLAlchemy ORM与数据库通信。

当我发布应用程序的新版本时，我可以修改数据库模式。我不希望用户每次更改模式时都扔掉他们的数据，所以我需要将他们的数据库迁移到最新格式。另外，我创建了很多临时数据库来保存数据子集，以便与一些外部进程一起使用。我想用alembic创建这些数据库，以便用正确的版本标记它们。

我有几个问题：

• 有没有办法从我的Python代码中调用alembic？我认为必须对纯Python模块使用Popen是很奇怪的，但是文档只是从命令行使用alembic。主要是，我需要将数据库位置更改为用户数据库所在的位置。

• 如果这不可能，我可以从命令行指定一个新的数据库位置而不编辑.ini文件吗？这将使得通过Popen调用alembic不是什么大事。

• 我看到alembic将其版本信息保存在一个名为alembic_version的简单表中，其中一列名为version_num，一行指定版本。我可以在我的模式中添加一个alembic_version表，并在创建新数据库时用最新版本填充它，这样就不会有开销了吗？这是个好主意吗？我应该用alembic来创建所有的数据库吗？

我让alembic为我用来在项目目录中开发的单个数据库工作得很好。我想使用alembic在任意位置方便地迁移和创建数据库，最好是通过某种Python API，而不是命令行。此应用程序还将使用cx_Freeze进行冻结，以防造成差异。

谢谢！

Answer 1

这是一个非常宽泛的问题，真正实现你的想法将取决于你，但这是可能的。

您可以从您的Python代码中调用Alembic而不使用命令，因为它也是用Python实现的！你只需要重新创建命令在幕后所做的事情。

不可否认，这些文档的状态不是很好，因为它们仍然是库的相对早期版本，但是稍微挖掘一下，您会发现以下内容：

1. 创建Config
2. 使用配置创建ScriptDirectory
3. 使用Config和script目录创建EnvironmentContext
4. 使用EnvironmentContext创建MigrationContext
5. 大多数命令使用Config和MigrationContext中的一些方法组合

我编写了一个扩展来提供对Flask SQLAlchemy数据库的编程Alembic访问。这个实现与Flask和Flask SQLAlchemy绑定在一起，但它应该是一个很好的起点。See Flask-Alembic here.

关于如何创建新数据库的最后一点，可以使用Alembic创建表，也可以使用metadata.create_all()然后alembic stamp head（或等效的python代码）。我建议始终使用迁移路径创建表，并忽略原始的metadata.create_all()。

我对cx_freeze没有任何经验，但只要迁移包含在发行版中，并且代码中指向该目录的路径正确，就应该没问题。