組件分享之后端組件——基于Golang實現(xiàn)的數(shù)據(jù)庫遷移工具dbmate

背景

近期正在探索前端拔莱、后端获洲、系統(tǒng)端各類常用組件與工具擒滑，對其一些常見的組件進行再次整理一下情萤，形成標(biāo)準(zhǔn)化組件專題，后續(xù)該專題將包含各類語言中的一些常用組件较屿。歡迎大家進行持續(xù)關(guān)注隧魄。

組件基本信息

• 組件：dbmate
• 開源協(xié)議：MIT license

內(nèi)容

本節(jié)我們分享一個基于Golang實現(xiàn)的數(shù)據(jù)庫遷移工具dbmate，可讓您的數(shù)據(jù)庫架構(gòu)在多個開發(fā)人員和生產(chǎn)服務(wù)器之間保持同步隘蝎。

它是一個獨立的命令行工具购啄，可與 Go、Node.js嘱么、Python狮含、Ruby、PHP 或您用來編寫數(shù)據(jù)庫支持的應(yīng)用程序的任何其他語言或框架一起使用拱撵。如果您正在用不同的語言編寫許多服務(wù)辉川，并且希望使用一致的開發(fā)工具保持一定的理智，這將特別有用拴测。

其具體特征如下：

• 支持 MySQL、PostgreSQL府蛇、SQLite 和 ClickHouse集索。
• 使用純 SQL 編寫模式遷移。
• 遷移是時間戳版本的，以避免與多個開發(fā)人員發(fā)生版本號沖突务荆。
• 遷移在事務(wù)中以原子方式運行妆距。
• 支持創(chuàng)建和刪除數(shù)據(jù)庫（在開發(fā)/測試中很方便）。
• 支持保存schema.sql文件以輕松區(qū)分 git 中的架構(gòu)更改函匕。
• 數(shù)據(jù)庫連接 URL 使用環(huán)境變量定義（DATABASE_URL默認情況下）娱据，或在命令行中指定。
• 內(nèi)置支持從.env文件中讀取環(huán)境變量盅惜。
• 易于分發(fā)中剩，單個獨立的二進制文件。

安裝方式如下：
1抒寂、mac安裝

brew install dbmate

2结啼、linux安裝

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

3、docker安裝

docker run --rm -it --network=host -v "$(pwd)/db:/db" ghcr.io/amacneil/dbmate:1 new create_users_table

4屈芜、windows安裝
下載

命令介紹如下：

dbmate --help    # print usage help
dbmate new       # generate a new migration file
dbmate up        # create the database (if it does not already exist) and run any pending migrations
dbmate create    # create the database
dbmate drop      # drop the database
dbmate migrate   # run any pending migrations
dbmate rollback  # roll back the most recent migration
dbmate down      # alias for rollback
dbmate status    # show the status of all migrations (supports --exit-code and --quiet)
dbmate dump      # write the database schema.sql file
dbmate wait      # wait for the database server to become available

命令行選項
以下選項適用于所有命令郊愧。您必須按順序使用命令行參數(shù)dbmate [global options] command [command options]。大多數(shù)選項也可以通過環(huán)境變量進行配置（并從您的.env文件中加載井佑，這有助于在團隊成員之間共享配置）属铁。

--url, -u "protocol://host:port/dbname"- 直接指定數(shù)據(jù)庫 url。（環(huán)境：）$DATABASE_URL
--env, -e "DATABASE_URL"- 指定一個環(huán)境變量來讀取數(shù)據(jù)庫連接 URL躬翁。
--migrations-dir, -d "./db/migrations"- 保存遷移文件的位置焦蘑。（環(huán)境：）$DBMATE_MIGRATIONS_DIR
--migrations-table "schema_migrations"- 用于記錄遷移的數(shù)據(jù)庫表。 （環(huán)境：）$DBMATE_MIGRATIONS_TABLE
--schema-file, -s "./db/schema.sql"- 保存 schema.sql 文件的路徑姆另。（環(huán)境：）$DBMATE_SCHEMA_FILE
--no-dump-schema- 不要在 migrate/rollback (env: $DBMATE_NO_DUMP_SCHEMA)時自動更新 schema.sql 文件
--wait- 在執(zhí)行后續(xù)命令(env: )之前等待 db 變?yōu)榭捎?DBMATE_WAIT
--wait-timeout 60s- --wait 標(biāo)志超時（環(huán)境$DBMATE_WAIT_TIMEOUT：）

具體使用方式可以參見該文檔

本文聲明：

88x31.png