diff --git a/source/faq.txt b/source/faq.txt index 3e6c03d5..3b7a6edf 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -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: diff --git a/source/index.txt b/source/index.txt index 6d456d74..53398b22 100644 --- a/source/index.txt +++ b/source/index.txt @@ -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 diff --git a/source/reference.txt b/source/reference.txt index 7127505b..d987e7c8 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -2,6 +2,9 @@ API Documentation ================= +.. meta:: + :description: Explore the MongoDB PHP library API reference for detailed information on available methods and classes. + .. toctree:: :titlesonly: diff --git a/source/reference/bson.txt b/source/reference/bson.txt index 8d5b1393..8b2948a3 100644 --- a/source/reference/bson.txt +++ b/source/reference/bson.txt @@ -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: diff --git a/source/reference/class/MongoDBClient.txt b/source/reference/class/MongoDBClient.txt index 27125c62..36b3cea6 100644 --- a/source/reference/class/MongoDBClient.txt +++ b/source/reference/class/MongoDBClient.txt @@ -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 the MongoDB PHP Library. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/class/MongoDBCollection.txt b/source/reference/class/MongoDBCollection.txt index 33e3e7e3..29501088 100644 --- a/source/reference/class/MongoDBCollection.txt +++ b/source/reference/class/MongoDBCollection.txt @@ -2,6 +2,9 @@ MongoDB\\Collection Class ========================= +.. meta:: + :description: Explore methods for performing CRUD operations and index management with the MongoDB\Collection class in the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/class/MongoDBDatabase.txt b/source/reference/class/MongoDBDatabase.txt index 9db6317f..713db8c5 100644 --- a/source/reference/class/MongoDBDatabase.txt +++ b/source/reference/class/MongoDBDatabase.txt @@ -2,6 +2,9 @@ MongoDB\\Database Class ======================= +.. meta:: + :description: Explore methods for database operations and collection management using the MongoDB\Database class in the MongoDB PHP Library. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/class/MongoDBGridFSBucket.txt b/source/reference/class/MongoDBGridFSBucket.txt index ab7f42b4..eb574d32 100644 --- a/source/reference/class/MongoDBGridFSBucket.txt +++ b/source/reference/class/MongoDBGridFSBucket.txt @@ -2,6 +2,9 @@ MongoDB\\GridFS\\Bucket Class ============================= +.. meta:: + :description: Explore the MongoDB\GridFS\Bucket class for managing file storage and retrieval in the MongoDB PHP Library using PHP Streams. + .. contents:: On this page :local: diff --git a/source/reference/exception-classes.txt b/source/reference/exception-classes.txt index d862eb7d..aed23515 100644 --- a/source/reference/exception-classes.txt +++ b/source/reference/exception-classes.txt @@ -2,6 +2,9 @@ Exception Classes ================= +.. meta:: + :description: Explore MongoDB\Exception classes in the MongoDB PHP Library, detailing their usage and inheritance. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBClient-addSubscriber.txt b/source/reference/method/MongoDBClient-addSubscriber.txt index 74b19d70..a51263a7 100644 --- a/source/reference/method/MongoDBClient-addSubscriber.txt +++ b/source/reference/method/MongoDBClient-addSubscriber.txt @@ -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 diff --git a/source/reference/method/MongoDBClient-createClientEncryption.txt b/source/reference/method/MongoDBClient-createClientEncryption.txt index b791d681..ac458644 100644 --- a/source/reference/method/MongoDBClient-createClientEncryption.txt +++ b/source/reference/method/MongoDBClient-createClientEncryption.txt @@ -2,6 +2,9 @@ MongoDB\\Client::createClientEncryption() ========================================= +.. meta:: + :description: Create a ClientEncryption object in PHP for manual encryption and decryption of values with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBClient-dropDatabase.txt b/source/reference/method/MongoDBClient-dropDatabase.txt index dc01eebe..d5420e3b 100644 --- a/source/reference/method/MongoDBClient-dropDatabase.txt +++ b/source/reference/method/MongoDBClient-dropDatabase.txt @@ -2,6 +2,9 @@ MongoDB\\Client::dropDatabase() =============================== +.. meta:: + :description: Drop a database on the server with options for comments, sessions, type maps, and write concerns with the MongoDB PHP Library. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBClient-getManager.txt b/source/reference/method/MongoDBClient-getManager.txt index 4aa73cea..e3d72282 100644 --- a/source/reference/method/MongoDBClient-getManager.txt +++ b/source/reference/method/MongoDBClient-getManager.txt @@ -2,6 +2,9 @@ MongoDB\\Client::getManager() ============================= +.. meta:: + :description: Access the MongoDB\Driver\Manager used by a Client with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBClient-getReadConcern.txt b/source/reference/method/MongoDBClient-getReadConcern.txt index 77026f76..7e8ec896 100644 --- a/source/reference/method/MongoDBClient-getReadConcern.txt +++ b/source/reference/method/MongoDBClient-getReadConcern.txt @@ -2,6 +2,9 @@ MongoDB\\Client::getReadConcern() ================================= +.. meta:: + :description: Retrieve the read concern level set for a Client with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBClient-getReadPreference.txt b/source/reference/method/MongoDBClient-getReadPreference.txt index 3ffd3240..4a7b2a2d 100644 --- a/source/reference/method/MongoDBClient-getReadPreference.txt +++ b/source/reference/method/MongoDBClient-getReadPreference.txt @@ -2,6 +2,9 @@ MongoDB\\Client::getReadPreference() ==================================== +.. meta:: + :description: Retrieve the read preference setting for a Client with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBClient-getTypeMap.txt b/source/reference/method/MongoDBClient-getTypeMap.txt index 57cae044..632933cd 100644 --- a/source/reference/method/MongoDBClient-getTypeMap.txt +++ b/source/reference/method/MongoDBClient-getTypeMap.txt @@ -2,6 +2,9 @@ MongoDB\\Client::getTypeMap() ============================= +.. meta:: + :description: Retrieve the type map for a Client with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBClient-getWriteConcern.txt b/source/reference/method/MongoDBClient-getWriteConcern.txt index d2a566de..19cb5cb1 100644 --- a/source/reference/method/MongoDBClient-getWriteConcern.txt +++ b/source/reference/method/MongoDBClient-getWriteConcern.txt @@ -2,6 +2,9 @@ MongoDB\\Client::getWriteConcern() ================================== +.. meta:: + :description: Retrieve the write concern for a Client with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBClient-listDatabaseNames.txt b/source/reference/method/MongoDBClient-listDatabaseNames.txt index 4f12d628..47ba4978 100644 --- a/source/reference/method/MongoDBClient-listDatabaseNames.txt +++ b/source/reference/method/MongoDBClient-listDatabaseNames.txt @@ -2,6 +2,9 @@ MongoDB\\Client::listDatabaseNames() ==================================== +.. meta:: + :description: Retrieve database names from a MongoDB server with the MongoDB PHP Library, with optional parameters for filtering and session management. + .. versionadded:: 1.7 diff --git a/source/reference/method/MongoDBClient-listDatabases.txt b/source/reference/method/MongoDBClient-listDatabases.txt index 718e3717..baada43b 100644 --- a/source/reference/method/MongoDBClient-listDatabases.txt +++ b/source/reference/method/MongoDBClient-listDatabases.txt @@ -2,6 +2,9 @@ MongoDB\\Client::listDatabases() ================================ +.. meta:: + :description: Retrieve information for all databases on the server with the MongoDB PHP Library, with optional parameters for filtering and session association. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBClient-removeSubscriber.txt b/source/reference/method/MongoDBClient-removeSubscriber.txt index 9c43f8b2..9d66b90d 100644 --- a/source/reference/method/MongoDBClient-removeSubscriber.txt +++ b/source/reference/method/MongoDBClient-removeSubscriber.txt @@ -2,6 +2,9 @@ MongoDB\\Client::removeSubscriber() =================================== +.. meta:: + :description: Unregister a monitoring event subscriber from a Client with the MongoDB PHP Library. + .. versionadded:: 1.18 diff --git a/source/reference/method/MongoDBClient-selectCollection.txt b/source/reference/method/MongoDBClient-selectCollection.txt index 0ca80161..aa2fdb29 100644 --- a/source/reference/method/MongoDBClient-selectCollection.txt +++ b/source/reference/method/MongoDBClient-selectCollection.txt @@ -2,6 +2,9 @@ MongoDB\\Client::selectCollection() =================================== +.. meta:: + :description: Select a collection on the server with the MongoDB PHP Library, with customizable options for read and write concerns. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBClient-selectDatabase.txt b/source/reference/method/MongoDBClient-selectDatabase.txt index 0c1913de..5f270aee 100644 --- a/source/reference/method/MongoDBClient-selectDatabase.txt +++ b/source/reference/method/MongoDBClient-selectDatabase.txt @@ -2,6 +2,9 @@ MongoDB\\Client::selectDatabase() ================================= +.. meta:: + :description: Select a database on the server with the MongoDB PHP Library, with options for read and write concerns, read preference, and type mapping. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBClient-startSession.txt b/source/reference/method/MongoDBClient-startSession.txt index 32a1ec0f..0c9c42a8 100644 --- a/source/reference/method/MongoDBClient-startSession.txt +++ b/source/reference/method/MongoDBClient-startSession.txt @@ -2,6 +2,9 @@ MongoDB\\Client::startSession() =============================== +.. meta:: + :description: Start a new client session with the MongoDB PHP Library and handle potential exceptions. + .. versionadded:: 1.3 diff --git a/source/reference/method/MongoDBClient-watch.txt b/source/reference/method/MongoDBClient-watch.txt index c097f4bf..8bf455d2 100644 --- a/source/reference/method/MongoDBClient-watch.txt +++ b/source/reference/method/MongoDBClient-watch.txt @@ -2,6 +2,9 @@ MongoDB\\Client::watch() ======================== +.. meta:: + :description: Execute a change stream operation on the Client to monitor cluster-level changes with the MongoDB PHP Library. + .. versionadded:: 1.4 diff --git a/source/reference/method/MongoDBClient__construct.txt b/source/reference/method/MongoDBClient__construct.txt index 6b052161..50214f2a 100644 --- a/source/reference/method/MongoDBClient__construct.txt +++ b/source/reference/method/MongoDBClient__construct.txt @@ -2,6 +2,9 @@ MongoDB\\Client::__construct() ============================== +.. meta:: + :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: diff --git a/source/reference/method/MongoDBClient__get.txt b/source/reference/method/MongoDBClient__get.txt index 82c1016a..153eb8c9 100644 --- a/source/reference/method/MongoDBClient__get.txt +++ b/source/reference/method/MongoDBClient__get.txt @@ -2,6 +2,9 @@ MongoDB\\Client::__get() ======================== +.. meta:: + :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: diff --git a/source/reference/method/MongoDBCollection-aggregate.txt b/source/reference/method/MongoDBCollection-aggregate.txt index 7f459acb..24080b45 100644 --- a/source/reference/method/MongoDBCollection-aggregate.txt +++ b/source/reference/method/MongoDBCollection-aggregate.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::aggregate() ================================ +.. meta:: + :description: Execute an aggregation framework pipeline operation on a collection with the MongoDB PHP Library, with various customizable options. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-bulkWrite.txt b/source/reference/method/MongoDBCollection-bulkWrite.txt index 0e5f9a97..4a85ab91 100644 --- a/source/reference/method/MongoDBCollection-bulkWrite.txt +++ b/source/reference/method/MongoDBCollection-bulkWrite.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::bulkWrite() ================================ +.. meta:: + :description: Execute multiple write operations with the MongoDB PHP Library, with options for write concern, session, and more. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-count.txt b/source/reference/method/MongoDBCollection-count.txt index 1419f55d..5e0d3112 100644 --- a/source/reference/method/MongoDBCollection-count.txt +++ b/source/reference/method/MongoDBCollection-count.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::count() ============================ +.. meta:: + :description: Count documents matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, limit, and more. + .. deprecated:: 1.4 diff --git a/source/reference/method/MongoDBCollection-countDocuments.txt b/source/reference/method/MongoDBCollection-countDocuments.txt index e4ef152a..dc882777 100644 --- a/source/reference/method/MongoDBCollection-countDocuments.txt +++ b/source/reference/method/MongoDBCollection-countDocuments.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::countDocuments() ===================================== +.. meta:: + :description: Count documents in a collection matching a filter criteria with the MongoDB PHP Library, with various options for customization. + .. versionadded:: 1.4 diff --git a/source/reference/method/MongoDBCollection-createIndex.txt b/source/reference/method/MongoDBCollection-createIndex.txt index aabb5679..e99712f6 100644 --- a/source/reference/method/MongoDBCollection-createIndex.txt +++ b/source/reference/method/MongoDBCollection-createIndex.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::createIndex() ================================== +.. meta:: + :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: diff --git a/source/reference/method/MongoDBCollection-createIndexes.txt b/source/reference/method/MongoDBCollection-createIndexes.txt index 244b3bec..dc6d2f5a 100644 --- a/source/reference/method/MongoDBCollection-createIndexes.txt +++ b/source/reference/method/MongoDBCollection-createIndexes.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::createIndexes() ==================================== +.. meta:: + :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 diff --git a/source/reference/method/MongoDBCollection-createSearchIndex.txt b/source/reference/method/MongoDBCollection-createSearchIndex.txt index a229a153..5666c5c9 100644 --- a/source/reference/method/MongoDBCollection-createSearchIndex.txt +++ b/source/reference/method/MongoDBCollection-createSearchIndex.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::createSearchIndex() ======================================== +.. meta:: + :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 diff --git a/source/reference/method/MongoDBCollection-createSearchIndexes.txt b/source/reference/method/MongoDBCollection-createSearchIndexes.txt index 6c1b4981..e96d1a5d 100644 --- a/source/reference/method/MongoDBCollection-createSearchIndexes.txt +++ b/source/reference/method/MongoDBCollection-createSearchIndexes.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::createSearchIndexes() ========================================== +.. meta:: + :description: Create Atlas Search or Vector Search indexes for a collection with the MongoDB PHP Library, specifying index definitions and options. + .. versionadded:: 1.17 diff --git a/source/reference/method/MongoDBCollection-deleteMany.txt b/source/reference/method/MongoDBCollection-deleteMany.txt index 756f8da8..0f38e058 100644 --- a/source/reference/method/MongoDBCollection-deleteMany.txt +++ b/source/reference/method/MongoDBCollection-deleteMany.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::deleteMany() ================================= +.. meta:: + :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: diff --git a/source/reference/method/MongoDBCollection-deleteOne.txt b/source/reference/method/MongoDBCollection-deleteOne.txt index 40204c82..a479f237 100644 --- a/source/reference/method/MongoDBCollection-deleteOne.txt +++ b/source/reference/method/MongoDBCollection-deleteOne.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::deleteOne() ================================ +.. meta:: + :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: diff --git a/source/reference/method/MongoDBCollection-distinct.txt b/source/reference/method/MongoDBCollection-distinct.txt index 2ca85299..045b3012 100644 --- a/source/reference/method/MongoDBCollection-distinct.txt +++ b/source/reference/method/MongoDBCollection-distinct.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::distinct() =============================== +.. meta:: + :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 diff --git a/source/reference/method/MongoDBCollection-drop.txt b/source/reference/method/MongoDBCollection-drop.txt index cb0bae16..a7a9df1f 100644 --- a/source/reference/method/MongoDBCollection-drop.txt +++ b/source/reference/method/MongoDBCollection-drop.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::drop() =========================== +.. meta:: + :description: Remove a collection with the MongoDB PHP Library, including options for write concern and session management. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-dropIndex.txt b/source/reference/method/MongoDBCollection-dropIndex.txt index c6546655..bbbff49c 100644 --- a/source/reference/method/MongoDBCollection-dropIndex.txt +++ b/source/reference/method/MongoDBCollection-dropIndex.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::dropIndex() ================================ +.. meta:: + :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 diff --git a/source/reference/method/MongoDBCollection-dropIndexes.txt b/source/reference/method/MongoDBCollection-dropIndexes.txt index 8e544d8b..cad32dcc 100644 --- a/source/reference/method/MongoDBCollection-dropIndexes.txt +++ b/source/reference/method/MongoDBCollection-dropIndexes.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::dropIndexes() ================================== +.. meta:: + :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 diff --git a/source/reference/method/MongoDBCollection-dropSearchIndex.txt b/source/reference/method/MongoDBCollection-dropSearchIndex.txt index 43066312..15e0880b 100644 --- a/source/reference/method/MongoDBCollection-dropSearchIndex.txt +++ b/source/reference/method/MongoDBCollection-dropSearchIndex.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::dropSearchIndex() ====================================== +.. meta:: + :description: Drop an Atlas Search index from a collection with the MongoDB PHP Library, available for Atlas deployments with a minimum M10 cluster tier. + .. versionadded:: 1.17 .. contents:: On this page diff --git a/source/reference/method/MongoDBCollection-estimatedDocumentCount.txt b/source/reference/method/MongoDBCollection-estimatedDocumentCount.txt index efddeba7..542d8c2f 100644 --- a/source/reference/method/MongoDBCollection-estimatedDocumentCount.txt +++ b/source/reference/method/MongoDBCollection-estimatedDocumentCount.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::estimatedDocumentCount() ============================================= +.. meta:: + :description: Estimate the number of documents in a collection with the MongoDB PHP Library, with optional parameters for read concern, read preference, and more. + .. versionadded:: 1.4 diff --git a/source/reference/method/MongoDBCollection-explain.txt b/source/reference/method/MongoDBCollection-explain.txt index 6912556e..52c2520f 100644 --- a/source/reference/method/MongoDBCollection-explain.txt +++ b/source/reference/method/MongoDBCollection-explain.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::explain() ============================== +.. meta:: + :description: Analyze command execution details with the MongoDB PHP Library, including parameters and return values. + .. versionadded:: 1.4 diff --git a/source/reference/method/MongoDBCollection-find.txt b/source/reference/method/MongoDBCollection-find.txt index 484edb55..34cd979f 100644 --- a/source/reference/method/MongoDBCollection-find.txt +++ b/source/reference/method/MongoDBCollection-find.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::find() =========================== +.. meta:: + :description: Query documents with the MongoDB PHP Library, with various options like filters, projections, and sorting in PHP. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBCollection-findOne.txt b/source/reference/method/MongoDBCollection-findOne.txt index 8b880eeb..99aca91c 100644 --- a/source/reference/method/MongoDBCollection-findOne.txt +++ b/source/reference/method/MongoDBCollection-findOne.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::findOne() ============================== +.. meta:: + :description: Find a single document in a collection with the MongoDB PHP Library, with various query and option parameters. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBCollection-findOneAndDelete.txt b/source/reference/method/MongoDBCollection-findOneAndDelete.txt index 67fac4d7..a1eb75cb 100644 --- a/source/reference/method/MongoDBCollection-findOneAndDelete.txt +++ b/source/reference/method/MongoDBCollection-findOneAndDelete.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::findOneAndDelete() ======================================= +.. meta:: + :description: Find and delete a single document in a collection with the MongoDB PHP Library, with options for collation, projection, and more. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-findOneAndReplace.txt b/source/reference/method/MongoDBCollection-findOneAndReplace.txt index 0edf7d68..68c862a4 100644 --- a/source/reference/method/MongoDBCollection-findOneAndReplace.txt +++ b/source/reference/method/MongoDBCollection-findOneAndReplace.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::findOneAndReplace() ======================================== +.. meta:: + :description: Find and replace a document in a collection with the MongoDB PHP Library, with various options and return the modified document. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-findOneAndUpdate.txt b/source/reference/method/MongoDBCollection-findOneAndUpdate.txt index be372645..c48db888 100644 --- a/source/reference/method/MongoDBCollection-findOneAndUpdate.txt +++ b/source/reference/method/MongoDBCollection-findOneAndUpdate.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::findOneAndUpdate() ======================================= +.. meta:: + :description: Find and update a single document in a collection with the MongoDB PHP Library, with options for projection, sorting, and more. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-getCollectionName.txt b/source/reference/method/MongoDBCollection-getCollectionName.txt index dd551923..f2af9daf 100644 --- a/source/reference/method/MongoDBCollection-getCollectionName.txt +++ b/source/reference/method/MongoDBCollection-getCollectionName.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getCollectionName() ======================================== +.. meta:: + :description: Retrieve the name of a collection with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-getDatabaseName.txt b/source/reference/method/MongoDBCollection-getDatabaseName.txt index 1c983c49..89450447 100644 --- a/source/reference/method/MongoDBCollection-getDatabaseName.txt +++ b/source/reference/method/MongoDBCollection-getDatabaseName.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getDatabaseName() ====================================== +.. meta:: + :description: Retrieve the name of the database containing a specific collection with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-getManager.txt b/source/reference/method/MongoDBCollection-getManager.txt index 5f927a2f..42ee0a59 100644 --- a/source/reference/method/MongoDBCollection-getManager.txt +++ b/source/reference/method/MongoDBCollection-getManager.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getManager() ================================= +.. meta:: + :description: Access the MongoDB\Driver\Manager used by a collection with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-getNamespace.txt b/source/reference/method/MongoDBCollection-getNamespace.txt index 09bc7f66..f8f5921e 100644 --- a/source/reference/method/MongoDBCollection-getNamespace.txt +++ b/source/reference/method/MongoDBCollection-getNamespace.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getNamespace() =================================== +.. meta:: + :description: Retrieve the namespace of a collection with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-getReadConcern.txt b/source/reference/method/MongoDBCollection-getReadConcern.txt index fd51e3db..014da099 100644 --- a/source/reference/method/MongoDBCollection-getReadConcern.txt +++ b/source/reference/method/MongoDBCollection-getReadConcern.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getReadConcern() ===================================== +.. meta:: + :description: Retrieve the read concern of a collection with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBCollection-getReadPreference.txt b/source/reference/method/MongoDBCollection-getReadPreference.txt index 8bbb22e7..88a11e03 100644 --- a/source/reference/method/MongoDBCollection-getReadPreference.txt +++ b/source/reference/method/MongoDBCollection-getReadPreference.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getReadPreference() ======================================== +.. meta:: + :description: Retrieve the read preference of a collection with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBCollection-getTypeMap.txt b/source/reference/method/MongoDBCollection-getTypeMap.txt index 02ac773d..63255778 100644 --- a/source/reference/method/MongoDBCollection-getTypeMap.txt +++ b/source/reference/method/MongoDBCollection-getTypeMap.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getTypeMap() ================================= +.. meta:: + :description: Retrieve the type map for a collection with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBCollection-getWriteConcern.txt b/source/reference/method/MongoDBCollection-getWriteConcern.txt index aaf867eb..35af5c1d 100644 --- a/source/reference/method/MongoDBCollection-getWriteConcern.txt +++ b/source/reference/method/MongoDBCollection-getWriteConcern.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::getWriteConcern() ====================================== +.. meta:: + :description: Retrieve the write concern of a collection with the MongoDB PHP Library. + .. versionadded:: 1.2 diff --git a/source/reference/method/MongoDBCollection-insertMany.txt b/source/reference/method/MongoDBCollection-insertMany.txt index 31c4ca82..85875ca5 100644 --- a/source/reference/method/MongoDBCollection-insertMany.txt +++ b/source/reference/method/MongoDBCollection-insertMany.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::insertMany() ================================= +.. meta:: + :description: Insert multiple documents into a collection with the MongoDB PHP Library, with options for validation, write concern, and session management. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-insertOne.txt b/source/reference/method/MongoDBCollection-insertOne.txt index dea76a90..aa92ba9f 100644 --- a/source/reference/method/MongoDBCollection-insertOne.txt +++ b/source/reference/method/MongoDBCollection-insertOne.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::insertOne() ================================ +.. meta:: + :description: Insert a single document into a collection with the MongoDB PHP Library, with options for validation, codec, session, and write concern. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-listIndexes.txt b/source/reference/method/MongoDBCollection-listIndexes.txt index 7281cf1e..de289989 100644 --- a/source/reference/method/MongoDBCollection-listIndexes.txt +++ b/source/reference/method/MongoDBCollection-listIndexes.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::listIndexes() ================================== +.. meta:: + :description: Retrieve information about all indexes in a collection with the MongoDB PHP Library. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBCollection-listSearchIndexes.txt b/source/reference/method/MongoDBCollection-listSearchIndexes.txt index f6a5b550..e08469f7 100644 --- a/source/reference/method/MongoDBCollection-listSearchIndexes.txt +++ b/source/reference/method/MongoDBCollection-listSearchIndexes.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::listSearchIndexes() ======================================== +.. meta:: + :description: Retrieve index information for all search indexes in a collection with the MongoDB PHP Library, with various customizable options. + .. versionadded:: 1.17 diff --git a/source/reference/method/MongoDBCollection-rename.txt b/source/reference/method/MongoDBCollection-rename.txt index eaec8950..720c4d34 100644 --- a/source/reference/method/MongoDBCollection-rename.txt +++ b/source/reference/method/MongoDBCollection-rename.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::rename() ============================= +.. meta:: + :description: Rename a collection with the MongoDB PHP Library, with options for database name, drop target, and write concern. + .. versionadded:: 1.10 .. contents:: On this page diff --git a/source/reference/method/MongoDBCollection-replaceOne.txt b/source/reference/method/MongoDBCollection-replaceOne.txt index b9cf0fc1..13797018 100644 --- a/source/reference/method/MongoDBCollection-replaceOne.txt +++ b/source/reference/method/MongoDBCollection-replaceOne.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::replaceOne() ================================= +.. meta:: + :description: Replace a single document in a collection based on filter criteria with the MongoDB PHP Library, with options for upsert, collation, and more. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBCollection-updateMany.txt b/source/reference/method/MongoDBCollection-updateMany.txt index a5c6b141..86d1d2a2 100644 --- a/source/reference/method/MongoDBCollection-updateMany.txt +++ b/source/reference/method/MongoDBCollection-updateMany.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::updateMany() ================================= +.. meta:: + :description: Update multiple documents in a collection with the MongoDB PHP Library, with various options like filters, collation, and upsert. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection-updateOne.txt b/source/reference/method/MongoDBCollection-updateOne.txt index 4ad2588b..131ac036 100644 --- a/source/reference/method/MongoDBCollection-updateOne.txt +++ b/source/reference/method/MongoDBCollection-updateOne.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::updateOne() ================================ +.. meta:: + :description: Update a single document in a collection with the MongoDB PHP Library, with various options like filters, collation, and upsert, and handle potential exceptions. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBCollection-updateSearchIndex.txt b/source/reference/method/MongoDBCollection-updateSearchIndex.txt index fb31d073..a08cf305 100644 --- a/source/reference/method/MongoDBCollection-updateSearchIndex.txt +++ b/source/reference/method/MongoDBCollection-updateSearchIndex.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::updateSearchIndex() ======================================== +.. meta:: + :description: Update an Atlas Search index for a collection with the MongoDB PHP Library, requiring an Atlas cluster tier of at least M10. + .. versionadded:: 1.17 diff --git a/source/reference/method/MongoDBCollection-watch.txt b/source/reference/method/MongoDBCollection-watch.txt index d02ba299..6510930b 100644 --- a/source/reference/method/MongoDBCollection-watch.txt +++ b/source/reference/method/MongoDBCollection-watch.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::watch() ============================ +.. meta:: + :description: Execute a change stream operation on a collection to monitor collection-level changes with the MongoDB PHP Library. + .. versionadded:: 1.3 diff --git a/source/reference/method/MongoDBCollection-withOptions.txt b/source/reference/method/MongoDBCollection-withOptions.txt index f7077e03..a320aa22 100644 --- a/source/reference/method/MongoDBCollection-withOptions.txt +++ b/source/reference/method/MongoDBCollection-withOptions.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::withOptions() ================================== +.. meta:: + :description: Clone a Collection object with different options with the MongoDB PHP Library, specifying parameters like codec, read concern, and write concern. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBCollection__construct.txt b/source/reference/method/MongoDBCollection__construct.txt index 250f07bf..35fdf3df 100644 --- a/source/reference/method/MongoDBCollection__construct.txt +++ b/source/reference/method/MongoDBCollection__construct.txt @@ -2,6 +2,9 @@ MongoDB\\Collection::__construct() ================================== +.. meta:: + :description: Construct a new Collection instance with the MongoDB PHP Library, with options for read and write concerns, type mapping, and more. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBDatabase-selectGridFSBucket.txt b/source/reference/method/MongoDBDatabase-selectGridFSBucket.txt index fe988ebf..174c0d31 100644 --- a/source/reference/method/MongoDBDatabase-selectGridFSBucket.txt +++ b/source/reference/method/MongoDBDatabase-selectGridFSBucket.txt @@ -2,6 +2,9 @@ MongoDB\\Database::selectGridFSBucket() ======================================= +.. meta:: + :description: Select a GridFS bucket in a MongoDB database with the MongoDB PHP Library, with customizable options for bucket name, chunk size, and more. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt b/source/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt index 420cf6ca..8580397b 100644 --- a/source/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt +++ b/source/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt @@ -2,6 +2,9 @@ MongoDB\\GridFS\\Bucket::downloadToStreamByName() ================================================= +.. meta:: + :description: Select a GridFS file by filename and copy its contents to a writable stream with the MongoDB PHP Library, with options for file revision. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBGridFSBucket-find.txt b/source/reference/method/MongoDBGridFSBucket-find.txt index f52538d0..3ceac0a9 100644 --- a/source/reference/method/MongoDBGridFSBucket-find.txt +++ b/source/reference/method/MongoDBGridFSBucket-find.txt @@ -2,6 +2,9 @@ MongoDB\\GridFS\\Bucket::find() =============================== +.. meta:: + :description: Query documents in a GridFS bucket's files collection with the MongoDB PHP Library, with various filter and option parameters. + .. contents:: On this page :local: :backlinks: none diff --git a/source/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt b/source/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt index 41062f29..25e0b87d 100644 --- a/source/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt +++ b/source/reference/method/MongoDBGridFSBucket-getFileDocumentForStream.txt @@ -2,6 +2,9 @@ MongoDB\\GridFS\\Bucket::getFileDocumentForStream() =================================================== +.. meta:: + :description: Retrieve the file document of a GridFS file associated with a stream with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt b/source/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt index a047362f..22a6b45e 100644 --- a/source/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt +++ b/source/reference/method/MongoDBGridFSBucket-getFileIdForStream.txt @@ -2,6 +2,9 @@ MongoDB\\GridFS\\Bucket::getFileIdForStream() ============================================= +.. meta:: + :description: Retrieve the file document ID for a GridFS file associated with a stream with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt b/source/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt index d853af80..90b4719f 100644 --- a/source/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt +++ b/source/reference/method/MongoDBGridFSBucket-openDownloadStreamByName.txt @@ -2,6 +2,9 @@ MongoDB\\GridFS\\Bucket::openDownloadStreamByName() =================================================== +.. meta:: + :description: Access a GridFS file by its filename and open it as a readable stream with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/tutorial.txt b/source/tutorial.txt index a472adb9..4786bb9e 100644 --- a/source/tutorial.txt +++ b/source/tutorial.txt @@ -3,6 +3,9 @@ Tutorials ========= +.. meta:: + :description: Explore various tutorials for using the MongoDB PHP Library. + .. toctree:: diff --git a/source/tutorial/collation.txt b/source/tutorial/collation.txt index 0cd239b1..26bc2df0 100644 --- a/source/tutorial/collation.txt +++ b/source/tutorial/collation.txt @@ -4,6 +4,9 @@ Collation ========= +.. meta:: + :description: Learn how to use collations to apply language-specific rules for string comparison in collections, indexes, and various operations with the MongoDB PHP Library. + .. contents:: On this page :local: diff --git a/source/tutorial/commands.txt b/source/tutorial/commands.txt index b540cc9e..4305e07a 100644 --- a/source/tutorial/commands.txt +++ b/source/tutorial/commands.txt @@ -4,6 +4,9 @@ Execute Database Commands ========================= +.. meta:: + :description: Learn to execute database commands with the MongoDB PHP Library, including handling single and multiple result documents and setting custom read preferences. + .. contents:: On this page :local: diff --git a/source/tutorial/encryption.txt b/source/tutorial/encryption.txt index fb0085ac..70b99df3 100644 --- a/source/tutorial/encryption.txt +++ b/source/tutorial/encryption.txt @@ -4,6 +4,9 @@ In-Use Encryption ================= +.. meta:: + :description: Learn how to implement in-use encryption in PHP projects with the MongoDB PHP Library, including managing encryption keys and configuring client-side field level encryption. + .. contents:: On this page :local: diff --git a/source/tutorial/server-selection.txt b/source/tutorial/server-selection.txt index 0ef65206..62c20cae 100644 --- a/source/tutorial/server-selection.txt +++ b/source/tutorial/server-selection.txt @@ -4,6 +4,9 @@ Server Selection and Monitoring =============================== +.. meta:: + :description: Understand how the MongoDB PHP Library selects and monitors servers, including connection string options for server selection and monitoring. + .. contents:: On this page :local: diff --git a/source/upgrade.txt b/source/upgrade.txt index b9d5c7ff..c37fc106 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -16,6 +16,7 @@ Upgrade Library Versions .. meta:: :keywords: compatibility, backwards compatibility + :description: Learn how to upgrade the MongoDB PHP Library and PHP extension, ensuring compatibility and addressing breaking changes. Overview --------