環境

Go 1.16~
sqlboiler v.4.4.0

1. sqlboilerのインストール

古いバージョンをインストールして期待通りの動作にならないことを防ぐため、/vサフィックス(/v4の部分)を忘れないようにしましょう！

2. 構成ファイル(sqlboiler.toml)の作成

データベースドライバーや構成オプションを設定するために、slqboiler.tomlファイルを作成します。

MySQLを利用する場合下記のような構成になります。

tips 【オプションの追加】

オプションとしてwhitelist、blacklistが存在します。
whitelist→追加したテーブルのsqlboiler modelが作成されます
blacklist→追加したテーブルのsqlboiler modelは作成されなくなります

whitelist

blacklist

すでにデータベースには存在しているが、sqlboiler modelとして生成したくない場合はテーブル名を指定します。

3. sqlboilerモデル群の作成

sqlboiler ドライバー名でsqlboiler modelの生成を行います。

コマンド実行後、実行フォルダ配下にsqlboiler model群が作成されます。

advanced!　 【オプションをつけてmodel生成をカスタマイズ】

model生成コマンドにもオプションをつけることができます。

Name	役割	Defaults
pkgname	作成ファイル名の指定	"models"
output	出力フォルダ名	"models"
tag	Struct tag出力オプション	[]
debug	デバッグモードの出力制限	false
add-global-variants	グローバル変数の出力制限	false
add-panic-variants	panic　変数の出力制限	false
no-context	context.Context利用無効	false
no-hooks	hooks機能の無効	false
no-tests	テストファイル無効	false
no-auto-timestamps	タイムスタンプ無効	false
no-rows-affected	APIで影響を受ける行の無効	false
no-driver-templates	DBドライバーのテンプレート解析無効	false
tag-ignore	タグの無視カラムリスト	[]

下記のような実行もできます。

・pkgname 出力ファイル名の指定
・output 出力フォルダの指定
・wipe 健全性確保のため、出力modelファイルを先に削除→出力する
・config sqlboiler.tomlで構成した内容で設定を上書き

出力結果