@@ -20,7 +20,7 @@ iPLAssでは、Lucene、Elasticsearch(OpenSearch) という全文検索エンジ
2020|概要
2121|Javaベースのオープンソースの全文検索ライブラリ。 +
2222iPLAssが稼働するAPサーバ内の同一VM上に組み込まれ動作。
23- |Elasticsearch(OpenSearch)はLuceneをベースに開発されたオープンソースの全文検索エンジン。 +
23+ |Elasticsearch(OpenSearch)はLuceneをベースに開発されたオープンソースの全文検索エンジン。 +
2424Elasticsearch(OpenSearch)単体でサーバとして稼働する。
2525
2626|データ保存先
@@ -111,12 +111,12 @@ Indexファイルの保存場所、Analyzerなどに関する設定などを行
111111
112112 <property name="maxRows" value="1000" />
113113 <property name="throwExceptionWhenOverLimit" value="true"/>
114-
114+
115115 <property name="analyzerSetting" class="org.iplass.mtp.impl.fulltextsearch.lucene.JapaneseAnalyzerSetting">
116116 <property name="className" value="org.apache.lucene.analysis.ja.JapaneseAnalyzer" />
117117 <property name="mode" value="SEARCH" />
118- </property>
119-
118+ </property>
119+
120120</service>
121121----
122122
@@ -146,7 +146,7 @@ true:maxRowsの設定値以上に検索結果件数が取得できた場合、
146146
147147image::images/FulltextSearch_Lucene_SearchResult_True.png[]
148148
149- |binaryParser|
149+ |binaryParser|
150150BinaryReference解析用のParserを設定します。
151151Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
152152
@@ -229,7 +229,7 @@ Bi-gram分割(文章が分かち書きされない言語である中国語、
229229
230230 <property name="maxRows" value="1000" />
231231 <property name="throwExceptionWhenOverLimit" value="true"/>
232-
232+
233233 <property name="analysisFactory" class="org.iplass.mtp.impl.fulltextsearch.elasticsearch.analysis.DefaultAnalysisFactory">
234234 <property name="analyzer" >
235235 <property name="my_kuromoji" class="org.iplass.mtp.impl.fulltextsearch.elasticsearch.analysis.analyzer.KuromojiAnalyzerFactory">
@@ -246,7 +246,7 @@ Bi-gram分割(文章が分かち書きされない言語である中国語、
246246 <property name="analyzer" value="my_kuromoji"/>
247247 </property>
248248 </property>
249-
249+
250250</service>
251251----
252252
@@ -275,136 +275,21 @@ true:maxRowsの設定値以上に検索結果件数が取得できた場合、
275275
276276image::images/FulltextSearch_Lucene_SearchResult_True.png[]
277277
278- |binaryParser|
278+ |binaryParser|
279279BinaryReference解析用のParserを設定します。
280280Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
281281
282282|analysisFactory| カスタムでAnalyzer等を定義したい場合に利用します。
283283classには `org.iplass.mtp.impl.fulltextsearch.elasticsearch.analysis.DefaultAnalysisFactory` を指定します。
284284
285- |defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.elasticsearch.mapping.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
285+ |defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.elasticsearch.mapping.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
286286デフォルトで提供されているAnalyzerについては、Elasticsearchのドキュメントを参照してください。
287287
288288|analyzerPropertyPerEntity|
289289Entity定義単位でAnalyzerを切り替えたい場合、Entity名とAnalyzerPropertyをMap形式で指定します。
290290
291291|===
292292
293- ==== [.eeonly]#(非推奨)OpenSearch設定#
294-
295- 全文検索に関する設定をFulltextSearchServiceに設定します。
296- サーバURL、Analyzerなどに関する設定などを行います。
297- 詳細は <<../../serviceconfig/index.adoc#FulltextSearchService, FulltextSearchService>> を参照してください。
298-
299- [CAUTION]
300- ====
301- AWS SDK for Java 1.x はメンテナンスモードになっており、2025年12月 にサポートを終了する予定です。 +
302- iPLAss では AWS SDK for Java 1.x ベースのライブラリ iplass-ee-aws を非推奨とし、AWS SDK for Java 2.x ベースのライブラリ iplass-ee-aws2 への移行を推奨します。 +
303- iplass-ee-aws2 の対応に伴い、opensearch の機能は iplass-ee-opensearch へ移管しました。 +
304- 本機能を利用している場合は、ライブラリ iplass-ee-opensearch の <<datamanagement_fulltextsearch_opensearch_opensearch>> へ設定を移行してください。 +
305- ライブラリ iplass-ee-aws は将来削除される予定です。
306- ====
307-
308- 次に設定ファイルの設定例を示します。
309-
310- .mtp-service-config.xmlの設定例(必要最低限の設定)
311- デフォルト値を利用し、必要最低限の設定のみを行った設定例を以下に示します。
312-
313- [source,xml]
314- ----
315- <service>
316- <interface>org.iplass.mtp.impl.fulltextsearch.FulltextSearchService</interface>
317-
318- <class>org.iplass.mtp.impl.aws.fulltextsearch.opensearch.OpenSearchFulltextSearchService</class> <1>
319- <property name="useFulltextSearch" value="true" /> <2>
320- <property name="restClientFactory" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.DefaultRestClientFactory">
321- <property name="openSearchUrl" value="{SCHEME}://{ADDRESS}:{PORT}"/> <3>
322- </property>
323- </service>
324- ----
325- <1> 実装クラスとしてOpenSearchFulltextSearchServiceを指定します
326- <2> 全文検索機能を有効化する場合trueを指定します
327- <3> OpenSearchのサーバURLを指定します
328-
329- .mtp-service-config.xmlの設定例(主要な項目を設定)
330-
331- 主要な設定項目を設定した例を以下に示します。
332-
333- [source,xml]
334- ----
335- <service>
336- <interface>org.iplass.mtp.impl.fulltextsearch.FulltextSearchService</interface>
337- <class>org.iplass.mtp.impl.aws.fulltextsearch.opensearch.OpenSearchFulltextSearchService</class>
338- <property name="useFulltextSearch" value="true" />
339- <property name="restClientFactory" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.DefaultRestClientFactory" >
340- <property name="openSearchUrl" value="{SCHEME}://{ADDRESS}:{PORT}"/>
341- <property name="httpRequestInterceptorFactory" class="org.iplass.mtp.impl.aws.AWSRequestSigningApacheInterceptorFactory" >
342- <property name="serviceName" value="es"/>
343- <property name="region" value="ap-northeast-1"/>
344- </property>
345- </property>
346-
347- <property name="analysisFactory" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.analysis.DefaultAnalysisFactory">
348- <property name="analyzer" >
349- <property name="my_kuromoji" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.analysis.analyzer.KuromojiAnalyzerFactory">
350- <property name="mode" value="Search"/>
351- <property name="method" value="Nfc"/>
352- </property>
353- </property>
354- </property>
355- <property name="defaultAnalyzerProperty" >
356- <property name="analyzer" value="kuromoji"/>
357- </property>
358- <property name="analyzerPropertyPerEntity" >
359- <property name="testEntity" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.mappings.AnalyzerProperty">
360- <property name="analyzer" value="my_kuromoji"/>
361- </property>
362- </property>
363-
364- </service>
365- ----
366-
367- 各設定項目の概要を以下に説明します。
368-
369- [cols="1,3a",options="header"]
370- |===
371- |プロパティ名|内容説明
372- |useFulltextSearch|全文検索機能を有効にする場合は `true` にします。
373- |openSearchUrl|OpenSearchのサーバURLを指定します。
374- |httpRequestInterceptorFactory| httpRequestInterceptorを生成するFactoryクラスを設定します。
375- BASIC認証ではなく、IAM認証情報を使用してリクエストを署名したい場合、実装クラスである `org.iplass.mtp.impl.aws.AWSRequestSigningApacheInterceptorFactory` を指定します。
376- |maxRows|
377- 全文検索サーバから取得する検索結果の最大件数を設定します。 +
378-
379- NOTE: 件数が1000件以上で、かつ、Oracleを利用する場合は、
380- Oracle設定の `enableInPartitioning` プロパティ値を `true` へ変更してください。
381-
382- |throwExceptionWhenOverLimit|
383- false:maxRowsの設定値以上に検索結果件数が取得できた場合でも、maxRowsの設定値分の件数は結果を表示します。
384-
385- 下記の画面は設定値以上に取得出来た場合となります。設定値未満の場合、メッセージ表示はありません。
386-
387- image::images/FulltextSearch_Lucene_SearchResult_False.png[]
388-
389- true:maxRowsの設定値以上に検索結果件数が取得できた場合、結果を表示せずに条件を絞り込むようメッセージで催促されます。
390-
391- image::images/FulltextSearch_Lucene_SearchResult_True.png[]
392-
393- |binaryParser|
394- BinaryReference解析用のParserを設定します。
395- Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
396-
397- |analysisFactory| カスタムでAnalyzer等を定義したい場合に利用します。
398- classには `org.iplass.mtp.impl.aws.fulltextsearch.opensearch.analysis.DefaultAnalysisFactory` を指定します。
399-
400- |defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.aws.fulltextsearch.opensearch.mappings.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
401- デフォルトで提供されているAnalyzerについては、OpenSearchのドキュメントを参照してください。
402-
403- |analyzerPropertyPerEntity|
404- Entity定義単位でAnalyzerを切り替えたい場合、Entity名とAnalyzerPropertyをMap形式で指定します。
405-
406- |===
407-
408293[[datamanagement_fulltextsearch_opensearch_opensearch]]
409294==== [.eeonly]#OpenSearch設定#
410295
@@ -503,14 +388,14 @@ true:maxRowsの設定値以上に検索結果件数が取得できた場合、
503388
504389image::images/FulltextSearch_Lucene_SearchResult_True.png[]
505390
506- |binaryParser|
391+ |binaryParser|
507392BinaryReference解析用のParserを設定します。
508393Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
509394
510395|analysisFactory| カスタムでAnalyzer等を定義したい場合に利用します。
511396classには `org.iplass.mtp.impl.fulltextsearch.opensearch.analysis.DefaultAnalysisFactory` を指定します。
512397
513- |defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.opensearch.mappings.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
398+ |defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.opensearch.mappings.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
514399デフォルトで提供されているAnalyzerについては、OpenSearchのドキュメントを参照してください。
515400
516401|analyzerPropertyPerEntity|
@@ -641,7 +526,7 @@ TopViewの機能概要、作成方法については<<../genericentitymanager/to
641526
642527image::images/FulltextSearch_SetParts.png[]
643528
644- ドラッグ&ドロップして出てきたFulltext Searchの設定ボタンをクリックすると、 `crawl for full text search`
529+ ドラッグ&ドロップして出てきたFulltext Searchの設定ボタンをクリックすると、 `crawl for full text search`
645530にチェックをつけたEntityのみが表示されます。 +
646531Entity View列に設定したSearchViewを使用して、全文検索結果となったEntityの情報を表示します。 +
647532
0 commit comments