Skip to content

DOCSP-35933: Upgrade version guide #2755

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

Merged
merged 9 commits into from
Mar 13, 2024
Merged

DOCSP-35933: Upgrade version guide #2755

merged 9 commits into from
Mar 13, 2024

Conversation

norareidy
Copy link
Contributor

@norareidy norareidy commented Mar 7, 2024

JIRA - https://jira.mongodb.org/browse/DOCSP-35933
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/laravel/DOCSP-35933-staging/upgrade/

Checklist

  • Add tests and ensure they pass
  • Add an entry to the CHANGELOG.md file
  • Update documentation for new features

jordan-smith721
jordan-smith721 previously approved these changes Mar 8, 2024
Copy link
Contributor

@jordan-smith721 jordan-smith721 left a comment

Choose a reason for hiding this comment

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

LGTM with a few suggestions

docs/upgrade.txt Outdated
- ``whereDate``, ``whereDay``, ``whereMonth``, ``whereYear``, ``whereTime``
now use MongoDB operators on date fields
A breaking change is a modification in a convention or behavior in
a specific version of {+odm-short+} that may prevent your application from
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
a specific version of {+odm-short+} that may prevent your application from
a specific version of {+odm-short+} that might prevent your application from

docs/upgrade.txt Outdated
Comment on lines 5 to 7
===================

.. facet::
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add the "on this page" directive for the right nav? I think that would be helpful if someone's looking for a certain version

docs/upgrade.txt Outdated
Comment on lines 87 to 88
- ``Query\Builder::delete()`` can only delete one or all documents. Ensure that you only pass a value
of ``1`` or ``null`` to ``limit()``.
Copy link
Contributor

Choose a reason for hiding this comment

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

The use of "only" is a bit tricky here. I think this gets the point across and removes some of the "only" ambiguity.

Suggested change
- ``Query\Builder::delete()`` can only delete one or all documents. Ensure that you only pass a value
of ``1`` or ``null`` to ``limit()``.
- ``Query\Builder::delete()`` can delete one or all documents. Ensure that you pass only the values
``1`` or ``null`` to ``limit()``.

docs/upgrade.txt Outdated
Comment on lines 97 to 100
- Removes support for the ``Query\Builder``: ``toSql``,
``toRawSql``, ``whereColumn``, ``whereFullText``, ``groupByRaw``,
``orderByRaw``, ``unionAll``, ``union``, ``having``, ``havingRaw``,
``havingBetween``, ``whereIntegerInRaw``, ``orWhereIntegerInRaw``,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this might work better as a list so it's not such a big block of methods:

Suggested change
- Removes support for the ``Query\Builder``: ``toSql``,
``toRawSql``, ``whereColumn``, ``whereFullText``, ``groupByRaw``,
``orderByRaw``, ``unionAll``, ``union``, ``having``, ``havingRaw``,
``havingBetween``, ``whereIntegerInRaw``, ``orWhereIntegerInRaw``,
Removes support for the following ``Query\Builder`` methods:
- ``toSql``
...
...

@norareidy norareidy marked this pull request as ready for review March 11, 2024 20:36
@norareidy norareidy requested a review from a team as a code owner March 11, 2024 20:36
@norareidy norareidy requested a review from GromNaN March 11, 2024 20:36
@norareidy norareidy merged commit 09580b3 into mongodb:4.1 Mar 13, 2024
@norareidy norareidy deleted the DOCSP-35933-upgrade-version branch March 13, 2024 20:21
@GromNaN GromNaN added the docs label May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants