SOLR-17066: Deprecate SolrJ "core URLs" in ref-guide (9x) #2409
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit is for branch_9x only.
epugh
requested changes
Apr 18, 2024
| "Admin" (i.e. non-core) requests, or requests made to other indices using the client will fail. | ||
| Because of these limitations, usage of this type of path is deprecated and will be removed in Solr 10. | ||
| Users are encouraged to instead provide a "root" base URL when creating their client (see below), and specify the core using the `withDefaultCollection(String)` method available on the relevant `SolrClient` Builder object. | ||
| . A URL pointing to the root Solr path (e.g. `http://hostname:8983/solr`). |
There was a problem hiding this comment.
Yep, the leading '.' on L127 is used to identify the start of a new item in the list. See L121 above for another example.
I've intentionally omitted the '.' on lines 124-126 because I want each of those sentences to be included in the preceding list item.
| @@ -136,7 +136,7 @@ If not an `IllegalArgumentException` will be thrown. | |||
|
|
|||
| ==== Base URLs of CloudSolrClient | |||
|
|
|||
| It is also possible to specify base URLs for `CloudSolrClient`, but URLs are expected to point to the root Solr path (e.g., `\http://hostname:8983/solr`). | |||
| It is also possible to specify base URLs for `CloudSolrClient`, but URLs must point to the root Solr path (e.g., `\http://hostname:8983/solr`). | |||
There was a problem hiding this comment.
Yes we do, the leading slash ensures that asciidoc renders the URL as unclick-able. (i.e. we want the URL to be formatted as code, not an actual link that a user would get value in clicking). See some of the other URLs in this page as examples...
gerlowskija
added a commit
that referenced
this pull request
Apr 22, 2024
This commit is for branch_9x only.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://issues.apache.org/jira/browse/SOLR-17066
Description
SOLR-17066 has replaced all usage of SolrJ "core URLs" in Solr, and the "Configuration" section of the SolrJ ref-guide page was overhauled for 10.0 to accommodate this change. But no changes have yet been made to the 9.x ref-guide to signal that the "core URL" capability is deprecated and will be going away.
Solution
This PR makes some ref-guide changes to branch_9x, to signal this deprecation to users. It also steers users towards the more helpful
withDefaultCollection(String)builder method.Tests
N/A - doc change only.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.