Skip to content

Commit 498acd3

Browse files
rachel-macknlarew
andauthored
Add missing meta descriptions (#235) (#236)
* Add missing meta descriptions * Apply suggestions from code review --------- Co-authored-by: Nick Larew <[email protected]>
1 parent 6d09763 commit 498acd3

File tree

80 files changed

+238
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+238
-0
lines changed

source/faq.txt

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Frequently Asked Questions
55
==========================
66

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

811
.. contents:: On this page
912
:local:

source/index.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB PHP Library
33
===================
44

5+
.. meta::
6+
:description: Explore the MongoDB PHP Library for high-level database operations, including installation, connection, data manipulation, and deployment on AWS Lambda.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
API Documentation
33
=================
44

5+
.. meta::
6+
:description: Explore the MongoDB PHP library API reference for detailed information on available methods and classes.
7+
58

69
.. toctree::
710
:titlesonly:

source/reference/bson.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
BSON
33
====
44

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

69
.. contents:: On this page
710
:local:

source/reference/class/MongoDBClient.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client Class
33
=====================
44

5+
.. meta::
6+
: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.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/class/MongoDBCollection.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection Class
33
=========================
44

5+
.. meta::
6+
:description: Explore methods for performing CRUD operations and index management with the MongoDB\Collection class in the MongoDB PHP Library.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/class/MongoDBDatabase.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Database Class
33
=======================
44

5+
.. meta::
6+
:description: Explore methods for database operations and collection management using the MongoDB\Database class in the MongoDB PHP Library.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/class/MongoDBGridFSBucket.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\GridFS\\Bucket Class
33
=============================
44

5+
.. meta::
6+
:description: Explore the MongoDB\GridFS\Bucket class for managing file storage and retrieval in the MongoDB PHP Library using PHP Streams.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/exception-classes.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Exception Classes
33
=================
44

5+
.. meta::
6+
:description: Explore MongoDB\Exception classes in the MongoDB PHP Library, detailing their usage and inheritance.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBClient-addSubscriber.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::addSubscriber()
33
================================
44

5+
.. meta::
6+
:description: Register a monitoring event subscriber with a MongoDB Client to receive notifications of all events for that Client.
7+
58
.. versionadded:: 1.18
69

710

source/reference/method/MongoDBClient-createClientEncryption.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::createClientEncryption()
33
=========================================
44

5+
.. meta::
6+
:description: Create a ClientEncryption object in PHP for manual encryption and decryption of values with the MongoDB PHP Library.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBClient-dropDatabase.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::dropDatabase()
33
===============================
44

5+
.. meta::
6+
:description: Drop a database on the server with options for comments, sessions, type maps, and write concerns with the MongoDB PHP Library.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBClient-getManager.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::getManager()
33
=============================
44

5+
.. meta::
6+
:description: Access the MongoDB\Driver\Manager used by a Client with the MongoDB PHP Library.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBClient-getReadConcern.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::getReadConcern()
33
=================================
44

5+
.. meta::
6+
:description: Retrieve the read concern level set for a Client with the MongoDB PHP Library.
7+
58
.. versionadded:: 1.2
69

710

source/reference/method/MongoDBClient-getReadPreference.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::getReadPreference()
33
====================================
44

5+
.. meta::
6+
:description: Retrieve the read preference setting for a Client with the MongoDB PHP Library.
7+
58
.. versionadded:: 1.2
69

710

source/reference/method/MongoDBClient-getTypeMap.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::getTypeMap()
33
=============================
44

5+
.. meta::
6+
:description: Retrieve the type map for a Client with the MongoDB PHP Library.
7+
58
.. versionadded:: 1.2
69

710

source/reference/method/MongoDBClient-getWriteConcern.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::getWriteConcern()
33
==================================
44

5+
.. meta::
6+
:description: Retrieve the write concern for a Client with the MongoDB PHP Library.
7+
58
.. versionadded:: 1.2
69

710

source/reference/method/MongoDBClient-listDatabaseNames.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::listDatabaseNames()
33
====================================
44

5+
.. meta::
6+
:description: Retrieve database names from a MongoDB server with the MongoDB PHP Library, with optional parameters for filtering and session management.
7+
58
.. versionadded:: 1.7
69

710

source/reference/method/MongoDBClient-listDatabases.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::listDatabases()
33
================================
44

5+
.. meta::
6+
:description: Retrieve information for all databases on the server with the MongoDB PHP Library, with optional parameters for filtering and session association.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBClient-removeSubscriber.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::removeSubscriber()
33
===================================
44

5+
.. meta::
6+
:description: Unregister a monitoring event subscriber from a Client with the MongoDB PHP Library.
7+
58
.. versionadded:: 1.18
69

710

source/reference/method/MongoDBClient-selectCollection.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::selectCollection()
33
===================================
44

5+
.. meta::
6+
:description: Select a collection on the server with the MongoDB PHP Library, with customizable options for read and write concerns.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBClient-selectDatabase.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::selectDatabase()
33
=================================
44

5+
.. meta::
6+
:description: Select a database on the server with the MongoDB PHP Library, with options for read and write concerns, read preference, and type mapping.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBClient-startSession.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::startSession()
33
===============================
44

5+
.. meta::
6+
:description: Start a new client session with the MongoDB PHP Library and handle potential exceptions.
7+
58
.. versionadded:: 1.3
69

710

source/reference/method/MongoDBClient-watch.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::watch()
33
========================
44

5+
.. meta::
6+
:description: Execute a change stream operation on the Client to monitor cluster-level changes with the MongoDB PHP Library.
7+
58
.. versionadded:: 1.4
69

710

source/reference/method/MongoDBClient__construct.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::__construct()
33
==============================
44

5+
.. meta::
6+
: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.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBClient__get.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Client::__get()
33
========================
44

5+
.. meta::
6+
:description: Access a database on the server with the MongoDB PHP Library, which acts as an alias for the selectDatabase() method.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-aggregate.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::aggregate()
33
================================
44

5+
.. meta::
6+
:description: Execute an aggregation framework pipeline operation on a collection with the MongoDB PHP Library, with various customizable options.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-bulkWrite.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::bulkWrite()
33
================================
44

5+
.. meta::
6+
:description: Execute multiple write operations with the MongoDB PHP Library, with options for write concern, session, and more.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-count.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::count()
33
============================
44

5+
.. meta::
6+
:description: Count documents matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, limit, and more.
7+
58
.. deprecated:: 1.4
69

710

source/reference/method/MongoDBCollection-countDocuments.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::countDocuments()
33
=====================================
44

5+
.. meta::
6+
:description: Count documents in a collection matching a filter criteria with the MongoDB PHP Library, with various options for customization.
7+
58
.. versionadded:: 1.4
69

710

source/reference/method/MongoDBCollection-createIndex.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::createIndex()
33
==================================
44

5+
.. meta::
6+
:description: Create an index in a MongoDB collection with the MongoDB PHP Library, with options for collation, TTL, uniqueness, and more.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-createIndexes.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::createIndexes()
33
====================================
44

5+
.. meta::
6+
:description: Create one or more indexes for a collection with the MongoDB PHP Library, with options for unique, compound, and 2dsphere indexes.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBCollection-createSearchIndex.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::createSearchIndex()
33
========================================
44

5+
.. meta::
6+
:description: Create an Atlas Search or Vector Search index for a collection with the MongoDB PHP Library, specifying index type and options.
7+
58
.. versionadded:: 1.17
69

710
.. contents:: On this page

source/reference/method/MongoDBCollection-createSearchIndexes.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::createSearchIndexes()
33
==========================================
44

5+
.. meta::
6+
:description: Create Atlas Search or Vector Search indexes for a collection with the MongoDB PHP Library, specifying index definitions and options.
7+
58
.. versionadded:: 1.17
69

710

source/reference/method/MongoDBCollection-deleteMany.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::deleteMany()
33
=================================
44

5+
.. meta::
6+
:description: Delete multiple documents in a collection with the MongoDB PHP Library, with options for collation, hint, and write concern.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-deleteOne.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::deleteOne()
33
================================
44

5+
.. meta::
6+
:description: Delete a single document matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, and write concern.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-distinct.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::distinct()
33
===============================
44

5+
.. meta::
6+
:description: Find distinct values for a specified field in a collection with the MongoDB PHP Library, with options for filtering and additional parameters.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBCollection-drop.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::drop()
33
===========================
44

5+
.. meta::
6+
:description: Remove a collection with the MongoDB PHP Library, including options for write concern and session management.
7+
58

69
.. contents:: On this page
710
:local:

source/reference/method/MongoDBCollection-dropIndex.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::dropIndex()
33
================================
44

5+
.. meta::
6+
:description: Drop an index from a collection with the MongoDB PHP Library, with options for session, write concern, and more.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

source/reference/method/MongoDBCollection-dropIndexes.txt

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
MongoDB\\Collection::dropIndexes()
33
==================================
44

5+
.. meta::
6+
: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.
7+
58
.. contents:: On this page
69
:local:
710
:backlinks: none

0 commit comments

Comments
 (0)