Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SOLR-17066: Replace 'data store' term in code and docs #2201

Merged

Conversation

gerlowskija
Copy link
Contributor

@gerlowskija gerlowskija commented Jan 16, 2024

https://issues.apache.org/jira/browse/SOLR-17066

Description

"Data store" as a term, was introduced a few weeks back as a way to refer generically to something that could be either a collection or a core. As its use expanded though, it turned out to not be very well liked in practice. @dsmiley and @epugh in particular suggested we start using "collection" in a more generic sense to refer to any sort of "logical index" (regardless of whether it's a single core or a distributed collection in actuality).

Solution

This PR replaces "data store" and the related term "store type", with "collection" and "index type" respectively.

The "Glossary" in our ref-guide has been updated to clarify that "collection" can be used to refer to both cores and collections.

Tests

N/A - existing tests continue to pass, but otherwise this is an IDE refactor/rename that doesn't add or remove any functionality.

Checklist

Please review the following and check all that apply:

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added documentation for the Reference Guide

"Data store" as a term, was introduced a few weeks back as a way to
refer generically to something that could be either a collection or a
core.  As its use expanded though, it turned out to not be very well
liked in practice.

This commit replaces all usage of the term with either "collection" or
"index type", depending on the specific usage.

(Or, to mangle a Chaucer quote:

  "Now 'data store' was liked at first /
  But felt stainèd on the morrow. /
  And thus does Fortune's wheel so turn, /
  Switching happiness for sorrow."

    - Geoffrey Chaucer, Canterbury Tales)
@github-actions github-actions bot added documentation Improvements or additions to documentation test-framework client:solrj api labels Jan 16, 2024
@gerlowskija
Copy link
Contributor Author

FYI @dsmiley and @epugh

Copy link
Contributor

@dsmiley dsmiley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making these changes!

Copy link
Contributor

@epugh epugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

couple of suggestions.. I lvoe how this reads much better!

@gerlowskija gerlowskija merged commit 9246075 into apache:main Jan 19, 2024
3 of 4 checks passed
@gerlowskija gerlowskija deleted the SOLR-17066-remove-datastore-naming branch January 19, 2024 16:01
gerlowskija added a commit that referenced this pull request Jan 19, 2024
"Data store" as a term, was introduced a few weeks back as a way to
refer generically to something that could be either a collection or a
core.  As its use expanded though, it turned out to not be very well
liked in practice.

This commit replaces all usage of the term with either "collection" or
"index type", depending on the specific usage.
freedev added a commit to freedev/solr that referenced this pull request Jan 26, 2024
* main: (27 commits)
  Update protected-branches to include branch_9_5 (apache#2211)
  SOLR-16397: Tweak v2 'REQUESTSTATUS' API to be more REST-ful  (apache#2144)
  SOLR-17120: handle null value when merging partials (apache#2214)
  SOLR-17119: Fix exception swallowing in /cluster/plugins (apache#2202)
  SOLR-15960 Cut over System.getProperty() to EnvUtils for modules (apache#2193)
  Final fix for node problems (apache#2208)
  SOLR-16397: Fix warning in merge-indices docs
  Fix nodeSetup, use node distBaseUrl instead of registry (apache#2208)
  Add next minor version 9.6.0
  SOLR-17089: Upgrade Jersey to 3.1.5 (apache#2178)
  solr-ref-guide: fix typo in result-clustering.adoc (apache#2210)
  SOLR-17074: Fixed not correctly escaped quote in bin/solr script (apache#2200)
  SOLR-15960: Rename getProp as getProperty (apache#2194)
  Add npmRegistry for nodeSetup as well (apache#2208)
  Give NPM registry option for downloading node tools (apache#2208)
  SOLR-17116: Fix INSTALLSHARDDATA async reporting (apache#2188)
  SOLR-17066: Replace 'data store' term in code and docs (apache#2201)
  SOLR-17121: Fix SchemaCodecFactory to get PostingsFormat and DocValues from field. (apache#2206)
  Sync CHANGES for 9.4.1
  Add bugfix version 9.4.1
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api client:solrj documentation Improvements or additions to documentation test-framework
Projects
None yet
3 participants