This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new 6f5e9d3f2be SOLR-17494: Document deprecation status of language
specific writer types (#2766)
6f5e9d3f2be is described below
commit 6f5e9d3f2be6a2c821a5ccc2c561105db67c5f0e
Author: Eric Pugh <[email protected]>
AuthorDate: Fri Oct 18 09:32:58 2024 -0400
SOLR-17494: Document deprecation status of language specific writer types
(#2766)
---
solr/CHANGES.txt | 2 ++
.../src/java/org/apache/solr/response/PHPResponseWriter.java | 1 +
.../apache/solr/response/PHPSerializedResponseWriter.java | 1 +
.../java/org/apache/solr/response/PythonResponseWriter.java | 1 +
.../java/org/apache/solr/response/RubyResponseWriter.java | 1 +
.../modules/query-guide/pages/response-writers.adoc | 12 ++++++++++++
.../modules/upgrade-notes/pages/major-changes-in-solr-9.adoc | 4 ++++
7 files changed, 22 insertions(+)
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 9d5dacef1ac..c01936493ec 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -99,6 +99,8 @@ led to the suppression of exceptions. (Andrey Bozhko)
* SOLR-17359: Move Zk Arg parsing into Java Code from bin/solr scripts.
(Eric Pugh, Rahul Goswami)
+* SOLR-17494: Document deprecation status of language specific writer types
(wt=python,ruby,php,phps). (Eric Pugh)
+
================== 9.7.0 ==================
New Features
---------------------
diff --git a/solr/core/src/java/org/apache/solr/response/PHPResponseWriter.java
b/solr/core/src/java/org/apache/solr/response/PHPResponseWriter.java
index b9f4c3417fd..c372fd87377 100644
--- a/solr/core/src/java/org/apache/solr/response/PHPResponseWriter.java
+++ b/solr/core/src/java/org/apache/solr/response/PHPResponseWriter.java
@@ -22,6 +22,7 @@ import java.util.List;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.request.SolrQueryRequest;
+@Deprecated(since = "9.8")
public class PHPResponseWriter implements QueryResponseWriter {
static String CONTENT_TYPE_PHP_UTF8 = "text/x-php;charset=UTF-8";
diff --git
a/solr/core/src/java/org/apache/solr/response/PHPSerializedResponseWriter.java
b/solr/core/src/java/org/apache/solr/response/PHPSerializedResponseWriter.java
index 0a6f828936f..1414145171d 100644
---
a/solr/core/src/java/org/apache/solr/response/PHPSerializedResponseWriter.java
+++
b/solr/core/src/java/org/apache/solr/response/PHPSerializedResponseWriter.java
@@ -36,6 +36,7 @@ import org.apache.solr.search.ReturnFields;
* A description of the PHP serialization format can be found here:
* http://www.hurring.com/scott/code/perl/serialize/
*/
+@Deprecated(since = "9.8")
public class PHPSerializedResponseWriter implements QueryResponseWriter {
static String CONTENT_TYPE_PHP_UTF8 = "text/x-php-serialized;charset=UTF-8";
diff --git
a/solr/core/src/java/org/apache/solr/response/PythonResponseWriter.java
b/solr/core/src/java/org/apache/solr/response/PythonResponseWriter.java
index d50fb95e287..ad25d0b99b1 100644
--- a/solr/core/src/java/org/apache/solr/response/PythonResponseWriter.java
+++ b/solr/core/src/java/org/apache/solr/response/PythonResponseWriter.java
@@ -20,6 +20,7 @@ import java.io.IOException;
import java.io.Writer;
import org.apache.solr.request.SolrQueryRequest;
+@Deprecated(since = "9.8")
public class PythonResponseWriter implements QueryResponseWriter {
static String CONTENT_TYPE_PYTHON_ASCII = "text/x-python;charset=US-ASCII";
diff --git
a/solr/core/src/java/org/apache/solr/response/RubyResponseWriter.java
b/solr/core/src/java/org/apache/solr/response/RubyResponseWriter.java
index bce2c2c9498..6d0bf913b03 100644
--- a/solr/core/src/java/org/apache/solr/response/RubyResponseWriter.java
+++ b/solr/core/src/java/org/apache/solr/response/RubyResponseWriter.java
@@ -20,6 +20,7 @@ import java.io.IOException;
import java.io.Writer;
import org.apache.solr.request.SolrQueryRequest;
+@Deprecated(since = "9.8")
public class RubyResponseWriter implements QueryResponseWriter {
static String CONTENT_TYPE_RUBY_UTF8 = "text/x-ruby;charset=UTF-8";
diff --git
a/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc
b/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc
index d4961312f34..5f97c3d236b 100644
--- a/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc
+++ b/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc
@@ -287,6 +287,10 @@ Not all spatial fields types are supported, and you'll get
an error if you use a
== Python Response Writer
+*Deprecation*
+
+The Python Response Writer is marked for deprecation and will be removed in
10.0.
+
Solr has an optional Python response format that extends its JSON output in
the following ways to allow the response to be safely evaluated by the python
interpreter:
* true and false changed to True and False
@@ -298,6 +302,10 @@ Solr has an optional Python response format that extends
its JSON output in the
[[php-writer]]
== PHP Response Writer and PHP Serialized Response Writer
+*Deprecation*
+
+The PHP Response Writer is marked for deprecation and will be removed in 10.0.
+
Solr has a PHP response format that outputs an array (as PHP code) which can
be evaluated.
Setting the `wt` parameter to `php` invokes the PHP Response Writer.
@@ -324,6 +332,10 @@ print_r($result);
== Ruby Response Writer
+*Deprecation*
+
+The Ruby Response Writer is marked for deprecation and will be removed in 10.0.
+
Solr has an optional Ruby response format that extends its JSON output in the
following ways to allow the response to be safely evaluated by Ruby's
interpreter:
* Ruby's single quoted strings are used to prevent possible string exploits.
diff --git
a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
index f448fa7bc0e..1c7bbb93c7e 100644
---
a/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
+++
b/solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc
@@ -77,6 +77,10 @@ users may pass `partialResults=false`.
This feature has been improved to eliminate some wasted processing.
In the presence of this parameter, queries encountering limits will return
zero results, and to make it clear when this has happened, the `partialResults`
response header will be set to `"omitted"`
+=== Deprecations
+* The language specific Response Writers have been deprecated in favour of
more widely used formats like JSON.
+The writer types invoked as part of the `wt` parameter that will be removed in
10 include `python`, `ruby`, `php`, and `phps`.
+
== Solr 9.7
=== SchemaVersion upgraded to 1.7
The default schemaVersion is now 1.7.
