Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 3 additions & 0 deletions source/faq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
Frequently Asked Questions
==========================

.. meta::
:description: Find solutions to common PHP extension installation errors, connection handling, and server selection failures when using the MongoDB PHP library.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB PHP Library
===================

.. meta::
:description: Explore the MongoDB PHP Library for high-level database operations, including installation, connection, data manipulation, and deployment on AWS Lambda.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
API Documentation
=================

.. meta::
:description: Explore the PHP library API reference for detailed information on available methods and classes.


.. toctree::
:titlesonly:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/bson.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
BSON
====

.. meta::
:description: Understand how BSON documents and arrays are represented and serialized in the MongoDB PHP Library using BSONDocument and BSONArray classes.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/class/MongoDBClient.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client Class
=====================

.. meta::
:description: Explore the MongoDB\Client class, which serves as the entry point for connecting to MongoDB servers and accessing databases and collections in PHP.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/class/MongoDBCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection Class
=========================

.. meta::
:description: Explore methods for performing CRUD operations and index management with the MongoDB\\Collection class in PHP.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/class/MongoDBDatabase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Database Class
=======================

.. meta::
:description: Explore methods for database operations and collection management using the `MongoDB\\Database` class in PHP.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/class/MongoDBGridFSBucket.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\GridFS\\Bucket Class
=============================

.. meta::
:description: Explore the `MongoDB\GridFS\Bucket` class for managing file storage and retrieval in MongoDB using PHP Streams.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/exception-classes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Exception Classes
=================

.. meta::
:description: Explore various exception classes in the PHP library for MongoDB, detailing their usage and inheritance.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-addSubscriber.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::addSubscriber()
================================

.. meta::
:description: Register a monitoring event subscriber with a MongoDB Client to receive notifications of all events for that Client.

.. versionadded:: 1.18


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::createClientEncryption()
=========================================

.. meta::
:description: Create a ClientEncryption object in PHP for manual encryption and decryption of values using MongoDB's `createClientEncryption()` method.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-dropDatabase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::dropDatabase()
===============================

.. meta::
:description: Drop a database on the server using `MongoDB\Client::dropDatabase()` with options for comments, sessions, type maps, and write concerns.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-getManager.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::getManager()
=============================

.. meta::
:description: Access the MongoDB\Driver\Manager used by a Client with the getManager() method.


.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-getReadConcern.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::getReadConcern()
=================================

.. meta::
:description: Retrieve the read concern level set for a MongoDB client using the `getReadConcern()` method.

.. versionadded:: 1.2


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-getReadPreference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::getReadPreference()
====================================

.. meta::
:description: Retrieve the read preference setting for a MongoDB client using the `getReadPreference()` method.

.. versionadded:: 1.2


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-getTypeMap.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::getTypeMap()
=============================

.. meta::
:description: Retrieve the type map for a MongoDB client using the `getTypeMap()` method in PHP.

.. versionadded:: 1.2


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-getWriteConcern.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::getWriteConcern()
==================================

.. meta::
:description: Retrieve the write concern for a MongoDB client using the `getWriteConcern()` method in PHP.

.. versionadded:: 1.2


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-listDatabaseNames.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::listDatabaseNames()
====================================

.. meta::
:description: Retrieve database names from a MongoDB server using the `listDatabaseNames()` method with optional parameters for filtering and session management.

.. versionadded:: 1.7


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-listDatabases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::listDatabases()
================================

.. meta::
:description: Retrieve information for all databases on the server using `MongoDB\Client::listDatabases()` with optional parameters for filtering and session association.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-removeSubscriber.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::removeSubscriber()
===================================

.. meta::
:description: Unregister a monitoring event subscriber from a MongoDB client using the `removeSubscriber()` method.

.. versionadded:: 1.18


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-selectCollection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::selectCollection()
===================================

.. meta::
:description: Select a collection on the server using `MongoDB\Client::selectCollection()` with customizable options for read and write concerns.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-selectDatabase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::selectDatabase()
=================================

.. meta::
:description: Select a database on the server using `MongoDB\Client::selectDatabase()`, with options for read and write concerns, read preference, and type mapping.

.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-startSession.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::startSession()
===============================

.. meta::
:description: Start a new client session in PHP using `MongoDB\Client::startSession()` and handle potential exceptions.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Start a new client session in PHP using `MongoDB\Client::startSession()` and handle potential exceptions.
:description: Start a new client session with the MongoDB PHP Library and handle potential exceptions.


.. versionadded:: 1.3


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient-watch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::watch()
========================

.. meta::
:description: Execute a change stream operation on the client to monitor cluster-level changes using `MongoDB\Client::watch()`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Execute a change stream operation on the client to monitor cluster-level changes using `MongoDB\Client::watch()`.
:description: Execute a change stream operation on the Client to monitor cluster-level changes with the MongoDB PHP Library.


.. versionadded:: 1.4


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient__construct.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::__construct()
==============================

.. meta::
:description: Learn how to construct a new MongoDB Client instance in PHP, including options for connection strings, authentication, SSL, and custom type maps.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Learn how to construct a new MongoDB Client instance in PHP, including options for connection strings, authentication, SSL, and custom type maps.
:description: Learn how to construct a new MongoDB Client instance with the MongoDB PHP Library, including options for connection strings, authentication, SSL, and custom type maps.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBClient__get.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Client::__get()
========================

.. meta::
:description: Access a database on the server using the `MongoDB\Client::__get()` method, which acts as an alias for `selectDatabase()`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Access a database on the server using the `MongoDB\Client::__get()` method, which acts as an alias for `selectDatabase()`.
:description: Access a database on the server with the MongoDB PHP Library, which acts as an alias for the selectDatabase() method.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-aggregate.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::aggregate()
================================

.. meta::
:description: Execute an aggregation framework pipeline operation on a collection using `MongoDB\Collection::aggregate()` with various customizable options.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Execute an aggregation framework pipeline operation on a collection using `MongoDB\Collection::aggregate()` with various customizable options.
:description: Execute an aggregation framework pipeline operation on a collection with the MongoDB PHP Library, with various customizable options.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-bulkWrite.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::bulkWrite()
================================

.. meta::
:description: Execute multiple write operations in MongoDB using `bulkWrite()` with options for write concern, session, and more.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Execute multiple write operations in MongoDB using `bulkWrite()` with options for write concern, session, and more.
:description: Execute multiple write operations with the MongoDB PHP Library, with options for write concern, session, and more.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-count.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::count()
============================

.. meta::
:description: Count documents matching filter criteria using `MongoDB\Collection::count()`, with options for collation, hint, limit, and more.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Count documents matching filter criteria using `MongoDB\Collection::count()`, with options for collation, hint, limit, and more.
:description: Count documents matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, limit, and more.


.. deprecated:: 1.4


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-countDocuments.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::countDocuments()
=====================================

.. meta::
:description: Count documents in a collection matching filter criteria using `MongoDB\Collection::countDocuments()` with various options for customization.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Count documents in a collection matching filter criteria using `MongoDB\Collection::countDocuments()` with various options for customization.
:description: Count documents in a collection matching a filter criteria with the MongoDB PHP Library, with various options for customization.


.. versionadded:: 1.4


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-createIndex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::createIndex()
==================================

.. meta::
:description: Create an index in a MongoDB collection using `createIndex()` with options for collation, TTL, uniqueness, and more.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Create an index in a MongoDB collection using `createIndex()` with options for collation, TTL, uniqueness, and more.
:description: Create an index in a MongoDB collection with the MongoDB PHP Library, with options for collation, TTL, uniqueness, and more.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-createIndexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::createIndexes()
====================================

.. meta::
:description: Create one or more indexes for a collection using `MongoDB\Collection::createIndexes()` with options for unique, compound, and 2dsphere indexes.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Create one or more indexes for a collection using `MongoDB\Collection::createIndexes()` with options for unique, compound, and 2dsphere indexes.
:description: Create one or more indexes for a collection with the MongoDB PHP Library, with options for unique, compound, and 2dsphere indexes.


.. contents:: On this page
:local:
:backlinks: none
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::createSearchIndex()
========================================

.. meta::
:description: Create an Atlas Search or Vector Search index for a collection using `MongoDB\Collection::createSearchIndex()` in PHP, specifying index type and options.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Create an Atlas Search or Vector Search index for a collection using `MongoDB\Collection::createSearchIndex()` in PHP, specifying index type and options.
:description: Create an Atlas Search or Vector Search index for a collection with the MongoDB PHP Library, specifying index type and options.


.. versionadded:: 1.17

.. contents:: On this page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::createSearchIndexes()
==========================================

.. meta::
:description: Create Atlas Search or Vector Search indexes for a collection using `createSearchIndexes()` in PHP, specifying index definitions and options.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Create Atlas Search or Vector Search indexes for a collection using `createSearchIndexes()` in PHP, specifying index definitions and options.
:description: Create Atlas Search or Vector Search indexes for a collection with the MongoDB PHP Library, specifying index definitions and options.


.. versionadded:: 1.17


Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-deleteMany.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::deleteMany()
=================================

.. meta::
:description: Delete multiple documents in a collection using `deleteMany()` with options for collation, hint, and write concern.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Delete multiple documents in a collection using `deleteMany()` with options for collation, hint, and write concern.
:description: Delete multiple documents in a collection with the MongoDB PHP Library, with options for collation, hint, and write concern.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-deleteOne.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::deleteOne()
================================

.. meta::
:description: Delete a single document matching filter criteria using `MongoDB\Collection::deleteOne()` with options for collation, hint, and write concern.
Copy link
Collaborator

@rachel-mack rachel-mack Apr 14, 2025

Choose a reason for hiding this comment

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

Suggested change
:description: Delete a single document matching filter criteria using `MongoDB\Collection::deleteOne()` with options for collation, hint, and write concern.
:description: Delete a single document matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, and write concern.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-distinct.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::distinct()
===============================

.. meta::
:description: Find distinct values for a specified field in a MongoDB collection using the `distinct()` method, with options for filtering and additional parameters.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Find distinct values for a specified field in a MongoDB collection using the `distinct()` method, with options for filtering and additional parameters.
:description: Find distinct values for a specified field in a collection with the MongoDB PHP Library, with options for filtering and additional parameters.


.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-drop.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::drop()
===========================

.. meta::
:description: Explore how to use the `MongoDB\Collection::drop()` method to remove a collection, including options for write concern and session management.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Explore how to use the `MongoDB\Collection::drop()` method to remove a collection, including options for write concern and session management.
:description: Remove a collection with the MongoDB PHP Library, including options for write concern and session management.



.. contents:: On this page
:local:
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-dropIndex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::dropIndex()
================================

.. meta::
:description: Drop an index from a collection using `MongoDB\Collection::dropIndex()` with options for session, write concern, and more.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Drop an index from a collection using `MongoDB\Collection::dropIndex()` with options for session, write concern, and more.
:description: Drop an index from a collection with the MongoDB PHP Library, with options for session, write concern, and more.


.. contents:: On this page
:local:
:backlinks: none
Expand Down
3 changes: 3 additions & 0 deletions source/reference/method/MongoDBCollection-dropIndexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
MongoDB\\Collection::dropIndexes()
==================================

.. meta::
:description: Drop all indexes in a MongoDB collection except the `_id` index using the `dropIndexes()` method, with options for comments, time limits, and write concerns.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
:description: Drop all indexes in a MongoDB collection except the `_id` index using the `dropIndexes()` method, with options for comments, time limits, and write concerns.
:description: Drop all indexes in a MongoDB collection except the `_id` index with the MongoDB PHP Library, with options for comments, time limits, and write concerns.


.. contents:: On this page
:local:
:backlinks: none
Expand Down
Loading
Loading