Golang Migrate 项目使用教程

尤歌泽Vigour

于 2024-10-10 07:11:45 发布

阅读量647

点赞数 23

本文链接：https://blog.csdn.net/gitblog_00959/article/details/142801939

版权

Golang Migrate 项目使用教程

migrate golang-migrate/migrate：这是一个基于Go语言的数据迁移库，适合进行数据库迁移和数据同步。特点包括简单易用、支持多种数据库类型、支持自定义迁移脚本等。项目地址: https://gitcode.com/gh_mirrors/mi/migrate

1. 项目介绍

Golang Migrate 是一个用 Go 语言编写的轻量级数据库迁移工具。它既可以作为命令行工具使用，也可以作为库导入到 Go 项目中。Golang Migrate 支持多种数据库，并且可以通过多种源（如本地文件系统、GitHub、AWS S3 等）读取迁移文件。

主要特点

多数据库支持：支持 PostgreSQL、MySQL、SQLite、MongoDB 等多种数据库。
多源支持：可以从本地文件系统、GitHub、AWS S3 等多种源读取迁移文件。
线程安全：确保在多线程环境下安全运行。
低内存开销：使用 io.Reader 流处理数据，减少内存占用。

2. 项目快速启动

安装

首先，确保你已经安装了 Go 语言环境。然后，使用以下命令安装 migrate 工具：

go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest

创建迁移文件

在项目目录下创建一个 migrations 文件夹，并在其中创建两个迁移文件：

1_create_users_table.up.sql
1_create_users_table.down.sql

-- 1_create_users_table.up.sql
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) UNIQUE NOT NULL
);

-- 1_create_users_table.down.sql
DROP TABLE users;

运行迁移

使用以下命令运行迁移：

migrate -source file://migrations -database postgres://localhost:5432/mydatabase up

在 Go 项目中使用

在你的 Go 项目中，可以通过以下代码使用 migrate 库：

package main

import (
    "github.com/golang-migrate/migrate/v4"
    _ "github.com/golang-migrate/migrate/v4/database/postgres"
    _ "github.com/golang-migrate/migrate/v4/source/file"
)

func main() {
    m, err := migrate.New(
        "file://migrations",
        "postgres://localhost:5432/mydatabase?sslmode=disable")
    if err != nil {
        log.Fatal(err)
    }
    if err := m.Up(); err != nil {
        log.Fatal(err)
    }
}