Geni

Geni 是一款独立的迁移工具，旨在与您选择的 ORM/工具包/代码库协同工作。它允许多个开发者协作而不会覆盖数据库迁移。它可以与您的代码一起在 CD 流中运行，以确保数据库保持最新。

该项目受到了 dbmate 的极大启发，并因其缺乏对 LibSQL 的支持而创建。

该应用程序使用 Rust 编程语言开发，并依赖于 libsql-client-rs 库用于 SQLite 和 LibSQL。此外，它使用 SQLX 来支持 Postgres、MariaDB 和 MySQL 数据库。由于它是用 Rust 编写的，因此它非常快，速度极快，体积小巧，超快速且内存安全。

Geni 新闻

• 使用 Geni 简化数据库迁移 - Jamie Barton

功能

• 数据库
  • Postgres
  • MariaDB
  • MySQL
  • SQLite
  • LibSQL
• 使用 geni new **name** 生成迁移
• 使用 geni up 迁移
• 使用 geni down 回滚
• 使用 geni create 创建数据库
• 使用 geni drop 删除数据库
• 基于时间戳的迁移
• 在事务中运行迁移
• 状态命令以查看待应用的迁移
• 每次迁移后导出 schema.sql，可用于版本控制
  • 导出需要其他二进制文件才能工作
    • Postgres：无需其他二进制文件即可工作。使用 SQL 代码获取模式
    • MySQL：需要安装 mysqldump（已安装在 docker 中）
    • MariaDB：需要安装 mariadb-dump（已安装在 docker 中）
    • SQLite：无需其他二进制文件即可工作。使用 SQL 代码获取模式
    • LibSQL: 无需其他二进制文件即可运行。使用SQL代码获取架构

待办事项

• 数据库
  • ClickHouse

安装

GitHub

$ sudo curl -fsSL -o /usr/local/bin/geni https://github.com/emilpriver/geni/releases/latest/download/geni-linux-amd64
$ sudo chmod +x /usr/local/bin/geni

Homebrew

brew install geni

Scoop

待定

PKGX

使用PKGX运行

pkgx geni up

Nix flake

使用nix运行

nix run github:emilpriver/geni -- up

Cargo

cargo install geni

Docker

Docker镜像已发布到GitHub容器注册中心（ghcr.io/emilpriver/geni）。

$ docker run --rm -it --network=host ghcr.io/emilpriver/geni:latest --help

还有一个精简的Docker镜像，它没有各自数据库的库（例如pg_dump）。

注意： 此镜像不会尝试转储数据库

$ docker run --rm -it --network=host ghcr.io/emilpriver/geni:latest-slim --help

如果您希望创建或应用迁移，您需要使用Docker的绑定挂载功能，以便将您的本地工作目录（pwd）在geni容器内可用

$ docker run --rm -it --network=host -v "$(pwd)/migrations:/migrations" ghcr.io/emilpriver/geni:latest new create_users_table`

命令

geni new    # Generate a new migrations file
geni up     # Run any pending migration
geni down   # Rollback migrations, use --amount to speify how many migrations(default 1)
geni create # Create the database, only works for Postgres, MariaDB and MySQL. If you use SQLite will geni create the file before running migrations if the sqlite file don't exist. LibSQL should be create using respective interface.
geni drop   # Remove database
geni status # Print pending migrations
geni help   # Print help message

环境变量

• DATABASE_MIGRATIONS_FOLDER
  • 指定geni应查找以运行迁移的位置。
  • 默认： ./migrations
• DATABASE_URL
  • geni应使用的数据库URL以进行迁移
  • 示例
    • Postgres:DATABASE_URL="postgres://[email protected]:5432/app?sslmode=disable"
    • MySQL: mysql://root:password@localhost:3307/app
    • MariaDB: mariadb://root:password@localhost:3307/app
    • Sqlite: sqlite://./database.sqlite
    • LibSQL: https://127.0.0.1:6000
      • LibSQL的协议是https。
      • 对于turso的使用：这是您可以使用Turso CLI或网站检索的内容
• DATABASE_TOKEN
  • 仅在您使用Turso和LibSQL并需要令牌进行认证的情况下。如果没有指定，Geni将尝试迁移而不进行任何认证
• DATABASE_WAIT_TIMEOUT
  • geni尝试迁移之前等待的时间。如果您数据库需要一些时间来启动，这将很有用
  • 默认： 30秒
• DATABASE_SCHEMA_FILE
  • 架构迁移文件的名称
• DATABASE_MIGRATIONS_TABLE
  • 要运行迁移的表名称

DATABASE_URL="x" geni new hello_world

CREATE TABLE Persons (
    PersonID int
)

DROP TABLE Persons;

-- transaction:no
CREATE TABLE table_2 (
  id INT PRIMARY KEY,
  name VARCHAR(255) NOT NULL,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

geni up

geni down

geni down -a 3

DATABASE_URL="postgres://[email protected]:5432/app?sslmode=disable" geni up

- uses: emilpriver/geni@main
  with:
    migrations_folder: "./migrations"
    wait_timeout: "30"
    migrations_table: "schema_migrations"
    database_url: "https://127.0.0.1:3000"
    database_token: "X"

geni up

use geni;

#[tokio::main]
async fn main() {
    // Migrate the database
    geni::migrate_database(
        "sqlite://./test.db".to_string(), // Database URL
        None,                             // Database Token
        "migrations".to_string(),         // Migration Table
        "./migrations".to_string(),       // Migration Folder
        "schema.sql".to_string(),         // Schema File
        Some(30),                         // Wait timeout for the database to be ready
        false,                            // Dump Schema
    )
    .await
    .unwrap();

    ()
}