NavigationForWeb

目次

• how to use
• 各種説明
  • DBへの接続
  • マイグレーション関係のコマンド
    • マイグレーション情報の確認
    • マイグレーションの実行
    • テーブルの削除
  • 環境別のフォルダ構成について
    • migration関連

how to use

local環境で動かす場合

sh ./serve.sh -e local

prod環境で動かす場合

sh ./serve.sh -e prod

それぞれ中ではdocker-compose upをしている．コマンド実行時には自動的にマイグレーションが実行されている．

実行後， http://127.0.0.1 or http://localhost にアクセスすることでブラウザで確認できる．

各種説明

DBへの接続

mysqlには mysql -h127.0.0.1 -u docker -p でパスワードが passwordで接続できる．ユーザ名とパスワードとDB名は，docker-compose.ymlを参考にしていただきたい．

マイグレーション関係のコマンド

docker execコマンドでコンテナに対してコマンドを実行する． docker execの次のspringdocker_app_1は，docker psで表示されるWebアプリケーションを動かしているコンテナのNAMESの部分である． コマンドラインからflywayを実行するには，各環境のapplication.propetiesを読み込む必要があるため，-Dflyway.configFile=で指定する必要がある．

マイグレーション情報の確認

./mvnw flyway:infoでマイグレーション情報の確認をすることが出来る．

localのapplication.propertiesで実行したい場合

docker exec springdocker_app_1 ./mvnw flyway:info -Dflyway.configFile=./src/main/resources/local/application.properties

prodのapplication.propertiesで実行したい場合

docker exec springdocker_app_1 ./mvnw flyway:info -Dflyway.configFile=./src/main/resources/prod/application.properties

マイグレーションの実行

マイグレーション自体は起動時に自動的に行ってくれるので，このコマンドを利用することは無い

./mvnw flyway:migrate でマイグレーションの実行をすることが出来る．

localのapplication.propertiesで実行したい場合

docker exec springdocker_app_1 ./mvnw flyway:migrate -Dflyway.configFile=./src/main/resources/local/application.properties -Dflyway.locations=filesystem:./src/main/resources/common/db/migration,filesystem:./src/main/resources/local/db/migration

prodのapplication.propertiesで実行したい場合

docker exec springdocker_app_1 ./mvnw flyway:migrate -Dflyway.configFile=./src/main/resources/prod/application.properties -Dflyway.locations=filesystem:./src/main/resources/common/db/migration,filesystem:./src/main/resources/prod/db/migration

テーブルの削除

./mvnw flyway:cleanでテーブルを削除出来る．本番環境では絶対してはいけない．

localのapplication.propertiesで実行したい場合

docker exec springdocker_app_1 ./mvnw flyway:clean -Dflyway.configFile=./src/main/resources/local/application.properties

環境別のフォルダ構成について

以下のmigrationやapplication.propertiesの各環境ごとに分けているのは，pom.xml の <profiles></profiles> に記述されている．

migration関連

各環境ごとにマイグレーションファイルを用意することが出来る．

• 共通の環境

  /src/main/resources/common/db/migration にテストデータを挿入するマイグレーションファイルを入れることでマイグレーション時に実行してくれる．

• local環境

  /src/main/resources/local/db/migration にテストデータを挿入するマイグレーションファイルを入れることでマイグレーション時に実行してくれる．

• prod環境

  /src/main/resources/prod/db/migration にテストデータを挿入するマイグレーションファイルを入れることでマイグレーション時に実行してくれる．

application.properties(環境変数のファイル)

/src/main/resources/以下に各環境ごとにフォルダ分けされている．

• local環境

  /src/main/resources/localのapplication.propertiesを参照する．

• prod環境

  /src/main/resources/localのapplication.propertiesを参照する．