You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by is...@apache.org on 2020/07/01 23:55:35 UTC

[lucene-solr] 01/01: SOLR-14066: Deprecate DIH

This is an automated email from the ASF dual-hosted git repository.

ishan pushed a commit to branch jira/solr-14066-master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git

commit 1add050fb96edb5952f58ecbadb2dd8af7345075
Author: Ishan Chattopadhyaya <is...@apache.org>
AuthorDate: Thu Jul 2 05:24:07 2020 +0530

    SOLR-14066: Deprecate DIH
---
 solr/CHANGES.txt                                                 | 3 +++
 solr/contrib/dataimporthandler-extras/src/java/overview.html     | 2 +-
 solr/contrib/dataimporthandler/README.md                         | 9 +++++++++
 .../org/apache/solr/handler/dataimport/DataImportHandler.java    | 3 +++
 solr/contrib/dataimporthandler/src/java/overview.html            | 2 +-
 solr/example/example-DIH/README.md                               | 2 ++
 solr/solr-ref-guide/src/dataimport-screen.adoc                   | 2 ++
 solr/solr-ref-guide/src/solr-upgrade-notes.adoc                  | 4 ++++
 ...-structured-data-store-data-with-the-data-import-handler.adoc | 2 ++
 solr/webapp/web/css/angular/dataimport.css                       | 3 ++-
 solr/webapp/web/partials/dataimport.html                         | 1 +
 11 files changed, 30 insertions(+), 3 deletions(-)

diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index ec67ed9..7282e2f 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -406,6 +406,9 @@ Other Changes
 * SOLR-14541: Ensure classes that implement equals implement hashCode or suppress warnings
   (gezapeti, Ilan Ginsburg, Erick Erickson)
 
+* SOLR-14066: Data Import Handler is deprecated. It is scheduled to be removed as of 9.0 and a community supported
+  package for the same may now be used instead. (Ishan Chattopadhyaya, janhoy)
+
 ==================  8.5.2 ==================
 
 Consult the LUCENE_CHANGES.txt file for additional, low level, changes in this release.
diff --git a/solr/contrib/dataimporthandler-extras/src/java/overview.html b/solr/contrib/dataimporthandler-extras/src/java/overview.html
index a60a25e..5a55432 100644
--- a/solr/contrib/dataimporthandler-extras/src/java/overview.html
+++ b/solr/contrib/dataimporthandler-extras/src/java/overview.html
@@ -16,6 +16,6 @@
 -->
 <html>
 <body>
-Apache Solr Search Server: DataImportHandler Extras contrib
+Apache Solr Search Server: DataImportHandler Extras contrib. <b>This contrib module is deprecated as of 8.6</b>
 </body>
 </html>
diff --git a/solr/contrib/dataimporthandler/README.md b/solr/contrib/dataimporthandler/README.md
index fa2cab1..8dc9391 100644
--- a/solr/contrib/dataimporthandler/README.md
+++ b/solr/contrib/dataimporthandler/README.md
@@ -15,3 +15,12 @@ running Solr you set the following system properties:
   -Duser.language=xx -Duser.country=YY -Duser.timezone=ZZZ
 
 where xx, YY, and ZZZ are consistent with any database server's configuration.
+
+Deprecation notice
+------------------
+This contrib module is deprecated as of v8.6, scheduled for removal in Solr 9.0.
+The reason is that DIH is no longer being maintained in a manner we feel is necessary in order to keep it
+healthy and secure. Also it was not designed to work with SolrCloud and does not meet current performance requirements.
+
+The project hopes that the community will take over maintenance of DIH as a 3rd party package (See SOLR-14066 for more details). Please reach out to us at the dev@ mailing list if you want to help.
+
diff --git a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataImportHandler.java b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataImportHandler.java
index 296fabe..a388a83 100644
--- a/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataImportHandler.java
+++ b/solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/DataImportHandler.java
@@ -63,8 +63,10 @@ import static org.apache.solr.handler.dataimport.DataImporter.IMPORT_CMD;
  * <p>
  * <b>This API is experimental and subject to change</b>
  *
+ * @deprecated since 8.6
  * @since solr 1.3
  */
+@Deprecated(since = "8.6", forRemoval = true)
 public class DataImportHandler extends RequestHandlerBase implements
         SolrCoreAware {
 
@@ -95,6 +97,7 @@ public class DataImportHandler extends RequestHandlerBase implements
     Map<String,String> macro = new HashMap<>();
     macro.put("expandMacros", "false");
     defaults = SolrParams.wrapDefaults(defaults, new MapSolrParams(macro));
+    log.warn("Data Import Handler is deprecated as of Solr 8.6. See SOLR-14066 for more details.");
   }
 
   @Override
diff --git a/solr/contrib/dataimporthandler/src/java/overview.html b/solr/contrib/dataimporthandler/src/java/overview.html
index 4bb2c8b..4c2d595 100644
--- a/solr/contrib/dataimporthandler/src/java/overview.html
+++ b/solr/contrib/dataimporthandler/src/java/overview.html
@@ -16,6 +16,6 @@
 -->
 <html>
 <body>
-Apache Solr Search Server: DataImportHandler contrib
+Apache Solr Search Server: DataImportHandler contrib. <b>This contrib module is deprecated as of 8.6.</b>
 </body>
 </html>
diff --git a/solr/example/example-DIH/README.md b/solr/example/example-DIH/README.md
index 8aa01f3..ab98905 100644
--- a/solr/example/example-DIH/README.md
+++ b/solr/example/example-DIH/README.md
@@ -18,6 +18,8 @@
 Solr DataImportHandler example configuration
 --------------------------------------------
 
+NOTE: The DataImportHandler is deprecated as of v8.6. See SOLR-14066 for more details.
+
 To run this multi-core example, use the "-e" option of the bin/solr script:
 
 ```
diff --git a/solr/solr-ref-guide/src/dataimport-screen.adoc b/solr/solr-ref-guide/src/dataimport-screen.adoc
index 647814c..1f28cd5 100644
--- a/solr/solr-ref-guide/src/dataimport-screen.adoc
+++ b/solr/solr-ref-guide/src/dataimport-screen.adoc
@@ -16,6 +16,8 @@
 // specific language governing permissions and limitations
 // under the License.
 
+WARNING: The Data Import Handler is deprecated as of v8.6 and is scheduled to be removed in 9.0.
+
 The Dataimport screen shows the configuration of the DataImportHandler (DIH) and allows you start, and monitor the status of, import commands as defined by the options selected on the screen and defined in the configuration file.
 
 .The Dataimport Screen
diff --git a/solr/solr-ref-guide/src/solr-upgrade-notes.adoc b/solr/solr-ref-guide/src/solr-upgrade-notes.adoc
index 1fbe747..02ec4bd 100644
--- a/solr/solr-ref-guide/src/solr-upgrade-notes.adoc
+++ b/solr/solr-ref-guide/src/solr-upgrade-notes.adoc
@@ -85,6 +85,10 @@ For more information about how to use this, see the section <<exporting-result-s
 
 * The `stats`, `facet`, and `timeseries` expressions now support percentiles and standard deviation aggregations.
 
+*Deprecations*
+
+* Data Import Handler is deprecated and is scheduled to be removed in 9.0. A community supported version of this may be available as an external package to be used with the package management system. For more details, please refer to SOLR-14066.
+
 === Solr 8.5
 
 See the https://cwiki.apache.org/confluence/display/SOLR/ReleaseNote85[8.5 Release Notes]
diff --git a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
index d9f6cf8..5d925ff 100644
--- a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
+++ b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
@@ -17,6 +17,8 @@
 // specific language governing permissions and limitations
 // under the License.
 
+WARNING: The Data Import Handler is deprecated as of v8.6 and is scheduled to be removed in 9.0.
+
 Many search applications store the content to be indexed in a structured data store, such as a relational database. The Data Import Handler (DIH) provides a mechanism for importing content from a data store and indexing it.
 
 In addition to relational databases, DIH can index content from HTTP based data sources such as RSS and ATOM feeds, e-mail repositories, and structured XML where an XPath processor is used to generate fields.
diff --git a/solr/webapp/web/css/angular/dataimport.css b/solr/webapp/web/css/angular/dataimport.css
index 6afb096..ad37896 100644
--- a/solr/webapp/web/css/angular/dataimport.css
+++ b/solr/webapp/web/css/angular/dataimport.css
@@ -258,7 +258,8 @@ limitations under the License.
   background-image: url( ../../img/ico/information.png );
 }
 
-#content #dataimport #error
+#content #dataimport #error,
+#content #dataimport #deprecation_message
 {
   background-color: #f00;
   background-image: url( ../../img/ico/construction.png );
diff --git a/solr/webapp/web/partials/dataimport.html b/solr/webapp/web/partials/dataimport.html
index dd11f54..a27be07 100644
--- a/solr/webapp/web/partials/dataimport.html
+++ b/solr/webapp/web/partials/dataimport.html
@@ -18,6 +18,7 @@ limitations under the License.
 
   <div ng-show="!hasHandlers">The solrconfig.xml file for this index does not have an operational DataImportHandler defined!</div>
   <div id="frame" ng-show="hasHandlers">
+    <div id="deprecation_message">The Data Import Handler is deprecated as of Solr 8.6 and may be removed in a future release. A community supported package for may be used instead (See SOLR-14066 for details).</div>
 
     <div id="error" ng-show="error"></div>