Skip to content

DOCSP-41991 What's New #145

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.

Sign up for GitHub

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
Sep 24, 2024
Merged

DOCSP-41991 What's New #145

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
265476f
DOCSP-41991 What's New
lindseymoore Sep 19, 2024
13ff962
add rest of versions
lindseymoore Sep 20, 2024
99c571d
fix links
lindseymoore Sep 20, 2024
de61ae1
fix links
lindseymoore Sep 20, 2024
122f58f
review comments
lindseymoore Sep 23, 2024
c4b9611
typo
lindseymoore Sep 23, 2024
83aa662
review comments
lindseymoore Sep 23, 2024
f3de45a
vale errors
lindseymoore Sep 24, 2024
d6803c4
small thing
lindseymoore Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/reference/class/MongoDBCollection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-mongodb-collection-class:

=========================
MongoDB\\Collection Class
=========================
Expand Down
2 changes: 2 additions & 0 deletions source/reference/function/add_logger.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-add-logger:

=====================
MongoDB\\add_logger()
=====================
Expand Down
2 changes: 2 additions & 0 deletions source/reference/function/remove_logger.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-remove-logger:

========================
MongoDB\\remove_logger()
========================
Expand Down
2 changes: 2 additions & 0 deletions source/reference/method/MongoDBClient-addSubscriber.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-client-add-subscriber:

================================
MongoDB\\Client::addSubscriber()
================================
Expand Down
2 changes: 2 additions & 0 deletions source/reference/method/MongoDBClient-removeSubscriber.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-client-remove-subscriber:

===================================
MongoDB\\Client::removeSubscriber()
===================================
Expand Down
2 changes: 2 additions & 0 deletions source/reference/method/MongoDBDatabase-createEncryptedCollection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-database-create-encrypted:

==============================================
MongoDB\\Database::createEncryptedCollection()
==============================================
Expand Down
2 changes: 2 additions & 0 deletions source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-gridfs-bucket-register-global:

===========================================================
MongoDB\\GridFS\\Bucket::registerGlobalStreamWrapperAlias()
===========================================================
Expand Down
95 changes: 94 additions & 1 deletion source/whats-new.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@

* :ref:`Version 1.20 <php-lib-version-1.20>`

* :ref:`Version 1.18 <php-lib-version-1.18>`

* :ref:`Version 1.17 <php-lib-version-1.17>`

* :ref:`Version 1.16 <php-lib-version-1.16>`

* :ref:`Version 1.15 <php-lib-version-1.15>`

.. _php-lib-version-1.20:

What's New in 1.20
Expand All @@ -32,4 +40,89 @@
Support for MongoDB Server v3.6 is removed in this release of the
library.

- Adds support for MongoDB Server v8.0.
- Adds support for MongoDB Server v8.0.
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: you can use the mdb-server constant here (applies to all mentions of MongoDB Server):

Suggested change
- Adds support for MongoDB Server v8.0.
- Adds support for {+mdb-server+} v8.0.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Why are constants helpful? Does it help with load speeds? Thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sorry I missed this question, but I think it just helps with consistency (if a product name or syntax changes we wouldn't have to fix it multiple times, for example). Not sure about load speeds but that would make sense.


.. _php-lib-version-1.18:

What's New in 1.18
------------------

- Adds a new GridFS API to make it more convenient to work with files using PHP's
existing filesystem functions. The :ref:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias() <api-gridfs-bucket-register-global>`
method may be used to register a global alias for a GridFS bucket. After
doing so, files within that bucket can be accessed using only a file URI
(e.g. "gridfs://mybucket/hello.txt"). A demonstration of this API can be found
in the `gridfs_stream_wrapper.php <https://github.com/mongodb/mongo-php-library/blob/1.18.0/examples/gridfs_stream_wrapper.php>`__
example script.

- Adds :ref:`addSubscriber() <api-client-add-subscriber>` and
:ref:`removeSubscriber()<api-client-remove-subscriber>` methods to the
``MongoDB\Client`` class to make it easier to register monitoring classes
on the underlying ``MongoDB\Driver\Manager`` object.

To learn more about this release, see the `v1.18 Release Notes
<https://github.com/mongodb/mongo-php-library/releases/tag/1.18.0>`__ on GitHub.

.. _php-lib-version-1.17:

What's New in 1.17
------------------

- Introduces a new "codec" API for converting BSON to and from PHP objects.
More information on this feature may be found in the
:ref:`Codecs tutorial <php-codecs>`.

- Adds :ref:`MongoDB\add_logger() <api-add-logger>` and
:ref:`MongoDB\remove_logger() <api-remove-logger>` functions to the library.
These functions allow applications to register a `PSR-3 Logger <https://www.php-fig.org/psr/psr-3/>`__
to receive log messages emitted by the driver. Previously, logs were only
accessible via the extension's `mongodb.debug <https://www.php.net/manual/en/mongodb.configuration.php#ini.mongodb.debug>`__

Check failure on line 79 in source/whats-new.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidAccessible] Use accessible only to refer to things that all people, including those with disabilities, can easily use. Don’t use it to mean simple or open.

Raw Output:
{"message": "[MongoDB.AvoidAccessible] Use accessible only to refer to things that all people, including those with disabilities, can easily use. Don’t use it to mean simple or open.", "location": {"path": "source/whats-new.txt", "range": {"start": {"line": 79, "column": 3}}}, "severity": "ERROR"}

Check failure on line 79 in source/whats-new.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidObscure] Use 'through, by' instead of 'via'.

Raw Output:
{"message": "[MongoDB.AvoidObscure] Use 'through, by' instead of 'via'.", "location": {"path": "source/whats-new.txt", "range": {"start": {"line": 79, "column": 14}}}, "severity": "ERROR"}
INI setting.

- Introduces new :ref:`MongoDB\Collection <api-mongodb-collection-class>` methods
to create and manage :atlas:`Atlas Search indexes </atlas-search>`. Atlas
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: since this link takes readers out of the PHP docs, I'd clarify where the link is going. You could remove the link here and add a sentence to the end of this bullet point ("To learn more about Atlas Search indexes, see the :atlas:`Atlas Search documentation `.")

Copy link
Collaborator

Choose a reason for hiding this comment

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

Applies to all inline links that go to the Atlas/server docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks! What do you think of changes?

Copy link
Collaborator

Choose a reason for hiding this comment

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

looks good!

Search indexes can be queried using the :manual:`$search </reference/operator/aggregation/search/>`
aggregation pipeline stage, which is supported in all versions of the library.

- Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP
7.2 and 7.3 has been removed and the library now requires PHP 7.4 or newer.

To learn more about this release, see the `v1.17 Release Notes
<https://github.com/mongodb/mongo-php-library/releases/tag/1.17.0>`__ on GitHub.

.. _php-lib-version-1.16:

What's New in 1.16
------------------

- Introduces support for :v7.0:`MongoDB 7.0 </release-notes/7.0>`.

- Introduces :ref:`MongoDB\Database::createEncryptedCollection() <api-database-create-encrypted>`.
This method automatically creates data encryption keys when creating a new
encrypted collection.

- This release upgrades the ``mongodb`` extension requirement to 1.16.0.

To learn more about this release, see the `v1.16 Release Notes
<https://github.com/mongodb/mongo-php-library/releases/tag/1.16.0>`__ on GitHub.

.. _php-lib-version-1.15:

What's New in 1.15
------------------

- Adds new ``examples/`` and ``tools/`` directories to library repository,
which contain code snippets and scripts that may prove useful when writing
or debugging applications, respectively. These directories are intended to

Check failure on line 116 in source/whats-new.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.Avoid] Don't use 'respectively'.

Raw Output:
{"message": "[MongoDB.Avoid] Don't use 'respectively'.", "location": {"path": "source/whats-new.txt", "range": {"start": {"line": 116, "column": 30}}}, "severity": "ERROR"}
supplement the library's existing documentation, and will be added to over time.

- Various backwards compatible typing improvements have been made throughout the
library. Downstream impact for these changes are discussed in
`UPGRADE-1.15.md <https://github.com/mongodb/mongo-php-library/blob/1.15.0/UPGRADE-1.15.md>`__.

- Integrates `Psalm <https://psalm.dev/>`__ for static analysis.

- This release upgrades the ``mongodb`` extension requirement to 1.15.0.

To learn more about this release, see the `v1.15 Release Notes
<https://github.com/mongodb/mongo-php-library/releases/tag/1.15.0>`__ on GitHub.
Loading