DB接続チェックを実行する - OpenStandia Wiki - OpenStandia

DB接続チェックを実行する

データベース接続チェックには、各DBにあったJDBCドライバが別途必要となります。

1. スタックファイルを定義する
   

   <?xml version="1.0" encoding="Shift_JIS"?>
   <!DOCTYPE stack PUBLIC
       "-//OpenStandia/Installer//DTD Stack Configuration 1.0//EN"
       "http://openstandia.sourceforge.jp/dtd/stack_1_0.dtd">
   
   <stack>
     <application>
       <name>サンプルスタック</name>
       <ver>1.0.0.0</ver>
       <description>スタックのサンプルです。</description>
       <properties>
         <products-dir>products/samples</products-dir>
       </properties>
     </application>
     <install-befores/>
     <products>
       <product no="19" name="DB接続チェックを実行する" def="${stack.application.properties.products-dir}/check-connected-db-1.0.0/win.xml"/>
       <product no="20" name="DB接続チェックを実行する" def="${stack.application.properties.products-dir}/check-connected-db-1.0.0/linux.xml"/>
     </products>
     <install-afters/>
   </stack>
   

   これは、｢DB接続チェックを実行する｣というプロダクトが、
   ｢products/samples/check-connected-db-1.0.0/win.xml｣ もしくは、 ｢products/samples/check-connected-db-1.0.0/linux.xml｣
   に定義されているという意味です。
   
2. プロダクトファイル(Windows/Linux)を定義する
   
   1. Windowsの場合
      

      <?xml version="1.0" encoding="Shift_JIS"?>
      <!DOCTYPE product PUBLIC
          "-//OpenStandia/Installer//DTD Product Configuration 1.0//EN"
          "http://openstandia.sourceforge.jp/dtd/product_1_0.dtd">
      
      <product os="windows">
        <name>Check Conntected DB</name>
        <ver>1.0.0</ver>
        <required>false</required>
        <localDir>products\samples\check-connected-db-${product.ver}</localDir>
        <description>DB接続チェックをします。</description>
        <properties>
          <property name="log">${define.windows.openStandia.tmp}/log.txt</property>
          <property name="jdbcLib">C:/mysql-connector-java.jar</property>
          <property name="driver">com.mysql.jdbc.Driver</property>
          <property name="url">jdbc:mysql://localhost/petStore?useUnicode=true^&amp;characterEncoding=WINDOWS-31J</property>
          <property name="user">root</property>
          <property name="password">root</property>
          <property name="sql">select sysdate();</property>
        </properties>
        <files/>
        <execs>
          <install>
            <check cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>CheckConnectedDB.bat</arg>
                <arg>"${product.properties.log}"</arg>
                <arg>"${product.properties.jdbcLib}"</arg>
                <arg>${product.properties.driver}</arg>
                <arg>${product.properties.url}</arg>
                <arg>${product.properties.user}</arg>
                <arg>${product.properties.password}</arg>
                <arg>"${product.properties.sql}"</arg>
              </args>
            </check>
            <exec cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>echo</arg>
                <arg>データベース接続に成功しました。</arg>
              </args>
            </exec>
          </install>
          <uninstall>
            <check cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>CheckConnectedDB.bat</arg>
                <arg>"${product.properties.log}"</arg>
                <arg>"${product.properties.jdbcLib}"</arg>
                <arg>${product.properties.driver}</arg>
                <arg>${product.properties.url}</arg>
                <arg>${product.properties.user}</arg>
                <arg>${product.properties.password}</arg>
                <arg>"${product.properties.sql}"</arg>
              </args>
            </check>
            <exec cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>echo</arg>
                <arg>データベース接続に成功しました。</arg>
              </args>
            </exec>
          </uninstall>
          <update>
            <check cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>CheckConnectedDB.bat</arg>
                <arg>"${product.properties.log}"</arg>
                <arg>"${product.properties.jdbcLib}"</arg>
                <arg>${product.properties.driver}</arg>
                <arg>${product.properties.url}</arg>
                <arg>${product.properties.user}</arg>
                <arg>${product.properties.password}</arg>
                <arg>"${product.properties.sql}"</arg>
              </args>
            </check>
            <exec cmd="cmd.exe">
              <args>
                <arg>/c</arg>
                <arg>echo</arg>
                <arg>データベース接続に成功しました。</arg>
              </args>
            </exec>
          </update>
        </execs>
      </product>
      

   2. Linuxの場合
      

      <?xml version="1.0" encoding="Shift_JIS"?>
      <!DOCTYPE product PUBLIC
        "-//OpenStandia/Installer//DTD Product Configuration 1.0//EN"
        "http://openstandia.sourceforge.jp/dtd/product_1_0.dtd">
      
      <product os="linux">
        <name>Check Conntected DB</name>
        <ver>1.0.0</ver>
        <required>false</required>
        <localDir>products/samples/check-connected-db-${product.ver}</localDir>
        <description>DB接続チェックをします。</description>
        <properties>
          <property name="log">${define.linux.openStandia.tmp}/log.txt</property>
          <property name="jdbcLib">/tmp/mysql-connector-java.jar</property>
          <property name="driver">com.mysql.jdbc.Driver</property>
          <property name="url">jdbc:mysql://localhost/petStore?useUnicode=true&amp;characterEncoding=WINDOWS-31J</property>
          <property name="user">root</property>
          <property name="password">root</property>
          <property name="sql">select\sysdate();</property>
        </properties>
        <files/>
        <execs>
          <install>
            <check cmd="sh">
              <args>
                <arg>CheckConnectedDB.sh</arg>
                <arg>"${product.properties.log}"</arg>
                <arg>"${product.properties.jdbcLib}"</arg>
                <arg>${product.properties.driver}</arg>
                <arg>${product.properties.url}</arg>
                <arg>${product.properties.user}</arg>
                <arg>${product.properties.password}</arg>
                <arg>"${product.properties.sql}"</arg>
              </args>
            </check>
            <exec cmd="echo">
              <args>
                <arg>データベース接続に成功しました。</arg>
              </args>
            </exec>
          </install>
          <uninstall>
            <check cmd="sh">
              <args>
                <arg>CheckConnectedDB.sh</arg>
                <arg>"${product.properties.log}"</arg>
                <arg>"${product.properties.jdbcLib}"</arg>
                <arg>${product.properties.driver}</arg>
                <arg>${product.properties.url}</arg>
                <arg>${product.properties.user}</arg>
                <arg>${product.properties.password}</arg>
                <arg>"${product.properties.sql}"</arg>
              </args>
            </check>
            <exec cmd="echo">
              <args>
                <arg>データベース接続に成功しました。</arg>
              </args>
            </exec>
          </uninstall>
          <update>
            <check cmd="sh">
              <args>
                <arg>CheckConnectedDB.sh</arg>
                <arg>"${product.properties.log}"</arg>
                <arg>"${product.properties.jdbcLib}"</arg>
                <arg>${product.properties.driver}</arg>
                <arg>${product.properties.url}</arg>
                <arg>${product.properties.user}</arg>
                <arg>${product.properties.password}</arg>
                <arg>"${product.properties.sql}"</arg>
              </args>
            </check>
            <exec cmd="echo">
              <args>
                <arg>データベース接続に成功しました。</arg>
              </args>
            </exec>
          </update>
        </execs>
      </product>
      

      これは、｢DB接続チェックを実行する｣というプロダクトが、
      各設定情報をもとに生存チェック用のSQLを実行しDB接続チェックをするという意味です。
      
   • インストール、アンインストール、アップデート総てにおいて同処理としてます。
     
   • DB接続チェックに必要な項目(引数)は、以下の通りです。
     (引数1) ログを出力するパス及びそのファイル名
     ※ javaによりスタックトレースが出力されます。
     (引数2) JDBCドライバへのパス及びそのファイル名
     ※ ここでは、MySQL用のドライバが、
     Windowsでは｢C:/mysql-connector-java.jar｣、Linuxでは｢/tmp/mysql-connector-java.jar｣に
     存在するものとしています。
     (引数3) JDBCドライバ名
     (引数4) データベース接続URL
     (引数5) データベース接続ユーザー
     (引数6) データベース接続ユーザーのパスワード
     (引数7) データベースの生存チェックを行うSQL
     ※ Linuxにおいて、SQLにスペースを含めたい場合は、スペースの代わりに｢\｣を記述してください。
     
     
3. 各ディレクトリ、各ファイルを以下のように配置する
   OpenStandiaIntaller
   　|--bin
   　|--create
   　|--lib
   　|--products
   　|　　|--samples
   　|　　 　　|--check-connected-db-1.0.0
   　|　　 　　 　　|--linux.xml
   　|　　 　　 　　|--win.xml
   　|--scripts
   　|--stack-sample.xml
   GUIの場合は、以上で終了です。
   OpenStandia/GUI Installerより上記で作成したスタックファイルを読み込ませることで実行できるはずです。
   CUIの場合は、引き続き以下を行ってください。
   
   
4. 起動バッチ(setup.bat)、起動シェル(setup.sh)の作成(編集)
   
   1. Windowsの場合
      
      1. OpenStandia/Installerに付属の起動バッチ(setup.bat)をメモ帳等で開いてください。
         
      2. 【初期設定】項目に使用するスタックファイルを定義する(l.4付近)
         
         REM ##### 初期設定 #####
         set OPENSTANDIA_INSTALLER_VER=sample
         set STACK_XML=stack-%OPENSTANDIA_INSTALLER_VER%.xml
         
         
         • ここでは、｢stack-sample.xml｣となるように定義しています。
           
      3. 【初期設定】項目にプロダクトの番号を定義する(l.4付近)
         
         REM ##### 初期設定 #####
         set OPENSTANDIA_INSTALLER_VER=sample
         set STACK_XML=stack-%OPENSTANDIA_INSTALLER_VER%.xml
         set ANT_DIR=apache-ant-1.7.0
         set SCRIPTS_DIR=scripts
         set CHECK_CONNECTED_DB_NO=19
         
         
         • スタックファイルに記述した該当プロダクトの番号(stack.products.product.no)の値である必要があります。
           
      4. 【問い合わせ】項目を記述する(l.79付近)
         
         REM ##### 問い合わせ #####
         cls
         REM check-connected-db
         set CHECK_CONNECTED_DB=y
         set /p CHECK_CONNECTED_DB=DB接続チェックを実行しますか？(y/n) [y]
         
         
      5. 【ダウンロード実行】項目を記述する(l.124付近)
         
         REM ##### ダウンロード実行 #####
         echo.
         echo ダウンロード処理を開始します...
         if "%CHECK_CONNECTED_DB%" == "y" (
         　　call ant -Dno=%CHECK_CONNECTED_DB_NO% -DstackXml=%STACK_XML% -f "%SCRIPTS_DIR%download.xml"
         　　if errorlevel 1 goto error
         )
         
         
         • ｢"%CHECK_CONNECTED_DB%" == "y"｣の部分の｢%CHECK_CONNECTED_DB%｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢-Dno=%CHECK_CONNECTED_DB_NO%｣の部分の｢%CHECK_CONNECTED_DB_NO%｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           
      6. 【インストール実行】項目を記述する(l.124付近)
         
         REM ##### インストール実行 #####
         set INSTALLED_NO=
         echo.
         echo %MODE_STR%処理を開始します...
         if "%CHECK_CONNECTED_DB%" == "y" (
         　　set INSTALLED_NO=%INSTALLED_NO%,%CHECK_CONNECTED_DB_NO%
         　　call ant -Dno=%CHECK_CONNECTED_DB_NO% -Dmode=%MODE% -DinstalledNo="%INSTALLED_NO%" -DstackXml=%STACK_XML% -f "%SCRIPTS_DIR%install.xml"
         　　if errorlevel 1 goto error
         )
         
         
         • ｢"%CHECK_CONNECTED_DB%" == "y"｣の部分の｢%CHECK_CONNECTED_DB%｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢set INSTALLED_NO=%INSTALLED_NO%,%CHECK_CONNECTED_DB_NO%｣及び｢-Dno=%CHECK_CONNECTED_DB_NO%｣の部分の｢%CHECK_CONNECTED_DB_NO%｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           
   2. Linuxの場合
      
      1. OpenStandia/Installerに付属の起動シェル(setup.sh)をUTF-8で編集できるエディター等で開いてください。
         
      2. 【初期設定】項目に使用するスタックファイルを定義する(l.5付近)
         
         ##### 初期設定 #####
         OS_LANG=UTF-8
         OPENSTANDIA_INSTALLER_VER=sample
         STACK_XML=stack-${OPENSTANDIA_INSTALLER_VER}.xml
         
         
         • ここでは、｢stack-sample.xml｣となるように定義しています。
           
      3. 【初期設定】項目にプロダクトの番号を定義する(l.5付近)
         
         ##### 初期設定 #####
         OS_LANG=UTF-8
         OPENSTANDIA_INSTALLER_VER=sample
         STACK_XML=stack-${OPENSTANDIA_INSTALLER_VER}.xml
         ANT_DIR=apache-ant-1.7.0
         SCRIPTS_DIR=scripts
         CHECK_CONNECTED_DB_NO=20
         
         
         • スタックファイルに記述した該当プロダクトの番号(stack.products.product.no)の値である必要があります。
           
      4. 【問い合わせ】項目を記述する(l.85付近)
         
         ##### 問い合わせ #####
         clear
         # check-connected-db
         read -p "DB接続チェックを実行しますか？(y/n) [y]" CHECK_CONNECTED_DB
         if [ "${KICK_EXE}" = "" ]; then
         　　CHECK_CONNECTED_DB=y
         fi
         
         
      5. 【ダウンロード実行】項目を記述する(l.146付近)
         
         ##### ダウンロード実行 #####
         echo
         echo ダウンロード処理を開始します...
         if [ "${CHECK_CONNECTED_DB}" = "y" ]; then
         　　ant -Dno=${CHECK_CONNECTED_DB_NO} -DstackXml=${STACK_XML} -f "${SCRIPTS_DIR}download.xml"
         　　if [ $? -ne 0 ]; then error_func; fi
         fi
         
         
         • ｢"${CHECK_CONNECTED_DB}" = "y"｣の部分の｢${CHECK_CONNECTED_DB}｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢-Dno=${CHECK_CONNECTED_DB_NO}｣の部分の｢${CHECK_CONNECTED_DB_NO}｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           
      6. 【インストール実行】項目を記述する(l.183付近)
         
         ##### インストール実行 #####
         INSTALLED_NO=
         echo
         echo ${MODE_STR}処理を開始します...
         if [ "${CHECK_CONNECTED_DB}" = "y" ]; then
         　　INSTALLED_NO=${INSTALLED_NO},${CHECK_CONNECTED_DB_NO}
         　　ant -Dno=${CHECK_CONNECTED_DB_NO} -Dmode=${MODE} -DinstalledNo="${INSTALLED_NO}" -DstackXml=${STACK_XML} -f "${SCRIPTS_DIR}install.xml"
         　　if [ $? -ne 0 ]; then error_func; fi
         fi
         
         
         • ｢"${CHECK_CONNECTED_DB}" = "y"｣の部分の｢${CHECK_CONNECTED_DB}｣は、
           【問い合わせ】項目で記述した変数名と合わせてください。
           
         • ｢INSTALLED_NO=${INSTALLED_NO},${CHECK_CONNECTED_DB_NO}｣及び｢-Dno=${CHECK_CONNECTED_DB_NO}｣の部分の｢${CHECK_CONNECTED_DB_NO}｣は、
           【初期設定】項目で記述した変数名と合わせてください。
           

以上でCUIの場合も終了です。
各起動バッチ、シェルを実行することで実行できるはずです。