SurrealDB Simple 迁移工具

一个简单的 SurrealDB 迁移过程库。

用法 - 库

1. 此库迁移符合模式 <file_number>(_<filename>).surql 的文件。以下是一些示例

    path_to_dir/001.surql
    path_to_dir/002_create_users_table.surql
    path_to_dir/003_drop.surql

2. 在代码中

    let db_connection = ...;
    let migration_directory_path = "your/custom/path";

    // Here the code from the Library
    surrealdb_simple_migration::migrate(&db_connection, migration_directory_path).await;

用法 - 命令行界面

使用 cargo install surrealdb-simple-migration 安装软件包。它将自动安装名为 ssm（即 surrealdb-simple-migration）的二进制文件。安装完成后，只需运行命令 ssm apply 以应用您的迁移文件。（迁移文件目录的默认路径：./，SurrealDB 实例的默认主机地址 https://127.0.0.1:8000）。

SurrealDB 实例上使用的默认命名空间和数据库是 default 和 dev。

如果您想重置迁移，请使用 ssm reset。

CLI 配置

您可以通过 CLI 配置使用环境变量或传递所需信息作为选项。

• SSM_HOST 或 CLI 中的 -H your_host_address：设置主机地址（默认 https://127.0.0.1:8000）。
• SSM_PATH 或 CLI 中的 -p your/migration/files/path/：设置运行迁移所用的路径（默认为 ./）。
• SSM_NAMESPACE 或 CLI 中的 -n the_database_namespace：设置运行迁移所用的命名空间（默认为 default）。
• SSM_DB_NAME 或 CLI 中的 -n the_database_namespace：设置运行迁移所用的数据库（默认为 dev）。