Use migrate in Go project(golang-migrate/migrate)

目录

         引言

测试postgre

1.启动数据库

2.创建migrations

3.目录树

4.运行go-migrations程序

4.测试结果

参数说明

1.postgres示例

golang-migrate 其他功能示例

1.index

2.functions

注意事项

1.命名规范

参考文章

引言

代码内集成的方式相对来说更加灵活,如果业务上需要在代码中进行数据库的维护作用,可以选择该方法。

测试postgre

1.启动数据库

 采用postgresSQL作为示例

进入postgres 容器内运行 

psql -h localhost -U postgres -w -c "create database pig;" 创建pig数据库。

2.创建migrations

migrate create -ext sql -dir ./migrations -seq create_books_table

3.目录树

000001 是某次修改的版本号,因为本次是第二次生成sql 脚本文件,create_books_tabel 前编号是000002

当前目录:

  golang project 目录文件

migrations 子级目录:

   •000002_create_books_table.down.sql    回滚本次操作的sql脚本
   •000002_create_books_table.up.sql  创建books表的sql脚本

代码文件示例:

000002_create_books_table.up.sql

CREATE TABLE books (

  user_id integer,

  name    varchar(40),

  author  varchar(40)

);

000002_create_books_table.down.sql

DROP TABLE IF EXISTS books;

4.运行go-migrations程序

  go app 是main.go 示例如下:

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:///root/TEST/migrate/migratesql/migrations",

                "postgres://postgres:123456@localhost:5432/pig?sslmode=disable")

        if err != nil {

                log.Fatal(err)

        }

        if err := m.Up(); err != nil {

                log.Fatal(err)

        }

}

4.测试结果

参数说明

1.postgres示例

postgres://user:password@host:port/dbname?query (postgresql:// works, too)

URL Query

WithInstance Config

Description

x-migrations-tableMigrationsTableName of the migrations table
x-migrations-table-quotedMigrationsTableQuotedBy default, migrate quotes the migration table for SQL injection safety reasons. This option disable quoting and naively checks that you have quoted the migration table name. e.g. "my_schema"."schema_migrations"
x-statement-timeoutStatementTimeoutAbort any statement that takes more than the specified number of milliseconds
x-multi-statementMultiStatementEnabledEnable multi-statement execution (default: false)
x-multi-statement-max-sizeMultiStatementMaxSizeMaximum size of single statement in bytes (default: 10MB)
dbnameDatabaseNameThe name of the database to connect to
search_pathThis variable specifies the order in which schemas are searched when an object is referenced by a simple name with no schema specified.
userThe user to sign in as
passwordThe user's password
hostThe host to connect to. Values that start with / are for unix domain sockets. (default is localhost)
portThe port to bind to. (default is 5432)
fallback_application_nameAn application_name to fall back to if one isn't provided.
connect_timeoutMaximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
sslcertCert file location. The file must contain PEM encoded data.
sslkeyKey file location. The file must contain PEM encoded data.
sslrootcertThe location of the root certificate file. The file must contain PEM encoded data.
sslmodeWhether or not to use SSL (disable|require|verify-ca|verify-full)

golang-migrate 其他功能示例

1.index

2.functions

常用函数示例: 

func New(sourceUrl, databaseUrl string) (*Migrate, error)
New 从源 URL 和数据库 URL 返回一个新的 Migrate 实例。
func (m *Migrate) Version() (version uint, dirty bool, err error)
版本返回当前活动的迁移版本。
func (m *Migrate) Up() error
Up 查看当前活动的迁移版本,并将一直向上迁移(应用所有向上迁移)。
func (m *Migrate) Down() error
Down 查看当前活动的迁移版本,并将一直向下迁移(应用所有向下迁移)。
func (m *Migrate) Steps(n int) error
Steps 查看当前活动的迁移版本。如果 n > 0,它将向上迁移,如果 n < 0,它将向下迁移。

注意事项

1.命名规范

create_

create_为前缀的,是创建数据表脚本。

addcolumn

add_column_为前缀的,是向已经创建的数据表添加字段,修改数据表时使用。

addindex

add_index_为前缀的,是向已经创建的数据表添加索引,修改数据表时使用。

dropcolumn

drop_column_为前缀的,是向已经创建的数据表删除字段,修改数据表时使用。

dropindex

drop_index_为前缀的,是向已经创建的数据表删除索引,修改数据表时使用。

renamecolumn

rename_column_为前缀的,是向已经创建的数据表重命名字段,修改数据表时使用。

renameindex

rename_index_为前缀的,是向已经创建的数据表重命名索引,修改数据表时使用。

参考文章

1.migrate/database/postgres at master · golang-migrate/migrate · GitHub

2.migrate package - github.com/golang-migrate/migrate - pkg.go.dev

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值