Skip to content

Commit

Permalink
5u25(5-LATEST), 6u2(LATEST) ブランクプロジェクトの記述を修正
Browse files Browse the repository at this point in the history
  • Loading branch information
tisuchida committed Oct 3, 2024
1 parent ce2a9ab commit 497eef0
Show file tree
Hide file tree
Showing 62 changed files with 320 additions and 124 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ nablarch-web-archetypeとnablarch-batch-archetypeのアーキタイプを使用

.. tip::

自動生成エンティティは `gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin>`_ を使用した場合に生成される。
自動生成エンティティは `gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_ を使用した場合に生成される。
使用する場合は、:doc:`../addin_gsp` に記載されている設定を行う必要がある。


Expand Down Expand Up @@ -569,7 +569,7 @@ DBに接続しないNablarchバッチアプリケーションがデプロイさ
* JDBCドライバ
* :ref:`firstStepBuiltInTools` に記載されているツールの設定。以下のような設定が存在する。

* `gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin>`_ で使用するデータベース接続設定(JDBC接続URLやデータベーススキーマなど)
* `gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_ で使用するデータベース接続設定(JDBC接続URLやデータベーススキーマなど)
* カバレッジ設定


Expand Down Expand Up @@ -747,7 +747,7 @@ Nablarchのライブラリの場合、pom.xmlにバージョン番号は通常

プロジェクトを分割する際には、リソースの重複が無い様に注意すること。

例えば、`gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin>`_ で使用するedmファイルを複数のMavenプロジェクトに混在させると、重複したEntityクラスが複数のMavenプロジェクトに存在することになる。
例えば、`gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_ で使用するedmファイルを複数のMavenプロジェクトに混在させると、重複したEntityクラスが複数のMavenプロジェクトに存在することになる。


.. _mavenModuleStructuresProblemsOfExcessivelyDivided:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ gsp-dba-maven-plugin(DBA作業支援ツール)の初期設定方法
概要
====================================================

`gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin>`_ は、Apache License Version 2.0 ライセンスで提供されるオープンソースのツールである。
`gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_ は、Apache License Version 2.0 ライセンスで提供されるオープンソースのツールである。

gsp-dba-maven-pluginは、使用開始前にRDBMSにあわせて設定する必要がある。

本手順では、アーキタイプから生成したプロジェクトで、gsp-dba-maven-pluginを使用するための設定方法を示す。

.. important::

`ツールのREADME(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin>`_ にもある通り、gsp-dba-maven-pluginは開発フェーズで用いることを想定している。
`ツールのREADME(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_ にもある通り、gsp-dba-maven-pluginは開発フェーズで用いることを想定している。
開発者のローカルDBを主ターゲットとしたツールであり、本番環境での使用は推奨しない。

ER図からツールによって生成されたDDLをそのまま本番環境に配置して実行するというような使い方も想定していない。
Expand Down Expand Up @@ -204,7 +204,7 @@ src/main/resources/entity以下にRDBMS毎にedmファイルが存在するの

実行に失敗する場合は、RDBMS固有の制限事項に抵触していないか確認する。

RDBMS固有の制限事項については、https://github.com/coastland/gsp-dba-maven-plugin (外部サイト)の「ゴール共通のパラメータ」を参照。
RDBMS固有の制限事項については、`gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_ の「ゴール共通のパラメータ」を参照。


**2.以下のコマンドを実行して、ダンプファイルをローカルリポジトリへインストールする。**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Password ``SAMPLE``
- test
- jacoco.execが生成されるところまで設定済み。|br|
jacoco.execは、SonarQube及びJenkinsのプラグインで使用出来る。
* - `gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin>`_
* - `gsp-dba-maven-plugin(外部サイト) <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main>`_
- -
- 起動は、「mvn -P gsp gsp-dba:<ゴール名>」で行う。|br|
例えば、「mvn -P gsp gsp-dba:generate-ddl」でgenerate-ddlを実行できる。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ gsp-dba-maven-pluginが使用する依存モジュールの追加

以下を参照して設定する。

`Java 11 での設定 <https://github.com/coastland/gsp-dba-maven-plugin#java11%E3%81%A7%E3%81%AE%E8%A8%AD%E5%AE%9A>`_ (外部サイト)
`Java 11 での設定 <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main?tab=readme-ov-file#java11%E3%81%A7%E3%81%AE%E8%A8%AD%E5%AE%9A>`_ (外部サイト)

.. _setup_java11_jetty9:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ gsp-dba-maven-pluginがJava17で動くように設定する

以下を参照して設定する。

`Java 17 での設定 <https://github.com/coastland/gsp-dba-maven-plugin#java17%E3%81%A7%E3%81%AE%E8%A8%AD%E5%AE%9A>`_ (外部サイト)
`Java 17 での設定 <https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main?tab=readme-ov-file#java17%E3%81%A7%E3%81%AE%E8%A8%AD%E5%AE%9A>`_ (外部サイト)

.. _setup_java17_jetty9:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ <h2><a class="toc-backref" href="#id33">全体構成の概要</a><a class="heade
</table>
<div class="admonition tip">
<p class="first admonition-title">補足</p>
<p class="last">自動生成エンティティは <a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">gsp-dba-maven-plugin(外部サイト)</a> を使用した場合に生成される。
<p class="last">自動生成エンティティは <a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">gsp-dba-maven-plugin(外部サイト)</a> を使用した場合に生成される。
使用する場合は、<a class="reference internal" href="../addin_gsp.html"><em>gsp-dba-maven-plugin(DBA作業支援ツール)の初期設定方法</em></a> に記載されている設定を行う必要がある。</p>
</div>
</div>
Expand Down Expand Up @@ -931,7 +931,7 @@ <h4>プロジェクトの構成<a class="headerlink" href="#id19" title="この
</ul>
</li>
<li><a class="reference internal" href="../firstStep_appendix/firststep_complement.html#firststepbuiltintools"><span>アーキタイプから生成したプロジェクトに組み込まれているツール</span></a> に記載されているツールの設定。以下のような設定が存在する。<ul>
<li><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">gsp-dba-maven-plugin(外部サイト)</a> で使用するデータベース接続設定(JDBC接続URLやデータベーススキーマなど)</li>
<li><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">gsp-dba-maven-plugin(外部サイト)</a> で使用するデータベース接続設定(JDBC接続URLやデータベーススキーマなど)</li>
<li>カバレッジ設定</li>
</ul>
</li>
Expand Down Expand Up @@ -1091,7 +1091,7 @@ <h3><a class="toc-backref" href="#id48">推奨するプロジェクト構成の
<div class="admonition tip">
<p class="first admonition-title">補足</p>
<p>プロジェクトを分割する際には、リソースの重複が無い様に注意すること。</p>
<p class="last">例えば、<a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">gsp-dba-maven-plugin(外部サイト)</a> で使用するedmファイルを複数のMavenプロジェクトに混在させると、重複したEntityクラスが複数のMavenプロジェクトに存在することになる。</p>
<p class="last">例えば、<a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">gsp-dba-maven-plugin(外部サイト)</a> で使用するedmファイルを複数のMavenプロジェクトに混在させると、重複したEntityクラスが複数のMavenプロジェクトに存在することになる。</p>
</div>
</div>
<div class="section" id="mavenmodulestructuresproblemsofexcessivelydivided">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -371,32 +371,32 @@
<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="id8">概要</a></li>
<li><a class="reference internal" href="#id3" id="id9">前提</a></li>
<li><a class="reference internal" href="#id4" id="id10">ファイル修正</a><ul>
<li><a class="reference internal" href="#pom-xml" id="id11">pom.xmlファイルの修正</a></li>
<li><a class="reference internal" href="#data-model-edm-src-main-resources-entity" id="id12">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="id13">動作確認</a></li>
<li><a class="reference internal" href="#id7" id="id14">データモデリングツールについての補足</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>
<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>
<h2><a class="toc-backref" href="#id8">概要</a><a class="headerlink" href="#id2" title="このヘッドラインへのパーマリンク"></a></h2>
<p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">gsp-dba-maven-plugin(外部サイト)</a> は、Apache License Version 2.0 ライセンスで提供されるオープンソースのツールである。</p>
<p>gsp-dba-maven-pluginは、使用開始前にRDBMSにあわせて設定する必要がある。</p>
<p>本手順では、アーキタイプから生成したプロジェクトで、gsp-dba-maven-pluginを使用するための設定方法を示す。</p>
<div class="admonition important">
<p class="first admonition-title">重要</p>
<p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">ツールのREADME(外部サイト)</a> にもある通り、gsp-dba-maven-pluginは開発フェーズで用いることを想定している。
<p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">ツールのREADME(外部サイト)</a> にもある通り、gsp-dba-maven-pluginは開発フェーズで用いることを想定している。
開発者のローカルDBを主ターゲットとしたツールであり、本番環境での使用は推奨しない。</p>
<p class="last">ER図からツールによって生成されたDDLをそのまま本番環境に配置して実行するというような使い方も想定していない。
ツールによって生成されたDDLを流用して本番環境向けのDDLを作成する場合はDBAの責任でDDLに問題ないかを確認すること。</p>
</div>
</div>
<div class="section" id="id3">
<h2><a class="toc-backref" href="#id8">前提</a><a class="headerlink" href="#id3" title="このヘッドラインへのパーマリンク"></a></h2>
<h2><a class="toc-backref" href="#id9">前提</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>
Expand All @@ -408,9 +408,9 @@ <h2><a class="toc-backref" href="#id8">前提</a><a class="headerlink" href="#id
</div>
</div>
<div class="section" id="id4">
<h2><a class="toc-backref" href="#id9">ファイル修正</a><a class="headerlink" href="#id4" title="このヘッドラインへのパーマリンク"></a></h2>
<h2><a class="toc-backref" href="#id10">ファイル修正</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="#id11">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>
Expand Down Expand Up @@ -520,12 +520,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="#id12">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="id5"></span><h2><a class="toc-backref" href="#id13">動作確認</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>
Expand Down Expand Up @@ -563,7 +563,7 @@ <h3><a class="toc-backref" href="#id11">data-model.edm (src/main/resources/enti
<div class="admonition tip">
<p class="first admonition-title">補足</p>
<p>実行に失敗する場合は、RDBMS固有の制限事項に抵触していないか確認する。</p>
<p class="last">RDBMS固有の制限事項については、<a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">https://github.com/coastland/gsp-dba-maven-plugin</a> (外部サイト)の「ゴール共通のパラメータ」を参照。</p>
<p class="last">RDBMS固有の制限事項については、<a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">gsp-dba-maven-plugin(外部サイト)</a> の「ゴール共通のパラメータ」を参照。</p>
</div>
<p><strong>2.以下のコマンドを実行して、ダンプファイルをローカルリポジトリへインストールする。</strong></p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>mvn -P gsp install:install-file
Expand Down Expand Up @@ -602,8 +602,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="id7">
<h2><a class="toc-backref" href="#id14">データモデリングツールについての補足</a><a class="headerlink" href="#id7" 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を生成・実行しデータベースを構築すれば、
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ <h2>H2のデータの確認方法<a class="headerlink" href="#h2" title="この
<td>jacoco.execが生成されるところまで設定済み。<br />
jacoco.execは、SonarQube及びJenkinsのプラグインで使用出来る。</td>
</tr>
<tr class="row-even"><td><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin">gsp-dba-maven-plugin(外部サイト)</a></td>
<tr class="row-even"><td><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main">gsp-dba-maven-plugin(外部サイト)</a></td>
<td></td>
<td><p class="first">起動は、「mvn -P gsp gsp-dba:&lt;ゴール名&gt;」で行う。<br />
例えば、「mvn -P gsp gsp-dba:generate-ddl」でgenerate-ddlを実行できる。</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@
<div class="section" id="gsp-dba-maven-plugin">
<h2>gsp-dba-maven-pluginが使用する依存モジュールの追加<a class="headerlink" href="#gsp-dba-maven-plugin" title="このヘッドラインへのパーマリンク"></a></h2>
<p>以下を参照して設定する。</p>
<p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin#java11%E3%81%A7%E3%81%AE%E8%A8%AD%E5%AE%9A">Java 11 での設定</a> (外部サイト)</p>
<p><a class="reference external" href="https://github.com/coastland/gsp-dba-maven-plugin/tree/4.x.x-main?tab=readme-ov-file#java11%E3%81%A7%E3%81%AE%E8%A8%AD%E5%AE%9A">Java 11 での設定</a> (外部サイト)</p>
</div>
<div class="section" id="jetty-restful">
<span id="setup-java11-jetty9"></span><h2>自動テストで使用するJettyのモジュール変更(ウェブプロジェクト または RESTfulウェブサービスプロジェクトの場合のみ)<a class="headerlink" href="#jetty-restful" title="このヘッドラインへのパーマリンク"></a></h2>
Expand Down
Loading

0 comments on commit 497eef0

Please sign in to comment.