->6u2(nablarch-document PR#655)

nablarch · Oct 3, 2024 · ce2a9ab · ce2a9ab
1 parent 992e6ee
commit ce2a9ab
Show file tree

Hide file tree

Showing 40 changed files with 253 additions and 57 deletions.
diff --git a/...u2/doc/_sources/application_framework/application_framework/blank_project/CustomizeDB.txt b/...u2/doc/_sources/application_framework/application_framework/blank_project/CustomizeDB.txt
@@ -1,3 +1,4 @@
+.. _customize-db:
 
 ======================================
 使用するRDBMSの変更手順

diff --git a/.../6u2/doc/_sources/application_framework/application_framework/blank_project/addin_gsp.txt b/.../6u2/doc/_sources/application_framework/application_framework/blank_project/addin_gsp.txt
@@ -25,22 +25,27 @@ gsp-dba-maven-pluginは、使用開始前にRDBMSにあわせて設定する必
   ER図からツールによって生成されたDDLをそのまま本番環境に配置して実行するというような使い方も想定していない。
   ツールによって生成されたDDLを流用して本番環境向けのDDLを作成する場合はDBAの責任でDDLに問題ないかを確認すること。
 
-前提
-====================================================
+generate-entityゴールがJava17以降で動くように設定する
+======================================================
+
+generate-entityゴールを実行することによりEntityクラスを自動生成できるが、Java 17以降で利用するにはJVMオプションを設定する必要がある。
+
+以下を参照して設定する。
 
-以下のプロジェクトを対象とする。
+`generate-entity(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/blob/main/README.md#generate-entity>`_
+
+ファイル修正
+===========================
+
+この手順は、以下のプロジェクトを対象とする。
 
 * アーキタイプから生成後、:doc:`CustomizeDB` の手順を実施した各種プロジェクト。
 
 .. tip::
 
   gsp-dba-maven-pluginはデフォルトでH2 Database Engine(以下H2)を使うように設定されている。
 
-  H2を使用する場合は、以降の手順は不要である。 :ref:`confirm_gsp` だけ行うこと。
-
-
-ファイル修正
-===========================
+  H2を使用する場合は、ここで記載しているファイル修正の手順は不要である。
 
 
 pom.xmlファイルの修正
@@ -176,6 +181,7 @@ src/main/resources/entity以下にRDBMS毎にedmファイルが存在するの
 
   * generate-ddl
   * execute-ddl
+  * generate-entity
   * load-data
   * export-schema
 
@@ -289,7 +295,7 @@ SI Object Browser ER 以外のモデリングツールを使用する場合は
     </plugins>
   </build>
 
-修正後に以下のコマンドを実行することでEntity クラスの生成、テストデータの登録、ダンプファイルの作成が行われる。
+修正後に以下のコマンドを実行することでEntityクラスの生成、テストデータの登録、ダンプファイルの作成が行われる。
 なお、コマンド実行前に任意の方法でデータベースを構築する必要がある。
 
 .. code-block:: bash

diff --git a/...ication_framework/application_framework/blank_project/setup_blankProject/setup_Jbatch.txt b/...ication_framework/application_framework/blank_project/setup_blankProject/setup_Jbatch.txt
@@ -263,6 +263,13 @@ batchlet方式のバッチアプリケーションでは、SAMPLE_USERテーブ
 原因が分からない場合は、:ref:`firstStepGenerateBatchEEBlankProject` からやり直してみること。
 
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
+
 
 補足
 --------------------

diff --git a/..._framework/application_framework/blank_project/setup_blankProject/setup_NablarchBatch.txt b/..._framework/application_framework/blank_project/setup_blankProject/setup_NablarchBatch.txt
@@ -291,6 +291,13 @@ SampleAction             バッチアプリケーション実装する際に一
 原因が分からない場合は、:ref:`firstStepGenerateBatchBlankProject` からやり直してみること。
 
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
+
 
 補足
 --------------------

diff --git a/...pplication_framework/application_framework/blank_project/setup_blankProject/setup_Web.txt b/...pplication_framework/application_framework/blank_project/setup_blankProject/setup_Web.txt
@@ -212,6 +212,12 @@ package      パッケージ(通常はグループIDと同じ)       ``com.examp
 
 原因が分からない場合は、:ref:`firstStepGenerateWebBlankProject` からやり直してみること。
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
 
 補足（web.xml）
 --------------------

diff --git a/...ion_framework/application_framework/blank_project/setup_blankProject/setup_WebService.txt b/...ion_framework/application_framework/blank_project/setup_blankProject/setup_WebService.txt
@@ -283,6 +283,13 @@ FireFoxまたはChromeを起動し、以下のURLをアドレスバーに入力
 原因が分からない場合は、:ref:`firstStepGenerateJaxrsBlankProject` からやり直してみること。
 
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
+
 
 補足
 --------------------

diff --git a/.../application_framework/blank_project/setup_containerBlankProject/setup_ContainerBatch.txt b/.../application_framework/blank_project/setup_containerBlankProject/setup_ContainerBatch.txt
@@ -225,6 +225,14 @@ package      パッケージ(通常はグループIDと同じ)       ``com.examp
 待機状態となるので、確認後はctrl+c等で強制終了させる。
 
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
+
+
 補足
 --------------------
 

diff --git a/...rk/application_framework/blank_project/setup_containerBlankProject/setup_ContainerWeb.txt b/...rk/application_framework/blank_project/setup_containerBlankProject/setup_ContainerWeb.txt
@@ -231,6 +231,14 @@ package      パッケージ(通常はグループIDと同じ)       ``com.examp
   docker rm myapp-container-web
 
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
+
+
 補足
 --------------------
 

diff --git a/...ication_framework/blank_project/setup_containerBlankProject/setup_ContainerWebService.txt b/...ication_framework/blank_project/setup_containerBlankProject/setup_ContainerWebService.txt
@@ -155,6 +155,13 @@ package      パッケージ(通常はグループIDと同じ)       ``com.examp
   * ``http://localhost:8080/find/xml``
 
 
+データベースに関する設定を行う
+------------------------------------
+
+ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、:ref:`customize-db` を参照して設定すること。
+
+またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は :ref:`gsp-maven-plugin` を参照。
+
 
 補足
 --------------------

diff --git a/docs/6u2/doc/application_framework/application_framework/blank_project/CustomizeDB.html b/docs/6u2/doc/application_framework/application_framework/blank_project/CustomizeDB.html
@@ -350,7 +350,7 @@
            <div itemprop="articleBody">
 
   <div class="section" id="rdbms">
-<h1>使用するRDBMSの変更手順<a class="headerlink" href="#rdbms" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<span id="customize-db"></span><h1>使用するRDBMSの変更手順<a class="headerlink" href="#rdbms" title="このヘッドラインへのパーマリンク">¶</a></h1>
 <div class="contents local topic" id="id1">
 <p class="topic-title first">目次</p>
 <ul class="simple">

diff --git a/docs/6u2/doc/application_framework/application_framework/blank_project/addin_gsp.html b/docs/6u2/doc/application_framework/application_framework/blank_project/addin_gsp.html
@@ -354,19 +354,19 @@
 <div class="contents local topic" id="id1">
 <p class="topic-title first">目次</p>
 <ul class="simple">
-<li><a class="reference internal" href="#id2" id="id7">概要</a></li>
-<li><a class="reference internal" href="#id3" id="id8">前提</a></li>
-<li><a class="reference internal" href="#id4" id="id9">ファイル修正</a><ul>
-<li><a class="reference internal" href="#pom-xml" id="id10">pom.xmlファイルの修正</a></li>
-<li><a class="reference internal" href="#data-model-edm-src-main-resources-entity" id="id11">data-model.edm  (src/main/resources/entity)の準備</a></li>
+<li><a class="reference internal" href="#id2" id="id6">概要</a></li>
+<li><a class="reference internal" href="#generate-entityjava17" id="id7">generate-entityゴールがJava17以降で動くように設定する</a></li>
+<li><a class="reference internal" href="#id3" id="id8">ファイル修正</a><ul>
+<li><a class="reference internal" href="#pom-xml" id="id9">pom.xmlファイルの修正</a></li>
+<li><a class="reference internal" href="#data-model-edm-src-main-resources-entity" id="id10">data-model.edm  (src/main/resources/entity)の準備</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#confirm-gsp" id="id12">動作確認</a></li>
-<li><a class="reference internal" href="#id6" id="id13">データモデリングツールについての補足</a></li>
+<li><a class="reference internal" href="#confirm-gsp" id="id11">動作確認</a></li>
+<li><a class="reference internal" href="#id5" id="id12">データモデリングツールについての補足</a></li>
 </ul>
 </div>
 <div class="section" id="id2">
-<h2><a class="toc-backref" href="#id7">概要</a><a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<h2><a class="toc-backref" href="#id6">概要</a><a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク">¶</a></h2>
 <p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">gsp-dba-maven-plugin(外部サイト)</a> は、Apache License Version 2.0 ライセンスで提供されるオープンソースのツールである。</p>
 <p>gsp-dba-maven-pluginは、使用開始前にRDBMSにあわせて設定する必要がある。</p>
 <p>本手順では、アーキタイプから生成したプロジェクトで、gsp-dba-maven-pluginを使用するための設定方法を示す。</p>
@@ -378,22 +378,25 @@ <h2><a class="toc-backref" href="#id7">概要</a><a class="headerlink" href="#id
 ツールによって生成されたDDLを流用して本番環境向けのDDLを作成する場合はDBAの責任でDDLに問題ないかを確認すること。</p>
 </div>
 </div>
+<div class="section" id="generate-entityjava17">
+<h2><a class="toc-backref" href="#id7">generate-entityゴールがJava17以降で動くように設定する</a><a class="headerlink" href="#generate-entityjava17" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>generate-entityゴールを実行することによりEntityクラスを自動生成できるが、Java 17以降で利用するにはJVMオプションを設定する必要がある。</p>
+<p>以下を参照して設定する。</p>
+<p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/blob/main/README.md#generate-entity">generate-entity(外部サイト)</a></p>
+</div>
 <div class="section" id="id3">
-<h2><a class="toc-backref" href="#id8">前提</a><a class="headerlink" href="#id3" title="このヘッドラインへのパーマリンク">¶</a></h2>
-<p>以下のプロジェクトを対象とする。</p>
+<h2><a class="toc-backref" href="#id8">ファイル修正</a><a class="headerlink" href="#id3" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>この手順は、以下のプロジェクトを対象とする。</p>
 <ul class="simple">
 <li>アーキタイプから生成後、<a class="reference internal" href="CustomizeDB.html"><em>使用するRDBMSの変更手順</em></a> の手順を実施した各種プロジェクト。</li>
 </ul>
 <div class="admonition tip">
 <p class="first admonition-title">補足</p>
 <p>gsp-dba-maven-pluginはデフォルトでH2 Database Engine(以下H2)を使うように設定されている。</p>
-<p class="last">H2を使用する場合は、以降の手順は不要である。 <a class="reference internal" href="#confirm-gsp"><span>動作確認</span></a> だけ行うこと。</p>
-</div>
+<p class="last">H2を使用する場合は、ここで記載しているファイル修正の手順は不要である。</p>
 </div>
-<div class="section" id="id4">
-<h2><a class="toc-backref" href="#id9">ファイル修正</a><a class="headerlink" href="#id4" title="このヘッドラインへのパーマリンク">¶</a></h2>
 <div class="section" id="pom-xml">
-<h3><a class="toc-backref" href="#id10">pom.xmlファイルの修正</a><a class="headerlink" href="#pom-xml" title="このヘッドラインへのパーマリンク">¶</a></h3>
+<h3><a class="toc-backref" href="#id9">pom.xmlファイルの修正</a><a class="headerlink" href="#pom-xml" title="このヘッドラインへのパーマリンク">¶</a></h3>
 <div class="section" id="properties">
 <h4>properties要素内<a class="headerlink" href="#properties" title="このヘッドラインへのパーマリンク">¶</a></h4>
 <p>pom.xmlのpropertiesタグ内の以下の箇所を修正する。</p>
@@ -503,12 +506,12 @@ <h4>build要素内<a class="headerlink" href="#build" title="このヘッドラ
 </div>
 </div>
 <div class="section" id="data-model-edm-src-main-resources-entity">
-<h3><a class="toc-backref" href="#id11">data-model.edm  (src/main/resources/entity)の準備</a><a class="headerlink" href="#data-model-edm-src-main-resources-entity" title="このヘッドラインへのパーマリンク">¶</a></h3>
+<h3><a class="toc-backref" href="#id10">data-model.edm  (src/main/resources/entity)の準備</a><a class="headerlink" href="#data-model-edm-src-main-resources-entity" title="このヘッドラインへのパーマリンク">¶</a></h3>
 <p>src/main/resources/entity以下にRDBMS毎にedmファイルが存在するので、使用するRDBMSに対応するファイルを「data-model.edm」にリネームする。</p>
 </div>
 </div>
 <div class="section" id="confirm-gsp">
-<span id="id5"></span><h2><a class="toc-backref" href="#id12">動作確認</a><a class="headerlink" href="#confirm-gsp" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<span id="id4"></span><h2><a class="toc-backref" href="#id11">動作確認</a><a class="headerlink" href="#confirm-gsp" title="このヘッドラインへのパーマリンク">¶</a></h2>
 <div class="admonition important">
 <p class="first admonition-title">重要</p>
 <p class="last">DBのデータが削除されるため、必要であれば現在DBに格納されているデータを退避しておくこと。</p>
@@ -523,6 +526,7 @@ <h3><a class="toc-backref" href="#id11">data-model.edm  (src/main/resources/enti
 <ul class="last simple">
 <li>generate-ddl</li>
 <li>execute-ddl</li>
+<li>generate-entity</li>
 <li>load-data</li>
 <li>export-schema</li>
 </ul>
@@ -585,8 +589,8 @@ <h3><a class="toc-backref" href="#id11">data-model.edm  (src/main/resources/enti
 </pre></div>
 </div>
 </div>
-<div class="section" id="id6">
-<h2><a class="toc-backref" href="#id13">データモデリングツールについての補足</a><a class="headerlink" href="#id6" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<div class="section" id="id5">
+<h2><a class="toc-backref" href="#id12">データモデリングツールについての補足</a><a class="headerlink" href="#id5" title="このヘッドラインへのパーマリンク">¶</a></h2>
 <p>ブランクプロジェクトは <a class="reference external" href="https://products.sint.co.jp/ober">SI Object Browser ER(外部サイト)</a> というモデリングツールを使用してデータモデル(data-model.edm)を作成することを前提としている。
 しかし、data-model.edm が使われるのはDDLの生成時だけである。
 そのため、任意の方法でDDLを生成・実行しデータベースを構築すれば、
@@ -615,7 +619,7 @@ <h2><a class="toc-backref" href="#id13">データモデリングツールにつ
 <span class="nt">&lt;/build&gt;</span>
 </pre></div>
 </div>
-<p>修正後に以下のコマンドを実行することでEntity クラスの生成、テストデータの登録、ダンプファイルの作成が行われる。
+<p>修正後に以下のコマンドを実行することでEntityクラスの生成、テストデータの登録、ダンプファイルの作成が行われる。
 なお、コマンド実行前に任意の方法でデータベースを構築する必要がある。</p>
 <div class="highlight-bash"><div class="highlight"><pre><span></span>mvn -P gsp clean generate-resources
 </pre></div>

diff --git a/...cation_framework/application_framework/blank_project/setup_blankProject/setup_Jbatch.html b/...cation_framework/application_framework/blank_project/setup_blankProject/setup_Jbatch.html
@@ -612,7 +612,12 @@ <h4>疎通確認になぜか失敗する場合<a class="headerlink" href="#id8"
 </div>
 </div>
 <div class="section" id="id9">
-<h3>補足<a class="headerlink" href="#id9" title="このヘッドラインへのパーマリンク">¶</a></h3>
+<h3>データベースに関する設定を行う<a class="headerlink" href="#id9" title="このヘッドラインへのパーマリンク">¶</a></h3>
+<p>ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、<a class="reference internal" href="../CustomizeDB.html#customize-db"><span>使用するRDBMSの変更手順</span></a> を参照して設定すること。</p>
+<p>またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は <a class="reference internal" href="../addin_gsp.html#gsp-maven-plugin"><span>gsp-dba-maven-plugin(DBA作業支援ツール)の初期設定方法</span></a> を参照。</p>
+</div>
+<div class="section" id="id10">
+<h3>補足<a class="headerlink" href="#id10" title="このヘッドラインへのパーマリンク">¶</a></h3>
 <p>H2のデータの確認方法や、ブランクプロジェクトに組み込まれているツールに関しては、 <a class="reference internal" href="../firstStep_appendix/firststep_complement.html"><em>初期セットアップ手順　補足事項</em></a> を参照すること。</p>
 </div>
 </div>

diff --git a/...framework/application_framework/blank_project/setup_blankProject/setup_NablarchBatch.html b/...framework/application_framework/blank_project/setup_blankProject/setup_NablarchBatch.html
@@ -641,7 +641,12 @@ <h3>疎通確認になぜか失敗する場合<a class="headerlink" href="#id14"
 </div>
 </div>
 <div class="section" id="id15">
-<h2>補足<a class="headerlink" href="#id15" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<h2>データベースに関する設定を行う<a class="headerlink" href="#id15" title="このヘッドラインへのパーマリンク">¶</a></h2>
+<p>ブランクプロジェクトは、初期状態ではH2 Database Engineを使用するように設定されている。使用するRDBMSを変更する場合は、<a class="reference internal" href="../CustomizeDB.html#customize-db"><span>使用するRDBMSの変更手順</span></a> を参照して設定すること。</p>
+<p>またER図からのDDL生成や実行、Entityクラスの自動生成を行うにはgsp-dba-maven-pluginの初期設定および実行を行う。詳細は <a class="reference internal" href="../addin_gsp.html#gsp-maven-plugin"><span>gsp-dba-maven-plugin(DBA作業支援ツール)の初期設定方法</span></a> を参照。</p>
+</div>
+<div class="section" id="id16">
+<h2>補足<a class="headerlink" href="#id16" title="このヘッドラインへのパーマリンク">¶</a></h2>
 <p>H2のデータの確認方法や、ブランクプロジェクトに組み込まれているツールに関しては、 <a class="reference internal" href="../firstStep_appendix/firststep_complement.html"><em>初期セットアップ手順　補足事項</em></a> を参照すること。</p>
 </div>
 </div>