Skip to content

Commit 9a7aa08

Browse files
committed
add ext upgrade command
1 parent ce8408f commit 9a7aa08

File tree

1 file changed

+19
-45
lines changed

1 file changed

+19
-45
lines changed

source/upgrade.txt

Lines changed: 19 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,28 @@ Before you upgrade, perform the following actions:
4343
To ensure compatibility across {+mdb-server+} versions when
4444
upgrading driver versions, use the :ref:`{+stable-api+} <php-stable-api>`.
4545

46-
To upgrade your driver version, replace ``<version-number>`` with the version number
46+
Major and minor versions of the PHP extension and library are in sync. This
47+
means you can run an upgrade command for the extension to also upgrade the PHP
48+
library.
49+
50+
Patch versions (x.x.x) for the library and extension are not in sync. Run the
51+
respective commands to update to the patch versions for the library or extension.
52+
53+
To upgrade the PHP extension, replace ``<version-number>`` with the version number
4754
you want to upgrade to and run the following command in your application's
4855
directory:
4956

57+
.. code-block:: bash
58+
59+
pecl upgrade mongodb-<version-number>
60+
61+
To upgrade the PHP Library version, use the following command:
62+
5063
.. code-block:: bash
5164

5265
composer require mongodb/mongodb:<version-number>
5366

54-
Installation instructions for the ``mongodb`` extension may be found in the
67+
Detailed installation instructions may be found in the
5568
:php:`PHP.net documentation <manual/en/mongodb.installation.php>`.
5669

5770
.. _php-breaking-changes:
@@ -77,47 +90,8 @@ This driver version introduces the following breaking changes:
7790

7891
- Drops support for {+mdb-server+} 3.6.
7992

80-
- Deprecates iterators for database, collection, and index enumeration.
81-
82-
Version 1.18 Breaking Changes
83-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84-
85-
This driver version introduces the following breaking changes:
86-
87-
- Deprecates setting ``disableMD5`` to ``false`` when instantiating a Bucket due to
88-
deprecated MD5 encoding. The default value for the setting is now ``true``.
89-
90-
Version 1.17 Breaking Changes
91-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92-
93-
This driver version introduces the following breaking changes:
94-
95-
- Upgrades the ``mongodb`` extension requirement to 1.17.0.
96-
97-
- Requires PHP 7.4 or newer.
98-
99-
- Removes aggregate compatibility logic, like the ``useCursor`` option, for
100-
{+mdb-server+} versions less than 3.6.
101-
102-
Version 1.16 Breaking Changes
103-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104-
105-
This driver version introduces the following breaking changes:
106-
107-
- Upgrades the ``mongodb`` extension requirement to 1.16.0.
108-
109-
- Deprecates ``IndexInfo::isGeoHaystack()``. ``geoHaystack`` was removed in
110-
{+mdb-server+} 5.0 and later.
111-
112-
- Drops support for Composer 1.x.
113-
114-
- Removes ``$server`` argument in ``Explainable::getCommandDocument``.
115-
116-
- Removes ``getNonce`` command usage for {+mdb-server+} 6.2 and later.
117-
118-
Version 1.15 Breaking Changes
119-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120-
121-
This driver version introduces the following breaking changes:
93+
Version 1.19 and Earlier
94+
~~~~~~~~~~~~~~~~~~~~~~~~
12295

123-
- Upgrades the ``mongodb`` extension requirement to 1.15.0.
96+
For driver versions 1.19 and earlier, see the release notes and associated
97+
JIRA tickets for each release on `GitHub <https://github.com/mongodb/mongo-php-library/releases>`__.

0 commit comments

Comments
 (0)